DriverPool Class Reference

Public Member Functions
	__construct ($extraTypes=[])
	getDriver ($code)

Data Fields
const	FILE = 'file'
const	HTTP = 'http'
const	HTTPS = 'https'
const	ZLIB = 'compress.zlib'

Protected Attributes
	$types

Detailed Description

A pool of stream wrappers

Definition at line 12 of file DriverPool.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$extraTypes = []

)

Obtain extra types in constructor

Parameters

array

$extraTypes

Exceptions

Definition at line 44 of file DriverPool.php.

    {
        foreach ($extraTypes as $code => $typeOrObject) {
            if (is_object($typeOrObject)) {
                $type = get_class($typeOrObject);
                $object = $typeOrObject;
            } else {
                $type = $typeOrObject;
                $object = false;
            }
            if (!is_subclass_of($type, \Magento\Framework\Filesystem\DriverInterface::class)) {
                throw new \InvalidArgumentException("The specified type '{$type}' does not implement DriverInterface.");
            }
            $this->types[$code] = $type;
            if ($object) {
                $this->pool[$code] = $typeOrObject;
            }
        }
    }

Member Function Documentation

getDriver()

getDriver

(

$code

)

Gets a driver instance by code

Parameters

string

$code

Returns

DriverInterface

Definition at line 70 of file DriverPool.php.

    {
        if (!isset($this->types[$code])) {
            $code = self::FILE;
        }
        if (!isset($this->pool[$code])) {
            $class = $this->types[$code];
            $this->pool[$code] = new $class();
        }
        return $this->pool[$code];
    }

Field Documentation

$types

$types

protected

Initial value:

= [
        self::FILE => \Magento\Framework\Filesystem\Driver\File::class,
        self::HTTP => \Magento\Framework\Filesystem\Driver\Http::class,
        self::HTTPS => \Magento\Framework\Filesystem\Driver\Https::class,
        self::ZLIB => \Magento\Framework\Filesystem\Driver\Zlib::class,
    ]

#- #-

Definition at line 24 of file DriverPool.php.

FILE

const FILE = 'file'

#+ Available driver types

Definition at line 17 of file DriverPool.php.

HTTP

const HTTP = 'http'

Definition at line 18 of file DriverPool.php.

HTTPS

const HTTPS = 'https'

Definition at line 19 of file DriverPool.php.

ZLIB

const ZLIB = 'compress.zlib'

Definition at line 20 of file DriverPool.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/framework/Filesystem/DriverPool.php