abstract class BusinessRulesItem in Business Rules 8

Defines a Business rules item base annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\business_rules\Annotation\BusinessRulesItem

See also

Plugin API

File

src/Annotation/BusinessRulesItem.php, line 14

Namespace

Drupal\business_rules\Annotation

abstract class BusinessRulesItem extends Plugin {

  /**
   * A human readable description of the item.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description;

  /**
   * The group of the item to be organized in the list box.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $group;

  /**
   * If the item has target bundle.
   *
   * @var bool
   */
  public $hasTargetBundle = FALSE;

  /**
   * If the item need a target entity.
   *
   * @var bool
   */
  public $hasTargetEntity = FALSE;

  /**
   * If the condition has target field.
   *
   * If true, you must need to add the field property on item schema file.
   *
   * @var bool
   */
  public $hasTargetField = FALSE;

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * If the item depends on context.
   *
   * @var bool
   */
  public $isContextDependent = FALSE;

  /**
   * The label of the plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $label;

  /**
   * The reactsOn ids applicable for the item.
   *
   * Leave empty if it's applicable for all reactsOn events.
   *
   * @var array
   */
  public $reactsOnIds = [];

}

Members

Name	Modifiers	Type	Description	Overrides
BusinessRulesItem::$description	public	property	A human readable description of the item.
BusinessRulesItem::$group	public	property	The group of the item to be organized in the list box.
BusinessRulesItem::$hasTargetBundle	public	property	If the item has target bundle.
BusinessRulesItem::$hasTargetEntity	public	property	If the item need a target entity.
BusinessRulesItem::$hasTargetField	public	property	If the condition has target field.
BusinessRulesItem::$id	public	property	The plugin ID.
BusinessRulesItem::$isContextDependent	public	property	If the item depends on context.
BusinessRulesItem::$label	public	property	The label of the plugin.
BusinessRulesItem::$reactsOnIds	public	property	The reactsOn ids applicable for the item.
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2