Zend_Cache_Backend Class Reference

Inheritance diagram for Zend_Cache_Backend:

Public Member Functions
	__construct (array $options=array())
	setDirectives ($directives)
	setOption ($name, $value)
	getOption ($name)
	getLifetime ($specificLifetime)
	isAutomaticCleaningAvailable ()
	getTmpDir ()

Protected Member Functions
	_isGoodTmpDir ($dir)
	_loggerSanity ()
	_log ($message, $priority=4)

Protected Attributes
	$_directives
	$_options = array()

Detailed Description

Definition at line 30 of file Backend.php.

Constructor & Destructor Documentation

__construct()

__construct

(

array

$options = array()

)

Constructor

Parameters

array

$options

Associative array of options

Definition at line 62 of file Backend.php.

    {
        foreach ($options as $name => $value) {
            $this->setOption($name, $value);
        }
    }

Member Function Documentation

_isGoodTmpDir()

_isGoodTmpDir (   $dir )

protected

Verify if the given temporary directory is readable and writable

Parameters

string

$dir

temporary directory

Returns

boolean true if the directory is ok

Definition at line 226 of file Backend.php.

    {
        if (is_readable($dir)) {
            if (is_writable($dir)) {
                return true;
            }
        }
        return false;
    }

_log()

_log (   $message,   $priority = 4  )

protected

Log a message at the WARN (4) priority.

Parameters

string	$message
int	$priority

Returns

void

Definition at line 273 of file Backend.php.

    {
        if (!$this->_directives['logging']) {
            return;
        }

        if (!isset($this->_directives['logger'])) {
            Zend_Cache::throwException('Logging is enabled but logger is not set.');
        }
        $logger = $this->_directives['logger'];
        if (!$logger instanceof Zend_Log) {
            Zend_Cache::throwException('Logger object is not an instance of Zend_Log class.');
        }
        $logger->log($message, $priority);
    }

_loggerSanity()

_loggerSanity ( )

protected

Make sure if we enable logging that the Zend_Log class is available. Create a default log object if none is set.

Exceptions

Zend_Cache_Exception

Returns

void

Definition at line 244 of file Backend.php.

    {
        if (!isset($this->_directives['logging']) || !$this->_directives['logging']) {
            return;
        }

        if (isset($this->_directives['logger'])) {
            if ($this->_directives['logger'] instanceof Zend_Log) {
                return;
            }
            Zend_Cache::throwException('Logger object is not an instance of Zend_Log class.');
        }

        // Create a default logger to the standard output stream
        #require_once 'Zend/Log.php';
        #require_once 'Zend/Log/Writer/Stream.php';
        #require_once 'Zend/Log/Filter/Priority.php';
        $logger = new Zend_Log(new Zend_Log_Writer_Stream('php://output'));
        $logger->addFilter(new Zend_Log_Filter_Priority(Zend_Log::WARN, '<='));
        $this->_directives['logger'] = $logger;
    }

getLifetime()

getLifetime

(

$specificLifetime

)

Get the life time

if $specificLifetime is not false, the given specific life time is used else, the global lifetime is used

Parameters

int

$specificLifetime

Returns

int Cache life time

Definition at line 143 of file Backend.php.

    {
        if ($specificLifetime === false) {
            return $this->_directives['lifetime'];
        }
        return $specificLifetime;
    }

getOption()

getOption

(

$name

)

Returns an option

Parameters

string

$name

Optional, the options name to return

Exceptions

Zend_Cache_Exceptions

Returns

mixed

Definition at line 119 of file Backend.php.

    {
        $name = strtolower($name);

        if (array_key_exists($name, $this->_options)) {
            return $this->_options[$name];
        }

        if (array_key_exists($name, $this->_directives)) {
            return $this->_directives[$name];
        }

        Zend_Cache::throwException("Incorrect option name : {$name}");
    }

getTmpDir()

getTmpDir

(

)

Determine system TMP directory and detect if we have read access

inspired from Zend_File_Transfer_Adapter_Abstract

Returns

string

Exceptions

Zend_Cache_Exception

if unable to determine directory

Definition at line 172 of file Backend.php.

    {
        $tmpdir = array();
        foreach (array($_ENV, $_SERVER) as $tab) {
            foreach (array('TMPDIR', 'TEMP', 'TMP', 'windir', 'SystemRoot') as $key) {
                if (isset($tab[$key]) && is_string($tab[$key])) {
                    if (($key == 'windir') or ($key == 'SystemRoot')) {
                        $dir = realpath($tab[$key] . '\\temp');
                    } else {
                        $dir = realpath($tab[$key]);
                    }
                    if ($this->_isGoodTmpDir($dir)) {
                        return $dir;
                    }
                }
            }
        }
        $upload = ini_get('upload_tmp_dir');
        if ($upload) {
            $dir = realpath($upload);
            if ($this->_isGoodTmpDir($dir)) {
                return $dir;
            }
        }
        if (function_exists('sys_get_temp_dir')) {
            $dir = sys_get_temp_dir();
            if ($this->_isGoodTmpDir($dir)) {
                return $dir;
            }
        }
        // Attemp to detect by creating a temporary file
        $tempFile = tempnam(md5(uniqid(rand(), TRUE)), '');
        if ($tempFile) {
            $dir = realpath(dirname($tempFile));
            unlink($tempFile);
            if ($this->_isGoodTmpDir($dir)) {
                return $dir;
            }
        }
        if ($this->_isGoodTmpDir('/tmp')) {
            return '/tmp';
        }
        if ($this->_isGoodTmpDir('\\temp')) {
            return '\\temp';
        }
        Zend_Cache::throwException('Could not determine temp directory, please specify a cache_dir manually');
    }

isAutomaticCleaningAvailable()

isAutomaticCleaningAvailable

(

)

Return true if the automatic cleaning is available for the backend

DEPRECATED : use getCapabilities() instead

Deprecated:

Returns

boolean

Definition at line 159 of file Backend.php.

    {
        return true;
    }

setDirectives()

setDirectives

(

$directives

)

Set the frontend directives

Parameters

array

$directives

Assoc of directives

Exceptions

Zend_Cache_Exception

Returns

void

Definition at line 76 of file Backend.php.

    {
        if (!is_array($directives)) Zend_Cache::throwException('Directives parameter must be an array');
        foreach ($directives as $name => $value) {
            if (!is_string($name)) {
                Zend_Cache::throwException("Incorrect option name : $name");
            }
            $name = strtolower($name);
            if (array_key_exists($name, $this->_directives)) {
                $this->_directives[$name] = $value;
            }

        }

        $this->_loggerSanity();
    }

setOption()

setOption	(		$name,
			$value
	)

Set an option

Parameters

string	$name
mixed	$value

Exceptions

Zend_Cache_Exception

Returns

void

Definition at line 101 of file Backend.php.

    {
        if (!is_string($name)) {
            Zend_Cache::throwException("Incorrect option name : $name");
        }
        $name = strtolower($name);
        if (array_key_exists($name, $this->_options)) {
            $this->_options[$name] = $value;
        }
    }

Field Documentation

$_directives

$_directives

protected

Initial value:

= array(
        'lifetime' => 3600,
        'logging'  => false,
        'logger'   => null
    )

Definition at line 44 of file Backend.php.

$_options

$_options = array()

protected

Definition at line 55 of file Backend.php.

---

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

• vendor/magento/zendframework1/library/Zend/Cache/Backend.php