class ThemeKeyRuleChainForm in ThemeKey 8

Provides a form for administering the ThemeKey rule chain.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\themekey\Form\ThemeKeyRuleChainForm uses RuleChainManagerTrait

Expanded class hierarchy of ThemeKeyRuleChainForm

1 string reference to 'ThemeKeyRuleChainForm'

themekey.routing.yml in ./themekey.routing.yml: themekey.routing.yml

File

src/Form/ThemeKeyRuleChainForm.php, line 13

Namespace

Drupal\themekey\Form

View source

class ThemeKeyRuleChainForm extends ConfigFormBase {
  use RuleChainManagerTrait;

  /**
   * Gets the ThemeKey Rule Chain manager.
   *
   * @return \Drupal\themekey\RuleChainManagerInterface
   *   The ThemeKey Rule Chain manager.
   */
  protected function getRuleChainManager() {
    if (!$this->ruleChainManager) {
      $this->ruleChainManager = \Drupal::service('themekey.rule_chain_manager');
      $this->ruleChainManager
        ->setRuleChainConfig($this
        ->config('themekey.rule_chain'));
    }
    return $this->ruleChainManager;
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $ruleChainManager = $this
      ->getRuleChainManager();
    if (!$form_state
      ->isSubmitted()) {
      $ruleChainManager
        ->rebuildChain();
    }
    $form['#title'] = $this
      ->t('ThemeKey Rule Chain');
    $form['table'] = array(
      '#theme' => 'themekey_rule_chain_table',
      '#tree' => TRUE,
    );
    $depth = 0;
    $ruleChain = $ruleChainManager
      ->getChain();
    foreach ($ruleChain as $ruleId => $ruleMetaData) {
      $form['table'][$ruleId] = array(
        '#type' => 'fieldset',
        '#title' => $ruleId,
      );
      $form['table'][$ruleId]['enabled'] = array(
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Enabled'),
        '#default_value' => $ruleMetaData['enabled'],
      );
      $form['table'][$ruleId]['weight'] = array(
        '#type' => 'weight',
        '#title' => $this
          ->t('Weight'),
        '#default_value' => $ruleMetaData['weight'],
        '#delta' => 100,
      );
      $form['table'][$ruleId]['parent'] = array(
        '#type' => 'textfield',
        '#title' => $this
          ->t('Parent'),
        '#default_value' => $ruleMetaData['parent'],
      );
      $form['table'][$ruleId]['depth'] = array(
        '#type' => 'value',
        '#value' => $ruleMetaData['depth'],
      );
    }
    $form['save'] = array(
      '#type' => 'submit',
      '#value' => $this
        ->t('Save rule chain'),
    );
    return $form;
  }

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

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $chain = array();
    foreach (Element::children($form['table']) as $ruleId) {
      $parent = $form_state
        ->getValue(array(
        'table',
        $ruleId,
        'parent',
      ));
      $chain[$ruleId] = array(
        'weight' => $form_state
          ->getValue(array(
          'table',
          $ruleId,
          'weight',
        )),
        'parent' => $parent ?: NULL,
        'enabled' => $form_state
          ->getValue(array(
          'table',
          $ruleId,
          'enabled',
        )),
      );
    }
    $ruleChainManager = $this
      ->getRuleChainManager();
    $ruleChainManager
      ->setChain($chain);
    drupal_set_message($this
      ->t('The rule chain has been saved.'));
  }

}

Members

Name	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.
ConfigFormBaseTrait::getEditableConfigNames	abstract protected	function	Gets the configuration names that will be editable.	32
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.
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.
RuleChainManagerTrait::$ruleChainManager	private	property	@var
RuleChainManagerTrait::setRuleChainManager	public	function	Sets the ThemeKey Rule Chain manager to use.
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.
ThemeKeyRuleChainForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
ThemeKeyRuleChainForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
ThemeKeyRuleChainForm::getRuleChainManager	protected	function	Gets the ThemeKey Rule Chain manager. Overrides RuleChainManagerTrait::getRuleChainManager
ThemeKeyRuleChainForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
ThemeKeyRuleChainForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
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.

You are here

class ThemeKeyRuleChainForm in ThemeKey 8

Hierarchy

File

Namespace

Members

API Navigation