Zend\Cache\Storage\Adapter\FilesystemOptions
These are options specific to the Filesystem adapter
Synopsis
class FilesystemOptions
extends AdapterOptions
{
- // members
- protected null|string $cacheDir;
- protected bool $clearStatCache;
- protected integer $dirLevel;
- protected false|int $dirPermission;
- protected bool $fileLocking;
- protected false|int $filePermission;
- protected string $keyPattern;
- protected string $namespaceSeparator;
- protected bool $noAtime;
- protected bool $noCtime;
- protected false|int $umask;
- // Inherited members from AdapterOptions
- protected null|Filesystem $adapter;
- protected string $keyPattern;
- protected string $namespace;
- protected bool $readable;
- protected int|float $ttl;
- protected bool $writable;
- // Inherited members from AbstractOptions
- protected bool $__strictMode__;
- // methods
- public FilesystemOptions __construct()
- public FilesystemOptions setCacheDir()
- public null|string getCacheDir()
- public FilesystemOptions setClearStatCache()
- public bool getClearStatCache()
- public FilesystemOptions setDirLevel()
- public int getDirLevel()
- public FilesystemOptions setDirPermission()
- public false|int getDirPermission()
- public FilesystemOptions setFileLocking()
- public bool getFileLocking()
- public FilesystemOptions setFilePermission()
- public false|int getFilePermission()
- public FilesystemOptions setNamespaceSeparator()
- public string getNamespaceSeparator()
- public FilesystemOptions setNoAtime()
- public bool getNoAtime()
- public FilesystemOptions setNoCtime()
- public bool getNoCtime()
- public FilesystemOptions setUmask()
- public false|int getUmask()
- // Inherited methods from AdapterOptions
- public AdapterOptions setAdapter()
- public AdapterOptions setKeyPattern()
- public string getKeyPattern()
- public AdapterOptions setNamespace()
- public string getNamespace()
- public AbstractAdapter setReadable()
- public bool getReadable()
- public AdapterOptions setTtl()
- public float getTtl()
- public AdapterOptions setWritable()
- public bool getWritable()
- protected void triggerOptionEvent()
- protected void normalizeTtl()
- // Inherited methods from AbstractOptions
- public void __construct()
- public AbstractOptions setFromArray()
- public array toArray()
- public void __set()
- public mixed __get()
- public bool __isset()
- public void __unset()
Hierarchy
Members
protected
- $__strictMode__
—
Zend\Stdlib\bool
We use the __ prefix to avoid collisions with properties in user-implementations. - $adapter
—
Zend\Cache\Storage\Adapter\null|Filesystem
The adapter using these options - $cacheDir
—
Zend\Cache\Storage\Adapter\null|string
Directory to store cache files - $clearStatCache
—
Zend\Cache\Storage\Adapter\bool
Call clearstatcache enabled? - $dirLevel
—
int
How much sub-directaries should be created? - $dirPermission
—
Zend\Cache\Storage\Adapter\false|int
Permission creating new directories - $fileLocking
—
Zend\Cache\Storage\Adapter\bool
Lock files on writing - $filePermission
—
Zend\Cache\Storage\Adapter\false|int
Permission creating new files - $keyPattern
—
string
Overwrite default key pattern - $keyPattern
—
string
Validate key against pattern - $namespace
—
string
Namespace option - $namespaceSeparator
—
string
Namespace separator - $noAtime
—
Zend\Cache\Storage\Adapter\bool
Don't get 'fileatime' as 'atime' on metadata - $noCtime
—
Zend\Cache\Storage\Adapter\bool
Don't get 'filectime' as 'ctime' on metadata - $readable
—
Zend\Cache\Storage\Adapter\bool
Readable option - $ttl
—
Zend\Cache\Storage\Adapter\int|float
TTL option - $umask
—
Zend\Cache\Storage\Adapter\false|int
Umask to create files and directories - $writable
—
Zend\Cache\Storage\Adapter\bool
Writable option
Methods
public
- __construct() — Constructor
- getCacheDir() — Get cache dir
- getClearStatCache() — Get clear stat cache
- getDirLevel() — Get dir level
- getDirPermission() — Get permission to create directories on unix systems
- getFileLocking() — Get file locking
- getFilePermission() — Get permission to create files on unix systems
- getNamespaceSeparator() — Get namespace separator
- getNoAtime() — Get no atime
- getNoCtime() — Get no ctime
- getUmask() — Get the umask to create files and directories on unix systems
- setCacheDir() — Set cache dir
- setClearStatCache() — Set clear stat cache
- setDirLevel() — Set dir level
- setDirPermission() — Set permission to create directories on unix systems
- setFileLocking() — Set file locking
- setFilePermission() — Set permission to create files on unix systems
- setNamespaceSeparator() — Set namespace separator
- setNoAtime() — Set no atime
- setNoCtime() — Set no ctime
- setUmask() — Set the umask to create files and directories on unix systems
Inherited from Zend\Cache\Storage\Adapter\AdapterOptions
protected
- normalizeTtl() — Validates and normalize a TTL.
- triggerOptionEvent() — Triggers an option event if this options instance has a connection to an adapter implements EventsCapableInterface.
public
- getKeyPattern() — Get key pattern
- getNamespace() — Get namespace
- getReadable() — If reading data from cache enabled.
- getTtl() — Get time to live.
- getWritable() — If writing data to cache enabled.
- setAdapter() — Adapter using this instance
- setKeyPattern() — Set key pattern
- setNamespace() — Set namespace.
- setReadable() — Enable/Disable reading data from cache.
- setTtl() — Set time to live.
- setWritable() — Enable/Disable writing data to cache.