interface RulesEventDispatcherInterface in Rules 7.2

Interface for event dispatchers.

Hierarchy

• interface \RulesEventHandlerInterface
  • interface \RulesEventDispatcherInterface

File

includes/rules.event.inc, line 155

Contains event handler interface and base classes.

interface RulesEventDispatcherInterface extends RulesEventHandlerInterface {

  /**
   * Starts the event watcher.
   */
  public function startWatching();

  /**
   * Stops the event watcher.
   */
  public function stopWatching();

  /**
   * Returns whether the event dispatcher is currently active.
   *
   * @return bool
   *   TRUE if the event dispatcher is currently active, FALSE otherwise.
   */
  public function isWatching();

}

Members

Name	Modifiers	Type	Description	Overrides
RulesEventDispatcherInterface::isWatching	public	function	Returns whether the event dispatcher is currently active.	1
RulesEventDispatcherInterface::startWatching	public	function	Starts the event watcher.	1
RulesEventDispatcherInterface::stopWatching	public	function	Stops the event watcher.	1
RulesEventHandlerInterface::availableVariables	public	function	Returns info about the variables provided by this event.	1
RulesEventHandlerInterface::buildForm	public	function	Builds the event settings form.	2
RulesEventHandlerInterface::extractFormValues	public	function	Extract the form values and update the event settings.	1
RulesEventHandlerInterface::getDefaults	public	function	Returns an array of default settings.	2
RulesEventHandlerInterface::getEventInfo	public	function	Returns the info array of the event the event handler belongs to.	1
RulesEventHandlerInterface::getEventName	public	function	Returns the base name of the event the event handler belongs to.	1
RulesEventHandlerInterface::getEventNameSuffix	public	function	Returns the suffix to be added to the base event named based upon settings.	2
RulesEventHandlerInterface::getSettings	public	function	Gets the event settings.	1
RulesEventHandlerInterface::setSettings	public	function	Sets the event settings.	1
RulesEventHandlerInterface::summary	public	function	Returns a user-facing summary of the settings.	2
RulesEventHandlerInterface::validate	public	function	Validate the event settings independent from a form submission.	1
RulesEventHandlerInterface::__construct	public	function	Constructs the event handler.	1