DataWizard/Application/Model/Configuration.php

<?php

/**
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 * 
 * https://www.d3data.de
 *
 * @copyright (C) D3 Data Development (Inh. Thomas Dartsch)
 * @author    D3 Data Development - Daniel Seifert <info@shopmodule.com>
 * @link      https://www.oxidmodule.com
 */

declare(strict_types=1);

namespace D3\DataWizard\Application\Model;

use D3\DataWizard\Application\Model\Exceptions\DataWizardException;

class Configuration
{
    const GROUP_SHOP     = 'D3_DATAWIZARD_GROUP_SHOP';
    const GROUP_CATEGORY = 'D3_DATAWIZARD_GROUP_CATEGORIES';
    const GROUP_ARTICLES = 'D3_DATAWIZARD_GROUP_ARTICLES';
    const GROUP_USERS    = 'D3_DATAWIZARD_GROUP_USERS';
    const GROUP_ORDERS   = 'D3_DATAWIZARD_GROUP_ORDERS';
    const GROUP_REMARKS  = 'D3_DATAWIZARD_GROUP_REMARKS';
    const GROUP_CMS      = 'D3_DATAWIZARD_GROUP_CMS';

    protected $actions = [];
    protected $exports = [];

    public function __construct()
    {
        $this->configure();
    }

    public function configure()
    {
        // extend to add exports and actions via 'registerAction()' or 'registerExport()' method
    }

    /**
     * @param            $group
     * @param ActionBase $action
     */
    public function registerAction($group, ActionBase $action)
    {
        $this->actions[$group][md5(get_class($action))] = $action;
    }

    /**
     * @param            $group
     * @param ExportBase $export
     */
    public function registerExport($group, ExportBase $export)
    {
        $this->exports[$group][md5(get_class($export))] = $export;
    }

    /**
     * @return array
     */
    public function getGroupedActions(): array
    {
        return $this->actions;
    }

    /**
     * @return array
     */
    public function getGroupedExports(): array
    {
        return $this->exports;
    }

    /**
     * @return array
     */
    public function getActionGroups(): array
    {
        return array_keys($this->actions);
    }

    /**
     * @return array
     */
    public function getExportGroups(): array
    {
        return array_keys($this->exports);
    }

    /**
     * @param $group
     *
     * @return mixed
     */
    public function getActionsByGroup($group)
    {
        return $this->actions[$group];
    }

    /**
     * @param $group
     *
     * @return mixed
     */
    public function getExportsByGroup($group)
    {
        return $this->exports[$group];
    }

    /**
     * @return array
     */
    public function getAllActions() : array
    {
        $all = [];

        foreach ($this->getActionGroups() as $group) {
            $all = array_merge($all, $this->getActionsByGroup($group));
        }

        return $all;
    }

    /**
     * @return array
     */
    public function getAllExports() : array
    {
        $all = [];

        foreach ($this->getExportGroups() as $group) {
            $all = array_merge($all, $this->getExportsByGroup($group));
        }

        return $all;
    }

    /**
     * @param $id
     *
     * @return ActionBase
     */
    public function getActionById($id) : ActionBase
    {
        $allActions = $this->getAllActions();

        if (false == $allActions[$id]) {
            throw oxNew(DataWizardException::class, 'no action with id '.$id);
        }

        return $allActions[$id];
    }

    /**
     * @param $id
     *
     * @return ExportBase
     */
    public function getExportById($id) : ExportBase
    {
        $allExports = $this->getAllExports();

        if (false == $allExports[$id]) {
            throw oxNew(DataWizardException::class, 'no export with id '.$id);
        }

        return $allExports[$id];
    }
}