interface FlysystemPluginInterface in Flysystem 7

Interface Flysystem plugins must implement.

Hierarchy

• interface \Drupal\flysystem\Plugin\FlysystemPluginInterface

File

src/Plugin/FlysystemPluginInterface.php, line 13

Contains FlysystemPluginInterface.

Namespace

Drupal\flysystem\Plugin

interface FlysystemPluginInterface {

  /**
   * Creates a new plugin instance.
   *
   * @param array $configuration
   *   The configuration array.
   *
   * @return \Drupal\flysystem\Plugin\FlysystemPluginInterface
   *   A new plugin.
   */
  public static function create(array $configuration);

  /**
   * Returns the Flysystem adapter
   *
   * @return \League\Flysystem\AdapterInterface
   *   The Flsysytem adapter.
   */
  public function getAdapter();

  /**
   * Returns a web accessible URL for the resource.
   *
   * This function should return a URL that can be embedded in a web page
   * and accessed from a browser. For example, the external URL of
   * "youtube://xIpLd0WQKCY" might be
   * "http://www.youtube.com/watch?v=xIpLd0WQKCY".
   *
   * @param string $uri
   *   The URI to provide a URL for.
   *
   * @return string
   *   Returns a string containing a web accessible URL for the resource.
   */
  public function getExternalUrl($uri);

}

Members

Name	Modifiers	Type	Description	Overrides
FlysystemPluginInterface::create	public static	function	Creates a new plugin instance.	1
FlysystemPluginInterface::getAdapter	public	function	Returns the Flysystem adapter	3
FlysystemPluginInterface::getExternalUrl	public	function	Returns a web accessible URL for the resource.	1