abstract class RulesConditionContainer in Rules 7.2
Base class for all condition containers.
Hierarchy
- class \RulesExtendable extends \FacesExtendable
- class \RulesPlugin
- class \RulesContainerPlugin implements \IteratorAggregate
- class \RulesConditionContainer implements RulesConditionInterface
- class \RulesContainerPlugin implements \IteratorAggregate
- class \RulesPlugin
Expanded class hierarchy of RulesConditionContainer
2 string references to 'RulesConditionContainer'
- hook_rules_plugin_info in ./
rules.api.php - Defines rules plugins.
- rules_rules_plugin_info in ./
rules.module - Implements hook_rules_plugin_info().
File
- includes/
rules.core.inc, line 2580 - Rules base classes and interfaces needed for any rule evaluation.
View source
abstract class RulesConditionContainer extends RulesContainerPlugin implements RulesConditionInterface {
protected $negate = FALSE;
/**
* Adds a condition to the container.
*
* Pass in either an instance of the RulesConditionInterface or the arguments
* as needed by rules_condition().
*
* @return $this
*/
public function condition($name, $settings = array()) {
$condition = is_object($name) && $name instanceof RulesConditionInterface ? $name : rules_condition($name, $settings);
$condition
->setParent($this);
return $this;
}
/**
* Negate this condition.
*
* @return RulesConditionContainer
*/
public function negate($negate = TRUE) {
$this->negate = (bool) $negate;
return $this;
}
public function isNegated() {
return $this->negate;
}
public function __sleep() {
return parent::__sleep() + array(
'negate' => 'negate',
);
}
/**
* Just return the condition container's result.
*/
protected function returnVariables(RulesState $state, $result = NULL) {
return $result;
}
protected function exportChildren($key = NULL) {
$key = isset($key) ? $key : strtoupper($this
->plugin());
return parent::exportChildren($this->negate ? 'NOT ' . $key : $key);
}
protected function importChildren($export, $key = NULL) {
$key = isset($key) ? $key : strtoupper($this
->plugin());
// Care for negated elements.
if (!isset($export[$key]) && isset($export['NOT ' . $key])) {
$this->negate = TRUE;
$key = 'NOT ' . $key;
}
parent::importChildren($export, $key);
}
/**
* Overridden to exclude variable assertions of negated conditions.
*/
protected function stateVariables($element = NULL) {
$vars = $this
->availableVariables();
if (isset($element)) {
// Add in variables provided by siblings executed before the element.
foreach ($this->children as $child) {
if ($child === $element) {
break;
}
$vars += $child
->providesVariables();
// Take variable info assertions into account.
if (!$this->negate && !$child
->isNegated() && ($assertions = $child
->variableInfoAssertions())) {
$vars = RulesData::addMetadataAssertions($vars, $assertions);
}
}
}
return $vars;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
RulesConditionContainer:: |
protected | property | ||
RulesConditionContainer:: |
public | function | Adds a condition to the container. | |
RulesConditionContainer:: |
protected | function |
Overrides RulesContainerPlugin:: |
|
RulesConditionContainer:: |
protected | function |
Overrides RulesContainerPlugin:: |
|
RulesConditionContainer:: |
public | function |
Returns whether the element is configured to negate the result. Overrides RulesConditionInterface:: |
|
RulesConditionContainer:: |
public | function |
Negate this condition. Overrides RulesConditionInterface:: |
|
RulesConditionContainer:: |
protected | function |
Just return the condition container's result. Overrides RulesPlugin:: |
|
RulesConditionContainer:: |
protected | function |
Overridden to exclude variable assertions of negated conditions. Overrides RulesContainerPlugin:: |
1 |
RulesConditionContainer:: |
public | function |
Overrides RulesContainerPlugin:: |
|
RulesContainerPlugin:: |
protected | property | ||
RulesContainerPlugin:: |
public | function |
Whether the currently logged in user has access to all configured elements. Overrides RulesPlugin:: |
1 |
RulesContainerPlugin:: |
public | function |
Returns info about variables available to be used as arguments for this element. Overrides RulesPlugin:: |
|
RulesContainerPlugin:: |
public | function | Returns the specified variables, in case the plugin is used as component. | |
RulesContainerPlugin:: |
public | function |
Overrides delete to keep the children alive, if possible. Overrides RulesPlugin:: |
1 |
RulesContainerPlugin:: |
public | function |
Calculates an array of required modules. Overrides RulesPlugin:: |
1 |
RulesContainerPlugin:: |
public | function |
Removes circular object references so PHP garbage collector can work. Overrides RulesPlugin:: |
1 |
RulesContainerPlugin:: |
public | function |
Executes container with the given arguments. Overrides RulesPlugin:: |
1 |
RulesContainerPlugin:: |
protected | function | Determines whether the element should be exported in flat style. | 1 |
RulesContainerPlugin:: |
protected | function |
Overrides RulesPlugin:: |
1 |
RulesContainerPlugin:: |
public | function | Allows access to the children through the iterator. | 1 |
RulesContainerPlugin:: |
public | function |
Applies the given export. Overrides RulesPlugin:: |
1 |
RulesContainerPlugin:: |
public | function |
Overrides RulesPlugin:: |
2 |
RulesContainerPlugin:: |
public | function |
Overrides optimize(). Overrides RulesPlugin:: |
|
RulesContainerPlugin:: |
public | function |
Returns info about parameters needed for executing the configured plugin. Overrides RulesPlugin:: |
|
RulesContainerPlugin:: |
public | function |
Resets any internal static caches. Overrides RulesPlugin:: |
1 |
RulesContainerPlugin:: |
protected | function |
Returns info about all variables that have to be setup in the state. Overrides RulesPlugin:: |
|
RulesContainerPlugin:: |
public | function | Sorts all child elements by their weight. | 1 |
RulesContainerPlugin:: |
protected | function |
Returns asserted additions to the available variable info. Overrides RulesPlugin:: |
1 |
RulesContainerPlugin:: |
public | function |
By default we do a deep clone. Overrides RulesPlugin:: |
1 |
RulesContainerPlugin:: |
public | function |
Overrides RulesExtendable:: |
1 |
RulesExtendable:: |
protected | property | ||
RulesExtendable:: |
protected | property | The name of the item this class represents in the info hook. | 9 |
RulesExtendable:: |
public | function | ||
RulesExtendable:: |
public | function | Forces the object to be setUp, this executes setUp() if not done yet. | 1 |
RulesExtendable:: |
public static | function | Returns whether the a RuleExtendable supports the given interface. | |
RulesExtendable:: |
public | function | Allows items to add something to the rules cache. | 1 |
RulesExtendable:: |
protected | function | 1 | |
RulesExtendable:: |
public | function | Magic method: Invoke the dynamically implemented methods. | |
RulesPlugin:: |
protected | property | Static cache for availableVariables(). | 1 |
RulesPlugin:: |
protected | property |
Overrides RulesExtendable:: |
|
RulesPlugin:: |
protected | property | Identifies an element inside a configuration. | |
RulesPlugin:: |
protected | property |
Overrides RulesExtendable:: |
|
RulesPlugin:: |
public | property | If this is a configuration saved to the db, the id of it. | |
RulesPlugin:: |
protected | property | Info about this element. Usage depends on the plugin. | 2 |
RulesPlugin:: |
public | property | ||
RulesPlugin:: |
protected | property | The parent element, if any. | |
RulesPlugin:: |
public | property | An array of settings for this element. | |
RulesPlugin:: |
public | property | ||
RulesPlugin:: |
public | function | Applies the given data selector. | |
RulesPlugin:: |
protected | function | Checks whether parameters are correctly configured. | |
RulesPlugin:: |
protected | function | ||
RulesPlugin:: |
protected static | function | ||
RulesPlugin:: |
public | function | Returns the depth of this element in the configuration. | |
RulesPlugin:: |
public | function | Returns the element id, which identifies the element inside the config. | |
RulesPlugin:: |
public | function | Gets the element map helper object, which helps mapping elements to ids. | |
RulesPlugin:: |
public | function | Iterate over all elements nested below the current element. | |
RulesPlugin:: |
protected | function | Ensure the configuration has a name. If not, generate one. | |
RulesPlugin:: |
public | function | ||
RulesPlugin:: |
public | function | ||
RulesPlugin:: |
abstract public | function | Evaluate the element on a given rules evaluation state. | 5 |
RulesPlugin:: |
public | function | Execute the configuration. | |
RulesPlugin:: |
public | function | Exports a rule configuration. | |
RulesPlugin:: |
protected | function | ||
RulesPlugin:: |
protected | function | 1 | |
RulesPlugin:: |
public | function | Seamlessly invokes the method implemented via faces. | |
RulesPlugin:: |
public | function | ||
RulesPlugin:: |
public | function | ||
RulesPlugin:: |
protected | function | Returns the argument for the parameter $name described with $info. | |
RulesPlugin:: |
public | function | Returns info about the configured argument. | |
RulesPlugin:: |
protected | function | Gets the right arguments for executing the element. | |
RulesPlugin:: |
public | function | Gets the name of this plugin instance. | 1 |
RulesPlugin:: |
public | function | Checks if the configuration has a certain exportable status. | |
RulesPlugin:: |
public | function | Returns the config name. | |
RulesPlugin:: |
protected | function | ||
RulesPlugin:: |
protected | function | 1 | |
RulesPlugin:: |
public | function | Returns the info of the plugin. | 2 |
RulesPlugin:: |
public | function | ||
RulesPlugin:: |
public | function | Returns whether the element is the root of the configuration. | |
RulesPlugin:: |
public | function | Returns the label of the element. | 4 |
RulesPlugin:: |
public | function | Returns the element's parent. | |
RulesPlugin:: |
public | function | Returns the name of the element's plugin. | |
RulesPlugin:: |
public | function | Returns info about the element's plugin. | |
RulesPlugin:: |
public | function | Returns info about parameters needed by the plugin. | 2 |
RulesPlugin:: |
public | function | Returns info about variables 'provided' by the plugin. | 2 |
RulesPlugin:: |
public | function | Processes the settings e.g. to prepare input evaluators. | 1 |
RulesPlugin:: |
public | function | Returns info about all variables provided for later evaluated elements. | 2 |
RulesPlugin:: |
protected | function | Finalizes the configuration export. | |
RulesPlugin:: |
public | function | Gets the root element of the configuration. | |
RulesPlugin:: |
public | function | Saves the configuration to the database. | 1 |
RulesPlugin:: |
public | function | Sets a new parent element. | |
RulesPlugin:: |
public | function | Sets up the execution state for the given arguments. | |
RulesPlugin:: |
public | function | When converted to a string, just use the export format. |