generators\AddonXml\AddonXmlGenerator

Complexity

Total Complexity

41

Size/Duplication

Total Lines	512
Duplicated Lines	0 %

Importance

Changes

0

28 Methods

Rating	Name	Duplication	Size	Complexity
A	getAddon()	0	9	2
A	setSettingsLayout()	0	5	1
A	createAddon()	0	12	1
A	setScheme()	0	5	1
A	setStatus()	0	5	1
A	getSection()	0	3	1
A	setSettings()	0	5	1
A	addSection()	0	29	3
A	setVersion()	0	5	1
A	setSetting()	0	28	1
A	getSettings()	0	3	1
A	setContent()	0	10	2
A	getTemplateFilename()	0	3	1
A	setMediator()	0	3	1
A	__construct()	0	5	1
A	trigger()	0	3	2
A	setAutoInstall()	0	5	1
A	removeSetting()	0	16	2
B	_setSetting()	0	40	6
A	setId()	0	5	1
A	toXml()	0	3	1
A	setPriority()	0	5	1
A	getSections()	0	3	1
A	create()	0	14	1
A	addSetting()	0	34	2
A	setEditionType()	0	5	1
A	toString()	0	8	1
A	getPath()	0	12	2

<?php

namespace generators\AddonXml;

use generators\AddonXml\exceptions\InvalidAddonXmlException;
use generators\AddonXml\exceptions\InvalidContentException;
use generators\AddonXml\exceptions\DuplicateIdException;
use generators\Xml;
use mediators\AbstractMediator;
use mediators\ICanNotify;
use Config;

/**
 * @todo make functions like setSettings curry of one general function
 */
final class AddonXmlGenerator extends \generators\AbstractGenerator implements ICanNotify
{
    const FILENAME = 'app/addons/${addon}/addon.xml';
    private $templatePath = '';
    private $content;
    private $config;
    private $mediator;

    protected $variants = [
        'scheme' => [
            '3.0',
            '4.0'
        ],
        'status' => [
            'active',
            'disabled'
        ],
        'item' => [
            'input',
            'textarea',
            'password',
            'checkbox',
            'selectbox',
            'multiple select',
            'multiple checkboxes',
            'countries list',
            'states list',
            'file',
            'info',
            'header',
            'template'
        ]
    ];

    function __construct(
        Config $config
    )
    {
        $this->config = $config;
    }

    public function setMediator(AbstractMediator $mediator): void
    {
        $this->mediator = $mediator;
    }

    public function trigger(string $name, $data = [], $sender = null): void
    {
        $this->mediator && $this->mediator->trigger($name, $data, $this);
    }

    /**
     * @inheritdoc
     */
    public function getTemplateFilename(): string
    {
        return $this->templatePath;
    }

    /**
     * returns full path for addon.xml file
     * @return string
     */
    public function getPath(): string
    {
        $addon_id = $this->config->get('addon.id');

        if (!$addon_id) {
            throw new \InvalidArgumentException('Addon id (name) not specified');
        }

        $path = $this->config->get('filesystem.output_path')
            . str_replace('${addon}', $addon_id, static::FILENAME);

        return sanitize_filename($path);
    }
    
    /**
     * Set initial content for generator to work with
     * @param string $content - content of input xml file
     * @throws InvalidContentException if the $content is not valid xml content
     * @return AddonXmlGenerator
     */
    public function setContent(string $content)
    {
        try {
            $simpleXmlElement = new \SimpleXMLElement($content);
            $this->content = new XML($simpleXmlElement);
        } catch (\Exception $error) {
            throw new InvalidContentException('Can\'t create xml from content');
        }

        return $this;
    }

    /**
     * Creates addon.xml content
     *
     * @return AddonXmlGenerator
     */
    public function create()
    {
        $this->createAddon();
        $this->setScheme($this->config->get('addon.scheme'));
        $this->setEditionType($this->config->get('addon.edition_type'));
        $this->setId($this->config->get('addon.id'));
        $this->setVersion($this->config->get('addon.version'));
        $this->setPriority($this->config->get('addon.priority'));
        $this->setStatus($this->config->get('addon.status'));
        $this->setAutoInstall($this->config->get('addon.auto_install'));
        $this->setSettings();
        // $this->setSettingsLayout();

        return $this;
    }

    /**
     * Creates root element for xml - addon
     * @return AddonXmlGenerator
     */
    public function createAddon()
    {
        $simpleXmlElement = new \SimpleXMLElement('<addon></addon>');
        $this->content = new XML($simpleXmlElement);
        $this->trigger(
            'addonxml.created',
            [
                'addon.id' => $this->config->get('addon.id')
            ]
        );

        return $this;
    }

    /**
     * Retrieves addon xml element
     * @throws InvalidAddonXmlException if no addon node found
     * @return Xml - addon node
     */
    public function getAddon()
    {
        $addonElemenent = $this->content;

        if ('addon' !== $addonElemenent->getName()) {
            throw new InvalidAddonXmlException('No addon node found');
        }

        return $addonElemenent;
    }

    /**
     * <addon ... scheme="3.0">
     * @param string $scheme - scheme
     * @return AddonXmlGenerator
     */
    public function setScheme(string $scheme = '3.0')
    {
        $this->getAddon()->setAttribute('scheme', $scheme);

        return $this;
    }

    /**
     * <addon ... edition_type="ROOT,ULT:VENDOR">
     * @param string $type - edition_type
     * @return AddonXmlGenerator
     */
    public function setEditionType(string $type = 'ROOT,ULT:VENDOR')
    {
        $this->getAddon()->setAttribute('edition_type', $type);

        return $this;
    }

    /**
     * <id>sample_addon</id>
     * @param string $value - content of id node
     * @return AddonXmlGenerator
     */
    public function setId(string $value = 'sample_addon')
    {
        $this->getAddon()->setUniqueChild('id', $value);

        return $this;
    }

    /**
     * <version>1.0</version>
     * @param string $value - content of version node
     * @return AddonXmlGenerator
     */
    public function setVersion(string $value = '4.9')
    {
        $this->getAddon()->setUniqueChild('version', $value);

        return $this;
    }

    /**
     * <priority>100</priority>
     * @param string $value - content of priority node
     * @return AddonXmlGenerator
     */
    public function setPriority(string $value = '1000')
    {
        $this->getAddon()->setUniqueChild('priority', $value);

        return $this;
    }

    /**
     * <status>active</status>
     * @param string $value - content of status node
     * @return AddonXmlGenerator
     */
    public function setStatus(string $value = 'active')
    {
        $this->getAddon()->setUniqueChild('status', $value);

        return $this;
    }

    /**
     * <auto_install>MULTIVENDOR,ULTIMATE</auto_install>
     * @param string $value - content of auto_install node
     * @return AddonXmlGenerator
     */
    public function setAutoInstall(string $value = 'MULTIVENDOR,ULTIMATE')
    {
        $this->getAddon()->setUniqueChild('auto_install', $value);

        return $this;
    }

    /**
     * <settings...>
     * @return AddonXmlGenerator
     */
    public function setSettings()
    {
        $this->getAddon()->setUniqueChild('settings', '');

        return $this;
    }

    /**
     * Retrieve settings node
     * @return Xml|null - settings node
     */
    public function getSettings()
    {
        return $this->getAddon()->getSingleElement('settings');

The expression return $this->getAddon()->getSingleElement('settings') also could return the type generators\XML[] which is incompatible with the documented return type generators\Xml|null.

    }

    /**
     * <settings ... layout="separate">
     * @param string layout - 'popup' or 'separate'

The type generators\AddonXml\layout was not found. Maybe you did not declare it correctly or list all dependencies?

     * @return AddonXmlGenerator
     */
    public function setSettingsLayout(string $value = 'popup')
    {
        $this->getSettings()->setAttribute('layout', $value);

        return $this;
    }

    /**
     * Adds section to settings element
     * @throws DuplicateIdException if section with same id already exists
     * @return AddonXmlGenerator
     */
    public function addSection(string $id)
    {
        if ($this->getSection($id)) {
            throw new DuplicateIdException('section with same id already exists: ' . $id);
        }

        $sections = $this->getSections();

        if (null === $sections) {
            $sections =
                $this
                    ->getAddon()
                    ->getSingleElement('settings')
                    ->addChild('sections');
        }

        $sections
            ->addChild('section')
            ->addAttribute('id', $id);

        $this->trigger(
            'addonxml.settingSection.added',
            [
                'addon.id'  => $this->config->getOr('addon', 'addon.id'),
                'id'        => $id
            ]
        );

        return $this;
    }

    /**
     * Retrieves section with the specified id
     * @param string $id - by this id function will find section
     * @return Xml|null
     */
    public function getSection(string $id)
    {
        return $this->getAddon()->getSingleElement('section', $id);

The expression return $this->getAddon()->getSingleElement('section', $id) also could return the type generators\XML[] which is incompatible with the documented return type generators\Xml|null.

    }

    /**
     * Retrieves sections node
     * @return Xml|null
     */
    public function getSections()
    {
        return $this->getAddon()->getSingleElement('sections');

The expression return $this->getAddon()->getSingleElement('sections') also could return the type generators\XML[] which is incompatible with the documented return type generators\Xml|null.

    }

    /**
     * Set setting with replace if exists
     * @param string $section_id - to which section (id) setting will belong
     * @param string type

The type generators\AddonXml\type was not found. Maybe you did not declare it correctly or list all dependencies?

     * @param string $id
     * @param string $default_value
     * @param array $variants - list of possible values
     * Full information about params [https://docs.cs-cart.com/4.9.x/developer_guide/addons/scheme/scheme3.0_structure.html]
     * @throws DuplicateIdException if setting with same id already exists
     *
     * @return AddonXmlGenerator
     * @todo setting item and variant item can be the same
     * write test and solve this problem
     */
    private function _setSetting(
        string $section_id = 'section1',
        string $type,
        string $id,
        string $default_value = '',
        array  $variants = []
    )
    {
        $itemElement = $this->content->getSingleElement('item', $id);
        if (null !== $itemElement) {
            $itemElement->remove();
        }

        $sectionElement = $this->getSection($section_id);

        if (null === $sectionElement) {
            $sectionElement = $this->addSection($section_id)->getSection($section_id);
        }

        $itemsElement = $sectionElement->getSingleElement('items');

        if (null === $itemsElement) {
            $itemsElement = $sectionElement->addChild('items');

The method addChild() does not exist on generators\XML. Since you implemented __call, consider adding a @method annotation.

        }

        $settingItem = $itemsElement->addChild('item');
        $settingItem->addAttribute('id', $id);
            $settingItem->addChild('type', $type);
            if ($variants) {

The expression $variants of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

                $variantsElement = $settingItem->addChild('variants');
                    foreach($variants as $variant)
                    {
                        $variantElement = $variantsElement->addChild('item');
                            $variantElement->addAttribute('id', $variant);
                    }
                    unset($variantElement);
            }
            $settingItem->addChild('default_value', $default_value);

        return $this;
    }

    /**
     * Set setting with replace if exists
     * @param string $section_id - to which section (id) setting will belong
     * @param string type
     * @param string $id
     * @param string $default_value
     * @param array $variants - list of possible values
     * Full information about params [https://docs.cs-cart.com/4.9.x/developer_guide/addons/scheme/scheme3.0_structure.html]
     *
     * @return AddonXmlGenerator
     */
    public function setSetting(
        string $section_id = 'section1',
        string $type,
        string $id,
        string $default_value = '',
        array  $variants = []
    )
    {
        $this->_setSetting(
            $section_id,
            $type,
            $id,
            $default_value,
            $variants
        );

        $this->trigger(
            'addonxml.setting.updated',
            [
                'addon.id'      => $this->config->get('addon.id'),
                'section_id'    => $section_id,
                'type'          => $type,
                'id'            => $id,
                'variants'      => $variants
            ]
        );

        return $this;
    }

    /**
     * Set setting without replace if exists
     * @param string $section_id - to which section (id) setting will belong
     * @param string type
     * @param string $id
     * @param string $default_value
     * @param array $variants - list of possible values
     * Full information about params [https://docs.cs-cart.com/4.9.x/developer_guide/addons/scheme/scheme3.0_structure.html]
     * @throws DuplicateIdException if setting with same id already exists
     *
     * @return AddonXmlGenerator
     */
    public function addSetting(
        string $section_id = 'section1',
        string $type,
        string $id,
        string $default_value = '',
        array  $variants = []
    )
    {
        $itemElement = $this->content->getSingleElement('item', $id);

        if (null !== $itemElement) {
            throw new DuplicateIdException('Item with same id already exists: ' . $id);
        }

        $this->_setSetting(
            $section_id,
            $type,
            $id,
            $default_value,
            $variants
        );

        $this->trigger(
            'addonxml.setting.added',
            [
                'addon.id'      => $this->config->getOr('addon', 'addon.id'),
                'section_id'    => $section_id,
                'type'          => $type,
                'id'            => $id,
                'variants'      => $variants
            ]
        );

        return $this;
    }

    /**
     * @todo test
     * Remove settings item
     * 
     * @param string $id
     * 
     * @return AddonXmlGenerator
     */
    public function removeSetting(string $id)
    {
        $itemElement = $this->content->getSingleElement('item', $id);
        if (null !== $itemElement) {
            $itemElement->remove();
        }

        $this->trigger(
            'addonxml.setting.removed',
            [
                'addon.id'      => $this->config->getOr('addon', 'addon.id'),
                'id'            => $id
            ]
        );

        return $this;
    }

    /**
     * @deprecated - Use toString instead
     */
    public function toXml(): string
    {
        return $this->toString();
    }

    /**
     * Converts generator result to string
     * @return string
     */
    public function toString(): string
    {
        $dom = new \DOMDocument('1.0');
        $dom->preserveWhiteSpace    = false;
        $dom->formatOutput          = true;
        $dom->loadXML($this->content->asXML());

        return $dom->saveXML();
    }
}