You are here

Home » API reference » Metatag 8 » MetatagTag.php

class MetatagTag in Metatag 8

Defines a MetatagTag annotation object.

Hierarchy

Expanded class hierarchy of MetatagTag

290 classes are annotated with MetatagTag
AbstractTag in metatag_dc_advanced/src/Plugin/metatag/Tag/AbstractTag.php
The Dublin Core "Abstract" meta tag.
AbstractTag in src/Plugin/metatag/Tag/AbstractTag.php
The basic "Abstract" meta tag.
AccessRights in metatag_dc_advanced/src/Plugin/metatag/Tag/AccessRights.php
The Dublin Core "accessRights" meta tag.
AccrualMethod in metatag_dc_advanced/src/Plugin/metatag/Tag/AccrualMethod.php
The Dublin Core "accrualMethod" meta tag.
AccrualPeriodicity in metatag_dc_advanced/src/Plugin/metatag/Tag/AccrualPeriodicity.php
The Dublin Core "accrualPeriodicity" meta tag.

... See full list

File

src/Annotation/MetatagTag.php, line 12

Namespace

Drupal\metatag\Annotation
View source 
class MetatagTag extends Plugin {

  /**
   * The meta tag plugin's internal ID, in machine name format.
   *
   * @var string
   */
  public $id;

  /**
   * The display label/name of the meta tag plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $label;

  /**
   * A longer explanation of what the field is for.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description;

  /**
   * Proper name of the actual meta tag itself.
   *
   * @var string
   */
  public $name;

  /**
   * The group this meta tag fits in, corresponds to a MetatagGroup plugin.
   *
   * @var string
   */
  public $group;

  /**
   * Weight of the tag.
   *
   * @var int
   */
  public $weight;

  /**
   * Type of the meta tag.
   *
   * Should be either 'date', 'image', 'integer', 'label', 'string' or 'uri'.
   *
   * @var string
   */
  public $type;

  /**
   * True if URL must use HTTPS.
   *
   * @var bool
   */
  protected $secure;

  /**
   * True if more than one is allowed.
   *
   * @var bool
   */
  public $multiple;

  /**
   * True if the tag should use a text area.
   *
   * @var bool
   */
  public $long;

  /**
   * True if the URL value(s) must be absolute.
   *
   * @var bool
   */
  protected $absoluteUrl;

}

Members

Namesort descending Modifiers Type Description Overrides
MetatagTag::$absoluteUrl protected property True if the URL value(s) must be absolute.
MetatagTag::$description public property A longer explanation of what the field is for.
MetatagTag::$group public property The group this meta tag fits in, corresponds to a MetatagGroup plugin.
MetatagTag::$id public property The meta tag plugin's internal ID, in machine name format.
MetatagTag::$label public property The display label/name of the meta tag plugin.
MetatagTag::$long public property True if the tag should use a text area.
MetatagTag::$multiple public property True if more than one is allowed.
MetatagTag::$name public property Proper name of the actual meta tag itself.
MetatagTag::$secure protected property True if URL must use HTTPS.
MetatagTag::$type public property Type of the meta tag.
MetatagTag::$weight public property Weight of the tag.
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