Factory Class Reference

Public Member Functions
	__construct (\Magento\Framework\ObjectManagerInterface $objectManager, Filesystem $filesystem, \Magento\Framework\App\ResourceConnection $resource, array $enforcedOptions=[], array $decorators=[])

Data Fields
const	DEFAULT_LIFETIME = 7200
const	PARAM_CACHE_FORCED_OPTIONS = 'cache_options'

Protected Member Functions
	_getBackendOptions (array $cacheOptions)
	_getDbAdapterOptions ()
	_getTwoLevelsBackendOptions ($fastOptions, $cacheOptions)
	_getFrontendOptions (array $cacheOptions)

Protected Attributes
	$_defaultBackend = 'Cm_Cache_Backend_File'
	$_backendOptions
	$_resource

Detailed Description

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 18 of file Factory.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\ObjectManagerInterface	$objectManager,
		Filesystem	$filesystem,
		\Magento\Framework\App\ResourceConnection	$resource,
		array	$enforcedOptions = [],
		array	$decorators = []
	)

Parameters

\Magento\Framework\ObjectManagerInterface	$objectManager
Filesystem	$filesystem
\Magento\Framework\App\ResourceConnection	$resource
array	$enforcedOptions
array	$decorators

Definition at line 89 of file Factory.php.

      {
        $this->_objectManager = $objectManager;
        $this->_filesystem = $filesystem;
        $this->_resource = $resource;
        $this->_enforcedOptions = $enforcedOptions;
        $this->_decorators = $decorators;
    }

Member Function Documentation

_getBackendOptions()

_getBackendOptions ( array  $cacheOptions )

protected

Get cache backend options. Result array contain backend type ('type' key) and backend options ('options')

Parameters

array

$cacheOptions

Returns

array @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 213 of file Factory.php.

    {
        $enableTwoLevels = false;
        $type = isset($cacheOptions['backend']) ? $cacheOptions['backend'] : $this->_defaultBackend;
        if (isset($cacheOptions['backend_options']) && is_array($cacheOptions['backend_options'])) {
            $options = $cacheOptions['backend_options'];
        } else {
            $options = [];
        }

        $backendType = false;
        switch (strtolower($type)) {
            case 'sqlite':
                if (extension_loaded('sqlite') && isset($options['cache_db_complete_path'])) {
                    $backendType = 'Sqlite';
                }
                break;
            case 'memcached':
                if (extension_loaded('memcached')) {
                    if (isset($cacheOptions['memcached'])) {
                        $options = $cacheOptions['memcached'];
                    }
                    $enableTwoLevels = true;
                    $backendType = 'Libmemcached';
                } elseif (extension_loaded('memcache')) {
                    if (isset($cacheOptions['memcached'])) {
                        $options = $cacheOptions['memcached'];
                    }
                    $enableTwoLevels = true;
                    $backendType = 'Memcached';
                }
                break;
            case 'apc':
                if (extension_loaded('apc') && ini_get('apc.enabled')) {
                    $enableTwoLevels = true;
                    $backendType = 'Apc';
                }
                break;
            case 'xcache':
                if (extension_loaded('xcache')) {
                    $enableTwoLevels = true;
                    $backendType = 'Xcache';
                }
                break;
            case 'eaccelerator':
            case 'varien_cache_backend_eaccelerator':
                if (extension_loaded('eaccelerator') && ini_get('eaccelerator.enable')) {
                    $enableTwoLevels = true;
                    $backendType = \Magento\Framework\Cache\Backend\Eaccelerator::class;
                }
                break;
            case 'database':
                $backendType = \Magento\Framework\Cache\Backend\Database::class;
                $options = $this->_getDbAdapterOptions();
                break;
            case 'remote_synchronized_cache':
                $backendType = \Magento\Framework\Cache\Backend\RemoteSynchronizedCache::class;
                $options['remote_backend'] = \Magento\Framework\Cache\Backend\Database::class;
                $options['remote_backend_options'] = $this->_getDbAdapterOptions();
                $options['local_backend'] = \Cm_Cache_Backend_File::class;
                $cacheDir = $this->_filesystem->getDirectoryWrite(DirectoryList::CACHE);
                $options['local_backend_options']['cache_dir'] = $cacheDir->getAbsolutePath();
                $cacheDir->create();
                break;
            default:
                if ($type != $this->_defaultBackend) {
                    try {
                        if (class_exists($type, true)) {
                            $implements = class_implements($type, true);
                            if (in_array('Zend_Cache_Backend_Interface', $implements)) {
                                $backendType = $type;
                            }
                        }
                    } catch (\Exception $e) {
                    }
                }
        }
        if (!$backendType) {
            $backendType = $this->_defaultBackend;
            $cacheDir = $this->_filesystem->getDirectoryWrite(DirectoryList::CACHE);
            $this->_backendOptions['cache_dir'] = $cacheDir->getAbsolutePath();
            $cacheDir->create();
        }
        foreach ($this->_backendOptions as $option => $value) {
            if (!array_key_exists($option, $options)) {
                $options[$option] = $value;
            }
        }

        $backendOptions = ['type' => $backendType, 'options' => $options];
        if ($enableTwoLevels) {
            $backendOptions = $this->_getTwoLevelsBackendOptions($backendOptions, $cacheOptions);
        }
        return $backendOptions;
    }

_getDbAdapterOptions()

_getDbAdapterOptions ( )

protected

Get options for database backend type

Returns

array

Definition at line 314 of file Factory.php.

    {
        $options['adapter_callback'] = function () {
            return $this->_resource->getConnection();
        };
        $options['data_table_callback'] = function () {
            return $this->_resource->getTableName('cache');
        };
        $options['tags_table_callback'] = function () {
            return $this->_resource->getTableName('cache_tag');
        };
        return $options;
    }

_getFrontendOptions()

_getFrontendOptions ( array  $cacheOptions )

protected

Get options of cache frontend (options of \Zend_Cache_Core)

Parameters

array

$cacheOptions

Returns

array @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 381 of file Factory.php.

    {
        $options = isset($cacheOptions['frontend_options']) ? $cacheOptions['frontend_options'] : [];
        if (!array_key_exists('caching', $options)) {
            $options['caching'] = true;
        }
        if (!array_key_exists('lifetime', $options)) {
            $options['lifetime'] = isset(
                $cacheOptions['lifetime']
            ) ? $cacheOptions['lifetime'] : self::DEFAULT_LIFETIME;
        }
        if (!array_key_exists('automatic_cleaning_factor', $options)) {
            $options['automatic_cleaning_factor'] = 0;
        }
        $options['type'] =
            isset($cacheOptions['frontend']) ? $cacheOptions['frontend'] : \Magento\Framework\Cache\Core::class;
        return $options;
    }

_getTwoLevelsBackendOptions()

_getTwoLevelsBackendOptions (   $fastOptions,   $cacheOptions  )

protected

Initialize two levels backend model options

Parameters

array	$fastOptions	fast level backend type and options
array	$cacheOptions	all cache options

Returns

array

Definition at line 335 of file Factory.php.

    {
        $options = [];
        $options['fast_backend'] = $fastOptions['type'];
        $options['fast_backend_options'] = $fastOptions['options'];
        $options['fast_backend_custom_naming'] = true;
        $options['fast_backend_autoload'] = true;
        $options['slow_backend_custom_naming'] = true;
        $options['slow_backend_autoload'] = true;

        if (isset($cacheOptions['auto_refresh_fast_cache'])) {
            $options['auto_refresh_fast_cache'] = (bool)$cacheOptions['auto_refresh_fast_cache'];
        } else {
            $options['auto_refresh_fast_cache'] = false;
        }
        if (isset($cacheOptions['slow_backend'])) {
            $options['slow_backend'] = $cacheOptions['slow_backend'];
        } else {
            $options['slow_backend'] = $this->_defaultBackend;
        }
        if (isset($cacheOptions['slow_backend_options'])) {
            $options['slow_backend_options'] = $cacheOptions['slow_backend_options'];
        } else {
            $options['slow_backend_options'] = $this->_backendOptions;
        }
        if ($options['slow_backend'] == 'database') {
            $options['slow_backend'] = \Magento\Framework\Cache\Backend\Database::class;
            $options['slow_backend_options'] = $this->_getDbAdapterOptions();
            if (isset($cacheOptions['slow_backend_store_data'])) {
                $options['slow_backend_options']['store_data'] = (bool)$cacheOptions['slow_backend_store_data'];
            } else {
                $options['slow_backend_options']['store_data'] = false;
            }
        }

        $backend = ['type' => 'TwoLevels', 'options' => $options];
        return $backend;
    }

Field Documentation

$_backendOptions

$_backendOptions

protected

Initial value:

= [
        'hashed_directory_level' => 1,
        'file_name_prefix' => 'mage',
    ]

Definition at line 70 of file Factory.php.

$_defaultBackend

$_defaultBackend = 'Cm_Cache_Backend_File'

protected

Definition at line 63 of file Factory.php.

$_resource

$_resource

protected

Definition at line 80 of file Factory.php.

DEFAULT_LIFETIME

const DEFAULT_LIFETIME = 7200

Default cache entry lifetime

Definition at line 23 of file Factory.php.

PARAM_CACHE_FORCED_OPTIONS

const PARAM_CACHE_FORCED_OPTIONS = 'cache_options'

Caching params, that applied for all cache frontends regardless of type

Definition at line 28 of file Factory.php.

---

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

• vendor/magento/framework/App/Cache/Frontend/Factory.php