Class BeObjectCache

BeObjectCache class

Class to read/write object data using Cake Cache

Located at libs/be_object_cache.php

Methods summary

`public`	# `__construct( )` Constructor Initialize cache config Constructor Initialize cache config
`public string`	# `getPathById( integer $id )` Get cached path by object ID. Get cached path by object ID. Parameters `$id` Object ID. Returns string
`private`	# `setCacheOptions( integer $id )` Prepare cached config for an object to be cached. Prepare cached config for an object to be cached. Parameters `$id` Object ID.
`private string`	# `cacheName( integer $id, array $options, string\|null $label = null )` Get cache name for an object. Get cache name for an object. Parameters `$id` Object ID. `$options` Additional caching options. `$label` Additional label. Returns string
`public boolean`	# `hasFileEngine( )` Returns true if cache engine type is 'File' Returns true if cache engine type is 'File' Returns boolean
`public integer`	# `readIdFromNickname( string $nickname )` Read id from nickname using cache Read id from nickname using cache Parameters `$nickname` object nickname Returns integer object id on success, null if $nickname is not found
`public boolean`	# `writeNicknameId( string $nickname, integer $id )` Writes $nickname => $id key-value pair in object cache Writes $nickname => $id key-value pair in object cache Parameters `$nickname` object nickname `$id` object id Returns boolean true on success, false on failure
`public data`	# `read( integer $id, array $options, $label = null )` Read object from cache Read object from cache Parameters `$id` `$options` `$label` Returns data array or false if no cache is found
`private boolean`	# `writeIndexedCache( integer $id, string $cacheName, mixed $data )` Write related indexes to cache Write related indexes to cache Parameters `$id` Object ID. `$cacheName` Cache key. `$data` Cache value to be stored. Returns boolean
`public boolean`	# `write( string $id, array $options, $data, $label = null )` Write object data to cache Write object data to cache Parameters `$id` $key `$options` `$data` `$label` Returns boolean True if the data was successfully cached, false on failure
`public`	# `delete( integer $id, array $options = null )` Delete objects from cache Delete objects from cache Parameters `$id` objectId `$options`
`public array\|null`	# `readPathCache( integer $id, array $statuses = array() )` Read path cache for an object. Read path cache for an object. Parameters `$id` Object ID. `$statuses` Allowed object statuses. Returns array\|null
`public boolean`	# `writePathCache( integer $id, array $path, array $statuses = array() )` Write path cache for an object. Write path cache for an object. Parameters `$id` Object ID. `$path` Object path. `$statuses` Allowed object statuses. Returns boolean
`public boolean`	# `deletePathCache( integer $id, array $descendants )` Delete path cache for an object and all its descendants. Delete path cache for an object and all its descendants. Parameters `$id` Object ID. `$descendants` Array of descendant IDs. Returns boolean

Properties summary

`private string\|null`	`$baseCachePath` Base path for objects cache on filesystem. Base path for objects cache on filesystem.	# `null`
`private array`	`$cacheConfig` Default cache config. Default cache config. It's overriden in constructor if exists a cache conf named 'objects'.	# `array( 'engine' => 'File', 'prefix' => '', 'duration' => '+24 hours' )`