Current File : /var/www/vinorea/modules/ps_edition_basic/src/Traits/UseHooks.php

<?php
/**
 * Copyright since 2007 PrestaShop SA and Contributors
 * PrestaShop is an International Registered Trademark & Property of PrestaShop SA
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Academic Free License version 3.0
 * that is bundled with this package in the file LICENSE.md.
 * It is also available through the world-wide-web at this URL:
 * https://opensource.org/licenses/AFL-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.
 *
 * @author    PrestaShop SA and Contributors <contact@prestashop.com>
 * @copyright Since 2007 PrestaShop SA and Contributors
 * @license   https://opensource.org/licenses/AFL-3.0 Academic Free License version 3.0
 */
declare(strict_types=1);

namespace PrestaShop\Module\PsEditionBasic\Traits;

use Symfony\Component\String\UnicodeString;

trait UseHooks
{
    use \PrestaShop\Module\PsEditionBasic\Traits\Hooks\UseActionAdminMenuTabsModifier;
    use \PrestaShop\Module\PsEditionBasic\Traits\Hooks\UseActionAdminControllerInitBefore;
    use \PrestaShop\Module\PsEditionBasic\Traits\Hooks\UseActionAdminBreadcrumbModifier;
    use \PrestaShop\Module\PsEditionBasic\Traits\Hooks\UseActionObjectLanguageAddAfter;
    use \PrestaShop\Module\PsEditionBasic\Traits\Hooks\UseActionAdminControllerSetMedia;
    use \PrestaShop\Module\PsEditionBasic\Traits\Hooks\UseDisplayBackOfficeHeader;
    use \PrestaShop\Module\PsEditionBasic\Traits\Hooks\UseDisplayAdminNavBarBeforeEnd;
    use \PrestaShop\Module\PsEditionBasic\Traits\Hooks\UseDisplayDashboardTop;
    use \PrestaShop\Module\PsEditionBasic\Traits\Hooks\UseActionObjectEmployeeAddAfter;
    use \PrestaShop\Module\PsEditionBasic\Traits\Hooks\UseActionObjectEmployeeUpdateAfter;

    /**
     * @var array An array of method that can be called to register media in the actionAdminControllerSetMedia hook
     *
     * @see UseActionAdminControllerSetMedia
     */
    protected $adminControllerMediaMethods = [];

    /**
     * Try to call the "bootHookClassName" method on each hook class.
     *
     * @return void
     */
    protected function bootHooks(): void
    {
        foreach ($this->getTraitNames() as $traitName) {
            if (method_exists($this, "boot{$traitName}")) {
                $this->{"boot{$traitName}"}();
            }
        }
    }

    /**
     * Try to call the "hookClassNameExtraOperations" method on each hook class.
     *
     * @return void
     */
    protected function installHooks(): void
    {
        foreach ($this->getTraitNames() as $traitName) {
            $traitName = lcfirst($traitName);
            if (method_exists($this, "{$traitName}ExtraOperations")) {
                $this->{"{$traitName}ExtraOperations"}();
            }
        }
    }

    /**
     * Guess the hooks names by using the traits names. Remove the "Use" in the traits name.
     *
     * @return string[]
     */
    protected function getHooksNames(): array
    {
        return array_map(function ($trait) {
            return str_replace('Use', '', $trait);
        }, $this->getTraitNames());
    }

    /**
     * Parse all classes used by this trait, and extract them
     *
     * @return string[]
     */
    protected function getTraitNames(): array
    {
        $traits = [];
        // Retrieve all used classes and iterate
        foreach (class_uses(UseHooks::class) as $trait) {
            // Get only the class name eg. 'UseAdminControllerSetMedia'
            $traits[] = (new UnicodeString($trait))->afterLast('\\')->toString();
        }

        return $traits;
    }
}