class DsFieldTemplate in Display Suite 8.4

Defines a DsFieldTemplate annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\ds\Annotation\DsFieldTemplate

5 classes are annotated with DsFieldTemplate

DefaultField in src/Plugin/DsFieldTemplate/DefaultField.php

Plugin for the default field template.

Expert in src/Plugin/DsFieldTemplate/Expert.php

Plugin for the expert field template.

Minimal in src/Plugin/DsFieldTemplate/Minimal.php

Plugin for the minimal field template.

Reset in src/Plugin/DsFieldTemplate/Reset.php

Plugin for the reset field template.

TestLayout in tests/modules/ds_test/src/Plugin/DsFieldTemplate/TestLayout.php

Plugin for the expert field template.

File

src/Annotation/DsFieldTemplate.php, line 12

Namespace

Drupal\ds\Annotation

class DsFieldTemplate extends Plugin {

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

  /**
   * The human-readable name of the DS field layout plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $title;

  /**
   * The theme function for this field layout.
   *
   * @var string
   */
  public $theme;

}

Members

Name	Modifiers	Type	Description	Overrides
DsFieldTemplate::$id	public	property	The plugin ID.
DsFieldTemplate::$theme	public	property	The theme function for this field layout.
DsFieldTemplate::$title	public	property	The human-readable name of the DS field layout plugin.
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