You are here

class NodeorderAdminForm in Node Order 8

Provides forms for managing Node Order.

Hierarchy

Expanded class hierarchy of NodeorderAdminForm

1 string reference to 'NodeorderAdminForm'
nodeorder.routing.yml in ./nodeorder.routing.yml
nodeorder.routing.yml

File

src/Form/NodeorderAdminForm.php, line 11

Namespace

Drupal\nodeorder\Form
View source
class NodeorderAdminForm extends ConfigFormBase {

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->configFactory()
      ->getEditable('nodeorder.settings');
    $form['nodeorder_show_links'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Display ordering links'),
      '#description' => $this
        ->t('Choose whether to show ordering links. Links can be shown for all categories associated to a node or for the currently active category. It is also possible to not show the ordering links at all.'),
    ];
    $form['nodeorder_show_links']['nodeorder_show_links_on_node'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Choose how to display ordering links'),
      '#default_value' => $config
        ->get('show_links_on_node'),
      '#description' => $this
        ->t('When displaying links based on the context, they will only be shown on taxonomy and nodeorder pages.'),
      '#options' => [
        $this
          ->t("Don't display ordering links"),
        $this
          ->t('Display ordering links for all categories'),
        $this
          ->t('Display ordering links based on the active category'),
      ],
    ];
    $form['nodeorder_link_to_ordering_page'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display link to the ordering page'),
      '#description' => $this
        ->t('If enabled, a tab will appear on all <em>nodeorder/term/%</em> and <em>taxonomy/term/%</em> pages that quickly allows administrators to get to the node ordering administration page for the term.'),
      '#default_value' => $config
        ->get('link_to_ordering_page'),
    ];
    $form['nodeorder_link_to_ordering_page_taxonomy_admin'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display link to the ordering page on taxonomy administration page'),
      '#description' => $this
        ->t('If enabled, a tab will appear on <em>admin/content/taxonomy/%</em> pages that quickly allows administrators to get to the node ordering administration page for the term.'),
      '#default_value' => $config
        ->get('link_to_ordering_page_taxonomy_admin'),
    ];
    $form['nodeorder_override_taxonomy_page'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Override the default taxonomy page with one from nodeorder'),
      '#description' => $this
        ->t('Disabling this will allow the panels module to override taxonomy pages instead. See <a href="https://www.drupal.org/node/1713048">this issue</a> for more information. You will have to clear caches for the change to take effect.'),
      '#default_value' => $config
        ->get('override_taxonomy_page'),
    ];
    return parent::buildForm($form, $form_state);
  }

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

    // ...
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->configFactory()
      ->getEditable('nodeorder.settings')
      ->set('show_links_on_node', $form_state
      ->getValue('nodeorder_show_links_on_node'))
      ->set('link_to_ordering_page', $form_state
      ->getValue('nodeorder_link_to_ordering_page'))
      ->set('link_to_ordering_page_taxonomy_admin', $form_state
      ->getValue('nodeorder_link_to_ordering_page_taxonomy_admin'))
      ->set('override_taxonomy_page', $form_state
      ->getValue('nodeorder_override_taxonomy_page'))
      ->save();
    parent::submitForm($form, $form_state);
  }

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

}

Members

Namesort descending 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.
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.
NodeorderAdminForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
NodeorderAdminForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
NodeorderAdminForm::getFormId public function . Overrides FormInterface::getFormId
NodeorderAdminForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
NodeorderAdminForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
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.