You are here

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

class Action in Schema.org Metatag 8.2

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

Plugin annotation


@SchemaPropertyType(
  id = "action",
  label = @Translation("Action"),
  tree_parent = {
    "Action",
  },
  tree_depth = -1,
  property_type = "Action",
  sub_properties = {
    "@type" = {
      "id" = "type",
      "label" = @Translation("@type"),
      "description" = "",
    },
    "target" = {
      "id" = "entry_point",
      "label" = @Translation("target"),
      "description" = @Translation("Indicates a target EntryPoint for an Action."),
      "tree_parent" = {
        "EntryPoint",
      },
      "tree_depth" = 0,
    },
    "result" = {
      "id" = "thing",
      "label" = @Translation("result"),
      "description" = @Translation("The result produced in the action. e.g. John wrote a book."),
      "tree_parent" = {
        "Thing",
      },
      "tree_depth" = 2,
    },
    "expectsAcceptanceOf" = {
      "id" = "offer",
      "label" = @Translation("expectsAcceptanceOf"),
      "description" = @Translation("An Offer which must be accepted before the user can perform the Action. For example, the user may need to buy a movie before being able to watch it."),
      "tree_parent" = {
        "Thing",
      },
      "tree_depth" = 2,
    },
    "query" = {
      "id" = "url",
      "label" = @Translation("query"),
      "description" = @Translation("The query used on this action, i.e. https://query.example.com/search?q={search_term_string}."),
    },
    "query-input" = {
      "id" = "text",
      "label" = @Translation("query-input"),
      "description" = @Translation("The placeholder for the query, i.e. required name=search_term_string."),
    },
  },
)

Hierarchy

Expanded class hierarchy of Action

File

src/Plugin/schema_metatag/PropertyType/Action.php, line 64

Namespace

Drupal\schema_metatag\Plugin\schema_metatag\PropertyType
View source 
class Action 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.