Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,059 of 9,059 pages
About the help in other languages
All help pages

requestrules.ini [RequestRuleSettings]

The settings of [RequestRuleSettings] in requestrules.ini: Enabled, RuleList, RuleProviders, FactProviders, MaxRewrites, ConditionHandlers, ActionHandlers

Download as PDF

Address: https://doc.exponential.earth/learninminutes/exphelp/viewer/examples/ini-settings/requestrules/RequestRuleSettings.md

On this page

requestrules.ini [RequestRuleSettings]

The block [RequestRuleSettings] of settings/requestrules.ini, with 7 setting(s).

Never edit settings/requestrules.ini itself: an update replaces it. Put the settings you change in an override, which wins over the shipped file:

  • settings/override/requestrules.ini.append.php for every siteaccess,
  • settings/siteaccess/<siteaccess>/requestrules.ini.append.php for one siteaccess,
  • extension/<extension>/settings/requestrules.ini.append.php in an extension (read when the extension is active).

Enabled

true or false. With false no rule is asked; the kernel behaves as before
this feature existed.

Default: true.

<?php /* #?ini charset="utf-8"?
# settings/override/requestrules.ini.append.php
[RequestRuleSettings]
Enabled=true
*/ ?>

RuleList

The rules asked, in order. Empty: no rule (and no cost). A siteaccess
override that starts with RuleList[] (empty) replaces the list.

Default: an empty list.

<?php /* #?ini charset="utf-8"?
# settings/override/requestrules.ini.append.php
[RequestRuleSettings]
# an empty "RuleList[]" first replaces the shipped list; without it the items are added
RuleList[]
*/ ?>

RuleProviders

Rules computed in PHP: classes implementing ezpRequestRuleProvider. Their
rules come after the RuleList rules.

Default: an empty list.

<?php /* #?ini charset="utf-8"?
# settings/override/requestrules.ini.append.php
[RequestRuleSettings]
# an empty "RuleProviders[]" first replaces the shipped list; without it the items are added
RuleProviders[]
*/ ?>

FactProviders

Facts added to every request, for conditions such as Conditions[fact:<name>]:
classes implementing ezpRequestFactProvider.

Default: an empty list.

<?php /* #?ini charset="utf-8"?
# settings/override/requestrules.ini.append.php
[RequestRuleSettings]
# an empty "FactProviders[]" first replaces the shipped list; without it the items are added
FactProviders[]
*/ ?>

MaxRewrites

How many times one request may be rewritten (Action=rewrite) before it is
answered with "not found". Stops a rewrite loop.

Default: 3.

<?php /* #?ini charset="utf-8"?
# settings/override/requestrules.ini.append.php
[RequestRuleSettings]
MaxRewrites=3
*/ ?>

ConditionHandlers

Conditions and actions by name, added to the built-in ones (listed in the
guide). An extension adds its own:
ConditionHandlers[customer_tier]=myCustomerTierCondition
ActionHandlers[paywall]=myPaywallAction

Default: an empty list.

<?php /* #?ini charset="utf-8"?
# settings/override/requestrules.ini.append.php
[RequestRuleSettings]
# an empty "ConditionHandlers[]" first replaces the shipped list; without it the items are added
ConditionHandlers[]
*/ ?>

ActionHandlers

Default: an empty list.

<?php /* #?ini charset="utf-8"?
# settings/override/requestrules.ini.append.php
[RequestRuleSettings]
# an empty "ActionHandlers[]" first replaces the shipped list; without it the items are added
ActionHandlers[]
*/ ?>

Generated by ./console exp:help:examples from settings/requestrules.ini. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x