You are here

Home » API reference » Schema.org Metatag 8.2 » WebPageElement.php

class WebPageElement in Schema.org Metatag 8.2

Provides a plugin for the 'WebPageElement' Schema.org property type.

Plugin annotation


@SchemaPropertyType(
  id = "web_page_element",
  label = @Translation("WebPageElement"),
  tree_parent = {
    "WebPageElement",
  },
  tree_depth = 0,
  property_type = "WebPageElement",
  sub_properties = {
    "@type" = {
      "id" = "type",
      "label" = @Translation("@type"),
      "description" = "",
    },
    "isAccessibleForFree" = {
      "id" = "boolean",
      "label" = @Translation("isAccessibleForFree"),
      "description" = @Translation("True or False, whether this element is accessible for free."),
    },
    "cssSelector" = {
      "id" = "text",
      "label" = @Translation("cssSelector"),
      "description" = @Translation("List of class names of the parts of the web page that are not free, i.e. '.first-class', '.second-class'. Do NOT surround class names with quotation marks!"),
    },
    "name" = {
      "id" = "text",
      "label" = @Translation("name"),
      "description" = @Translation("The name of the work."),
    },
    "url" = {
      "id" = "url",
      "label" = @Translation("url"),
      "description" = @Translation("Absolute URL of the canonical Web page for the work."),
    },
    "sameAs" = {
      "id" = "url",
      "label" = @Translation("sameAs"),
      "description" = @Translation("Urls and social media links, comma-separated list of absolute URLs."),
    },
    "datePublished" = {
      "id" = "date",
      "label" = @Translation("datePublished"),
      "description" = @Translation("Publication date."),
    },
  },
)

Hierarchy

Expanded class hierarchy of WebPageElement

File

src/Plugin/schema_metatag/PropertyType/WebPageElement.php, line 57

Namespace

Drupal\schema_metatag\Plugin\schema_metatag\PropertyType
View source 
class WebPageElement extends PropertyTypeBase {

}

Members

Namesort descending Modifiers Type Description Overrides
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.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 92
PropertyTypeBase::$propertyTypeManager protected property The propertyTypeManager service.
PropertyTypeBase::$schemaMetatagClient protected property The SchemaMetatagClient service.
PropertyTypeBase::$schemaMetatagManager protected property The schemaMetatagManager service.
PropertyTypeBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
PropertyTypeBase::form public function Create a complete form element for this property type. Overrides PropertyTypeInterface::form 1
PropertyTypeBase::formElement public function A property form element. Overrides PropertyTypeInterface::formElement 5
PropertyTypeBase::getChildPropertyType public function Get an instance of a child property type. Overrides PropertyTypeInterface::getChildPropertyType
PropertyTypeBase::getOptionList public function Create an option list for a given tree section. Overrides PropertyTypeInterface::getOptionList
PropertyTypeBase::getPropertyType public function The property type. Overrides PropertyTypeInterface::getPropertyType
PropertyTypeBase::getSubProperties public function The sub-properties. Overrides PropertyTypeInterface::getSubProperties
PropertyTypeBase::getTree public function Get some or all of the object tree as options for @type. Overrides PropertyTypeInterface::getTree
PropertyTypeBase::getTreeDepth public function The depth of the class tree to use for @type options. Overrides PropertyTypeInterface::getTreeDepth
PropertyTypeBase::getTreeParent public function The classes to use for the @type options of this property. Overrides PropertyTypeInterface::getTreeParent
PropertyTypeBase::getVisibility public function Construct the visibility selector for a set of values. Overrides PropertyTypeInterface::getVisibility
PropertyTypeBase::outputValue public function Transform input value to its display output. Overrides PropertyTypeInterface::outputValue 2
PropertyTypeBase::pivotForm public function Pivot form element. Overrides PropertyTypeInterface::pivotForm
PropertyTypeBase::processedTestValue public function Provide a test output value for the input value. Overrides SchemaMetatagTestTagInterface::processedTestValue
PropertyTypeBase::processTestExplodeValue public function Explode a test value. Overrides SchemaMetatagTestTagInterface::processTestExplodeValue
PropertyTypeBase::propertyInfo public function Get all the properties of a property type. Overrides PropertyTypeInterface::propertyInfo
PropertyTypeBase::schemaMetatagClient public function The Schema Metatag Client service. Overrides PropertyTypeInterface::schemaMetatagClient
PropertyTypeBase::schemaMetatagManager public function The Schema Metatag Manager service. Overrides PropertyTypeInterface::schemaMetatagManager
PropertyTypeBase::setPropertyTypeManager public function Sets PropertyTypeManager service.
PropertyTypeBase::setSchemaMetatagClient public function Sets SchemaMetatagClient service.
PropertyTypeBase::setSchemaMetatagManager public function Sets schemaMetatagManager service.
PropertyTypeBase::testDefaultValue public function Provide a random test value. Overrides SchemaMetatagTestTagInterface::testDefaultValue
PropertyTypeBase::testValue public function Provide a test input value for the property that will validate. Overrides SchemaMetatagTestTagInterface::testValue 3
PropertyTypeBase::validateProperty public static function Validates the property form when submitted. Overrides PropertyTypeInterface::validateProperty
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.