You are here

Home » API reference » Video Embed Brightcove 8 » SettingsForm.php

class SettingsForm in Video Embed Brightcove 8

Configure Video Embed Brightcove module.

Hierarchy

Expanded class hierarchy of SettingsForm

1 string reference to 'SettingsForm'
video_embed_brightcove.routing.yml in ./video_embed_brightcove.routing.yml
video_embed_brightcove.routing.yml

File

src/Form/SettingsForm.php, line 16

Namespace

Drupal\video_embed_brightcove\Form
View source 
class SettingsForm extends ConfigFormBase {

  /**
   * The HTTP client.
   *
   * @var \GuzzleHttp\ClientInterface
   */
  protected $httpClient;

  /**
   * Constructs a new SettingsForm instance.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \GuzzleHttp\ClientInterface $http_client
   *   The HTTP client.
   */
  public function __construct(ConfigFactoryInterface $config_factory, ClientInterface $http_client) {
    parent::__construct($config_factory);
    $this->httpClient = $http_client;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('http_client'));
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('video_embed_brightcove.settings');
    $url = Url::fromUri('https://studio.brightcove.com/products/videocloud/admin/oauthsettings', [
      'attributes' => [
        'target' => '_blank',
      ],
    ]);
    $form['client_id'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Brightcove API Client ID'),
      '#default_value' => $config
        ->get('client_id'),
      '#description' => $this
        ->t('The Client ID of the Brightcove API Authentication credentials, available @link. Required for thumbnail download (used for video lazy load).', [
        '@link' => Link::fromTextAndUrl($this
          ->t('here'), $url)
          ->toString(),
      ]),
    ];
    $form['client_secret'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Brightcove API Secret Key'),
      '#default_value' => $config
        ->get('client_secret'),
      '#description' => $this
        ->t('The Secret Key associated with the Client ID above. Required for thumbnail download (used for video lazy load).'),
    ];
    $form['autoplay_player'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Autoplay player name'),
      '#default_value' => $config
        ->get('autoplay_player'),
      '#description' => $this
        ->t('The player name to be used when autoplay is enabled (instead of player name from the input URL). Autoplay option needs to be enabled inside Brightcove UI.'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
    $client_id = $form_state
      ->getValue('client_id');
    $client_secret = $form_state
      ->getValue('client_secret');

    // Check authentication if keys are provided.
    if (!empty($client_id) || !empty($client_secret)) {
      $auth_uri = 'https://oauth.brightcove.com/v4/access_token';
      $auth_string = base64_encode($client_id . ':' . $client_secret);
      $auth_options = [
        'headers' => [
          'Authorization' => 'Basic ' . $auth_string,
          'Content-Type' => 'application/x-www-form-urlencoded',
        ],
        'body' => 'grant_type=client_credentials',
      ];
      try {
        $this->httpClient
          ->request('POST', $auth_uri, $auth_options);
      } catch (\Exception $e) {

        // Set error if authentication was not successful.
        $form_state
          ->setErrorByName('client_id', 'Brightcove API authentication failed.');
        $form_state
          ->setErrorByName('client_secret', 'Please check client ID and secret key.');
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $config = $this
      ->config('video_embed_brightcove.settings');
    $config
      ->set('client_id', trim($form_state
      ->getValue('client_id')));
    $config
      ->set('client_secret', trim($form_state
      ->getValue('client_secret')));
    $config
      ->set('autoplay_player', trim($form_state
      ->getValue('autoplay_player')));
    $config
      ->save();
  }

}

Members

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