You are here

Home » API reference » Brightcove Video Connect 8 » BrightcoveProxyForm.php

class BrightcoveProxyForm in Brightcove Video Connect 8

Same name and namespace in other branches
  1. 8.2 modules/brightcove_proxy/src/Form/BrightcoveProxyForm.php \Drupal\brightcove_proxy\Form\BrightcoveProxyForm
  2. 3.x modules/brightcove_proxy/src/Form/BrightcoveProxyForm.php \Drupal\brightcove_proxy\Form\BrightcoveProxyForm

Builds form for the Brightcove Proxy settings.

Hierarchy

Expanded class hierarchy of BrightcoveProxyForm

1 string reference to 'BrightcoveProxyForm'
brightcove_proxy.routing.yml in modules/brightcove_proxy/brightcove_proxy.routing.yml
modules/brightcove_proxy/brightcove_proxy.routing.yml

File

modules/brightcove_proxy/src/Form/BrightcoveProxyForm.php, line 11

Namespace

Drupal\brightcove_proxy\Form
View source 
class BrightcoveProxyForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {

    // Get config.
    $config = $this
      ->config('brightcove_proxy.config');
    $form['use_proxy'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Use proxy'),
      '#default_value' => $config
        ->get('use_proxy'),
      '#description' => 'Enable proxy connection.',
    ];

    // Proxy config.
    $form['proxy_config'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Proxy configuration'),
      '#states' => [
        'visible' => [
          ':input[name="use_proxy"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
      'proxy_username' => [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Username'),
        '#default_value' => $config
          ->get('proxy_username'),
        '#description' => $this
          ->t('The username to use for the connection to the proxy.'),
      ],
      'proxy_password' => [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Password'),
        '#default_value' => $config
          ->get('proxy_password'),
        '#description' => $this
          ->t('The password to use for the connection to the proxy.'),
      ],
      'proxy_auth' => [
        '#type' => 'select',
        '#title' => $this
          ->t('Auth'),
        '#options' => [
          CURLAUTH_ANY => $this
            ->t('Any'),
          CURLAUTH_ANYSAFE => $this
            ->t('Any safe'),
          CURLAUTH_BASIC => $this
            ->t('Basic'),
          CURLAUTH_DIGEST => $this
            ->t('Digest'),
          CURLAUTH_GSSNEGOTIATE => $this
            ->t('GSS Negotiation'),
          CURLAUTH_NTLM => $this
            ->t('NTLM'),
        ],
        '#default_value' => $config
          ->get('proxy_auth'),
        '#description' => $this
          ->t('The HTTP authentication method(s) to use for the proxy connection.<br>For proxy authentication, only <em>Basic</em> and <em>NTLM</em> are currently supported.<p><em>Any</em> means either <em>Basic</em>, <em>Digest</em>, <em>GSS Negotiation</em> or <em>NTLM</em></p><p><em>Any safe</em> means either <em>Digest</em>, <em>GSS Negotiation</em> or <em>NTLM</em>.</p>'),
      ],
      'proxy_type' => [
        '#type' => 'select',
        '#title' => $this
          ->t('Type'),
        '#options' => [
          CURLPROXY_HTTP => 'HTTP',
          CURLPROXY_SOCKS4 => 'SOCKS4',
          CURLPROXY_SOCKS5 => 'SOCKS5',
        ],
        '#default_value' => $config
          ->get('proxy_type'),
      ],
      'proxy' => [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Proxy'),
        '#default_value' => $config
          ->get('proxy'),
        '#description' => $this
          ->t('The HTTP proxy to tunnel requests through.'),
      ],
      'proxy_port' => [
        '#type' => 'number',
        '#title' => $this
          ->t('Port'),
        '#default_value' => $config
          ->get('proxy_port'),
        '#min' => 1,
        '#max' => 65535,
        '#size' => 5,
        '#description' => $this
          ->t('The port number of the proxy to connect to.'),
      ],
      'http_proxy_tunnel' => [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('HTTP tunnel proxy'),
        '#default_value' => $config
          ->get('http_proxy_tunnel'),
        '#description' => $this
          ->t('Enable to tunnel through a given HTTP proxy.'),
      ],
    ];
    return parent::buildForm($form, $form_state);
  }

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

    // Validate proxy config.
    if ($form_state
      ->getValue('use_proxy')) {
      $ch = curl_init("{$_SERVER['HTTP_HOST']}:{$_SERVER['SERVER_PORT']}/brightcove-proxy/test");
      curl_setopt_array($ch, [
        CURLOPT_PROXYUSERPWD => "{$form_state->getValue('proxy_username')}:{$form_state->getValue('proxy_password')}",
        CURLOPT_PROXYAUTH => $form_state
          ->getValue('proxy_auth'),
        CURLOPT_PROXYTYPE => $form_state
          ->getValue('proxy_type'),
        CURLOPT_PROXY => $form_state
          ->getValue('proxy'),
        CURLOPT_PROXYPORT => $form_state
          ->getValue('proxy_port'),
        CURLOPT_HTTPPROXYTUNNEL => $form_state
          ->getValue('http_proxy_tunnel'),
        CURLOPT_RETURNTRANSFER => FALSE,
        CURLOPT_AUTOREFERER => TRUE,
        CURLOPT_FOLLOWLOCATION => TRUE,
        CURLOPT_MAXREDIRS => 5,
      ]);
      curl_exec($ch);
      $info = curl_getinfo($ch);
      if ($info['http_code'] != 200) {
        $form_state
          ->setErrorByName('', curl_error($ch));
      }
      curl_close($ch);
    }
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('brightcove_proxy.config')
      ->set('use_proxy', $form_state
      ->getValue('use_proxy'));

    // Set proxy values.
    if ($form_state
      ->getValue('use_proxy')) {
      foreach (array_keys($form['proxy_config']) as $config_name) {
        if (strpos($config_name, '#') === 0) {
          continue;
        }
        $config
          ->set($config_name, $form_state
          ->getValue($config_name));
      }
    }
    else {
      foreach (array_keys($form['proxy_config']) as $config_name) {
        if (strpos($config_name, '#') === 0) {
          continue;
        }
        $config
          ->set($config_name, NULL);
      }
    }
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BrightcoveProxyForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
BrightcoveProxyForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
BrightcoveProxyForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
BrightcoveProxyForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
BrightcoveProxyForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
ConfigFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 13
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.
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.