You are here

abstract class ResourceFieldEnhancerBase in JSON:API Extras 8.3

Same name and namespace in other branches
  1. 8 src/Plugin/ResourceFieldEnhancerBase.php \Drupal\jsonapi_extras\Plugin\ResourceFieldEnhancerBase
  2. 8.2 src/Plugin/ResourceFieldEnhancerBase.php \Drupal\jsonapi_extras\Plugin\ResourceFieldEnhancerBase

Common base class for resourceFieldEnhancer plugins.

Hierarchy

Expanded class hierarchy of ResourceFieldEnhancerBase

See also

\Drupal\jsonapi_extras\Annotation\ResourceFieldEnhancer

\Drupal\jsonapi_extras\Plugin\ResourceFieldEnhancerManager

\Drupal\jsonapi_extras\Plugin\ResourceFieldEnhancerInterface

Plugin API

4 files declare their use of ResourceFieldEnhancerBase
JSONFieldEnhancer.php in src/Plugin/jsonapi/FieldEnhancer/JSONFieldEnhancer.php
SingleNestedEnhancer.php in src/Plugin/jsonapi/FieldEnhancer/SingleNestedEnhancer.php
UrlLinkEnhancer.php in src/Plugin/jsonapi/FieldEnhancer/UrlLinkEnhancer.php
UuidLinkEnhancer.php in src/Plugin/jsonapi/FieldEnhancer/UuidLinkEnhancer.php

File

src/Plugin/ResourceFieldEnhancerBase.php, line 23

Namespace

Drupal\jsonapi_extras\Plugin
View source
abstract class ResourceFieldEnhancerBase extends PluginBase implements ResourceFieldEnhancerInterface {
  use DataAdaptorValidatorTrait;
  use DataAdaptorTransformerTrait;

  /**
   * Holds the plugin configuration.
   *
   * @var array
   */
  protected $configuration;

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {

    // @todo This should have a dependency on the resource_config entity.
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getConfiguration() {
    return $this->configuration ? $this->configuration : $this
      ->setConfiguration([]);
  }

  /**
   * {@inheritdoc}
   */
  public function setConfiguration(array $configuration) {
    $this->configuration = $configuration + $this
      ->defaultConfiguration();
    return $this->configuration;
  }

  /**
   * {@inheritdoc}
   */
  public function getSettingsForm(array $resource_field_info) {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getInternalValidator() {
    return new AcceptValidator();
  }

  /**
   * {@inheritdoc}
   */
  public function getInputValidator() {

    // @todo Implement a getInputJsonSchema method.
    return new AcceptValidator();
  }

  /**
   * {@inheritdoc}
   */
  public function getOutputValidator() {
    return new JsonSchemaValidator($this
      ->getOutputJsonSchema(), new Validator(), Constraint::CHECK_MODE_TYPE_CAST);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
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
ResourceFieldEnhancerBase::$configuration protected property Holds the plugin configuration. Overrides PluginBase::$configuration
ResourceFieldEnhancerBase::calculateDependencies public function
ResourceFieldEnhancerBase::defaultConfiguration public function 4
ResourceFieldEnhancerBase::getConfiguration public function
ResourceFieldEnhancerBase::getInputValidator public function
ResourceFieldEnhancerBase::getInternalValidator public function
ResourceFieldEnhancerBase::getOutputValidator public function
ResourceFieldEnhancerBase::getSettingsForm public function Get a form element to render the settings. Overrides ResourceFieldEnhancerInterface::getSettingsForm 4
ResourceFieldEnhancerBase::setConfiguration public function
ResourceFieldEnhancerInterface::getOutputJsonSchema public function Get the JSON Schema for the new output. 5
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.