编辑文件 - HookableKpiRowFactory.php

✏️ 正在编辑: HookableKpiRowFactory.php

路径: /home/bpioifn/www/pigmentse/src/Core/Kpi/Row/HookableKpiRowFactory.php
提示: 您可以编辑任何文件（包括二进制文件），但请注意不当修改可能导致文件损坏。

<?php
/**
 * 2007-2019 PrestaShop and Contributors
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is bundled with this package in the file LICENSE.txt.
 * It is also available through the world-wide-web at this URL:
 * https://opensource.org/licenses/OSL-3.0
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@prestashop.com so we can send you a copy immediately.
 *
 * DISCLAIMER
 *
 * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
 * versions in the future. If you wish to customize PrestaShop for your
 * needs please refer to https://www.prestashop.com for more information.
 *
 * @author    PrestaShop SA <contact@prestashop.com>
 * @copyright 2007-2019 PrestaShop SA and Contributors
 * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
 * International Registered Trademark & Property of PrestaShop SA
 */

namespace PrestaShop\PrestaShop\Core\Kpi\Row;

use PrestaShop\PrestaShop\Core\Kpi\Exception\InvalidArgumentException;
use PrestaShop\PrestaShop\Core\Kpi\KpiInterface;
use PrestaShop\PrestaShop\Core\Hook\HookDispatcherInterface;

/**
 * Class KpiRowFactory builds a KPI row, able to dispatch a hook.
 */
final class HookableKpiRowFactory implements KpiRowFactoryInterface
{
    /**
     * @var KpiInterface[] the list of KPIs to display
     */
    private $kpis;

/**
     * @var HookDispatcherInterface the Hook Dispatcher
     */
    private $hookDispatcher;

/**
     * @var string used to make the hook selectable
     */
    private $identifier;

/**
     * @param KpiInterface[] $kpis
     * @param HookDispatcherInterface $hookDispatcher
     * @param string $identifier
     */
    public function __construct(
        array $kpis,
        HookDispatcherInterface $hookDispatcher,
        $identifier
    ) {
        if ($this->validateKpis($kpis) && $this->validateIdentifier($identifier)) {
            $this->kpis = $kpis;
            $this->hookDispatcher = $hookDispatcher;
            $this->identifier = $identifier;
        }
    }

/**
     * {@inheritdoc}
     */
    public function build()
    {
        $kpiRow = new KpiRow();

$this->hookDispatcher->dispatchWithParameters($this->getHookName($this->identifier), [
            'kpis' => &$this->kpis,
        ]);

if ($this->validateKpis($this->kpis)) {
            foreach ($this->kpis as $kpi) {
                $kpiRow->addKpi($kpi);
            }

return $kpiRow;
        }
    }

/**
     * @param array $kpis
     *
     * @return bool true if valid, else throw an exception
     *
     * @throws InvalidArgumentException
     */
    private function validateKpis(array $kpis)
    {
        foreach ($kpis as $kpi) {
            if (!$kpi instanceof KpiInterface) {
                throw InvalidArgumentException::invalidKpi($kpi);
            }
        }

return true;
    }

/**
     * @param mixed $identifier
     *
     * @return bool true if valid, else throw an exception
     *
     * @throws InvalidArgumentException
     */
    private function validateIdentifier($identifier)
    {
        if (!is_string($identifier)) {
            throw InvalidArgumentException::invalidIdentifier($identifier);
        }

return true;
    }

/**
     * @param string $identifier
     *
     * @return string
     */
    private function getHookName($identifier)
    {
        return 'action' . ucfirst($identifier) . 'KpiRowModifier';
    }
}

← 返回文件管理器