interface RulesTriggerableInterface

Same name in other branches
  1. 8.x-3.x src/Core/RulesTriggerableInterface.php \Drupal\rules\Core\RulesTriggerableInterface

Interface for objects that are triggerable.

Hierarchy

Expanded class hierarchy of RulesTriggerableInterface

All classes that implement RulesTriggerableInterface

File

includes/rules.core.inc, line 1948

View source
interface RulesTriggerableInterface {
    
    /**
     * Returns the array of (configured) event names associated with this object.
     */
    public function events();
    
    /**
     * Removes an event from the rule configuration.
     *
     * @param string $event_name
     *   The name of the (configured) event to remove.
     *
     * @return RulesTriggerableInterface
     *   The object instance itself, to allow chaining.
     */
    public function removeEvent($event_name);
    
    /**
     * Adds the specified event.
     *
     * @param string $event_name
     *   The base name of the event to add.
     * @param array $settings
     *   (optional) The event settings. If there are no event settings, pass an
     *   empty array (default).
     *
     * @return RulesTriggerableInterface
     */
    public function event($event_name, array $settings = array());
    
    /**
     * Gets the event settings associated with the given (configured) event.
     *
     * @param string $event_name
     *   The (configured) event's name.
     *
     * @return array|null
     *   The array of event settings, or NULL if there are no settings.
     */
    public function getEventSettings($event_name);

}

Members

Title Sort descending Modifiers Object type Summary Overrides
RulesTriggerableInterface::event public function Adds the specified event. 1
RulesTriggerableInterface::events public function Returns the array of (configured) event names associated with this object. 1
RulesTriggerableInterface::getEventSettings public function Gets the event settings associated with the given (configured) event. 1
RulesTriggerableInterface::removeEvent public function Removes an event from the rule configuration. 1