You are here

Home » API reference » Module Filter 8 » ModuleFilter.php

class ModuleFilter in Module Filter 8

Provides a one-line text field form element.

Plugin annotation

@FormElement("module_filter");

Hierarchy

Expanded class hierarchy of ModuleFilter

2 #type uses of ModuleFilter
ModuleFilterUpdateStatusForm::buildForm in src/Form/ModuleFilterUpdateStatusForm.php
Form constructor.
module_filter_form_system_modules_alter in ./module_filter.module
Implements hook_form_FORM_ID_alter().

File

src/Element/ModuleFilter.php, line 18
Contains \Drupal\module_filter\Element\ModuleFilter.

Namespace

Drupal\module_filter\Element
View source 
class ModuleFilter extends FormElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return array(
      '#input' => TRUE,
      '#process' => array(
        array(
          $class,
          'processModuleFilter',
        ),
        array(
          $class,
          'processAjaxForm',
        ),
      ),
      '#weight' => -1,
      '#tree' => TRUE,
      '#theme' => 'module_filter',
      '#theme_wrappers' => array(
        'form_element',
      ),
    );
  }

  /**
   * {@inheritdoc}
   */
  public static function valueCallback(&$element, $input, FormStateInterface $form_state) {

    /*if ($input !== FALSE && $input !== NULL) {
        // This should be a string, but allow other scalars since they might be
        // valid input in programmatic form submissions.
        if (!is_scalar($input)) {
          $input = '';
        }
        return str_replace(array("\r", "\n"), '', $input);
      }
      return NULL;*/

    //return $input;
    return NULL;
  }

  /**
   * #process callback for #modulefilter form element property.
   *
   * @param array $element
   *   An associative array containing the properties and children of the
   *   generic input element.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   * @param array $complete_form
   *   The complete form structure.
   *
   * @return array
   *   The processed element.
   */
  public static function processModuleFilter(&$element, FormStateInterface $form_state, &$complete_form) {
    $config = \Drupal::config('module_filter.settings');
    $module_handler = \Drupal::moduleHandler();
    $element['name'] = array(
      '#type' => 'textfield',
      '#title' => isset($element['#title']) ? $element['#title'] : t('Filter list'),
      '#default_value' => isset($element['#default_value']) ? $element['#default_value'] : (isset($_GET['filter']) ? $_GET['filter'] : ''),
      '#size' => isset($element['#size']) ? $element['#size'] : 45,
      '#weight' => isset($element['#weight']) ? $element['#weight'] : -10,
      '#attributes' => (isset($element['#attributes']) ? $element['#attributes'] : array()) + array(
        'autocomplete' => 'off',
      ),
      '#attached' => array(
        'library' => array(
          'module_filter/drupal.module_filter',
        ),
        'drupalSettings' => array(
          'moduleFilter' => array(
            'setFocus' => $config
              ->get('module_filter_set_focus'),
            'tabs' => $config
              ->get('module_filter_tabs'),
            'countEnabled' => $config
              ->get('module_filter_count_enabled'),
            'visualAid' => $config
              ->get('module_filter_visual_aid'),
            'hideEmptyTabs' => $config
              ->get('module_filter_hide_empty_tabs'),
            'dynamicPosition' => !$module_handler
              ->moduleExists('page_actions') ? $config
              ->get('module_filter_dynamic_save_position') : FALSE,
            'useURLFragment' => $config
              ->get('module_filter_use_url_fragment'),
            'useSwitch' => $config
              ->get('module_filter_use_switch'),
            'trackRecent' => $config
              ->get('module_filter_track_recent_modules'),
            'rememberActiveTab' => $config
              ->get('module_filter_remember_active_tab'),
            'rememberUpdateState' => $config
              ->get('module_filter_remember_update_state'),
          ),
        ),
      ),
    );
    if (isset($element['#description'])) {
      $element['name']['#description'] = $element['#description'];
    }
    return $element;
  }

}

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
FormElement::processAutocomplete public static function Adds autocomplete functionality to elements.
FormElement::processPattern public static function #process callback for #pattern form element property.
FormElement::validatePattern public static function #element_validate callback for #pattern form element property.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
ModuleFilter::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
ModuleFilter::processModuleFilter public static function #process callback for #modulefilter form element property.
ModuleFilter::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 92
RenderElement::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup public static function Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm public static function Form element processing handler for the #ajax form property. 1
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes
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.