xplo.re Medusa Core Framework 3.1
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Event
  • Todo
  • Download

Namespaces

  • Core
    • Authentication
      • Auto
        • Driver
      • Driver
    • Cache
      • Driver
    • Charset
      • Driver
    • Configuration
    • Controller
    • Converter
      • Driver
    • Decoder
      • Driver
    • Encoder
      • Driver
    • Env
      • Authentication
      • Locale
      • Proxy
      • Server
        • HTTP
        • Redirect
        • X
    • Exception
    • Exchange
      • Driver
    • Field
    • Filter
      • Driver
    • Formatter
      • Driver
        • coreuimarkup
          • Token
    • Hash
    • Loader
    • Locale
    • Log
      • Driver
    • Module
      • Dependency
        • Requirement
          • Core
          • PHP
      • Linkage
        • Driver
    • PDF
    • Plugin
    • Query
      • Driver
    • Server
      • Driver
    • Session
      • Driver
    • Set
    • Storage
      • Driver
      • Field
        • Element
    • Stream
      • Driver
    • String
    • Translation
      • Driver
      • Language
        • Driver
    • URI
      • Driver
    • Version
    • View
      • Driver
        • coreui
          • Control
            • Button
            • Table
          • Element
        • htmlbuilder
          • Tags
        • yui
          • Modules
  • None
  • PHP

Classes

  • apc
  • file
  • null
  • storage

Class null

Debug cache that does not store any entries (i.e. TTL is always 0). Throws an exception on read attempts to identify incorrect cache usage.

Core\Object implements Core\Chainable
Extended by Core\Set implements Core\Accessor
Extended by Core\Cache
Extended by Core\Cache\Driver\null
Namespace: Core\Cache\Driver
Package: Core\Cache
Since: 3.0
Requires: PHP 5.3
Version: 1.1
Located at Cache/Driver/null.inc.php

Methods summary

public boolean
# exists( string $class, string $key )

Tests, whether a cache entry for a class item exists.

Tests, whether a cache entry for a class item exists.

Parameters

$class
Cache class of item to test for.
$key
The item key to test for.

Returns

boolean

true, if a cache entry for the requested item exists, otherwise false.

Since

3.0
public string
# get( string $class, string $key )

Reads a cache entry and returns all binary data for the entry.

Reads a cache entry and returns all binary data for the entry.

Parameters

$class
Class of cache item.
$key
The key of the cache item.

Returns

string
Binary data string of cache entry.

Since

3.0

Overrides

Core\Cache::get
public Core\Stream
# getStream( string $class, string $key )

Returns a reading stream instance for the requested cache entry.

Returns a reading stream instance for the requested cache entry.

Parameters

$class
Class of cache item.
$key
The key of the cache item.

Returns

Core\Stream
Reading Stream instance for the requested cache entry.

Since

3.0
public integer
# getTimestamp( string $class, string $key )

Returns a UNIX timestamp of the last cache entry modification.

Returns a UNIX timestamp of the last cache entry modification.

Parameters

$class
Class of cache item.
$key
The key of the cache item.

Returns

integer
UNIX timestamp of last modification to the named cache entry.

Since

3.0
public
# put( string $class, string $key, string $binaryData, integer $ttl = Core\Cache\Driver\null )

Writes binary data to a specified cache entry.

Writes binary data to a specified cache entry.

Parameters

$class
Class of cache item.
$key
The key of the cache item.
$binaryData
Binary data string to write to the cache entry.
$ttl

Time to live for cache entry (in seconds). Set to null if entry does not timeout.

Since

3.0

Overrides

Core\Cache::put
public Core\Stream
# putStream( string $class, string $key, integer $ttl = Core\Cache\Driver\null )

Returns a writing stream instance for the requested cache entry.

Returns a writing stream instance for the requested cache entry.

Parameters

$class
Class of cache item.
$key
The key of the cache item.
$ttl

Time to live for cache entry (in seconds). Set to null if entry does not timeout.

Returns

Core\Stream
Writing Stream instance for the requested cache entry.

Since

3.0
public
# remove( string $class, string $key )

Deletes a cache key entry. If the entry does not exist, no operation is performed.

Deletes a cache key entry. If the entry does not exist, no operation is performed.

Parameters

$class
Class of cache item.
$key
The key of the cache item.

Since

3.1

Methods inherited from Core\Cache

__construct(), activate(), active(), autocreate(), defaultInstance(), getAge(), getHash(), getMeta(), getVar(), putVar(), setVersionID(), unify()

Methods inherited from Core\Set

__get(), __isset()

Methods inherited from Core\Object

__autocreateFactory(), __call(), __processParameters(), __toString(), attachMethod(), chain(), getValueForKey(), getValueForKeyPath(), getValueForUndefinedKey(), hash(), issetValueForKey(), setValueForKey(), setValueForKeyPath(), setValueForUndefinedKey(), uuid()

Constants summary

Constants inherited from Core\Cache

SharedClass

Constants inherited from Core\Object

AnyParameterType, AutochainParameterType, AutocreateParameterType, BooleanParameterType, CharParameterType, EnumParameterType, IntegerParameterType, RealParameterType, StringParameterType, UserParameterType

Properties summary

Properties inherited from Core\Cache

$_activeInstance, $_v_versionID

Magic properties inherited from Core\Cache

$versionID

Magic properties inherited from Core\Object

$hash, $uuid

xplo.re Medusa Core Framework 3.1 API documentation generated by ApiGen