You are here

Home » API reference » UC Wish List 8 » UcWishlistConfigForm.php

class UcWishlistConfigForm in UC Wish List 8

Hierarchy

Expanded class hierarchy of UcWishlistConfigForm

1 string reference to 'UcWishlistConfigForm'
uc_wishlist.routing.yml in ./uc_wishlist.routing.yml
uc_wishlist.routing.yml

File

src/Form/UcWishlistConfigForm.php, line 11

Namespace

Drupal\uc_wishlist\Form
View source 
class UcWishlistConfigForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('uc_wishlist.settings');
    $form['default_title'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Default wish list title'),
      '#description' => $this
        ->t('The default name of a new wish list. The token %user will be replaced by the user\'s name.'),
      '#default_value' => $config
        ->get('default_title'),
    ];
    $form['save_address'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Permit a saved shipping address in a wishlist.'),
      '#default_value' => $config
        ->get('save_address'),
      '#description' => $this
        ->t('Check this box to permit users to specify a default delivery address when creating a wish list. If not checked, purchasers of wish list items must enter a delivery address at checkout.'),
    ];
    $form['default_private'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Make users wishlist private by default.'),
      '#default_value' => $config
        ->get('default_private'),
      '#description' => $this
        ->t('This makes the users wish list private by default and exclude it from wish list search results.This will not give the option to users to set the privacy of their wishlists.'),
    ];
    $form['allow_private'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Allow users to make their wishlist private.'),
      '#default_value' => $config
        ->get('allow_private'),
      '#description' => $this
        ->t('Check this box to allow users to make their wish list private and exclude it from wish list search results.This option will disable when <em>Make users wishlist private by default.</em> is enabled.'),
    ];
    $form['show_all'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show all wish lists by default.'),
      '#default_value' => $config
        ->get('show_all'),
      '#description' => $this
        ->t('If no keywords are entered in the wish list search form, display all wish lists. Else keywords must be entered, and there is no way to view all created wish lists.'),
    ];
    $form['out_of_stock'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Allow users to add out of stock item into wishlist.'),
      '#default_value' => $config
        ->get('out_of_stock'),
      '#description' => $this
        ->t('Check this box to allow user to add product to their wishlist if product is out of stock.'),
    ];
    $form['default_from'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Specify a default <em>From</em> address'),
      '#default_value' => $config
        ->get('default_from'),
      '#description' => $this
        ->t("If this field is set then all outgoing emails will have the From address set to the given value (normally something like no-reply@example.com). The <em>Reply To</em> address will be set to the users specified email address. This is recommended if you find your outgoing emails are being flagged as spam due to the sender address domain differing from the domain of the outgoing SMTP server."),
    ];
    return parent::buildForm($form, $form_state);
  }

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

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    $this
      ->config('uc_wishlist.settings')
      ->set('default_title', $values['default_title'])
      ->set('save_address', $values['save_address'])
      ->set('default_private', $values['default_private'])
      ->set('allow_private', $values['allow_private'])
      ->set('show_all', $values['show_all'])
      ->set('out_of_stock', $values['out_of_stock'])
      ->set('default_from', $values['default_from'])
      ->save();
    parent::submitForm($form, $form_state);
  }

}

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