You are here

Home » API reference » Animations (JS/CSS) 8 » AnimationsConfigForm.php

class AnimationsConfigForm in Animations (JS/CSS) 8

Hierarchy

Expanded class hierarchy of AnimationsConfigForm

1 string reference to 'AnimationsConfigForm'
animations.routing.yml in ./animations.routing.yml
animations.routing.yml

File

src/Form/AnimationsConfigForm.php, line 9

Namespace

Drupal\animations\Form
View source 
class AnimationsConfigForm extends FormBase {

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return "animations_config_form";
  }

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

    // check dependencies
    $requirements = array();
    $config = \Drupal::config('animations.config');
    foreach ($config
      ->get("animations_dependencies") as $key => $library) {
      $fileExists = file_exists(DRUPAL_ROOT . '/libraries/' . $key . '/' . $library["file"]);
      if (!$fileExists) {
        $requirements[$key] = array(
          'title' => t($library["name"] . ' library'),
        );
        $requirements[$key]['description'] = t('Please use command "drush dal" to download dependencies or manually download the repository ' . $library["repository"] . ' into the libraries folder to define the following structure [DRUPAL_ROOT]/libraries/' . $key . '/' . $library["file"]);
        $requirements[$key]['severity'] = REQUIREMENT_ERROR;
      }
    }
    if (count($requirements) > 0) {
      $form['errors'] = [
        '#type' => 'table',
        '#header' => [
          t('Missing library'),
          t('Actions'),
        ],
        '#rows' => [],
      ];
      foreach ($requirements as $requirement) {
        $form['errors']["#rows"][] = array(
          $requirement["title"],
          $requirement["description"],
        );
      }
      print_r($form['errors']["rows"]);
      return $form;
    }

    // get the module configuration
    $config = $this
      ->config('animations.config');
    $form['topsubmit'] = array(
      '#type' => 'submit',
      '#value' => t('Save changes'),
    );
    $form['examples'] = [
      '#type' => 'details',
      '#open' => TRUE,
      '#title' => t('Examples'),
    ];
    $form['examples']['content'] = [
      '#type' => 'table',
      '#header' => [
        t('CSS selector'),
        t('Description'),
      ],
      '#rows' => [
        [
          'input, textarea',
          t('Use all single line text fields and textareas on site.'),
        ],
        [
          '.your-form-class *',
          t('Use all text fields in given form class.'),
        ],
        [
          '#your-form-id *',
          t('Use all text fields in given form id.'),
        ],
        [
          '#your-form-id *:not(textarea)',
          t('Use all single line text fields but not textareas in given form id.'),
        ],
        [
          '#your-form-id input:not(input[type=password])',
          t('Use all single line text fields but not password text fields in given form id.'),
        ],
      ],
    ];

    // add collapsible sections for all effects by cycling the config file and adding one textarea for each key
    foreach ($config
      ->get('animations') as $key => $effect) {
      $title = t(ucfirst($key) . ' effect');
      if (isset($effect["name"])) {
        $title = t($effect["name"]);
      }
      $desc = $this
        ->t('CSS selectors');
      if (isset($effect["desc"])) {
        $desc = t($effect["desc"]);
      }
      $form['group' . $key] = array(
        '#type' => 'details',
        '#title' => $title,
        '#collapsible' => TRUE,
        '#collapsed' => TRUE,
      );
      $form['group' . $key][$key] = array(
        '#type' => 'textarea',
        '#title' => $desc,
        // implode the config values array into multi line string for displaying in the textarea
        '#default_value' => implode("\n", $effect['classes']),
      );
    }
    $form['submit'] = array(
      '#type' => 'submit',
      '#value' => t('Save changes'),
    );
    return $form;
  }

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

    // TODO: validate the css selectors before saving
  }

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

    // get editibale instance of the module config
    $config = \Drupal::service('config.factory')
      ->getEditable('animations.config');

    // loop and save the new values in the module config
    foreach ($form_state
      ->getValues() as $key => $value) {

      // check if the field name is present in the config - because not all submitted fields are css selectors
      if (is_array($config
        ->get('animations.' . $key . '.classes'))) {

        // explode the input string back to array
        $config
          ->set('animations.' . $key . '.classes', explode("\n", $form_state
          ->getValue($key)));
      }
    }
    $config
      ->save();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AnimationsConfigForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
AnimationsConfigForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
AnimationsConfigForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
AnimationsConfigForm::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.