FlysystemPluginInterface.php in Flysystem 7

Contains FlysystemPluginInterface.

Namespace

Drupal\flysystem\Plugin

File

src/Plugin/FlysystemPluginInterface.php

<?php

/**
 * @file
 * Contains FlysystemPluginInterface.
 */
namespace Drupal\flysystem\Plugin;


/**
 * Interface Flysystem plugins must implement.
 */
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);

}

Interfaces

Name	Description
FlysystemPluginInterface	Interface Flysystem plugins must implement.