class BrightcoveSubscriptionForm in Brightcove Video Connect 8.2

Builds the form for Brightcove Subscription add, edit.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\brightcove\Form\BrightcoveSubscriptionForm

1 string reference to 'BrightcoveSubscriptionForm'

brightcove.routing.yml in ./brightcove.routing.yml

brightcove.routing.yml

File

src/Form/BrightcoveSubscriptionForm.php, line 13

Namespace

Drupal\brightcove\Form

class BrightcoveSubscriptionForm extends FormBase {

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

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

    /** @var \Drupal\brightcove\Entity\BrightcoveAPIClient[] $api_clients */
    $api_clients = BrightcoveAPIClient::loadMultiple();
    $api_client_options = [];
    foreach ($api_clients as $api_client) {
      $api_client_options[$api_client
        ->id()] = $api_client
        ->label();
    }
    $form['api_client_id'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Client'),
      '#options' => $api_client_options,
      '#required' => TRUE,
    ];
    if (empty($api_client_options)) {
      $form['api_client_id']['#empty_option'] = $this
        ->t('No API clients available');
    }
    elseif (empty($form['api_client_id']['#default'])) {
      $api_client_ids = array_keys($api_client_options);
      $default = reset($api_client_ids);
      $form['api_client_id']['#default_value'] = $default;
    }
    $form['endpoint'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Endpoint'),
      '#description' => $this
        ->t('The notifications endpoint.'),
      '#required' => TRUE,
    ];

    // Hard-code "video-change" event since it's the only one.
    $form['events'] = [
      '#type' => 'checkboxes',
      '#required' => TRUE,
      '#title' => 'Events',
      '#options' => [
        'video-change' => $this
          ->t('Video change'),
      ],
      '#default_value' => [
        'video-change',
      ],
      '#disabled' => TRUE,
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Add'),
    ];
    return $form;
  }

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

    // Validate endpoint, it should be unique.
    if (!empty(BrightcoveSubscription::loadByEndpoint($form_state
      ->getValue('endpoint')))) {
      $form_state
        ->setErrorByName('endpoint', $this
        ->t('A subscription with the %endpoint endpoint already exists.', [
        '%endpoint' => $form_state
          ->getValue('endpoint'),
      ]));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    try {
      $brightcove_subscription = BrightcoveSubscription::createFromArray([
        'api_client_id' => $form_state
          ->getValue('api_client_id'),
        'endpoint' => $form_state
          ->getValue('endpoint'),
        'events' => array_values($form_state
          ->getValue('events')),
      ]);
      $brightcove_subscription
        ->save(TRUE);
      drupal_set_message($this
        ->t('Created Brightcove Subscription with %endpoint endpoint.', [
        '%endpoint' => $brightcove_subscription
          ->getEndpoint(),
      ]));
    } catch (\Exception $e) {

      // In case of an exception, show an error message and rebuild the form.
      if ($e
        ->getMessage()) {
        drupal_set_message($this
          ->t('Failed to create subscription: %error', [
          '%error' => $e
            ->getMessage(),
        ]), 'error');
      }
      else {
        drupal_set_message($this
          ->t('Failed to create subscription.'), 'error');
      }
      $form_state
        ->setRebuild(TRUE);
    }

    // Redirect back to the Subscriptions list.
    $form_state
      ->setRedirect('entity.brightcove_subscription.list');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BrightcoveSubscriptionForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
BrightcoveSubscriptionForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
BrightcoveSubscriptionForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
BrightcoveSubscriptionForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
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::config	protected	function	Retrieves a configuration object.
FormBase::configFactory	protected	function	Gets the config factory for this form.	1
FormBase::container	private	function	Returns the service container.
FormBase::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	87
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.