class SchemaArticleAggregateRating in Schema.org Metatag 8.2

Provides a plugin for the 'schema_article_aggregate_rating' meta tag.

• 'id' should be a globally unique id.
• 'name' should match the Schema.org element name.
• 'group' should match the id of the group that defines the Schema.org type.

Plugin annotation

@MetatagTag(
  id = "schema_article_aggregate_rating",
  label = @Translation("aggregateRating"),
  description = @Translation("The overall rating, based on a collection of reviews or ratings, of the item."),
  name = "aggregateRating",
  group = "schema_article",
  weight = 11,
  type = "string",
  secure = FALSE,
  multiple = TRUE,
  property_type = "aggregate_rating",
  tree_parent = {
    "AggregateRating",
  },
  tree_depth = 0,
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\metatag\Plugin\metatag\Tag\MetaNameBase uses StringTranslationTrait
    • class \Drupal\schema_metatag\Plugin\metatag\Tag\SchemaNameBase implements ContainerFactoryPluginInterface
      • class \Drupal\schema_article\Plugin\metatag\Tag\SchemaArticleAggregateRating

File

schema_article/src/Plugin/metatag/Tag/SchemaArticleAggregateRating.php, line 31

Namespace

Drupal\schema_article\Plugin\metatag\Tag

class SchemaArticleAggregateRating extends SchemaNameBase {

}

Members

Name	Modifiers	Type	Description	Overrides
MetaNameBase::$absoluteUrl	protected	property	True if the URL value(s) must be absolute.
MetaNameBase::$description	protected	property	A longer explanation of what the field is for.
MetaNameBase::$group	protected	property	The category this meta tag fits in.
MetaNameBase::$id	protected	property	Machine name of the meta tag plugin.
MetaNameBase::$label	protected	property	The title of the plugin.
MetaNameBase::$long	protected	property	True if the tag should use a text area.
MetaNameBase::$multiple	protected	property	True if more than one is allowed.
MetaNameBase::$name	protected	property	Official metatag name.	1
MetaNameBase::$nameAttribute	protected	property	The attribute this tag uses for the name.	3
MetaNameBase::$request	protected	property	Retrieves the currently active request object.
MetaNameBase::$secure	protected	property	True if URL must use HTTPS.
MetaNameBase::$type	protected	property	Type of the value being stored.
MetaNameBase::$value	protected	property	The value of the metatag in this instance.
MetaNameBase::description	public	function	The meta tag's description.
MetaNameBase::group	public	function	The meta tag group this meta tag belongs to.
MetaNameBase::id	public	function	Obtain the meta tag's internal ID.
MetaNameBase::isActive	public	function	Whether or not this meta tag is active.
MetaNameBase::isLong	public	function	Whether or not this meta tag should use a text area.
MetaNameBase::label	public	function	This meta tag's label.
MetaNameBase::multiple	public	function	Whether or not this meta tag supports multiple values.
MetaNameBase::name	public	function	The meta tag's machine name.	1
MetaNameBase::parseImageUrl	protected	function	Extract any image URLs that might be found in a meta tag.
MetaNameBase::requiresAbsoluteUrl	public	function	Whether or not this meta tag must output required absolute URLs.
MetaNameBase::secure	public	function	Whether or not this meta tag must output secure (HTTPS) URLs.
MetaNameBase::tidy	private	function	Make the string presentable.
MetaNameBase::type	public	function	Obtain this meta tag's type.
MetaNameBase::validateTag	public static	function	Validates the metatag data.
MetaNameBase::weight	public	function	This meta tag's form field's weight.
MetaNameBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
SchemaNameBase::$propertyTypeManager	protected	property	The PropertyTypeManager service.
SchemaNameBase::$schemaMetatagManager	protected	property	The SchemaMetatagManager service.
SchemaNameBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
SchemaNameBase::form	public	function	Generate a form element for this meta tag. Overrides MetaNameBase::form
SchemaNameBase::getInputValues	public	function	Get default values used to create a form element.
SchemaNameBase::neverExplode	protected	function	Nested elements that cannot be exploded.
SchemaNameBase::output	public	function	Generate the HTML tag output for a meta tag. Overrides MetaNameBase::output
SchemaNameBase::outputValue	public	function	Transform input value to its display output.
SchemaNameBase::parseImageUrlValue	protected	function	Parse the image url out of image markup.
SchemaNameBase::pivotItem	public	function
SchemaNameBase::processItem	protected	function
SchemaNameBase::propertyTypeManager	protected	function	Return the PropertyTypeManager service.
SchemaNameBase::schemaMetatagManager	protected	function	Return the SchemaMetatagManager service.
SchemaNameBase::setPropertyTypeManager	public	function	Sets schemaMetatagManager service.
SchemaNameBase::setSchemaMetatagManager	public	function	Sets schemaMetatagManager service.
SchemaNameBase::setValue	public	function	Metatag expects a string value, so serialize any array of values. Overrides MetaNameBase::setValue
SchemaNameBase::value	public	function	The serialized value for the metatag. Overrides MetaNameBase::value
SchemaNameBase::visibilitySelector	protected	function	The #states base visibility selector for this element.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.