You are here

Home » API reference » Background Video 8 » BackgroundVideoSettingsForm.php

class BackgroundVideoSettingsForm in Background Video 8

Hierarchy

Expanded class hierarchy of BackgroundVideoSettingsForm

1 string reference to 'BackgroundVideoSettingsForm'
background_video.routing.yml in ./background_video.routing.yml
background_video.routing.yml

File

src/Form/BackgroundVideoSettingsForm.php, line 9

Namespace

Drupal\background_video\Form
View source 
class BackgroundVideoSettingsForm extends ConfigFormBase {
  public function __construct(ConfigFactoryInterface $config_factory) {
    parent::__construct($config_factory);
  }
  public function getFormId() {
    return 'background_video_config_form';
  }
  protected function getEditableConfigNames() {
    return [
      'config.background_video',
    ];
  }
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('config.background_video');
    $form['background_video_source_mp4'] = [
      '#title' => $this
        ->t('.mp4 Video'),
      '#type' => 'managed_file',
      '#description' => $this
        ->t('Please upload a .mp4 file. MP4 adds support for Safari & IE.'),
      '#default_value' => $config
        ->get('background_video_source_mp4', NULL),
      '#upload_validators' => [
        'file_validate_extensions' => [
          'mp4',
        ],
      ],
      '#upload_location' => 'public://background_video',
      '#required' => TRUE,
    ];
    $form['background_video_source_webm'] = [
      '#title' => $this
        ->t('.webm Video'),
      '#type' => 'managed_file',
      '#description' => $this
        ->t('Please upload a .webm file. WEBM adds support for Chrome, Firefox, & Opera.'),
      '#required' => TRUE,
      '#default_value' => $config
        ->get('background_video_source_webm', NULL),
      '#upload_validators' => [
        'file_validate_extensions' => [
          'webm',
        ],
      ],
      '#upload_location' => 'public://background_video',
    ];
    $form['background_video_source_ogv'] = [
      '#title' => $this
        ->t('.ogv Video'),
      '#type' => 'managed_file',
      '#description' => $this
        ->t('Provide upload a .ogg video. OGV adds support to different browsers.'),
      '#required' => TRUE,
      '#default_value' => $config
        ->get('background_video_source_ogv', NULL),
      '#upload_validators' => [
        'file_validate_extensions' => [
          'ogv',
        ],
      ],
      '#upload_location' => 'public://background_video',
    ];
    $form['background_video_id'] = [
      '#title' => $this
        ->t('ID/Class Name'),
      '#type' => 'textfield',
      '#description' => $this
        ->t('Provide the specific ID/Class to which you want to add the background video. Prepend # with ID or . with class'),
      '#required' => TRUE,
      '#default_value' => $config
        ->get('background_video_id', 'body'),
    ];
    $form['background_video_control_position'] = [
      '#title' => $this
        ->t('Control Position'),
      '#type' => 'textfield',
      '#description' => $this
        ->t('Provide the specific ID where controls like Play/Pause and Mute/Unmute are placed. Leave blank if you do not want that user can control the background video.'),
      '#default_value' => $config
        ->get('background_video_control_position', '#footer'),
    ];
    $form['background_video_source_poster'] = [
      '#title' => $this
        ->t('Video Poster'),
      '#type' => 'managed_file',
      '#description' => $this
        ->t('Provide the poster for the video.'),
      '#required' => TRUE,
      '#default_value' => $config
        ->get('background_video_source_poster', NULL),
      '#upload_validators' => [
        'file_validate_extensions' => [
          'gif jpg jpeg png',
        ],
      ],
      '#upload_location' => 'public://background_video',
    ];
    $form['background_video_loop'] = [
      '#title' => $this
        ->t('Loop Video'),
      '#type' => 'checkbox',
      '#description' => $this
        ->t('Select the checkbox if you want to play the video in the loop.'),
      '#default_value' => $config
        ->get('background_video_loop', 1),
    ];
    $form['background_video_autoplay'] = [
      '#title' => $this
        ->t('Autoplay Video'),
      '#type' => 'checkbox',
      '#description' => $this
        ->t('Select the checkbox if you want to autpplay the video when the page is loaded.'),
      '#default_value' => $config
        ->get('background_video_autoplay', 1),
    ];
    return parent::buildForm($form, $form_state);
  }
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->configFactory()
      ->getEditable('config.background_video');
    $values = $form_state
      ->getValues();
    $config
      ->set('background_video_source_mp4', $values['background_video_source_mp4'])
      ->set('background_video_source_webm', $values['background_video_source_webm'])
      ->set('background_video_source_ogv', $values['background_video_source_ogv'])
      ->set('background_video_id', $values['background_video_id'])
      ->set('background_video_control_position', $values['background_video_control_position'])
      ->set('background_video_autoplay', $values['background_video_autoplay'])
      ->set('background_video_loop', $values['background_video_loop'])
      ->set('background_video_source_poster', $values['background_video_source_poster'])
      ->save();
    $file_types = [
      'mp4',
      'ogv',
      'webm',
      'poster',
    ];
    foreach ($file_types as $ftype) {
      $fid = $values['background_video_source_' . $ftype][0];
      $file = File::load($fid);
      $file->status = FILE_STATUS_PERMANENT;
      $file
        ->save();
      $file_usage = \Drupal::service('file.usage');
      $file_usage
        ->add($file, 'background_video', 'file', $fid);
      parent::submitForm($form, $form_state);
    }
  }

}

Members

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