You are here

Home » API reference » Ubercart 8.4 » CatalogSettingsForm.php

class CatalogSettingsForm in Ubercart 8.4

Configure catalog settings for this site.

Hierarchy

Expanded class hierarchy of CatalogSettingsForm

1 string reference to 'CatalogSettingsForm'
uc_catalog.routing.yml in uc_catalog/uc_catalog.routing.yml
uc_catalog/uc_catalog.routing.yml

File

uc_catalog/src/Form/CatalogSettingsForm.php, line 14

Namespace

Drupal\uc_catalog\Form
View source 
class CatalogSettingsForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('uc_catalog.settings');
    $view = Views::getView('uc_catalog');
    $view
      ->initDisplay();
    $displays = [];
    foreach ($view->displayHandlers as $display) {
      if ($display
        ->getPluginId() == 'page') {
        $displays[$display->display['id']] = $display->display['display_title'];
      }
    }
    $form['uc_catalog_display'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Catalog display'),
      '#default_value' => $config
        ->get('display'),
      '#options' => $displays,
    ];
    $vid = $config
      ->get('vocabulary');
    if ($vid) {
      $catalog = Vocabulary::load($vid);
      $form['catalog_vid'] = [
        '#prefix' => '<p>',
        '#markup' => $this
          ->t('The taxonomy vocabulary <a href=":edit-url">%name</a> is set as the product catalog.', [
          ':edit-url' => Url::fromRoute('entity.taxonomy_vocabulary.edit_form', [
            'taxonomy_vocabulary' => $catalog
              ->id(),
          ])
            ->toString(),
          '%name' => $catalog
            ->label(),
        ]),
        '#suffix' => '</p>',
      ];
    }
    $vocabs = [];
    $vocabularies = Vocabulary::loadMultiple();
    foreach ($vocabularies as $vid => $vocabulary) {
      $vocabs[$vid] = $vocabulary
        ->label();
    }
    $form['uc_catalog_vid'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Catalog vocabulary'),
      '#default_value' => $config
        ->get('vocabulary'),
      '#options' => $vocabs,
    ];
    $form['uc_catalog_breadcrumb'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display the catalog breadcrumb'),
      '#default_value' => $config
        ->get('breadcrumb'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('uc_catalog.settings')
      ->set('display', $form_state
      ->getValue('uc_catalog_display'))
      ->set('vocabulary', $form_state
      ->getValue('uc_catalog_vid'))
      ->set('breadcrumb', $form_state
      ->getValue('uc_catalog_breadcrumb'))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CatalogSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
CatalogSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
CatalogSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
CatalogSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
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.
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.
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.