libraries/src/WebAsset/WebAssetRegistryInterface.php - 5.4-dev - githubmirror/joomla-cms

libraries/src/WebAsset/WebAssetRegistryInterface.php

74 строки2 KB

Allon Moritz

Replace JPATH_PLATFORM with _JEXEC (#40343)

29 май 2023, 11:12

29 май 2023, 11:12e2170c8

<?php

/**
 * Joomla! Content Management System
 *
 * @copyright  (C) 2019 Open Source Matters, Inc. <https://www.joomla.org>
 * @license    GNU General Public License version 2 or later; see LICENSE.txt
 */

namespace Joomla\CMS\WebAsset;

use Joomla\CMS\WebAsset\Exception\UnknownAssetException;

// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects

/**
 * Web Asset Registry interface
 *
 * @since  4.0.0
 */
interface WebAssetRegistryInterface
{
    /**
     * Get an existing Asset from a registry, by asset name and asset type.
     *
     * @param   string  $type  Asset type, script or style etc
     * @param   string  $name  Asset name
     *
     * @return  WebAssetItem
     *
     * @throws  UnknownAssetException  When Asset cannot be found
     *
     * @since   4.0.0
     */
    public function get(string $type, string $name): WebAssetItemInterface;

    /**
     * Add Asset to registry of known assets
     *
     * @param   string                 $type   Asset type, script or style etc
     * @param   WebAssetItemInterface  $asset  Asset instance
     *
     * @return  self
     *
     * @since   4.0.0
     */
    public function add(string $type, WebAssetItemInterface $asset): self;

    /**
     * Remove Asset from registry.
     *
     * @param   string  $type  Asset type, script or style etc
     * @param   string  $name  Asset name
     *
     * @return  self
     *
     * @since   4.0.0
     */
    public function remove(string $type, string $name): self;

    /**
     * Check whether the asset exists in the registry.
     *
     * @param   string  $type  Asset type, script or style etc
     * @param   string  $name  Asset name
     *
     * @return  boolean
     *
     * @since   4.0.0
     */
    public function exists(string $type, string $name): bool;
}