Class CacheableBehavior

CacheableBehavior class

Used from BEObject to clean cached data when save or delete object Data are meant to be cached through BeObjectCache class in libs

ModelBehavior

Extended by

CacheableBehavior

Located at models/behaviors/cacheable.php

Methods summary

`public`	# `setup( & $model, $settings = array() )`
`public boolean`	# `isCacheableOn( Model & $model )` Is CacheableBehavior on? Is CacheableBehavior on? Parameters `$model` Returns boolean
`public`	# `resetObjectsToClean( Model & $model )` Reset self::objectsToClean Reset self::objectsToClean Parameters `$model`
`public`	# `setObjectsToClean( Model & $model, integer $objectId, array $excludeIds = array() )` Set an array of object id to clean from cache starting from an object id Set an array of object id to clean from cache starting from an object id Parameters `$model` `$objectId` `$excludeIds` object ids to not clean See CacheableBehavior::getObjectsToCleanById() to see which object ids are set
`public`	# `getObjectsToCleanById( Model & $model, integer $objectId, array $excludeIds = array() )` Return an array of object ids to clean from cache starting from $objectId Return an array of object ids to clean from cache starting from $objectId Objects to clean: - object itself - parents - related objects Parameters `$model` `$objectId` `$excludeIds` object ids to not clean
`public`	# `addObjectsToClean( Model & $model, array\|integer $ids = array() )` Add object ids to delete from cache to self::objectsToClean array Add object ids to delete from cache to self::objectsToClean array Parameters `$model` `$ids` array of ids or single id
`protected array`	# `getDescendantSections( integer $id )` Get a list of IDs of all descendant sections. Get a list of IDs of all descendant sections. Parameters `$id` Object ID. Returns array
`public`	# `clearCache( Model & $model, integer $objectId, boolean $reset = true, $descendants = true )` Clear object cache Clear object cache If objectId is passed start from it to obtain all object ids to delete from cache else use self::objectsToClean array that has to be build previously Parameters `$model` `$objectId` `$reset` `$descendants`
`public`	# `clearCacheByIds( Model & $model, array $objectIds )` Clear cache of an array of objects calculating from $objectIds Clear cache of an array of objects calculating from $objectIds Parameters `$model` `$objectIds` object ids from which calculate the objects to clean See CacheableBehavior::getObjectsToCleanById() to see which how object ids to clean are calculated
`public boolean`	# `beforeSave( Model & $model )` beforeSave callback beforeSave callback Prepare object ids that must to be cleaned from cache Parameters `$model` Returns boolean
`public`	# `afterSave( Model & $model, boolean $created )` afterSave callback afterSave callback If object already exists then delete cached objects listed in self::objectsToClean Parameters `$model` `$created`
`public boolean`	# `beforeDelete( Model & $model, boolean $cascade )` beforeDelete callback beforeDelete callback Prepare object ids that must to be cleaned from cache Parameters `$model` `$cascade` Returns boolean
`public`	# `afterDelete( Model & $model )` afterDelete callback afterDelete callback Delete cached objects listed in self::objectsToClean Parameters `$model`

Properties summary

`private boolean`	`$on` If the behavior is active or not If the behavior is active or not	# `false`
`private BeObjectCache`	`$BeObjectCache` If object cache is activate by objectCakeCache config param contain instance of BeObjectCache class in libs If object cache is activate by objectCakeCache config param contain instance of BeObjectCache class in libs	# `null`
`private array`	`$objectsToClean`	# `array()`