TechDivision\Import\Converter\Plugins\GenericExportableConverterPlugin

Complexity

Total Complexity

9

Size/Duplication

Total Lines	98
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getTargetDir()	0	3	1
A	getArtefacts()	0	18	4
A	getExportableArtefactTypes()	0	10	2
A	__construct()	0	12	1
A	resetArtefacts()	0	2	1

<?php

/**
 * TechDivision\Import\Converter\Plugins\GenericExportableConverterPlugin
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Tim Wagner <t.wagner@techdivision.com>
 * @copyright 2019 TechDivision GmbH <info@techdivision.com>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import-converter
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import\Converter\Plugins;

use TechDivision\Import\Utils\CacheKeys;
use TechDivision\Import\ApplicationInterface;
use TechDivision\Import\Converter\Utils\ConfigurationKeys;
use TechDivision\Import\Plugins\SubjectPlugin;
use TechDivision\Import\Plugins\ExportableTrait;
use TechDivision\Import\Plugins\ExportablePluginInterface;
use TechDivision\Import\Services\RegistryProcessorInterface;
use TechDivision\Import\Subjects\SubjectExecutorInterface;
use TechDivision\Import\Subjects\FileResolver\FileResolverFactoryInterface;

/**
 * Plugin that exports artefacts with type names defined in configuration.
 *
 * @author    Tim Wagner <t.wagner@techdivision.com>
 * @copyright 2019 TechDivision GmbH <info@techdivision.com>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import-converter
 * @link      http://www.techdivision.com
 */
class GenericExportableConverterPlugin extends SubjectPlugin implements ExportablePluginInterface
{

    /**
     * The trait that provides export functionality.
     *
     * @var \TechDivision\Import\Plugins\ExportableTrait
     */
    use ExportableTrait;

    /**
     * The registry processor instance.
     *
     * @var \TechDivision\Import\Services\RegistryProcessorInterface
     */
    protected $registryProcessor;

    /**
     * Initializes the plugin with the application instance.
     *
     * @param \TechDivision\Import\ApplicationInterface                               $application         The application instance
     * @param \TechDivision\Import\Subjects\SubjectExecutorInterface                  $subjectExecutor     The subject executor instance
     * @param \TechDivision\Import\Subjects\FileResolver\FileResolverFactoryInterface $fileResolverFactory The file resolver instance
     * @param \TechDivision\Import\Services\RegistryProcessorInterface                $registryProcessor   The registry processor instance
     */
    public function __construct(
        ApplicationInterface $application,
        SubjectExecutorInterface $subjectExecutor,
        FileResolverFactoryInterface $fileResolverFactory,
        RegistryProcessorInterface $registryProcessor
    ) {

        // call the parent constructor
        parent::__construct($application, $subjectExecutor, $fileResolverFactory);

        // set the subject executor and the file resolver factory
        $this->registryProcessor = $registryProcessor;
    }

    /**
     * Returns the array with the exportable artefact types from the configuration.
     *
     * @return array The artefact types
     */
    protected function getExportableArtefactTypes()
    {

        // query whether or not the configuration value is available
        if ($this->getPluginConfiguration()->hasParam(ConfigurationKeys::EXPORTABLE_ARTEFACT_TYPES)) {
            return $this->getPluginConfiguration()->getParam(ConfigurationKeys::EXPORTABLE_ARTEFACT_TYPES);

The expression return $this->getPluginConfiguration()->getParam(TechDivision\Import\Converter\Utils\ConfigurationKeys::EXPORTABLE_ARTEFACT_TYPES) returns the type string which is incompatible with the documented return type array.

        }

        // return an empty array if the param has NOT been set
        return array();
    }

    /**
     * Return's the artefacts for post-processing.
     *
     * @return array The artefacts
     */
    public function getArtefacts()
    {

        // load the available artefacts
        $artefacts = $this->registryProcessor->getAttribute(CacheKeys::ARTEFACTS);

        // initialize the array for the artefacts that has to be exported
        $toExport = array();

        // load the artefacts that has to be exported
        foreach ($this->getExportableArtefactTypes() as $exportableArtefactType) {
            if (isset($artefacts[$exportableArtefactType]) && is_array($artefacts[$exportableArtefactType])) {
                $toExport[$exportableArtefactType] = $artefacts[$exportableArtefactType];
            }
        }

        // return the array with the exportable artefac types
        return $toExport;
    }

    /**
     * Return's the target directory for the artefact export.
     *
     * @return string The target directory for the artefact export
     */
    public function getTargetDir()
    {
        return sprintf('%s/%s', $this->getConfiguration()->getTargetDir(), $this->getSerial());
    }

    /**
     * Reset the array with the artefacts to free the memory.
     *
     * @return void
     */
    public function resetArtefacts()
    {
        // do nothing here, because we can't remove only one key from the array with artefacts in a multiprocess compatible manner
    }
}