You are here

Home » API reference » Schema.org Metatag 8 » SchemaActionBase.php

class SchemaActionBase in Schema.org Metatag 8

Schema.org Action items should extend this class.

Hierarchy

Expanded class hierarchy of SchemaActionBase

4 files declare their use of SchemaActionBase
SchemaMetatagTestAction.php in tests/modules/schema_metatag_test/src/Plugin/metatag/Tag/SchemaMetatagTestAction.php
SchemaMoviePotentialAction.php in schema_movie/src/Plugin/metatag/Tag/SchemaMoviePotentialAction.php
SchemaOrganizationPotentialAction.php in schema_organization/src/Plugin/metatag/Tag/SchemaOrganizationPotentialAction.php
SchemaWebSitePotentialAction.php in schema_web_site/src/Plugin/metatag/Tag/SchemaWebSitePotentialAction.php
2 string references to 'SchemaActionBase'
SchemaCreativeWorkTrait::creativeWorkProperties in src/Plugin/metatag/Tag/SchemaCreativeWorkTrait.php
Return an array of the unique properties for an object type.
SchemaHasPartTrait::hasPartProperties in src/Plugin/metatag/Tag/SchemaHasPartTrait.php
Return an array of the unique properties for an object type.

File

src/Plugin/metatag/Tag/SchemaActionBase.php, line 8

Namespace

Drupal\schema_metatag\Plugin\metatag\Tag
View source 
class SchemaActionBase extends SchemaNameBase {
  use SchemaActionTrait;

  /**
   * Allowed actions.
   *
   * @var array
   */
  protected $actions;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, array $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->actions = [];
  }

  /**
   * {@inheritdoc}
   */
  public function form(array $element = []) {
    $value = $this
      ->schemaMetatagManager()
      ->unserialize($this
      ->value());
    $input_values = [
      'title' => $this
        ->label(),
      'description' => $this
        ->description(),
      'value' => $value,
      '#required' => isset($element['#required']) ? $element['#required'] : FALSE,
      'visibility_selector' => $this
        ->visibilitySelector(),
      'actions' => $this->actions,
    ];
    $form = $this
      ->actionForm($input_values);
    if (empty($this
      ->multiple())) {
      unset($form['pivot']);
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public static function testValue() {
    $items = [];
    $keys = [
      '@type',
      'target',
    ];
    foreach ($keys as $key) {
      switch ($key) {
        case '@type':
          $items[$key] = 'Action';
          break;
        case 'target':
          $items[$key] = SchemaEntryPointBase::testValue();
          break;
        default:
          $items[$key] = parent::testDefaultValue(1, '');
          break;
      }
    }
    return $items;
  }

  /**
   * {@inheritdoc}
   */
  public static function processedTestValue($items) {
    foreach ($items as $key => $value) {
      switch ($key) {
        case 'target':
          $items[$key] = SchemaEntryPointBase::processedTestValue($items[$key]);
          break;
      }
    }
    return $items;
  }

}

Members

Namesort descending 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.
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.
SchemaActionBase::$actions protected property Allowed actions.
SchemaActionBase::form public function Generate a form element for this meta tag. Overrides MetaNameBase::form 4
SchemaActionBase::processedTestValue public static function Provide a test output value for the input value. Overrides SchemaNameBase::processedTestValue
SchemaActionBase::testValue public static function Provide a test input value for the property that will validate. Overrides SchemaNameBase::testValue 1
SchemaActionBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides MetaNameBase::__construct
SchemaActionTrait::actionForm public function Create the form element.
SchemaActionTrait::actionObjects public static function Return an array of all actions for an action type.
SchemaActionTrait::actionProperties public static function Return an array of the unique properties for an action type.
SchemaActionTrait::actionTypes public static function All action types.
SchemaActionTrait::getActionType public static function Get the action type for a given action.
SchemaActionTrait::getAllActions public static function Get an array of all actions, grouped by action type.
SchemaActionTrait::schemaMetatagManager abstract protected function Return the SchemaMetatagManager. Overrides SchemaPersonOrgTrait::schemaMetatagManager 1
SchemaImageTrait::imageForm public function The form element.
SchemaNameBase::$schemaMetatagManager protected property The schemaMetatagManager service.
SchemaNameBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
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 1
SchemaNameBase::outputValue public static function Transform input value to its display output. Overrides SchemaMetatagTestTagInterface::outputValue 2
SchemaNameBase::parseImageUrlValue protected function Parse the image url out of image markup.
SchemaNameBase::pivotItem public static function
SchemaNameBase::processItem protected function
SchemaNameBase::processTestExplodeValue public static function Explode a test value. Overrides SchemaMetatagTestTagInterface::processTestExplodeValue
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::testDefaultValue public static function Provide a random test value. Overrides SchemaMetatagTestTagInterface::testDefaultValue
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.
SchemaPersonOrgTrait::personOrgForm public function The form 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.