• 홈
• Cachearium
• CacheAbstract

PHP 클래스 Cachearium\CacheAbstract

파일 보기 프로젝트 열기: corollarium/cachearium 1 사용 예제들

공개 프로퍼티들

프로퍼티	타입	설명
$debugLogFile		Controls debug to a file
$debugOnPage	boolean	Controls debug on html page for all Cache backends.

보호된 프로퍼티들

프로퍼티	타입	설명
$cache_log	array	Stores cache log for debugging.
$enabled	boolean	Is this cache enabled?
$lifetime
$namespace	string	Initialize it to a unique string. If you are not running multiple instances, ignore.
$should_log	boolean	Is log enabled? Log can take a lot of RAM, so only turn this on when profiling.
$summary	array	Array for basic cache profiling. Keys are CacheLogEnum, values are counters.

공개 메소드들

메소드	설명
appendCallback ( callable $callback ) : boolean	Appends a callback to the current start()/end() cache
clean ( CacheKey $k ) : boolean	Cleans cache: all entries with a certain $base and $id in the $key are deleted.
cleanP ( $base, $id ) : boolean	Cleans cache: all entries with a certain $base and $id
clear ( )	Clears entire cache. Use sparingly.
clearAll ( )	Clears all cache classes.
cssDebug ( )	Renders CSS for live view debugging of cached data.
delete ( CacheKey $k ) : boolean	Deletes an entry from the cache
deleteP ( string $base, string $id, mixed $sub = null )
disable ( ) : CacheAbstract	Disable this cache
dumpSummary ( )	Dumps a short HTML summary of the cache hits/misses
enable ( ) : CacheAbstract	Enable this cache
end ( $print = true )	Ends the cache start().
factory ( string $backend ) : CacheAbstract	Returns a cache
footerDebug ( )	Extensive footer debug code. Shows which parts of the HTML were cached or missed visually. Great!
get ( CacheKey $k ) : mixed	Get cached entry.
getData ( CacheKey $k ) : CacheData	Same as get, but assumes data was stored with a CacheData object and will treat it accordingly.
getDataP ( string $base, string $id, mixed $sub = null )	Same as getData(), but expanded parameters.
getDefaultLifetime ( )
getLogSummary ( ) : array()	Returns basic cache statistics. See $summary.
getMulti ( array $cacheid, callable $callback = null ) : array:mixed	Gets data from multiple cache keys at once
getNamespace ( ) : string
getP ( string $base, string $id, mixed $sub = null ) : mixed	Same as get(), but expanded parameters.
increment ( integer $value, CacheKey $k, integer $default ) : integer	Increment a variable. Backend deals with this, but in general this is atomic.
invalidate ( CacheKey $k )	Invalidates a dependency index. If the index does not exist it is created.
isEnabled ( ) : True
logHigh ( $message )	High level log for testing and debugging
newEnd ( $print = true )
newstart ( CacheKey $k, $lifetime = null, $fail = false )
prefetch ( array $data )	Prefetches data which will be used. This avoids multiple trips to the cache server if they can be avoided.
recursiveEnd ( boolean $print = true ) : string
recursiveStart ( CacheKey $k, integer $lifetime = null, boolean $print = true, boolean $fail = false ) : string
recursiveStartP ( $base, $id, $sub = null, $lifetime = null, $print = true, $fail = false )
report ( )	Generates a report for this backend
resetLogSummary ( )
setDefaultLifetime ( number $lifetime )
setEnabled ( $b ) : CacheAbstract	Enable this cache
setLog ( boolean $b ) : CacheAbstract
setNamespace ( string $name )
start ( CacheKey $k, string $lifetime = null, boolean $print = true, boolean $fail = false ) : boolean | string	Starts a cache if it doesn't exist, or outputs the data and returns true.
startCallback ( CacheKey $k, callable $c, array $cparams = [], integer $lifetime = null )	start() using a callable. Same as start()/c()/end().
startP ( $base, $id, $sub = null, $lifetime = null, $print = true, $fail = false )
store ( mixed $data, CacheKey $k, integer $lifetime ) : boolean	Saves data in cache.
storeData ( CacheData $data, number $lifetime ) : boolean	Same as store() but expanded parameters
storeP ( mixed $data, string $base, string $id, string $sub = null, number $lifetime ) : boolean	Same as store() but expanded parameters

보호된 메소드들

메소드	설명
hashKey ( CacheKey $k )	Returns a key given parameters. This is up to storage and different values may be returned for the same parameters, as storages are likely to use key-based cache expiration.
keyFromDeps ( CacheKey $k, $deps )
log ( string $status, CacheKey $k, integer $lifetime )	Logs cache accesses for debugging
printProbeEnd ( string $key, CacheData $cachedata )	Prints HTML for cache debug probes -> closes tag
printProbeStart ( string $key, CacheData $cachedata, string $type )	Prints HTML for cache debug probes -> opens tag

비공개 메소드들

메소드	설명
extraSub ( unknown &$sub )	Get extra sub

메소드 상세

프로퍼티 상세