You are here

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

class StatusOverviewForm in Brightcove Video Connect 8

Same name and namespace in other branches
  1. 8.2 src/Form/StatusOverviewForm.php \Drupal\brightcove\Form\StatusOverviewForm
  2. 3.x src/Form/StatusOverviewForm.php \Drupal\brightcove\Form\StatusOverviewForm

Class StatusOverviewForm.

@package Drupal\brightcove\Form

Hierarchy

Expanded class hierarchy of StatusOverviewForm

1 string reference to 'StatusOverviewForm'
brightcove.routing.yml in ./brightcove.routing.yml
brightcove.routing.yml

File

src/Form/StatusOverviewForm.php, line 18

Namespace

Drupal\brightcove\Form
View source 
class StatusOverviewForm extends FormBase {

  /**
   * The queue factory.
   *
   * @var \Drupal\Core\Queue\QueueFactory
   */
  protected $queueFactory;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManager
   */
  protected $entityTypeManager;

  /**
   * Constructs a StatusOverviewForm object.
   *
   * @param \Drupal\Core\Queue\QueueFactory $queueFactory
   *   The queue factory.
   * @param \Drupal\Core\Entity\EntityTypeManager $entityTypeManager
   *   Entity type manager.
   */
  public function __construct(QueueFactory $queueFactory, EntityTypeManager $entityTypeManager) {
    $this->queueFactory = $queueFactory;
    $this->entityTypeManager = $entityTypeManager;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $video_num = $this->entityTypeManager
      ->getStorage('brightcove_video')
      ->getQuery()
      ->count()
      ->execute();
    $playlist_num = $this->entityTypeManager
      ->getStorage('brightcove_playlist')
      ->getQuery()
      ->count()
      ->execute();
    $subscription_num = BrightcoveSubscription::count();
    $counts = [
      'client' => $this->entityTypeManager
        ->getStorage('brightcove_api_client')
        ->getQuery()
        ->count()
        ->execute(),
      'subscription' => $subscription_num,
      'subscription_delete' => $subscription_num,
      'video' => $video_num,
      'video_delete' => $video_num,
      'text_track' => $this->entityTypeManager
        ->getStorage('brightcove_text_track')
        ->getQuery()
        ->count()
        ->execute(),
      'playlist' => $playlist_num,
      'playlist_delete' => $playlist_num,
      'player' => $this->entityTypeManager
        ->getStorage('brightcove_player')
        ->getQuery()
        ->count()
        ->execute(),
      'custom_field' => $this->entityTypeManager
        ->getStorage('brightcove_custom_field')
        ->getQuery()
        ->count()
        ->execute(),
    ];
    $queues = [
      'client' => $this
        ->t('Client'),
      'subscription' => $this
        ->t('Subscription'),
      'player' => $this
        ->t('Player'),
      'custom_field' => $this
        ->t('Custom field'),
      'video' => $this
        ->t('Video'),
      'text_track' => $this
        ->t('Text Track'),
      'playlist' => $this
        ->t('Playlist'),
      'video_delete' => $this
        ->t('Check deleted videos *'),
      'playlist_delete' => $this
        ->t('Check deleted playlists *'),
      'subscription_delete' => $this
        ->t('Check deleted subscriptions'),
    ];

    // There is no form element (ie. widget) in the table, so it's safe to
    // return a render array for a table as a part of the form build array.
    $form['queues'] = [
      '#type' => 'table',
      '#header' => [
        $this
          ->t('Name'),
        $this
          ->t('Number of entities'),
        $this
          ->t('Item(s) in queue'),
      ],
      '#rows' => [],
    ];
    foreach ($queues as $queue => $title) {
      $form['queues']['#rows'][$queue] = [
        $title,
        $counts[$queue],
        $this->queueFactory
          ->get("brightcove_{$queue}_queue_worker")
          ->numberOfItems(),
      ];
    }
    $form['notice'] = [
      '#type' => 'item',
      '#markup' => '<em>* ' . $this
        ->t('May run slowly with lots of items.') . '</em>',
    ];
    $form['sync'] = [
      '#name' => 'sync',
      '#type' => 'submit',
      '#value' => $this
        ->t('Sync all'),
    ];
    $form['run'] = [
      '#name' => 'run',
      '#type' => 'submit',
      '#value' => $this
        ->t('Run all queues'),
    ];
    $form['clear'] = [
      '#name' => 'clear',
      '#type' => 'submit',
      '#value' => $this
        ->t('Clear all queues'),
      '#description' => $this
        ->t('Remove all items from all queues'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    if ($triggering_element = $form_state
      ->getTriggeringElement()) {
      BrightcoveUtil::runStatusQueues($triggering_element['#name'], $this->queueFactory);
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
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.
StatusOverviewForm::$entityTypeManager protected property The entity type manager.
StatusOverviewForm::$queueFactory protected property The queue factory.
StatusOverviewForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
StatusOverviewForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
StatusOverviewForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
StatusOverviewForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
StatusOverviewForm::__construct public function Constructs a StatusOverviewForm object.
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.