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
`private string`	# `cachePrefix( integer $id )` Get prefix for all cache keys relative to an object. Get prefix for all cache keys relative to an object. Parameters `$id` Object ID. Returns string
`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
`private string`	# `cacheNickname( string $nickname )` Get cache name for a nickname. Get cache name for a nickname. Parameters `$nickname` Nickname. 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 boolean`	# `deleteNicknameCache( string $nickname )` Deletes cache for a nickname. Deletes cache for a nickname. Parameters `$nickname` Nickname. Returns boolean
`public boolean`	# `isCacheable( integer $id, array $options )` Return true if the object `$id` with `$options` is cacheable. Return true if the object `$id` with `$options` is cacheable. Parameters `$id` The object id `$options` The options used for build the cache Returns boolean
`public array\|false`	# `read( integer $id, array $options, $label = null )` Read object from cache. Read object from cache. It returns the data cached or false if the object is not cacheable or the cache was not found Parameters `$id` `$options` `$label` Returns array\|false
`public boolean`	# `write( string $id, array $options, $data, $label = null )` Write object data to cache. Write object data to cache. It returns true if data was successfully cached or false if the data was not cacheable or the write fails Parameters `$id` $key `$options` `$data` `$label` Returns boolean
`public`	# `delete( integer $id )` Delete objects from cache Delete objects from cache Parameters `$id` objectId
`public array\|null`	# `readPathCache( integer $id, array $statuses = array(), integer $publicationId = null )` Read path cache for an object. Read path cache for an object. Parameters `$id` Object ID. `$statuses` Allowed object statuses. `$publicationId` The publication id Returns array\|null
`public boolean`	# `writePathCache( integer $id, array $path, array $statuses = array(), integer $publicationId = null )` Write path cache for an object. Write path cache for an object. Parameters `$id` Object ID. `$path` Object path. `$statuses` Allowed object statuses. `$publicationId` The publication id 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' )`
`private array`	`$blacklistOptions` Blacklist option items on which avoid to create cache. Blacklist option items on which avoid to create cache.	# `array('user_created', 'user_modified')`