[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /**
   4   * Joomla! Content Management System
   5   *
   6   * @copyright  (C) 2019 Open Source Matters, Inc. <https://www.joomla.org>
   7   * @license    GNU General Public License version 2 or later; see LICENSE.txt
   8   */
   9  
  10  namespace Joomla\CMS\WebAsset;
  11  
  12  use Joomla\CMS\WebAsset\Exception\UnknownAssetException;
  13  
  14  // phpcs:disable PSR1.Files.SideEffects
  15  \defined('JPATH_PLATFORM') or die;
  16  // phpcs:enable PSR1.Files.SideEffects
  17  
  18  /**
  19   * Web Asset Registry interface
  20   *
  21   * @since  4.0.0
  22   */
  23  interface WebAssetRegistryInterface
  24  {
  25      /**
  26       * Get an existing Asset from a registry, by asset name and asset type.
  27       *
  28       * @param   string  $type  Asset type, script or style etc
  29       * @param   string  $name  Asset name
  30       *
  31       * @return  WebAssetItem
  32       *
  33       * @throws  UnknownAssetException  When Asset cannot be found
  34       *
  35       * @since   4.0.0
  36       */
  37      public function get(string $type, string $name): WebAssetItemInterface;
  38  
  39      /**
  40       * Add Asset to registry of known assets
  41       *
  42       * @param   string                 $type   Asset type, script or style etc
  43       * @param   WebAssetItemInterface  $asset  Asset instance
  44       *
  45       * @return  self
  46       *
  47       * @since   4.0.0
  48       */
  49      public function add(string $type, WebAssetItemInterface $asset): self;
  50  
  51      /**
  52       * Remove Asset from registry.
  53       *
  54       * @param   string  $type  Asset type, script or style etc
  55       * @param   string  $name  Asset name
  56       *
  57       * @return  self
  58       *
  59       * @since   4.0.0
  60       */
  61      public function remove(string $type, string $name): self;
  62  
  63      /**
  64       * Check whether the asset exists in the registry.
  65       *
  66       * @param   string  $type  Asset type, script or style etc
  67       * @param   string  $name  Asset name
  68       *
  69       * @return  boolean
  70       *
  71       * @since   4.0.0
  72       */
  73      public function exists(string $type, string $name): bool;
  74  }