You are here

Home » API reference » Opigno module 8 » ModuleH5PAdminSettingsForm.php

class ModuleH5PAdminSettingsForm in Opigno module 8

Same name and namespace in other branches
  1. 3.x src/Form/ModuleH5PAdminSettingsForm.php \Drupal\opigno_module\Form\ModuleH5PAdminSettingsForm

Class LearningPathAdminSettingsForm.

Hierarchy

Expanded class hierarchy of ModuleH5PAdminSettingsForm

1 file declares its use of ModuleH5PAdminSettingsForm
opigno_module.install in ./opigno_module.install
Opigno module app install/update functionality.
1 string reference to 'ModuleH5PAdminSettingsForm'
opigno_module.routing.yml in ./opigno_module.routing.yml
opigno_module.routing.yml

File

src/Form/ModuleH5PAdminSettingsForm.php, line 12

Namespace

Drupal\opigno_module\Form
View source 
class ModuleH5PAdminSettingsForm extends ConfigFormBase {

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

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

  /**
   * Returns disabled H5P libraries by default.
   *
   * @return array
   */
  public function disabledByDefault() {
    return [
      'H5P.Dialogcards',
      'H5P.MarkTheWords',
      'H5P.Audio',
      'H5P.Summary',
      'H5P.TwitterUserFeed',
      'H5P.AppearIn',
      'H5P.SingleChoiceSet',
      'H5P.Accordion',
      'H5P.Agamotto',
      'H5P.Collage',
      'H5P.ImageMultipleHotspotQuestion',
      'H5P.IFrameEmbed',
      'H5P.MemoryGame',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $editor = H5PEditorUtilities::getInstance();
    $list = $editor
      ->getLatestGlobalLibrariesData();
    $options = [];
    foreach ($list as $item) {
      $options[$item['machineName']] = $item['title'] . ' (' . $item['machineName'] . ')';
    }
    $form['h5p_disabled'] = array(
      '#type' => 'checkboxes',
      '#title' => t('Disabled H5P types'),
      '#options' => $options,
    );
    $not_recommended = $this
      ->disabledByDefault();
    foreach ($not_recommended as $item) {
      $form['h5p_disabled'][$item] = [
        '#disabled' => TRUE,
      ];
    }
    $config = $this
      ->config('opigno_module.settings');
    $disabled = $config
      ->get('disabled_h5p');
    $form['h5p_disabled']['#default_value'] = array_merge($not_recommended, $disabled);
    return parent::buildForm($form, $form_state);
  }

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

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $form_values = $form_state
      ->getValues();
    $disabled = array_filter($form_values['h5p_disabled'], function ($item) {
      if ($item !== 0) {
        return $item;
      }
    });
    $not_recommended = $this
      ->disabledByDefault();
    $config = array_merge($disabled, $not_recommended);
    $this
      ->config('opigno_module.settings')
      ->set('disabled_h5p', array_values($config))
      ->save();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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.
ModuleH5PAdminSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
ModuleH5PAdminSettingsForm::disabledByDefault public function Returns disabled H5P libraries by default.
ModuleH5PAdminSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
ModuleH5PAdminSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ModuleH5PAdminSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
ModuleH5PAdminSettingsForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
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.