Caution: This documentation is for eZ Publish legacy, from version 3.x to 5.x.
For 5.x documentation covering Platform see eZ Documentation Center, for difference between legacy and Platform see 5.x Architecture overview.

ClearRelationTypes

Summary

Controls whether the view caches for objects related in various ways should be cleared or not.

Usage

 

ClearRelationTypes[]=type1
ClearRelationTypes[]=type2
...

Description

This directive sets which related and reverse related objects the view caches should be cleared for as a response to the view cache being cleared for a specific object. More precisely, it can be used to control whether the view caches for objects that are related in various ways (common, linked, embedded and so on) should be cleared or not. This setting is an array of strings where only eight pre-defined values can be used (refer to the following table).

Type

Description

common

Clear cache for related objects that have relations of the "common" type.

reverse_common

Clear cache for reverse related objects that have relations of the "common" type.

linked

Clear cache for related objects that have relations of the "XML linked" type.

reverse_linked

Clear cache for reverse related objects that have relations of the "XML linked" type.

embedded

Clear cache for related objects that have relations of the "XML embedded" type.

reverse_embedded

Clear cache for reverse related objects that have relations of the "XML embedded" type.

attribute

Clear cache for related objects that have relations at the attribute level.

reverse_attribute

Clear cache for reverse related objects that have relations at the attribute level.

Note that if you need to set up additional/custom rules that control which nodes the view cache should be cleared for when the view cache for a specific object is being cleared, you'll have to use smart viewcache cleaning.

Examples

Example 1

 

[ViewCacheSettings]
ClearRelationTypes[]
SmartCacheClear=disabled


When clearing the view cache for an object, the system will automatically clear the view cache for the following nodes:

  • All published nodes of this object and their parent nodes
  • Nodes of the objects that have the same keyword (if any)

Since the "ClearRelationTypes" configuration array is empty, the view caches for related and reverse related objects will not be cleared.

Example 2

 

[ViewCacheSettings]
ClearRelationTypes[]
ClearRelationTypes[]=common
ClearRelationTypes[]=reverse_common
ClearRelationTypes[]=reverse_embedded
SmartCacheClear=disabled


When clearing the view cache for an object, the system will automatically clear the view cache for the following nodes:

  • All published nodes of this object and their parent nodes
  • Nodes of the objects that have the same keyword (if any)
  • Nodes of related and reverse related objects that have relations of the "common" type
  • Nodes of reverse related objects that have relations of the "XML embedded" type

Note that the first two items on the list are not controlled by the "ClearRelationTypes" setting.

Julia Shymova (16/04/2007 9:36 am)

Svitlana Shatokhina (07/05/2007 11:11 am)

Julia Shymova, Svitlana Shatokhina


Comments

There are no comments.