filicious/core
Back to top  

A plugin provide additional functionality for a filesystem or file.

package filicious-core
author Christian Schiffler
author Tristan Lins
author Oliver Hoff

 Methods

Return a file plugin.

getFilePlugin(\Filicious\File $file) : \Filicious\Plugin\FilePluginInterface

Parameters

$file

Exceptions

\Filicious\Exception\UnsupportedPluginException Thrown if this plugin does not provide a file plugin.

Returns

\Filicious\Plugin\FilePluginInterface

Return a filesystem plugin.

getFilesystemPlugin(\Filicious\Filesystem $filesystem) : \Filicious\Plugin\FilesystemPluginInterface

Parameters

$filesystem

Exceptions

\Filicious\Exception\UnsupportedPluginException Thrown if this plugin does not provide a filesystem plugin.

Returns

\Filicious\Plugin\FilesystemPluginInterface

Return the plugin name.

getName() : string

Returns

string

Determine if this plugin provide a file plugin.

providesFilePlugin(\Filicious\File $file) : bool

Parameters

$file

Returns

bool

Determine if this plugin provide a filesystem plugin.

providesFilesystemPlugin(\Filicious\Filesystem $filesystem) : bool

Parameters

$filesystem

Returns

bool