You are here

Home » API reference » Web Service Data 2.0.x » WSConnectorSimpleHTTPWithLangReplacement.php

class WSConnectorSimpleHTTPWithLangReplacement in Web Service Data 2.0.x

Same name and namespace in other branches
  1. 8 src/Plugin/WSConnector/WSConnectorSimpleHTTPWithLangReplacement.php \Drupal\wsdata\Plugin\WSConnector\WSConnectorSimpleHTTPWithLangReplacement

HTTP Connector.

Plugin annotation


@WSConnector(
  id = "WSConnectorSimpleHTTPWithLangReplacement",
  label = @Translation("Simple HTTP connector with Language Replacement", context = "WSConnector"),
)

Hierarchy

Expanded class hierarchy of WSConnectorSimpleHTTPWithLangReplacement

File

src/Plugin/WSConnector/WSConnectorSimpleHTTPWithLangReplacement.php, line 20

Namespace

Drupal\wsdata\Plugin\WSConnector
View source 
class WSConnectorSimpleHTTPWithLangReplacement extends WSConnectorSimpleHTTP {

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, Client $http_client, Token $token, LanguageManagerInterface $language_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $http_client, $token, $language_manager);
    $this->http_client = $http_client;
    $this->token = $token;
    $this->language_manager = $language_manager;
  }

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

  /**
   * {@inheritdoc}
   */
  public function getReplacements(array $options) {
    $replacements = parent::getReplacements($options);
    unset($replacements[array_search('LANGUAGE', $replacements)]);
    return $replacements;
  }

  /**
   * {@inheritdoc}
   */
  public function getOptionsForm($options = []) {
    $form = parent::getOptionsForm($options);
    $form['intructions'] = [
      '#markup' => $this
        ->t("This connector will replace the string [LANGUAGE] in the path or the WSServer URL with the strings defined below, depending on the site's current content language"),
      '#weight' => -50,
    ];
    $form['urllang'] = [
      '#title' => $this
        ->t('URL Language Replacement'),
      '#type' => 'fieldset',
    ];
    foreach ($this->language_manager
      ->getLanguages() as $langcode => $language) {
      $form['lang-' . $langcode] = [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Replacement value for %lang', [
          '%lang' => $language
            ->getName(),
        ]),
        '#default_value' => $langcode,
      ];
    }
    return $form;
  }

  /**
   * Ajax callback function.
   */
  public static function wsconnectorHttpHeaderAjaxCallback(array &$form, FormStateInterface $form_state) {
    return $form['options']['wsserveroptions']['headers'];
  }

  /**
   * {@inheritdoc}
   */
  public function call($options, $method, $replacements = [], $data = NULL, array $tokens = []) {
    $langcode = $options['langcode'] ?? $this->language_manager
      ->getCurrentLanguage(LanguageInterface::TYPE_CONTENT)
      ->getId();
    $replacements['LANGUAGE'] = $options['lang-' . $langcode] ?? $langcode;
    return parent::call($options, $method, $replacements, $data, $tokens);
  }

  /**
   * {@inheritdoc}
   */
  public function getCache() {
    return $this->language_manager
      ->getCurrentLanguage(LanguageInterface::TYPE_CONTENT)
      ->getId();
  }

}

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 2
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.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.
WSConnectorBase::$cacheDefaultOverride protected property
WSConnectorBase::$cacheDefaultTime protected property
WSConnectorBase::$endpoint protected property
WSConnectorBase::$error protected property
WSConnectorBase::$expires protected property
WSConnectorBase::$languagePlugins protected property
WSConnectorBase::$staleCache protected property
WSConnectorBase::$status protected property
WSConnectorBase::applyReplacements protected function Internal function for applying replacements.
WSConnectorBase::clearError protected function Clear current error.
WSConnectorBase::defaultCache public function Figure out the overrides for cache times.
WSConnectorBase::expires public function Get the expired time for caching.
WSConnectorBase::findTokens protected function Internal function for finding tokens.
WSConnectorBase::getEndpoint public function Getter for the endpoint.
WSConnectorBase::getError public function Return the last error the connector received.
WSConnectorBase::getStatus public function Return the status of the last call.
WSConnectorBase::getSupportedLanguagePlugins public function Return the list of supported language handling plugins.
WSConnectorBase::isDegraded public function Whether the connector is in a dead state and shouldn't be called.
WSConnectorBase::setEndpoint public function Setter for the endpoint.
WSConnectorBase::setError protected function Setter for the connector errors.
WSConnectorSimpleHTTP::getMethods public function Return available methods supported by the connector. Overrides WSConnectorBase::getMethods 2
WSConnectorSimpleHTTP::getOptions public function Return available options supported by the connector. Overrides WSConnectorBase::getOptions 2
WSConnectorSimpleHTTP::saveOptions public function Saves the options form. Overrides WSConnectorBase::saveOptions
WSConnectorSimpleHTTP::setCacheExpire public function Sets the expires times based on the response.
WSConnectorSimpleHTTP::supportsCaching public function Whether returned data can be cached. Overrides WSConnectorBase::supportsCaching
WSConnectorSimpleHTTPWithLangReplacement::call public function Make the connector call. Overrides WSConnectorSimpleHTTP::call
WSConnectorSimpleHTTPWithLangReplacement::create public static function Creates an instance of the plugin. Overrides WSConnectorSimpleHTTP::create
WSConnectorSimpleHTTPWithLangReplacement::getCache public function Return cache cid for cases cache rules change. Overrides WSConnectorBase::getCache
WSConnectorSimpleHTTPWithLangReplacement::getOptionsForm public function Return the settings form provided by the connector. Overrides WSConnectorSimpleHTTP::getOptionsForm
WSConnectorSimpleHTTPWithLangReplacement::getReplacements public function Return an array of replacements. Overrides WSConnectorSimpleHTTP::getReplacements
WSConnectorSimpleHTTPWithLangReplacement::wsconnectorHttpHeaderAjaxCallback public static function Ajax callback function. Overrides WSConnectorSimpleHTTP::wsconnectorHttpHeaderAjaxCallback
WSConnectorSimpleHTTPWithLangReplacement::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides WSConnectorSimpleHTTP::__construct