class ResourceFieldEnhancer in JSON:API Extras 8

Defines a Plugin annotation object for resource field enhancers.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\jsonapi_extras\Annotation\ResourceFieldEnhancer

See also

\Drupal\jsonapi_extras\Plugin\ResourceFieldEnhancerInterface

4 classes are annotated with ResourceFieldEnhancer

DateTimeEnhancer in src/Plugin/jsonapi/FieldEnhancer/DateTimeEnhancer.php

Perform additional manipulations to timestamp fields.

DateTimeFromStringEnhancer in src/Plugin/jsonapi/FieldEnhancer/DateTimeFromStringEnhancer.php

Perform additional manipulations to datetime fields.

SingleNestedEnhancer in src/Plugin/jsonapi/FieldEnhancer/SingleNestedEnhancer.php

Perform additional manipulations to date fields.

UuidLinkEnhancer in src/Plugin/jsonapi/FieldEnhancer/UuidLinkEnhancer.php

Use UUID for internal link field value.

File

src/Annotation/ResourceFieldEnhancer.php, line 14

Namespace

Drupal\jsonapi_extras\Annotation

class ResourceFieldEnhancer extends Plugin {

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

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

  /**
   * A short description of the formatter type.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description;

  /**
   * The name of the field formatter class.
   *
   * This is not provided manually, it will be added by the discovery mechanism.
   *
   * @var string
   */
  public $class;

}

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
ResourceFieldEnhancer::$class	public	property	The name of the field formatter class.
ResourceFieldEnhancer::$description	public	property	A short description of the formatter type.
ResourceFieldEnhancer::$id	public	property	The plugin ID.
ResourceFieldEnhancer::$label	public	property	The human-readable name of the formatter type.