class RulesConditionalTestStubElement in Conditional Rules 7

Test element.

Hierarchy

• class \RulesExtendable extends \FacesExtendable
  • class \RulesPlugin
    • class \RulesContainerPlugin implements \IteratorAggregate
      • class \RulesActionContainer implements RulesActionInterface
        • class \RulesConditionalElement implements RulesActionInterface
          • class \RulesConditionalTestStubElement

1 string reference to 'RulesConditionalTestStubElement'

rules_conditional_test_rules_plugin_info in tests/rules_conditional_test.module

Implements hook_rules_plugin_info().

File

tests/rules_conditional_test.inc, line 54

Testing implementations.

class RulesConditionalTestStubElement extends RulesConditionalElement {
  protected $itemName = 'stub conditional element';
  protected $pass;
  public function __construct($pass = TRUE) {
    parent::__construct();
    $this
      ->setPass($pass);
  }

  /**
   * Sets whether the element should pass.
   */
  public function setPass($pass) {
    $this->pass = $pass;
  }

  /**
   * Determines whether this branch can be evaluated.
   */
  public function canEvaluate(RulesState $state) {
    return $this->pass;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
RulesActionContainer::action	public	function	Adds an action to the container.
RulesActionContainer::componentProvidesVariables	public	function	Returns an array of provided variable names.
RulesActionContainer::evaluate	public	function	Evaluate, whereas by default new vars are visible in the parent's scope. Overrides RulesPlugin::evaluate	2
RulesActionContainer::exportToArray	protected	function	Overrides RulesContainerPlugin::exportToArray	1
RulesActionContainer::import	public	function	Applies the given export. Overrides RulesContainerPlugin::import	1
RulesActionContainer::pluginProvidesVariables	public	function	Returns info about variables 'provided' by the plugin. Overrides RulesPlugin::pluginProvidesVariables
RulesConditionalElement::$parent	protected	property	The parent conditional. Overrides RulesPlugin::$parent
RulesConditionalElement::checkSiblings	protected	function	Checks basic conditional element integrity.
RulesConditionalElement::delete	public	function	Deletes the element and its children. Overrides RulesContainerPlugin::delete	1
RulesConditionalElement::dependencies	public	function	Calculates an array of required modules. Overrides RulesContainerPlugin::dependencies	1
RulesConditionalElement::exportChildren	protected	function	Overrides RulesContainerPlugin::exportChildren	3
RulesConditionalElement::exportSettings	protected	function	Overrides RulesPlugin::exportSettings
RulesConditionalElement::getAllSibling	public	function	Gets sibling elements.
RulesConditionalElement::getNextSibling	public	function	Gets the next sibling element.
RulesConditionalElement::getPreviousSibling	public	function	Gets the previous sibling element.
RulesConditionalElement::importChildren	protected	function	Overrides RulesContainerPlugin::importChildren	3
RulesConditionalElement::integrityCheck	public	function	Makes sure the plugin is configured right. Overrides RulesContainerPlugin::integrityCheck	1
RulesConditionalElement::isDefault	public	function	Determines whether this branch is default, i.e. covers the remainder of conditions outside of all non-default branches inside the conditional.	3
RulesConditionalElement::label	public	function	Returns the label of the element. Overrides RulesPlugin::label	1
RulesConditionalElement::providesVariables	public	function	Returns info about all variables provided for later evaluated elements. Overrides RulesActionContainer::providesVariables	1
RulesConditionalElement::setParent	public	function	@todo Remove once http://drupal.org/node/1671344 is resolved. Overrides RulesPlugin::setParent
RulesConditionalTestStubElement::$itemName	protected	property	The name of the item this class represents in the info hook. Overrides RulesExtendable::$itemName
RulesConditionalTestStubElement::$pass	protected	property
RulesConditionalTestStubElement::canEvaluate	public	function	Determines whether this branch can be evaluated. Overrides RulesConditionalElement::canEvaluate
RulesConditionalTestStubElement::setPass	public	function	Sets whether the element should pass.
RulesConditionalTestStubElement::__construct	public	function	Overrides RulesActionContainer::__construct
RulesContainerPlugin::$children	protected	property
RulesContainerPlugin::access	public	function	Whether the currently logged in user has access to all configured elements. Overrides RulesPlugin::access	1
RulesContainerPlugin::availableVariables	public	function	Returns info about variables available to be used as arguments for this element. Overrides RulesPlugin::availableVariables
RulesContainerPlugin::componentVariables	public	function	Returns the specified variables, in case the plugin is used as component.
RulesContainerPlugin::destroy	public	function	Removes circular object references so PHP garbage collector can work. Overrides RulesPlugin::destroy	1
RulesContainerPlugin::executeByArgs	public	function	Executes container with the given arguments. Overrides RulesPlugin::executeByArgs	1
RulesContainerPlugin::exportFlat	protected	function	Determines whether the element should be exported in flat style.	1
RulesContainerPlugin::getIterator	public	function	Allows access to the children through the iterator.	1
RulesContainerPlugin::optimize	public	function	Overrides optimize(). Overrides RulesPlugin::optimize
RulesContainerPlugin::parameterInfo	public	function	Returns info about parameters needed for executing the configured plugin. Overrides RulesPlugin::parameterInfo
RulesContainerPlugin::resetInternalCache	public	function	Resets any internal static caches. Overrides RulesPlugin::resetInternalCache	1
RulesContainerPlugin::setUpVariables	protected	function	Returns info about all variables that have to be setup in the state. Overrides RulesPlugin::setUpVariables
RulesContainerPlugin::sortChildren	public	function	Sorts all child elements by their weight.	1
RulesContainerPlugin::stateVariables	protected	function	Returns available state variables for an element.	4
RulesContainerPlugin::variableInfoAssertions	protected	function	Returns asserted additions to the available variable info. Overrides RulesPlugin::variableInfoAssertions	1
RulesContainerPlugin::__clone	public	function	By default we do a deep clone. Overrides RulesPlugin::__clone	1
RulesContainerPlugin::__sleep	public	function	Overrides RulesPlugin::__sleep	2
RulesExtendable::$itemInfo	protected	property
RulesExtendable::facesAs	public	function
RulesExtendable::forceSetUp	public	function	Forces the object to be setUp, this executes setUp() if not done yet.	1
RulesExtendable::itemFacesAs	public static	function	Returns whether the a RuleExtendable supports the given interface.
RulesExtendable::rebuildCache	public	function	Allows items to add something to the rules cache.	1
RulesExtendable::setUp	protected	function		1
RulesExtendable::__call	public	function	Magic method: Invoke the dynamically implemented methods.
RulesPlugin::$availableVariables	protected	property	Static cache for availableVariables().	1
RulesPlugin::$cache	protected	property	Overrides RulesExtendable::$cache
RulesPlugin::$elementId	protected	property	Identifies an element inside a configuration.
RulesPlugin::$hook	protected	property	Overrides RulesExtendable::$hook
RulesPlugin::$id	public	property	If this is a configuration saved to the db, the id of it.
RulesPlugin::$info	protected	property	Info about this element. Usage depends on the plugin.	2
RulesPlugin::$name	public	property
RulesPlugin::$settings	public	property	An array of settings for this element.
RulesPlugin::$weight	public	property
RulesPlugin::applyDataSelector	public	function	Applies the given data selector.
RulesPlugin::checkParameterSettings	protected	function	Checks whether parameters are correctly configured.
RulesPlugin::checkVarName	protected	function
RulesPlugin::compare	protected static	function
RulesPlugin::depth	public	function	Returns the depth of this element in the configuration.
RulesPlugin::elementId	public	function	Returns the element id, which identifies the element inside the config.
RulesPlugin::elementMap	public	function	Gets the element map helper object, which helps mapping elements to ids.
RulesPlugin::elements	public	function	Iterate over all elements nested below the current element.
RulesPlugin::ensureNameExists	protected	function	Ensure the configuration has a name. If not, generate one.
RulesPlugin::entityInfo	public	function
RulesPlugin::entityType	public	function
RulesPlugin::execute	public	function	Execute the configuration.
RulesPlugin::export	public	function	Exports a rule configuration.
RulesPlugin::exportParameterSetting	protected	function
RulesPlugin::form	public	function	Seamlessly invokes the method implemented via faces.
RulesPlugin::form_submit	public	function
RulesPlugin::form_validate	public	function
RulesPlugin::getArgument	protected	function	Returns the argument for the parameter $name described with $info.
RulesPlugin::getArgumentInfo	public	function	Returns info about the configured argument.
RulesPlugin::getExecutionArguments	protected	function	Gets the right arguments for executing the element.
RulesPlugin::getPluginName	public	function	Gets the name of this plugin instance.	1
RulesPlugin::hasStatus	public	function	Checks if the configuration has a certain exportable status.
RulesPlugin::identifier	public	function	Returns the config name.
RulesPlugin::importParameterSetting	protected	function
RulesPlugin::importSettings	protected	function		1
RulesPlugin::info	public	function	Returns the info of the plugin.	2
RulesPlugin::internalIdentifier	public	function
RulesPlugin::isRoot	public	function	Returns whether the element is the root of the configuration.
RulesPlugin::parentElement	public	function	Returns the element's parent.
RulesPlugin::plugin	public	function	Returns the name of the element's plugin.
RulesPlugin::pluginInfo	public	function	Returns info about the element's plugin.
RulesPlugin::pluginParameterInfo	public	function	Returns info about parameters needed by the plugin.	2
RulesPlugin::processSettings	public	function	Processes the settings e.g. to prepare input evaluators.	1
RulesPlugin::returnExport	protected	function	Finalizes the configuration export.
RulesPlugin::returnVariables	protected	function	Gets variables to return once the configuration has been executed.	2
RulesPlugin::root	public	function	Gets the root element of the configuration.
RulesPlugin::save	public	function	Saves the configuration to the database.	1
RulesPlugin::setUpState	public	function	Sets up the execution state for the given arguments.
RulesPlugin::__toString	public	function	When converted to a string, just use the export format.