www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/libraries/src/ExternalLibrary/Remote/RemoteLibraryInterface.php

   1 <?php
   2
   3 namespace Drupal\libraries\ExternalLibrary\Remote;
   4
   5 use Drupal\libraries\ExternalLibrary\LibraryInterface;
   6
   7 /**
   8  * Provides an interface for remote libraries.
   9  *
  10  * Assuming they declare a remote URL, remote libraries are always loaded. It is
  11  * not checked whether or not the Drupal site has network access or the remote
  12  * resource is available.
  13  */
  14 interface RemoteLibraryInterface extends LibraryInterface {
  15
  16   /**
  17    * Checks whether the library has a remote URL.
  18    *
  19    * This check allows using the same library class for multiple libraries only
  20    * some of which are available remotely.
  21    *
  22    * @return bool
  23    *   TRUE if the library has a remote URL; FALSE otherwise.
  24    *
  25    * @see \Drupal\libraries\ExternalLibrary\Asset\AssetLibraryInterface
  26    */
  27   public function hasRemoteUrl();
  28
  29   /**
  30    * Returns the remote URL of the library.
  31    *
  32    * @return string
  33    *   The remote URL of the library.
  34    *
  35    * @todo Consider throwing an exception if hasRemoteUrl() return FALSE.
  36    */
  37   public function getRemoteUrl();
  38
  39 }