Documentation

FilesystemManager
in package

Application

implements Factory

Interfaces, Classes and Traits

Factory

$app : Application: The application instance.
$customCreators : array<string|int, mixed>: The registered custom driver creators.
$disks : array<string|int, mixed>: The array of resolved filesystem drivers.
__call() : mixed: Dynamically call the default driver instance.
__construct() : void: Create a new filesystem manager instance.
cloud() : Filesystem: Get a default cloud filesystem instance.
createFtpDriver() : Filesystem: Create an instance of the ftp driver.
createLocalDriver() : Filesystem: Create an instance of the local driver.
createRackspaceDriver() : Cloud: Create an instance of the Rackspace driver.
createS3Driver() : Cloud: Create an instance of the Amazon S3 driver.
disk() : Filesystem: Get a filesystem instance.
drive() : Filesystem: Get a filesystem instance.
extend() : $this: Register a custom driver creator Closure.
getDefaultCloudDriver() : string: Get the default cloud driver name.
getDefaultDriver() : string: Get the default driver name.
set() : void: Set the given disk instance.
adapt() : Filesystem: Adapt the filesystem implementation.
callCustomCreator() : Filesystem: Call a custom driver creator.
createCacheStore() : CacheInterface: Create a cache store instance.
createFlysystem() : FilesystemInterface: Create a Flysystem instance with the given adapter.
formatS3Config() : array<string|int, mixed>: Format the given S3 configuration with the default options.
get() : Filesystem: Attempt to get the disk from the local cache.
getConfig() : array<string|int, mixed>: Get the filesystem connection configuration.
getRackspaceContainer() : Container: Get the Rackspace Cloud Files container.
resolve() : Filesystem: Resolve the given disk.

$app

The application instance.


    protected
        Application
    $app

$customCreators

The registered custom driver creators.


    protected
        array<string|int, mixed>
    $customCreators
     = []

$disks

The array of resolved filesystem drivers.


    protected
        array<string|int, mixed>
    $disks
     = []

__call()

Dynamically call the default driver instance.


    public
                __call(string $method, array<string|int, mixed> $parameters) : mixed

Parameters

$method : string
$parameters : array<string|int, mixed>

Return values

mixed —

__construct()

Create a new filesystem manager instance.


    public
                __construct(Application $app) : void

Parameters

$app : Application

Return values

void —

cloud()

Get a default cloud filesystem instance.


    public
                cloud() : Filesystem

Return values

Filesystem —

createFtpDriver()

Create an instance of the ftp driver.


    public
                createFtpDriver(array<string|int, mixed> $config) : Filesystem

Parameters

$config : array<string|int, mixed>

Return values

Filesystem —

createLocalDriver()

Create an instance of the local driver.


    public
                createLocalDriver(array<string|int, mixed> $config) : Filesystem

Parameters

$config : array<string|int, mixed>

Return values

Filesystem —

createRackspaceDriver()

Create an instance of the Rackspace driver.


    public
                createRackspaceDriver(array<string|int, mixed> $config) : Cloud

Parameters

$config : array<string|int, mixed>

Return values

Cloud —

createS3Driver()

Create an instance of the Amazon S3 driver.


    public
                createS3Driver(array<string|int, mixed> $config) : Cloud

Parameters

$config : array<string|int, mixed>

Return values

Cloud —

disk()

Get a filesystem instance.


    public
                disk([string $name = null ]) : Filesystem

Parameters

$name : string = null

Return values

Filesystem —

drive()

Get a filesystem instance.


    public
                drive([string $name = null ]) : Filesystem

Parameters

$name : string = null

Return values

Filesystem —

extend()


    public
                extend(string $driver, Closure $callback) : $this

Parameters

$driver : string
$callback : Closure

Return values

$this —

getDefaultCloudDriver()

Get the default cloud driver name.


    public
                getDefaultCloudDriver() : string

Return values

string —

getDefaultDriver()

Get the default driver name.


    public
                getDefaultDriver() : string

Return values

string —

set()

Set the given disk instance.


    public
                set(string $name, mixed $disk) : void

Parameters

$name : string
$disk : mixed

Return values

void —

adapt()

Adapt the filesystem implementation.


    protected
                adapt(FilesystemInterface $filesystem) : Filesystem

Parameters

$filesystem : FilesystemInterface

Return values

Filesystem —

callCustomCreator()

Call a custom driver creator.


    protected
                callCustomCreator(array<string|int, mixed> $config) : Filesystem

Parameters

$config : array<string|int, mixed>

Return values

Filesystem —

createCacheStore()

Create a cache store instance.


    protected
                createCacheStore(mixed $config) : CacheInterface

Parameters

$config : mixed

Return values

CacheInterface —

createFlysystem()

Create a Flysystem instance with the given adapter.


    protected
                createFlysystem(AdapterInterface $adapter, array<string|int, mixed> $config) : FilesystemInterface

Parameters

$adapter : AdapterInterface
$config : array<string|int, mixed>

Return values

FilesystemInterface —

formatS3Config()

Format the given S3 configuration with the default options.


    protected
                formatS3Config(array<string|int, mixed> $config) : array<string|int, mixed>

Parameters

$config : array<string|int, mixed>

Return values

array<string|int, mixed> —

get()

Attempt to get the disk from the local cache.


    protected
                get(string $name) : Filesystem

Parameters

$name : string

Return values

Filesystem —

getConfig()

Get the filesystem connection configuration.


    protected
                getConfig(string $name) : array<string|int, mixed>

Parameters

$name : string

Return values

array<string|int, mixed> —

getRackspaceContainer()

Get the Rackspace Cloud Files container.


    protected
                getRackspaceContainer(Rackspace $client, array<string|int, mixed> $config) : Container

Parameters

$client : Rackspace
$config : array<string|int, mixed>

Return values

Container —

resolve()

Resolve the given disk.


    protected
                resolve(string $name) : Filesystem

Parameters

$name : string

Return values

Filesystem —