class DsField in Display Suite 8.2

Defines a DsField annotation object.

Hierarchy

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

36 classes are annotated with DsField

BlockDescription in src/Plugin/DsField/Block/BlockDescription.php

Plugin that renders the title of a block.

BookNavigation in src/Plugin/DsField/Book/BookNavigation.php

Plugin that the book navigation.

BundleField in src/Plugin/DsField/BundleField.php

Defines a generic bundle field.

CommentAuthor in src/Plugin/DsField/Comment/CommentAuthor.php

Plugin that renders the author of a comment.

CommentChangedDate in src/Plugin/DsField/Comment/CommentChangedDate.php

Plugin that renders the changed date of a comment.

... See full list

File

src/Annotation/DsField.php, line 12

Namespace

Drupal\ds\Annotation

class DsField extends Plugin {

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

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

  /**
   * The entity type this plugin should work on.
   *
   * @var string
   */
  public $entity_type;

  /**
   * An array of limits for showing this field.
   *
   * In the format: "bundle|view_mode".
   *
   * @var array
   */
  public $ui_limit;

}

Members

Name	Modifiers	Type	Description	Overrides
DsField::$entity_type	public	property	The entity type this plugin should work on.
DsField::$id	public	property	The plugin ID.
DsField::$title	public	property	The human-readable name of the DS plugin.
DsField::$ui_limit	public	property	An array of limits for showing this field.
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