abstract class ValidatableConfigFormBase in CDN 8.3

@todo Lift the config validation logic out of this module into core.

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\cdn_ui\Form\ValidatableConfigFormBase

File

cdn_ui/src/Form/ValidatableConfigFormBase.php, line 19

Namespace

Drupal\cdn_ui\Form

abstract class ValidatableConfigFormBase extends ConfigFormBase {

  /***
   * The typed config manager.
   *
   * @var \Drupal\Core\Config\TypedConfigManagerInterface
   */
  protected $typedConfigManager;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('config.typed'));
  }
  public function __construct(ConfigFactoryInterface $config_factory, TypedConfigManagerInterface $typed_config_manager) {
    $this->typedConfigManager = $typed_config_manager;
    parent::__construct($config_factory);
  }
  protected static abstract function getMainConfigName() : string;

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $config = static::mapFormValuesToConfig($form_state, $this
      ->config(static::getMainConfigName()));
    $typed_config = $this->typedConfigManager
      ->createFromNameAndData(static::getMainConfigName(), $config
      ->getRawData());
    $violations = $typed_config
      ->validate();
    foreach ($violations as $violation) {
      $form_state
        ->setErrorByName(static::mapViolationPropertyPathsToFormNames($violation
        ->getPropertyPath()), $violation
        ->getMessage());
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = static::mapFormValuesToConfig($form_state, $this
      ->config(static::getMainConfigName()));
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }
  protected static abstract function mapFormValuesToConfig(FormStateInterface $form_state, Config $config);
  protected static function mapViolationPropertyPathsToFormNames(string $property_path) : string {
    return str_replace('.', '][', $property_path);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBase::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm	26
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.
FormInterface::getFormId	public	function	Returns a unique string identifying the form.	236
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.
ValidatableConfigFormBase::$typedConfigManager	protected	property
ValidatableConfigFormBase::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create	1
ValidatableConfigFormBase::getMainConfigName	abstract protected static	function		1
ValidatableConfigFormBase::mapFormValuesToConfig	abstract protected static	function		1
ValidatableConfigFormBase::mapViolationPropertyPathsToFormNames	protected static	function		1
ValidatableConfigFormBase::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
ValidatableConfigFormBase::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
ValidatableConfigFormBase::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object. Overrides ConfigFormBase::__construct	1