• Home
  • Nexcessnet_Turpentine_Model_Observer_Ban

PHP Class Nexcessnet_Turpentine_Model_Observer_Ban

Inheritance: extends Varien_Event_Observer
Show file Open project: nexcess/magento-turpentine

Protected Properties

Property Type Description
$_esiClearFlag boolean Flag to prevent doing the ESI cache clear more than once per request
$_varnishAdmin Nexcessnet_Turpentine_Model_Varnish_Admin Cache the varnish admin object

Public Methods

Method Description
banAllCache ( Varien_Object $eventObject ) : null Do a full cache flush, corresponds to "Flush Magento Cache" and "Flush Cache Storage" buttons in admin > cache management
banCacheType ( Varien_Object $eventObject ) : null Do a flush on the ESI blocks
banCatalogImagesCache ( Varien_Object $eventObject ) : null Flush catalog images cache, corresponds to same button in admin cache management page
banCategoryCache ( Varien_Object $eventObject ) : null Ban a category page, and any subpages on save
banClientEsiCache ( Varien_Object $eventObject ) : null Clear the ESI block cache for a specific client
banCmsPageCache ( Varien_Object $eventObject ) : null Ban a specific CMS page from cache after edit
banCmsPageRevisionCache ( Varien_Object $eventObject ) : null Ban a specific CMS page revision from cache after edit (enterprise edition only) Events: enterprise_cms_revision_save_commit_after
banMediaCache ( Varien_Object $eventObject ) : null Clear the media (CSS/JS) cache, corresponds to the buttons on the cache page in admin
banProductPageCache ( Varien_Object $eventObject ) : null Ban a specific product page from the cache
banProductPageCacheCheckStock ( Varien_Object $eventObject ) : null Ban a product page from the cache if it's stock status changed
banProductReview ( Varien_Object $eventObject ) : boolean Ban a product's reviews page

Protected Methods

Method Description
_checkResult ( array $result ) : boolean Check a result from varnish admin action, log if result has errors
_getVarnishAdmin ( ) : Nexcessnet_Turpentine_Model_Varnish_Admin Get the varnish admin socket

Method Details

_checkResult() protected method

Check a result from varnish admin action, log if result has errors
protected _checkResult ( array $result ) : boolean
$result array stored as $socketName => $result
return boolean

_getVarnishAdmin() protected method

Get the varnish admin socket
protected _getVarnishAdmin ( ) : Nexcessnet_Turpentine_Model_Varnish_Admin
return Nexcessnet_Turpentine_Model_Varnish_Admin

banAllCache() public method

Events: adminhtml_cache_flush_system adminhtml_cache_flush_all
public banAllCache ( Varien_Object $eventObject ) : null
$eventObject Varien_Object
return null

banCacheType() public method

Events: adminhtml_cache_refresh_type
public banCacheType ( Varien_Object $eventObject ) : null
$eventObject Varien_Object
return null

banCatalogImagesCache() public method

Events: clean_catalog_images_cache_after
public banCatalogImagesCache ( Varien_Object $eventObject ) : null
$eventObject Varien_Object
return null

banCategoryCache() public method

Events: catalog_category_save_commit_after
public banCategoryCache ( Varien_Object $eventObject ) : null
$eventObject Varien_Object
return null

banClientEsiCache() public method

Events: the events are applied dynamically according to what events are set for the various blocks' esi policies
public banClientEsiCache ( Varien_Object $eventObject ) : null
$eventObject Varien_Object
return null

banCmsPageCache() public method

Events: cms_page_save_commit_after
public banCmsPageCache ( Varien_Object $eventObject ) : null
$eventObject Varien_Object
return null

banCmsPageRevisionCache() public method

Ban a specific CMS page revision from cache after edit (enterprise edition only) Events: enterprise_cms_revision_save_commit_after
public banCmsPageRevisionCache ( Varien_Object $eventObject ) : null
$eventObject Varien_Object
return null

banMediaCache() public method

Events: clean_media_cache_after
public banMediaCache ( Varien_Object $eventObject ) : null
$eventObject Varien_Object
return null

banProductPageCache() public method

Events: catalog_product_save_commit_after
public banProductPageCache ( Varien_Object $eventObject ) : null
$eventObject Varien_Object
return null

banProductPageCacheCheckStock() public method

Events: cataloginventory_stock_item_save_after
public banProductPageCacheCheckStock ( Varien_Object $eventObject ) : null
$eventObject Varien_Object
return null

banProductReview() public method

Ban a product's reviews page
public banProductReview ( Varien_Object $eventObject ) : boolean
$eventObject Varien_Object
return boolean

Property Details

$_esiClearFlag protected property

Flag to prevent doing the ESI cache clear more than once per request
protected bool $_esiClearFlag
return boolean

$_varnishAdmin protected property

Cache the varnish admin object
protected Nexcessnet_Turpentine_Model_Varnish_Admin $_varnishAdmin
return Nexcessnet_Turpentine_Model_Varnish_Admin