class RulesPluginHandlerBase

Base class for implementing abstract plugins via classes.

Hierarchy

Expanded class hierarchy of RulesPluginHandlerBase

File

includes/rules.core.inc, line 2124

View source 
abstract class RulesPluginHandlerBase extends FacesExtender implements RulesPluginHandlerInterface {
    
    /**
     * @var RulesAbstractPlugin
     */
    protected $element;
    
    /**
     * Overridden to provide $this->element to make the code more meaningful.
     */
    public function __construct(FacesExtendable $object) {
        $this->object = $object;
        $this->element = $object;
    }
    
    /**
     * Implements RulesPluginImplInterface::access().
     */
    public function access() {
        return TRUE;
    }
    public function validate() {
    }
    public function process() {
    }
    public function info_alter(&$element_info) {
    }
    public function dependencies() {
    }
    public function form_alter(&$form, $form_state, $options) {
    }
    public function assertions() {
    }

}

Members

Title Modifiers Object type Summary Overriden Title
RulesPluginHandlerBase::$element protected property
RulesPluginHandlerBase::access public function Implements RulesPluginImplInterface::access(). Overrides RulesPluginHandlerInterface::access
RulesPluginHandlerBase::assertions public function Returns an array of info assertions for the specified parameters. Overrides RulesPluginHandlerInterface::assertions
RulesPluginHandlerBase::dependencies public function Returns an array of required modules. Overrides RulesPluginHandlerInterface::dependencies
RulesPluginHandlerBase::form_alter public function Alters the generated configuration form of the element. Overrides RulesPluginHandlerInterface::form_alter
RulesPluginHandlerBase::info_alter public function Allows altering of the element's action/condition info. Overrides RulesPluginHandlerInterface::info_alter
RulesPluginHandlerBase::process public function Processes settings independent from a form submission. Overrides RulesPluginHandlerInterface::process
RulesPluginHandlerBase::validate public function Validates $settings independent from a form submission. Overrides RulesPluginHandlerInterface::validate
RulesPluginHandlerBase::__construct public function Overridden to provide $this->element to make the code more meaningful.