class SingleNestedEnhancer in JSON:API Extras 8.2

Perform additional manipulations to date fields.

Plugin annotation

@ResourceFieldEnhancer(
  id = "nested",
  label = @Translation("Single Nested Property"),
  description = @Translation("Extracts or wraps nested properties from an object.")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\jsonapi_extras\Plugin\ResourceFieldEnhancerBase implements ResourceFieldEnhancerInterface uses \Shaper\DataAdaptor\DataAdaptorValidatorTrait, \Shaper\DataAdaptor\DataAdaptorTransformerTrait
      • class \Drupal\jsonapi_extras\Plugin\jsonapi\FieldEnhancer\SingleNestedEnhancer

File

src/Plugin/jsonapi/FieldEnhancer/SingleNestedEnhancer.php, line 17

Namespace

Drupal\jsonapi_extras\Plugin\jsonapi\FieldEnhancer

class SingleNestedEnhancer extends ResourceFieldEnhancerBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'path' => 'value',
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function doUndoTransform($data, Context $context) {
    $output = $data;
    $configuration = $this
      ->getConfiguration();
    $path = $configuration['path'];
    $path_parts = explode('.', $path);

    // Start drilling down until there are no more path parts.
    while ($output && ($path_part = array_shift($path_parts))) {
      $output = empty($output[$path_part]) ? NULL : $output[$path_part];
    }
    return $output;
  }

  /**
   * {@inheritdoc}
   */
  protected function doTransform($data, Context $context) {
    $input = $data;
    $configuration = $this
      ->getConfiguration();
    $path = $configuration['path'];
    $path_parts = explode('.', $path);

    // Start wrapping up until there are no more path parts.
    while ($path_part = array_pop($path_parts)) {
      $input = [
        $path_part => $input,
      ];
    }
    return $input;
  }

  /**
   * {@inheritdoc}
   */
  public function getOutputJsonSchema() {
    return [
      'oneOf' => [
        [
          'type' => 'string',
        ],
        [
          'type' => 'null',
        ],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getSettingsForm(array $resource_field_info) {
    $settings = empty($resource_field_info['enhancer']['settings']) ? $this
      ->getConfiguration() : $resource_field_info['enhancer']['settings'];
    return [
      'path' => [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Path'),
        '#description' => $this
          ->t('A dot separated path to extract the sub-property.'),
        '#default_value' => $settings['path'],
      ],
    ];
  }

}

Members

Name	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::getConfiguration	public	function
ResourceFieldEnhancerBase::getInputValidator	public	function
ResourceFieldEnhancerBase::getInternalValidator	public	function
ResourceFieldEnhancerBase::getOutputValidator	public	function
ResourceFieldEnhancerBase::setConfiguration	public	function
SingleNestedEnhancer::defaultConfiguration	public	function	Overrides ResourceFieldEnhancerBase::defaultConfiguration
SingleNestedEnhancer::doTransform	protected	function
SingleNestedEnhancer::doUndoTransform	protected	function
SingleNestedEnhancer::getOutputJsonSchema	public	function	Get the JSON Schema for the new output. Overrides ResourceFieldEnhancerInterface::getOutputJsonSchema
SingleNestedEnhancer::getSettingsForm	public	function	Get a form element to render the settings. Overrides ResourceFieldEnhancerBase::getSettingsForm
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.