Zend Framework » \Zend\Cache\Storage\Adapter\FilesystemOptions

These are options specific to the Filesystem adapter

Methods

Constructor

__construct(array | \Traversable | null $options) : \Zend\Cache\Storage\Adapter\FilesystemOptions

Parameters

$options

array\Traversablenull

Exceptions

`\Zend\Cache\Exception\InvalidArgumentException`

Returns

\Zend\Cache\Storage\Adapter\FilesystemOptions

Get a configuration property

__get(string $key) : mixed

Inherited

see	\Zend\Stdlib\ParameterObject::__get()
inherited_from	\Zend\Stdlib\AbstractOptions::__get()
inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::__get()

Parameters

$key

string

Exceptions

`\Zend\Stdlib\Exception\BadMethodCallException`

Returns

mixed

Test if a configuration property is null

__isset(string $key) : bool

Inherited

see	\Zend\Stdlib\ParameterObject::__isset()
inherited_from	\Zend\Stdlib\AbstractOptions::__isset()
inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::__isset()

Parameters

$key

string

Returns

bool

Set a configuration property

__set(string $key, mixed $value) : void

Inherited

see	\Zend\Stdlib\ParameterObject::__set()
inherited_from	\Zend\Stdlib\AbstractOptions::__set()
inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::__set()

Parameters

$key

string

$value

mixed

Exceptions

`\Zend\Stdlib\Exception\BadMethodCallException`

Set a configuration property to NULL

__unset(string $key) : void

Inherited

see	\Zend\Stdlib\ParameterObject::__unset()
inherited_from	\Zend\Stdlib\AbstractOptions::__unset()
inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::__unset()

Parameters

$key

string

Exceptions

`\Zend\Stdlib\Exception\InvalidArgumentException`

Get cache dir

getCacheDir() : null | string

Returns

nullstring

Get clear stat cache

getClearStatCache() : bool

Returns

bool

Get dir level

getDirLevel() : int

Returns

int

Get permission to create directories on unix systems

getDirPermission() : false | int

Returns

falseint

Get file locking

getFileLocking() : bool

Returns

bool

Get permission to create files on unix systems

getFilePermission() : false | int

Returns

falseint

Get key pattern

getKeyPattern() : string

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::getKeyPattern()

Returns

string

Get namespace

getNamespace() : string

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::getNamespace()

Returns

string

Get namespace separator

getNamespaceSeparator() : string

Returns

string

Get no atime

getNoAtime() : bool

Returns

bool

Get no ctime

getNoCtime() : bool

Returns

bool

If reading data from cache enabled.

getReadable() : bool

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::getReadable()

Returns

bool

Get time to live.

getTtl() : float

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::getTtl()

Returns

float

Get the umask to create files and directories on unix systems

getUmask() : false | int

Returns

falseint

If writing data to cache enabled.

getWritable() : bool

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::getWritable()

Returns

bool

Adapter using this instance

setAdapter(\Zend\Cache\Storage\StorageInterface $adapter) : \Zend\Cache\Storage\Adapter\AdapterOptions

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::setAdapter()

Parameters

$adapter

\Zend\Cache\Storage\StorageInterfacenull

Returns

\Zend\Cache\Storage\Adapter\AdapterOptions

Set cache dir

setCacheDir(string $cacheDir) : \Zend\Cache\Storage\Adapter\FilesystemOptions

Parameters

$cacheDir

string

Exceptions

`\Zend\Cache\Exception\InvalidArgumentException`

Returns

\Zend\Cache\Storage\Adapter\FilesystemOptions

Set clear stat cache

setClearStatCache(bool $clearStatCache) : \Zend\Cache\Storage\Adapter\FilesystemOptions

Parameters

$clearStatCache

bool

Returns

\Zend\Cache\Storage\Adapter\FilesystemOptions

Set dir level

setDirLevel(int $dirLevel) : \Zend\Cache\Storage\Adapter\FilesystemOptions

Parameters

$dirLevel

int

Exceptions

`\Zend\Cache\Exception\InvalidArgumentException`

Returns

\Zend\Cache\Storage\Adapter\FilesystemOptions

Set permission to create directories on unix systems

setDirPermission(false | string | int $dirPermission) : \Zend\Cache\Storage\Adapter\FilesystemOptions

see	\Zend\Cache\Storage\Adapter\setUmask
see	\Zend\Cache\Storage\Adapter\setFilePermission
link	http://php.net/manual/function.chmod.php

Parameters

$dirPermission

falsestringint

FALSE to disable explicit permission or an octal number

Returns

\Zend\Cache\Storage\Adapter\FilesystemOptions

Set file locking

setFileLocking(bool $fileLocking) : \Zend\Cache\Storage\Adapter\FilesystemOptions

Parameters

$fileLocking

bool

Returns

\Zend\Cache\Storage\Adapter\FilesystemOptions

Set permission to create files on unix systems

setFilePermission(false | string | int $filePermission) : \Zend\Cache\Storage\Adapter\FilesystemOptions

see	\Zend\Cache\Storage\Adapter\setUmask
see	\Zend\Cache\Storage\Adapter\setDirPermission
link	http://php.net/manual/function.chmod.php

Parameters

$filePermission

falsestringint

FALSE to disable explicit permission or an octal number

Returns

\Zend\Cache\Storage\Adapter\FilesystemOptions

Set one or more configuration properties

setFromArray(array | \Traversable | \Zend\Stdlib\AbstractOptions $options) : \Zend\Stdlib\AbstractOptions

Inherited

inherited_from	\Zend\Stdlib\AbstractOptions::setFromArray()
inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::setFromArray()

Parameters

$options

array\Traversable\Zend\Stdlib\AbstractOptions

Exceptions

`\Zend\Stdlib\Exception\InvalidArgumentException`

Returns

\Zend\Stdlib\AbstractOptionsProvides fluent interface

Set key pattern

setKeyPattern(null | string $keyPattern) : \Zend\Cache\Storage\Adapter\AdapterOptions

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::setKeyPattern()

Parameters

$keyPattern

nullstring

Exceptions

`\Zend\Cache\Exception\InvalidArgumentException`

Returns

\Zend\Cache\Storage\Adapter\AdapterOptions

Set namespace.

setNamespace(string $namespace) : \Zend\Cache\Storage\Adapter\AdapterOptions

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::setNamespace()

Parameters

$namespace

string

Returns

\Zend\Cache\Storage\Adapter\AdapterOptions

Set namespace separator

setNamespaceSeparator(string $namespaceSeparator) : \Zend\Cache\Storage\Adapter\FilesystemOptions

Parameters

$namespaceSeparator

string

Returns

\Zend\Cache\Storage\Adapter\FilesystemOptions

Set no atime

setNoAtime(bool $noAtime) : \Zend\Cache\Storage\Adapter\FilesystemOptions

Parameters

$noAtime

bool

Returns

\Zend\Cache\Storage\Adapter\FilesystemOptions

Set no ctime

setNoCtime(bool $noCtime) : \Zend\Cache\Storage\Adapter\FilesystemOptions

Parameters

$noCtime

bool

Returns

\Zend\Cache\Storage\Adapter\FilesystemOptions

Enable/Disable reading data from cache.

setReadable(bool $readable) : \Zend\Cache\Storage\Adapter\AbstractAdapter

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::setReadable()

Parameters

$readable

bool

Returns

\Zend\Cache\Storage\Adapter\AbstractAdapter

Set time to live.

setTtl(int | float $ttl) : \Zend\Cache\Storage\Adapter\AdapterOptions

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::setTtl()

Parameters

$ttl

intfloat

Returns

\Zend\Cache\Storage\Adapter\AdapterOptions

Set the umask to create files and directories on unix systems

setUmask(false | string | int $umask) : \Zend\Cache\Storage\Adapter\FilesystemOptions

Note: On multithreaded webservers it's better to explicit set file and dir permission.

see	\Zend\Cache\Storage\Adapter\setFilePermission
see	\Zend\Cache\Storage\Adapter\setDirPermission
link	http://php.net/manual/function.umask.php
link	http://en.wikipedia.org/wiki/Umask

Parameters

$umask

falsestringint

FALSE to disable umask or an octal number

Returns

\Zend\Cache\Storage\Adapter\FilesystemOptions

Enable/Disable writing data to cache.

setWritable(bool $writable) : \Zend\Cache\Storage\Adapter\AdapterOptions

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::setWritable()

Parameters

$writable

bool

Returns

\Zend\Cache\Storage\Adapter\AdapterOptions

Cast to array

toArray() : array

Inherited

inherited_from	\Zend\Stdlib\AbstractOptions::toArray()
inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::toArray()

Returns

array

Validates and normalize a TTL.

normalizeTtl(int | float $ttl) : void

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::normalizeTtl()

Parameters

$ttl

intfloat

Exceptions

`\Zend\Cache\Exception\InvalidArgumentException`

Triggers an option event if this options instance has a connection to an adapter implements EventsCapableInterface.

triggerOptionEvent(string $optionName, mixed $optionValue) : void

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::triggerOptionEvent()

Parameters

$optionName

string

$optionValue

mixed

Properties

We use the __ prefix to avoid collisions with properties in user-implementations.

$__strictMode__ : bool

Inherited

inherited_from	\Zend\Stdlib\AbstractOptions::$$__strictMode__
inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::$$__strictMode__

The adapter using these options

$adapter : null | \Zend\Cache\Storage\StorageInterface

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::$$adapter

Directory to store cache files

$cacheDir : null | string

Call clearstatcache enabled?

$clearStatCache : bool

How much sub-directaries should be created?

$dirLevel : int

Permission creating new directories

$dirPermission : false | int

Lock files on writing

$fileLocking : bool

Permission creating new files

$filePermission : false | int

Overwrite default key pattern

$keyPattern : string

Defined in AdapterOptions

Namespace option

$namespace : string

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::$$namespace

Namespace separator

$namespaceSeparator : string

Don't get 'fileatime' as 'atime' on metadata

$noAtime : bool

Don't get 'filectime' as 'ctime' on metadata

$noCtime : bool

Readable option

$readable : bool

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::$$readable

TTL option

$ttl : int | float

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::$$ttl

Umask to create files and directories

$umask : false | int

Writable option

$writable : bool

Inherited

inherited_from	\Zend\Cache\Storage\Adapter\AdapterOptions::$$writable