You are here

Home » API reference » HTTP Client Manager 8.2 » HttpClientManagerConfigForm.php

class HttpClientManagerConfigForm in HTTP Client Manager 8.2

Same name and namespace in other branches
  1. 8 src/Form/HttpClientManagerConfigForm.php \Drupal\http_client_manager\Form\HttpClientManagerConfigForm

Class HttpClientManagerConfigForm.

@package Drupal\http_client_manager\Form

Hierarchy

Expanded class hierarchy of HttpClientManagerConfigForm

1 string reference to 'HttpClientManagerConfigForm'
http_client_manager.routing.yml in ./http_client_manager.routing.yml
http_client_manager.routing.yml

File

src/Form/HttpClientManagerConfigForm.php, line 16

Namespace

Drupal\http_client_manager\Form
View source 
class HttpClientManagerConfigForm extends ConfigFormBase {

  /**
   * The HTTP Service API Handler service.
   *
   * @var \Drupal\http_client_manager\HttpServiceApiHandlerInterface
   */
  protected $httpServicesApi;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $instance = parent::create($container);
    $instance->httpServicesApi = $container
      ->get('http_client_manager.http_services_api');
    return $instance;
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'http_client_manager.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'http_client_manager_config_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('http_client_manager.settings');
    $form['enable_overriding_service_definitions'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable overriding of HTTP Services API definitions'),
      '#description' => $this
        ->t('Check this option to enable overriding of HTTP Services API definitions.'),
      '#default_value' => $config
        ->get('enable_overriding_service_definitions'),
    ];
    $overrides = $config
      ->get('overrides');
    $form['overrides'] = [
      '#type' => 'table',
      '#header' => [
        'id' => $this
          ->t('ID'),
        'title' => $this
          ->t('Title'),
        'api_path' => $this
          ->t('API Path'),
        'config' => $this
          ->t('Configurations'),
        'commands' => $this
          ->t('Commands'),
      ],
    ];
    $rows = [];
    foreach ($this->httpServicesApi
      ->getServicesApi() as $service) {
      $id = $service['id'];
      $row = [
        'id' => $service['id'],
        'title' => [
          'data' => [
            '#type' => 'textfield',
            '#title' => $this
              ->t('Override'),
            '#name' => 'overrides[' . $id . '][title]',
            '#value' => isset($overrides[$id]['title']) ? $overrides[$id]['title'] : NULL,
            '#description' => $this
              ->t('Default value: @value', [
              '@value' => isset($service['_original']['title']) ? $service['_original']['title'] : $service['title'],
            ]),
            '#description_display' => 'after',
          ],
        ],
        'api_path' => [
          'data' => [
            '#type' => 'textfield',
            '#title' => $this
              ->t('Override'),
            '#name' => 'overrides[' . $id . '][api_path]',
            '#value' => isset($overrides[$id]['api_path']) ? $overrides[$id]['api_path'] : NULL,
            '#description' => $this
              ->t('Default value: @value', [
              '@value' => isset($service['_original']['api_path']) ? $service['_original']['api_path'] : $service['api_path'],
            ]),
            '#description_display' => 'after',
          ],
        ],
        'config' => [
          'data' => [
            'override' => [
              '#title' => $this
                ->t('Override'),
              '#type' => 'textarea',
              '#name' => 'overrides[' . $id . '][config]',
              '#value' => isset($overrides[$id]['config']) ? Yaml::encode($overrides[$id]['config']) : NULL,
              '#rows' => 3,
              '#placeholder' => $this
                ->t('Enter data in YAML format.'),
            ],
            'default' => [
              '#type' => 'details',
              '#title' => $this
                ->t('Default value'),
              'value' => [
                '#markup' => '<pre>' . (!empty($service['_original']['config']) ? Yaml::encode($service['_original']['config']) : Yaml::encode($service['config'])) . '</pre>',
              ],
            ],
          ],
        ],
        'commands' => [
          'data' => [
            'override' => [
              '#title' => $this
                ->t('Override'),
              '#type' => 'textarea',
              '#name' => 'overrides[' . $id . '][commands]',
              '#value' => isset($overrides[$id]['commands']) ? Yaml::encode($overrides[$id]['commands']) : NULL,
              '#rows' => 3,
              '#placeholder' => $this
                ->t('Enter data in YAML format.'),
              '#element_validate' => [
                [
                  $this,
                  'validateYaml',
                ],
              ],
            ],
            'default' => [
              '#type' => 'details',
              '#title' => $this
                ->t('Default value'),
              'value' => [
                '#markup' => '<pre>' . (!empty($service['_original']['commands']) ? Yaml::encode($service['_original']['commands']) : NULL) . '</pre>',
              ],
            ],
          ],
        ],
      ];
      $rows[] = $row;
    }
    $form['overrides']['#rows'] = $rows;
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $overrides = $form_state
      ->getValue('overrides');
    foreach ($overrides as $id => $override) {
      foreach ([
        'config',
        'commands',
      ] as $setting) {
        if (!empty($setting)) {
          try {
            $overrides[$id][$setting] = Yaml::decode($overrides[$id][$setting]);
          } catch (InvalidDataTypeException $e) {
            $message = $this
              ->t('There was an error while parsing your YAML data: @message', [
              '@message' => $e
                ->getMessage(),
            ]);
            $this
              ->messenger()
              ->addError($message);
            continue;
          }
        }
      }
      $overrides[$id] = array_filter($overrides[$id]);
    }
    $overrides = array_filter($overrides);
    $this
      ->config('http_client_manager.settings')
      ->set('enable_overriding_service_definitions', $form_state
      ->getValue('enable_overriding_service_definitions'))
      ->set('overrides', $overrides)
      ->save();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBase::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 11
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
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
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
HttpClientManagerConfigForm::$httpServicesApi protected property The HTTP Service API Handler service.
HttpClientManagerConfigForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
HttpClientManagerConfigForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
HttpClientManagerConfigForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
HttpClientManagerConfigForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
HttpClientManagerConfigForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
HttpClientManagerConfigForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.