Cache.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Cache
version: $Id: Cache.php 21974 2010-04-23 17:10:17Z alexander $
Classes: Zend_Cache

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Cache
jump to top

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Cache
Constants: CLEANING_MODE_ALL; CLEANING_MODE_OLD; CLEANING_MODE_MATCHING_TAG; CLEANING_MODE_NOT_MATCHING_TAG; CLEANING_MODE_MATCHING_ANY_TAG
Properties: $standardFrontends; $standardBackends; $standardExtendedBackends; $availableFrontends; $availableBackends
Methods: factory; _makeBackend; _makeFrontend; throwException; _normalizeName; _isReadable

Description

Constants

CLEANING_MODE_ALL
jump to class

 CLEANING_MODE_ALL = 'all'

Consts for clean() method

Details

value: all

CLEANING_MODE_OLD
jump to class

 CLEANING_MODE_OLD = 'old'

Details

value: old

CLEANING_MODE_MATCHING_TAG
jump to class

 CLEANING_MODE_MATCHING_TAG = 'matchingTag'

Details

value: matchingTag

CLEANING_MODE_NOT_MATCHING_TAG
jump to class

 CLEANING_MODE_NOT_MATCHING_TAG = 'notMatchingTag'

Details

value: notMatchingTag

CLEANING_MODE_MATCHING_ANY_TAG
jump to class

 CLEANING_MODE_MATCHING_ANY_TAG = 'matchingAnyTag'

Details

value: matchingAnyTag

Properties

$availableBackends
jump to class

array $availableBackends = 'array'

Only for backward compatibily (may be removed in next major release)

Details

$availableBackends: array
visibility: public
default: array
final: false
static: true
deprecated

$availableFrontends
jump to class

array $availableFrontends = 'array'

Only for backward compatibily (may be removed in next major release)

Details

$availableFrontends: array
visibility: public
default: array
final: false
static: true
deprecated

$standardBackends
jump to class

array $standardBackends = 'array'

Standard backends

Details

$standardBackends: array
visibility: public
default: array
final: false
static: true

$standardExtendedBackends
jump to class

array $standardExtendedBackends = 'array'

Standard backends which implement the ExtendedInterface

Details

$standardExtendedBackends: array
visibility: public
default: array
final: false
static: true

$standardFrontends
jump to class

array $standardFrontends = 'array'

Standard frontends

Details

$standardFrontends: array
visibility: public
default: array
final: false
static: true

Methods

_isReadable
jump to class

_isReadable(
          string $filename
          )
        
        :
        boolean

Returns TRUE if the $filename is readable, or FALSE otherwise.

This function uses the PHP include_path, where PHP's is_readable() does not.

Note : this method comes from Zend_Loader (see #ZF-2891 for details)

Arguments

$filename: string

Output

boolean

Details

visibility: private
final: false
static: true

_makeBackend
jump to class

_makeBackend(
          string $backend, array $backendOptions, boolean $customBackendNaming
              =
              false, boolean $autoload
              =
              false
          )
        
        :
        Zend_Cache_Backend

Frontend Constructor

Arguments

$backend: string
$backendOptions: array
$customBackendNaming: boolean
$autoload: boolean

Output

Zend_Cache_Backend

Details

visibility: public
final: false
static: true

_makeFrontend
jump to class

_makeFrontend(
          string $frontend, array $frontendOptions
              =
              array, boolean $customFrontendNaming
              =
              false, boolean $autoload
              =
              false
          )
        
        :
        Zend_Cache_Core|Zend_Cache_Frontend

Backend Constructor

Arguments

$frontend: string
$frontendOptions: array
$customFrontendNaming: boolean
$autoload: boolean

Output

Zend_Cache_Core|Zend_Cache_Frontend

Details

visibility: public
final: false
static: true

_normalizeName
jump to class

_normalizeName(
          string $name
          )
        
        :
        string

Normalize frontend and backend names to allow multiple words TitleCased

Arguments

$name: string
Name to normalize

Output

string

Details

visibility: protected
final: false
static: true

factory
jump to class

factory(
          mixed $frontend, mixed $backend, array $frontendOptions
              =
              array, array $backendOptions
              =
              array, boolean $customFrontendNaming
              =
              false, boolean $customBackendNaming
              =
              false, boolean $autoload
              =
              false
          )
        
        :
        Zend_Cache_Core|Zend_Cache_Frontend

Factory

Arguments

$frontend: mixed
frontend name (string) or Zend_Cache_Frontend_ object
$backend: mixed
backend name (string) or Zend_Cache_Backend_ object
$frontendOptions: array
associative array of options for the corresponding frontend constructor
$backendOptions: array
associative array of options for the corresponding backend constructor
$customFrontendNaming: boolean
if true, the frontend argument is used as a complete class name ; if false, the frontend argument is used as the end of "Zend_Cache_Frontend_[...]" class name
$customBackendNaming: boolean
if true, the backend argument is used as a complete class name ; if false, the backend argument is used as the end of "Zend_Cache_Backend_[...]" class name
$autoload: boolean
if true, there will no require_once for backend and frontend (usefull only for custom backends/frontends)

Output

Zend_Cache_Core|Zend_Cache_Frontend

Details

visibility: public
final: false
static: true
throws

throwException
jump to class

throwException(
          string $msg,  $e
              =
              null
          )
        
        :

Throw an exception

Note : for perf reasons, the "load" of Zend/Cache/Exception is dynamic

Arguments

$msg: string
Message for the exception
$e

Details

visibility: public
final: false
static: true
throws

API Documentation

Cache.php

Description

Zend_Cachejump to top

Description

Constants

CLEANING_MODE_ALLjump to class

Details

CLEANING_MODE_OLDjump to class

Details

CLEANING_MODE_MATCHING_TAGjump to class

Details

CLEANING_MODE_NOT_MATCHING_TAGjump to class

Details

CLEANING_MODE_MATCHING_ANY_TAGjump to class

Details

Properties

$availableBackendsjump to class

Details

$availableFrontendsjump to class

Details

$standardBackendsjump to class

Details

$standardExtendedBackendsjump to class

Details

$standardFrontendsjump to class

Details

Methods

_isReadablejump to class

Arguments

Output

Details

_makeBackendjump to class

Arguments

Output

Details

_makeFrontendjump to class

Arguments

Output

Details

_normalizeNamejump to class

Arguments

Output

Details

factoryjump to class

Arguments

Output

Details

throwExceptionjump to class

Arguments

Details

Zend_Cache
jump to top

CLEANING_MODE_ALL
jump to class

CLEANING_MODE_OLD
jump to class

CLEANING_MODE_MATCHING_TAG
jump to class

CLEANING_MODE_NOT_MATCHING_TAG
jump to class

CLEANING_MODE_MATCHING_ANY_TAG
jump to class

$availableBackends
jump to class

$availableFrontends
jump to class

$standardBackends
jump to class

$standardExtendedBackends
jump to class

$standardFrontends
jump to class

_isReadable
jump to class

_makeBackend
jump to class

_makeFrontend
jump to class

_normalizeName
jump to class

factory
jump to class

throwException
jump to class