class Property in ThemeKey 8

Defines a property item annotation object.

Plugin Namespace: Plugin\themekey\property

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\themekey\Annotation\Property

See also

Plugin API

3 string references to 'Property'

ThemeKeyRuleForm::form in src/Form/ThemeKeyRuleForm.php

Gets the actual form array to be built.

ThemeKeyRuleListBuilder::buildHeader in src/Controller/ThemeKeyRuleListBuilder.php

Builds the header row for the entity listing.

themekey_rule.schema.yml in config/schema/themekey_rule.schema.yml

config/schema/themekey_rule.schema.yml

4 classes are annotated with Property

DrupalRouteName in src/Plugin/Property/DrupalRouteName.php

Provides a 'query param' property.

NodeNid in src/Plugin/Property/NodeNid.php

Provides a 'node id' property.

NodeNid in src/Plugin/PropertyAdmin/NodeNid.php

Administers a 'node id' property.

SystemQueryParam in src/Plugin/Property/SystemQueryParam.php

Provides a 'query param' property.

File

src/Annotation/Property.php, line 21

Contains \Drupal\themekey\Annotation\Property.

Namespace

Drupal\themekey\Annotation

class Property extends Plugin {

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

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

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

  /**
   * Indicates if the property is compatible to page caching.
   *
   * @var bool
   */
  public $page_cache_compatible;

}

Members

Name	Modifiers	Type	Description	Overrides
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
Property::$description	public	property	The description of the property.
Property::$id	public	property	The plugin ID.
Property::$name	public	property	The name of the property.
Property::$page_cache_compatible	public	property	Indicates if the property is compatible to page caching.