\Numenor\CacheCacheDisco

Classe de controle do adaptador de cache em disco do framework Zend2.

Embora este adaptador de cache seja o mais comumente utilizado pela conveniência (os registros do cache ficam armazenados em disco, e não é necessário instalar nenhuma extensão para que funcione), tenha em mente que operações de I/O (leitura/escrita em disco) podem ser demoradas em caso de demanda simultânea muito grande.

Summary

Methods
Properties
Constants
__construct()
getItem()
getMetadata()
setItem()
verificarItem()
renovarItem()
setDiretorioPadrao()
No public properties found
No constants found
No protected methods found
$namespace
$duracao
$adapter
N/A
No private methods found
$diretorioPadrao
$modo
$diretorio
$nivel
N/A

Properties

$namespace

$namespace : string

Identificador de namespace do cache (para evitar colisão com outras instâncias)

Type

string

$duracao

$duracao : integer

Duração da validade do cache, em segundos

O valor 0 indica que o cache não expira por duração (mas pode expirar por outras razões, de acordo com as regras do adaptador de cache escolhido).

Type

integer

$adapter

$adapter : \Zend\Cache\Storage\Adapter

Instância do objeto adaptador de cache

Type

\Zend\Cache\Storage\Adapter

$diretorioPadrao

$diretorioPadrao : string

Diretório padrão de armazenamento dos arquivos de cache.

As instâncias da classe CacheDisco podem sobrescrever este diretório em seus construtores.

Type

string

$modo

$modo : string

Modo de acesso ao cache.

('r' = somente leitura, 'w' = somente escrita, 'rw' = leitura e escrita).

Type

string

$diretorio

$diretorio : string

Diretório onde os arquivos de cache serão armazeados.

O diretório deve ter permissão de leitura, execução e escrita para o usuário do PHP (normalmente 0700, mas nesse caso não será possível remover os arquivos de cache via FTP ou SSH a menos que se tenha acesso como super- usuário).

Type

string

$nivel

$nivel : integer

Em quantos subníveis de diretórios os arquivos de cache deverão ser subdivididos (espelhados) dentro do diretório de cache.

Quando há muitos registros de cache diferentes (namespace + id + tags), pode ser necessário subdividir os mesmos em 2 ou mais subníveis de subdiretórios para não causar problemas na estrutura de arquivos do sistema operacional. No entanto, a divisão em subníveis torna a operação de remover os registros por tag mais demorada.

Type

integer

Methods

__construct()

__construct(\Numenor\Cache\string  $namespace, \Numenor\Cache\int  $duracao, string  $diretorio = '', integer  $nivel = 1, string  $modo = 'rw') 

Método construtor da classe

Parameters

\Numenor\Cache\string $namespace

Identificador de namespace do cache

\Numenor\Cache\int $duracao

Validade do cache, em segundos (0 = cache não expira)

string $diretorio

Diretório onde os arquivos de cache serão armazenados.

integer $nivel

Em quantos subníveis de diretórios os arquivos de cache serão divididos (1 = não há subdivisão).

string $modo

Modo de acesso do cache ('r' = somente leitura, 'w' = somente escrita, 'rw' = leitura e e scrita).

Throws

\Numenor\Excecao\ExcecaoCacheDiscoDirNaoDefinido

se tanto o parâmetro $diretorio quanto a propriedade estática self::$diretorioPadrao não estiverem definidos.

\Numenor\Excecao\ExcecaoCacheDiscoDirEscrita

se o diretório de cache informado não existir ou não tiver permissão de escrita.

getItem()

getItem(string  $key) : mixed|null

Recupera um item do cache, identificado pela chave

Parameters

string $key

Chave de identificação do item do cache

Returns

mixed|null —

Item carregado do cache, ou NULL caso o item não exista

getMetadata()

getMetadata(string  $key) : array|boolean

Retorna a metadata de um item do cache, identificado pela chave

Parameters

string $key

Chave de identificação do item do cache

Returns

array|boolean —

Array associativo contendo os dados de metadata do item do cache, ou FALSE caso o item não exista

setItem()

setItem(string  $key, mixed  $value) : boolean

Armazena um item no cache, identificado por uma chave

Parameters

string $key

Chave de identificação do item do cache

mixed $value

Valor armazenado

Returns

boolean —

O item foi armazenado no cache com sucesso?

verificarItem()

verificarItem(string  $key) : boolean

Verifica se um item existe e está ativo no cache, identificado pela chave.

Parameters

string $key

Chave de identificação do item do cache

Returns

boolean —

O item existe e está ativo no cache?

renovarItem()

renovarItem(string  $key) : boolean

Renova a validade do item do cache, identificado por uma chave.

Parameters

string $key

Chave de identificação do item do cache

Returns

boolean —

O item deve sua validade renovada com sucesso?

setDiretorioPadrao()

setDiretorioPadrao(string  $diretorioPadrao) 

Define o diretório padrão de armazenamento do cache em disco.

Parameters

string $diretorioPadrao

Diretório de armazenamento do cache em disco

Throws

\Numenor\Excecao\ExcecaoCacheDiscoDirEscrita

se o diretório padrão informado não existir ou não tiver permissão de escrita.