You are here

Home » API reference » JSON:API Extras 8.3 » UrlLinkEnhancer.php

class UrlLinkEnhancer in JSON:API Extras 8.3

Add URL aliases to links.

Plugin annotation


@ResourceFieldEnhancer(
  id = "url_link",
  label = @Translation("URL for link (link field only)"),
  description = @Translation("Use Url for link fields.")
)

Hierarchy

Expanded class hierarchy of UrlLinkEnhancer

File

src/Plugin/jsonapi/FieldEnhancer/UrlLinkEnhancer.php, line 22

Namespace

Drupal\jsonapi_extras\Plugin\jsonapi\FieldEnhancer
View source 
class UrlLinkEnhancer extends ResourceFieldEnhancerBase implements ContainerFactoryPluginInterface {

  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

  /**
   * The logger service.
   *
   * @var \Drupal\Core\Logger\LoggerChannelInterface
   */
  protected $logger;

  /**
   * Constructs UrlLinkEnhancer.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param array $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager.
   * @param \Drupal\Core\Logger\LoggerChannelFactoryInterface $logger_factory
   *   The logger service.
   */
  public function __construct(array $configuration, $plugin_id, array $plugin_definition, LanguageManagerInterface $language_manager, LoggerChannelFactoryInterface $logger_factory) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->languageManager = $language_manager;
    $this->logger = $logger_factory
      ->get('jsonapi_extras');
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('language_manager'), $container
      ->get('logger.factory'));
  }

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

  /**
   * {@inheritDoc}
   */
  public function getSettingsForm(array $resource_field_info) {
    $settings = empty($resource_field_info['enhancer']['settings']) ? $this
      ->getConfiguration() : $resource_field_info['enhancer']['settings'];
    $form = parent::getSettingsForm($resource_field_info);
    $form['absolute_url'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Get Absolute Urls'),
      '#default_value' => $settings['absolute_url'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  protected function doUndoTransform($data, Context $context) {
    if (isset($data['uri'])) {
      try {
        $url = Url::fromUri($data['uri'], [
          'language' => $this->languageManager
            ->getCurrentLanguage(),
        ]);

        // Use absolute urls if configured.
        $configuration = $this
          ->getConfiguration();
        if ($configuration['absolute_url']) {
          $url
            ->setAbsolute(TRUE);
        }
        $data['url'] = $url
          ->toString();
      } catch (\Exception $e) {
        $this->logger
          ->error('Failed to create a URL from uri @uri. Error: @error', [
          '@uri' => $data['uri'],
          '@error' => $e
            ->getMessage(),
        ]);
      }
    }
    return $data;
  }

  /**
   * {@inheritdoc}
   */
  protected function doTransform($value, Context $context) {
  }

  /**
   * {@inheritdoc}
   */
  public function getOutputJsonSchema() {
    return [
      'type' => 'object',
      'properties' => [
        'uri' => [
          'type' => 'string',
        ],
        'title' => [
          'type' => 'string',
        ],
        'options' => [
          'type' => 'array',
        ],
        'url' => [
          'type' => 'string',
        ],
      ],
    ];
  }

}

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.
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
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.
UrlLinkEnhancer::$languageManager protected property The language manager.
UrlLinkEnhancer::$logger protected property The logger service.
UrlLinkEnhancer::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
UrlLinkEnhancer::defaultConfiguration public function Overrides ResourceFieldEnhancerBase::defaultConfiguration
UrlLinkEnhancer::doTransform protected function
UrlLinkEnhancer::doUndoTransform protected function
UrlLinkEnhancer::getOutputJsonSchema public function Get the JSON Schema for the new output. Overrides ResourceFieldEnhancerInterface::getOutputJsonSchema
UrlLinkEnhancer::getSettingsForm public function Get a form element to render the settings. Overrides ResourceFieldEnhancerBase::getSettingsForm
UrlLinkEnhancer::__construct public function Constructs UrlLinkEnhancer. Overrides PluginBase::__construct