class TranslateFilterForm in Zircon Profile 8.0

Same name and namespace in other branches

8 core/modules/locale/src/Form/TranslateFilterForm.php \Drupal\locale\Form\TranslateFilterForm

Provides a filtered translation edit form.

View source

class TranslateFilterForm extends TranslateFormBase {

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $filters = $this
      ->translateFilters();
    $filter_values = $this
      ->translateFilterValues();
    $form['#attached']['library'][] = 'locale/drupal.locale.admin';
    $form['filters'] = array(
      '#type' => 'details',
      '#title' => $this
        ->t('Filter translatable strings'),
      '#open' => TRUE,
    );
    foreach ($filters as $key => $filter) {

      // Special case for 'string' filter.
      if ($key == 'string') {
        $form['filters']['status']['string'] = array(
          '#type' => 'search',
          '#title' => $filter['title'],
          '#description' => $filter['description'],
          '#default_value' => $filter_values[$key],
        );
      }
      else {
        $empty_option = isset($filter['options'][$filter['default']]) ? $filter['options'][$filter['default']] : '- None -';
        $form['filters']['status'][$key] = array(
          '#title' => $filter['title'],
          '#type' => 'select',
          '#empty_value' => $filter['default'],
          '#empty_option' => $empty_option,
          '#size' => 0,
          '#options' => $filter['options'],
          '#default_value' => $filter_values[$key],
        );
        if (isset($filter['states'])) {
          $form['filters']['status'][$key]['#states'] = $filter['states'];
        }
      }
    }
    $form['filters']['actions'] = array(
      '#type' => 'actions',
      '#attributes' => array(
        'class' => array(
          'container-inline',
        ),
      ),
    );
    $form['filters']['actions']['submit'] = array(
      '#type' => 'submit',
      '#value' => $this
        ->t('Filter'),
    );
    if (!empty($_SESSION['locale_translate_filter'])) {
      $form['filters']['actions']['reset'] = array(
        '#type' => 'submit',
        '#value' => $this
          ->t('Reset'),
        '#submit' => array(
          '::resetForm',
        ),
      );
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $filters = $this
      ->translateFilters();
    foreach ($filters as $name => $filter) {
      if ($form_state
        ->hasValue($name)) {
        $_SESSION['locale_translate_filter'][$name] = $form_state
          ->getValue($name);
      }
    }
    $form_state
      ->setRedirect('locale.translate_page');
  }

  /**
   * Provides a submit handler for the reset button.
   */
  public function resetForm(array &$form, FormStateInterface $form_state) {
    $_SESSION['locale_translate_filter'] = array();
    $form_state
      ->setRedirect('locale.translate_page');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.	3
FormBase::$loggerFactory	protected	property	The logger factory.
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.	3
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::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	64
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator	protected	function	Returns the link generator.
LinkGeneratorTrait::l	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator	public	function	Sets the link generator service.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.
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.
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.
TranslateFilterForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
TranslateFilterForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
TranslateFilterForm::resetForm	public	function	Provides a submit handler for the reset button.
TranslateFilterForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
TranslateFormBase::$filterValues	protected static	property
TranslateFormBase::$languageManager	protected	property	The language manager.
TranslateFormBase::$localeStorage	protected	property	The locale storage.
TranslateFormBase::$state	protected	property	The state store.
TranslateFormBase::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
TranslateFormBase::translateFilterLoadStrings	protected	function	Builds a string search query and returns an array of string objects.
TranslateFormBase::translateFilters	protected	function	Lists locale translation filters that can be applied.
TranslateFormBase::translateFilterValues	protected	function	Builds an array out of search criteria specified in request variables.
TranslateFormBase::__construct	public	function	Constructs a new TranslationFormBase object.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator	protected	function	Returns the URL generator service.
UrlGeneratorTrait::redirect	protected	function	Returns a redirect response object for the specified route.
UrlGeneratorTrait::setUrlGenerator	public	function	Sets the URL generator service.
UrlGeneratorTrait::url	protected	function	Generates a URL or path for a specific route based on the given parameters.

You are here

class TranslateFilterForm in Zircon Profile 8.0

Hierarchy

File

Namespace

Members

API Navigation