class FieldDiffBuilder in Diff 8

Defines a FieldDiffBuilder annotation object.

Diff builders handle how fields are compared by the diff module.

Additional annotation keys for diff builders can be defined in hook_field_diff_builder_info_alter().

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\diff\Annotation\FieldDiffBuilder

See also

\Drupal\diff\FieldDiffBuilderPluginManager

\Drupal\diff\FieldDiffBuilderInterface

11 classes are annotated with FieldDiffBuilder

CommentFieldBuilder in src/Plugin/diff/Field/CommentFieldBuilder.php

Plugin to diff comment fields.

CoreFieldBuilder in src/Plugin/diff/Field/CoreFieldBuilder.php

Plugin to diff core field types.

EntityReferenceFieldBuilder in src/Plugin/diff/Field/EntityReferenceFieldBuilder.php

Plugin to diff entity reference fields.

FileFieldBuilder in src/Plugin/diff/Field/FileFieldBuilder.php

Plugin to diff file fields.

ImageFieldBuilder in src/Plugin/diff/Field/ImageFieldBuilder.php

Plugin to diff image fields.

... See full list

File

src/Annotation/FieldDiffBuilder.php, line 20

Namespace

Drupal\diff\Annotation

class FieldDiffBuilder extends Plugin {

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

  /**
   * The human-readable name of the diff builder.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $label;

  /**
   * An array of field types the diff builder supports.
   *
   * @var array
   */
  public $field_types = [];

  /**
   * The weight of the plugin that defines its importance when applied.
   *
   * @var int
   */
  public $weight = 0;

}

Members

Name	Modifiers	Type	Description	Overrides
FieldDiffBuilder::$field_types	public	property	An array of field types the diff builder supports.
FieldDiffBuilder::$id	public	property	The plugin ID.
FieldDiffBuilder::$label	public	property	The human-readable name of the diff builder.
FieldDiffBuilder::$weight	public	property	The weight of the plugin that defines its importance when applied.
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