You are here

Home » API reference » Simplify 8 » SimplifyAdminForm.php

class SimplifyAdminForm in Simplify 8

Configure simplify global configurations.

Hierarchy

Expanded class hierarchy of SimplifyAdminForm

1 string reference to 'SimplifyAdminForm'
simplify.routing.yml in ./simplify.routing.yml
simplify.routing.yml

File

src/Form/SimplifyAdminForm.php, line 14

Namespace

Drupal\simplify\Form
View source 
class SimplifyAdminForm extends ConfigFormBase {

  /**
   * The module handler service.
   *
   * @var \Drupal\Core\Extension\ModuleHandler
   */
  protected $moduleHandler;

  /**
   * Constructs a SimplifyAdminForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Extension\ModuleHandler $module_handler
   *   The module handler service.
   */
  public function __construct(ConfigFactoryInterface $config_factory, ModuleHandler $module_handler) {
    parent::__construct($config_factory);
    $this->moduleHandler = $module_handler;
  }

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

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

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

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

    // Admin user permission.
    $form['simplify_admin'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Hide fields from admin users.'),
      '#description' => $this
        ->t("By default, Drupal gives User 1 and admin users <em>all</em> permissions (including Simplify's <em>View hidden fields</em> permission). This means that those users will always be able to view all hidden fields (and is by design).<br>Check this box to override this functionality and hide fields from any users. NOTE: As this option overrides default Drupal behaviour, it should be used sparingly and only when you fully understand the consequences."),
      '#default_value' => _simplify_get_config_value('simplify_admin', FALSE),
    ];

    // Nodes.
    if ($this->moduleHandler
      ->moduleExists('node')) {
      $form['nodes'] = [
        '#type' => 'details',
        '#title' => $this
          ->t('Nodes'),
        '#description' => $this
          ->t("These fields will be hidden from <em>all</em> node forms. Alternatively, to hide fields from node forms of a particular content type, edit the content type and configure the hidden fields there."),
        '#open' => TRUE,
      ];
      $form['nodes']['simplify_nodes_global'] = [
        '#type' => 'checkboxes',
        '#title' => $this
          ->t('Simplify the following options'),
        '#options' => simplify_get_fields('nodes'),
        '#default_value' => _simplify_get_config_value('simplify_nodes_global'),
      ];
    }

    // Users.
    if ($this->moduleHandler
      ->moduleExists('user')) {
      $form['users'] = [
        '#type' => 'details',
        '#title' => $this
          ->t('Users'),
        '#description' => $this
          ->t("These fields will be hidden from all user account forms."),
        '#open' => TRUE,
      ];
      $form['users']['simplify_users_global'] = [
        '#type' => 'checkboxes',
        '#title' => $this
          ->t('Simplify the following options'),
        '#options' => simplify_get_fields('users'),
        '#default_value' => _simplify_get_config_value('simplify_users_global'),
      ];
    }

    // Comments.
    if ($this->moduleHandler
      ->moduleExists('comment')) {
      $form['comments'] = [
        '#type' => 'details',
        '#title' => $this
          ->t('Comments'),
        '#description' => $this
          ->t("These fields will be hidden from <em>all</em> comment forms. Alternatively, to hide fields from comment forms for comments of a particular comment type, edit the comment type and configure the hidden fields there."),
        '#open' => TRUE,
      ];
      $form['comments']['simplify_comments_global'] = [
        '#type' => 'checkboxes',
        '#title' => $this
          ->t('Simplify the following options'),
        '#options' => simplify_get_fields('comments'),
        '#default_value' => _simplify_get_config_value('simplify_comments_global'),
      ];
    }

    // Taxonomy.
    if ($this->moduleHandler
      ->moduleExists('taxonomy')) {
      $form['taxonomy'] = [
        '#type' => 'details',
        '#title' => $this
          ->t('Taxonomy'),
        '#description' => $this
          ->t("These fields will be hidden from <em>all</em> taxonomy term forms. Alternatively, to hide fields from taxonomy term forms for a particular vocabulary, edit the vocabulary and configure the hidden fields there."),
        '#open' => TRUE,
      ];
      $form['taxonomy']['simplify_taxonomies_global'] = [
        '#type' => 'checkboxes',
        '#title' => $this
          ->t('Simplify the following options'),
        '#options' => simplify_get_fields('taxonomy'),
        '#default_value' => _simplify_get_config_value('simplify_taxonomies_global'),
      ];
    }

    // Blocks.
    if ($this->moduleHandler
      ->moduleExists('block')) {
      $form['blocks'] = [
        '#type' => 'details',
        '#title' => $this
          ->t('Blocks'),
        '#description' => $this
          ->t("These fields will be hidden from <em>all</em> blocks forms. Alternatively, to hide fields from block forms of a particular block type, edit the block type and configure the hidden fields there."),
        '#open' => TRUE,
      ];
      $form['blocks']['simplify_blocks_global'] = [
        '#type' => 'checkboxes',
        '#title' => $this
          ->t('Simplify the following options'),
        '#options' => simplify_get_fields('blocks'),
        '#default_value' => _simplify_get_config_value('simplify_blocks_global'),
      ];
    }

    // Profiles.
    if ($this->moduleHandler
      ->moduleExists('profile2_page')) {
      $form['profiles'] = [
        '#type' => 'details',
        '#title' => $this
          ->t('Profiles'),
        '#description' => $this
          ->t("These fields will be hidden from all profile forms."),
        '#open' => TRUE,
      ];
      $form['profiles']['simplify_profiles_global'] = [
        '#type' => 'checkboxes',
        '#title' => $this
          ->t('Simplify the following options'),
        '#options' => simplify_get_fields('profiles'),
        '#default_value' => _simplify_get_config_value('simplify_profiles_global'),
      ];
    }

    // Remove empty values from saved variables.
    // (see: http://drupal.org/node/61760#comment-402631)
    $form['array_filter'] = [
      '#type' => 'hidden',
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this->configFactory
      ->getEditable('simplify.global')
      ->set('simplify_admin', $form_state
      ->getValue('simplify_admin'))
      ->set('simplify_nodes_global', $this
      ->getFormValue($form_state, 'simplify_nodes_global'))
      ->set('simplify_users_global', $this
      ->getFormValue($form_state, 'simplify_users_global'))
      ->set('simplify_comments_global', $this
      ->getFormValue($form_state, 'simplify_comments_global'))
      ->set('simplify_taxonomies_global', $this
      ->getFormValue($form_state, 'simplify_taxonomies_global'))
      ->set('simplify_blocks_global', $this
      ->getFormValue($form_state, 'simplify_blocks_global'))
      ->set('simplify_profiles_global', $this
      ->getFormValue($form_state, 'simplify_profiles_global'))
      ->save();
    parent::submitForm($form, $form_state);
  }

  /**
   * Gets an array representing the configuration form values.
   *
   * @param Drupal\Core\Form\FormStateInterface $form_state
   *   The form state array.
   * @param string $config_name
   *   The configuration name to be retrieved.
   *
   * @return array
   *   An array representing the configuration or empty array if the
   *   configuration is not applicable.
   */
  protected function getFormValue(FormStateInterface $form_state, $config_name) {
    $value = $form_state
      ->getValue($config_name);
    return !empty($value) ? $value : [];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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.
SimplifyAdminForm::$moduleHandler protected property The module handler service.
SimplifyAdminForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
SimplifyAdminForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
SimplifyAdminForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SimplifyAdminForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SimplifyAdminForm::getFormValue protected function Gets an array representing the configuration form values.
SimplifyAdminForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
SimplifyAdminForm::__construct public function Constructs a SimplifyAdminForm object. Overrides ConfigFormBase::__construct
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.