Property | Type | Description | |
---|---|---|---|
$_params | array | Configuration parameters. | |
$_rules | array | Rules list. |
Method | Description | |
---|---|---|
__construct ( array $params = [] ) | Constructor. | |
__get ( $name ) | ||
addRule ( Ingo_Rule $rule ) | Adds a rule to the filters list. | |
clearCache ( ) | Clears the internal rule cache. | |
copyRule ( Ingo_Rule $rule ) : boolean | Creates a copy of an existing rule. | |
count ( ) | ||
deleteRule ( Ingo_Rule $rule ) : boolean | Deletes an existing rule. | |
getIterator ( ) | ||
getRuleByUid ( string $uid ) : Ingo_Rule | Returns a rule given a UID. | |
getSystemRule ( string $rule ) : Ingo_Rule | Retrieves the specified system rule. | |
maxRules ( ) : integer | Has the maximum number of rules been reached? | |
removeUserData ( string $user ) | Removes the user data from the storage backend. | |
sort ( array $rules ) | Sorts the list of rules in the given order. | |
updateRule ( Ingo_Rule $rule ) | Updates an existing rule. |
Method | Description | |
---|---|---|
_getRule ( Ingo_Rule $rule ) : integer | Retrieves a rule. | |
_load ( ) | Load the rules. | |
_loadFromBackend ( ) | Load the rules from the storage backend. | |
_removeUserData ( string $user ) | Removes the user data from the storage backend. | |
_store ( integer $action, Ingo_Rule $rule = null ) | Store a rule. | |
_storeBackend ( $action, $rule ) | Store a rule in the backend. |
abstract protected _loadFromBackend ( ) |
abstract protected _removeUserData ( string $user ) | ||
$user | string | The user name to delete filters for. |
abstract protected _storeBackend ( $action, $rule ) |
public addRule ( Ingo_Rule $rule ) | ||
$rule | Ingo_Rule | A rule object. |
public deleteRule ( Ingo_Rule $rule ) : boolean | ||
$rule | Ingo_Rule | A rule object. |
return | boolean | True if the rule has been found and deleted. |
public getRuleByUid ( string $uid ) : Ingo_Rule | ||
$uid | string | Rule UID. |
return | Ingo_Rule | The rule object (null if not found). |
public getSystemRule ( string $rule ) : Ingo_Rule | ||
$rule | string | The rule name. |
return | Ingo_Rule | A rule object. |
public removeUserData ( string $user ) | ||
$user | string | The user name to delete filters for. |
public updateRule ( Ingo_Rule $rule ) | ||
$rule | Ingo_Rule | A rule object. |