Rules

Summary

Sets which modules and views to enable or disable.

Usage

 
Rules[]=function1;parameter1
Rules[]=function2;parameter2

Description

The "Rules" setting defines a ruleset that eZ Publish uses to determine wether module and views should be available or not. Each line of the ruleset is read and evaluated. The order in which you enable/disable modules does not matter, but more specific rules will override global rules.

The available functions are:

access

The access function is used to change if subsequent module or moduleall rules should be enabled or disabled. The access function has two possible parameter options

enable - enable subsequently mentioned modules and views
disable - disables subsequently mentioned modules and views

module

The module function is used to specify complete modules or specific views.
The module or view will get the access level of the last access level set. To specify a module simply provide the module name as the parameter value:

Rules[]=module;name_of_module

If you specify a module, the access mode is set for all views in that module.

To specify a single view you need to specify both the name of the module and the view as the parameter value:

Rules[]=module;name_of_module/name_of_view

moduleall

Moduleall is a special mode that should be used on a line on itself without a trailing function definition. It is used to set the current access mode to all modules in the system.

Examples

Example 1

Rules[]=access;enable
Rules[]=moduleall

This configuration enables all modules and views. This is equal to the default ruleset.

Example 2

Rules[]=access;enable
Rules[]=moduleall
Rules[]=access;disable
Rules[]=module;ezinfo
Rules[]=module;content/search

This configuration enables all modules and views except all views in the ezinfo module and the view content/search.

Example 3

Rules[]=access;disable
Rules[]=moduleall
Rules[]=access;enable
Rules[]=module;content/view

This configuration takes a different approach. It disables all modules by default and enables only the modules that you want to use. In this case only the content/view module is available.