class PostalCodeSettingsForm in Postal Code 8

Postal code admin settings form.

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\postal_code\Form\PostalCodeSettingsForm

Expanded class hierarchy of PostalCodeSettingsForm

1 string reference to 'PostalCodeSettingsForm'

postal_code.routing.yml in ./postal_code.routing.yml: postal_code.routing.yml

File

src/Form/PostalCodeSettingsForm.php, line 16

Namespace

Drupal\postal_code\Form

View source

class PostalCodeSettingsForm extends ConfigFormBase {

  /**
   * The CountryManager service.
   *
   * @var \Drupal\Core\Locale\CountryManager
   */
  protected $countryManager;

  /**
   * The PostalCodeValidation service.
   *
   * @var \Drupal\postal_code\PostalCodeValidation
   */
  protected $postalCodeValidation;

  /**
   * The postal code settings.
   *
   * @var \Drupal\postal_code\Form\PostalCodeSettingsForm
   */
  protected $postalCodeSettings;

  /**
   * Constructs a \Drupal\postal_code\Form\PostalCodeSettingsFor object.
   *
   * @param \Drupal\Core\Locale\CountryManagerInterface $country_manager
   *    The CountryManager service.
   *
   * @param \Drupal\postal_code\PostalCodeValidationInterface $postal_code_validation
   *    The PostalCodeValidation service.
   */
  public function __construct(CountryManagerInterface $country_manager, PostalCodeValidationInterface $postal_code_validation) {
    $this->countryManager = $country_manager;
    $this->postalCodeValidation = $postal_code_validation;
    $this->postalCodeSettings = $this
      ->config('postal_code.settings');
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('country_manager'), $container
      ->get('postal_code.validator'));
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $country_list = $this->countryManager
      ->getStandardList();
    $postal_code_validation_data = $this->postalCodeValidation
      ->getValidationPatterns();
    $options = array();
    foreach ($postal_code_validation_data as $country_code => $info) {
      $options[$country_code] = $country_list[mb_strtoupper($country_code)];
    }
    $form['postal_code_valid_countries'] = array(
      '#type' => 'select',
      '#title' => t('Valid "Any" Countries'),
      '#size' => 16,
      '#multiple' => TRUE,
      '#options' => $options,
      '#default_value' => $this->postalCodeSettings
        ->get('valid_countries'),
      '#description' => '<p>' . t('Select the countr(y/ies) for Postal Code Validation for "Any" field type.') . '</p><p><em>' . t('This is most useful when you have a form that allows, for example, US and Canadian addresses.') . '</em></p><p><strong>' . t('VALIDATION ONLY OCCURS IF THE "VALIDATE" CHECKBOX BELOW IS SELECTED.') . '</strong></p>',
    );
    $form['postal_code_validate'] = array(
      '#type' => 'checkbox',
      '#title' => t('Validate'),
      '#default_value' => $this->postalCodeSettings
        ->get('validate'),
      '#description' => t('Validate submitted postal codes?'),
    );
    return parent::buildForm($form, $form_state);
  }

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

    // Write settings into config file.
    $this->postalCodeSettings
      ->set('valid_countries', $form_state
      ->getValue('postal_code_valid_countries'))
      ->set('validate', $form_state
      ->getValue('postal_code_validate'))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
PostalCodeSettingsForm::$countryManager	protected	property	The CountryManager service.
PostalCodeSettingsForm::$postalCodeSettings	protected	property	The postal code settings.
PostalCodeSettingsForm::$postalCodeValidation	protected	property	The PostalCodeValidation service.
PostalCodeSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
PostalCodeSettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
PostalCodeSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
PostalCodeSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
PostalCodeSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
PostalCodeSettingsForm::__construct	public	function	Constructs a \Drupal\postal_code\Form\PostalCodeSettingsFor object. Overrides ConfigFormBase::__construct
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.

You are here

class PostalCodeSettingsForm in Postal Code 8

Hierarchy

File

Namespace

Members

API Navigation