FlysystemPluginInterface.php in Flysystem 3.0.x
Same filename and directory in other branches
Namespace
Drupal\flysystem\PluginFile
src/Plugin/FlysystemPluginInterface.phpView source
<?php
namespace Drupal\flysystem\Plugin;
interface FlysystemPluginInterface {
/**
* Returns the Flysystem adapter.
*
* Plugins should not keep references to the adapter. If a plugin needs to
* perform filesystem operations, it should either use a scheme:// or have the
* \Drupal\flysystem\FlysystemFactory injected.
*
* @return \League\Flysystem\AdapterInterface
* The Flysytem 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);
/**
* Checks the sanity of the filesystem.
*
* If this is a local filesystem, .htaccess file should be in place.
*
* @return array
* A list of error messages.
*/
public function ensure($force = FALSE);
}
Interfaces
Name | Description |
---|---|
FlysystemPluginInterface |