ElggPluginManifestParser18.php

Go to the documentation of this file.

<?php
class ElggPluginManifestParser18 extends \ElggPluginManifestParser {
    protected $validAttributes = [
        'name',
        'author',
        'version',
        'blurb',
        'description',
        'id',
        'website',
        'copyright',
        'license',
        'requires',
        'suggests',
        'screenshot',
        'contributor',
        'category',
        'conflicts',
        'provides',
        'activate_on_install',
        'repository',
        'bugtracker',
        'donations',
    ];

    protected $requiredAttributes = [
        'name', 'author', 'version', 'description', 'requires'
    ];

    public function parse() {
        $parsed = [];
        foreach ($this->manifestObject->children as $element) {
            switch ($element->name) {
                // single elements
                case 'blurb':
                case 'description':
                case 'name':
                case 'author':
                case 'version':
                case 'id':
                case 'website':
                case 'copyright':
                case 'license':
                case 'repository':
                case 'bugtracker':
                case 'donations':
                case 'activate_on_install':
                    $parsed[$element->name] = $element->content;
                    break;

                // arrays
                case 'category':
                    $parsed[$element->name][] = $element->content;
                    break;

                // 3d arrays
                case 'screenshot':
                case 'contributor':
                case 'provides':
                case 'conflicts':
                case 'requires':
                case 'suggests':
                    if (!isset($element->children)) {
                        return false;
                    }

                    $info = [];
                    foreach ($element->children as $child_element) {
                        $info[$child_element->name] = $child_element->content;
                    }

                    $parsed[$element->name][] = $info;
                    break;
            }
        }

        // check we have all the required fields
        foreach ($this->requiredAttributes as $attr) {
            if (!array_key_exists($attr, $parsed)) {
                $msg = elgg_echo(
                    'PluginException:ParserErrorMissingRequiredAttribute',
                    [$attr, $this->caller->getPluginID()]
                );
                    
                throw PluginException::factory('ParserErrorMissingRequiredAttribute', null, $msg);
            }
        }

        $this->manifest = $parsed;

        if (!$this->manifest) {
            return false;
        }

        return true;
    }
}