class ConfigForm in Color API 8

Form definition for the Color API module configuration page.

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\colorapi\Form\ConfigForm

Expanded class hierarchy of ConfigForm

File

src/Form/ConfigForm.php, line 15

Namespace

Drupal\colorapi\Form

View source

class ConfigForm extends ConfigFormBase {

  /**
   * The entity field manager.
   *
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  protected $entityFieldManager;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructs a ConfigForm Entity.
   *
   * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entityFieldManager
   *   The entity field manager.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   The entity type manager.
   */
  public function __construct(EntityFieldManagerInterface $entityFieldManager, EntityTypeManagerInterface $entityTypeManager) {
    $this->entityFieldManager = $entityFieldManager;
    $this->entityTypeManager = $entityTypeManager;
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('colorapi.settings');
    $form['enable_color_field'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable Color Field'),
      '#description' => $this
        ->t('When this box is checked, a "Color" field type will be enabled on the system.'),
      '#default_value' => $config
        ->get('enable_color_field'),
    ];
    $form['enable_color_entity'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable Color Entity'),
      '#description' => $this
        ->t('When this box is checked, a "Color" configuration entity type will be enabled on the system.'),
      '#default_value' => $config
        ->get('enable_color_entity'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    if ($this->entityTypeManager
      ->hasDefinition('colorapi_color') && !$form_state
      ->getValue('enable_color_entity') && $this->entityTypeManager
      ->getStorage('colorapi_color')
      ->hasData()) {
      $form_state
        ->setError($form['enable_color_entity'], $this
        ->t('You have Color entity data in the database, and must delete the content before you can disable the Color entity type.'));
    }
    if (!$form_state
      ->getValue('enable_color_field')) {
      $field_info = $this->entityFieldManager
        ->getFieldMapByFieldType('colorapi_color_field');
      $fields = [];
      if (count($field_info)) {
        foreach (array_keys($field_info) as $entity_type) {
          foreach (array_keys($field_info[$entity_type]) as $field_name) {
            $fields[] = $entity_type . '.' . $field_name;
          }
        }
      }
      if (count($fields)) {
        if (count($fields) === 1) {
          $form_state
            ->setErrorByName('enable_color_field', $this
            ->t('The Color field cannot be disabled until the following Color field has been deleted: %field', [
            '%field' => array_pop($fields),
          ]));
        }
        else {
          $string = '<ul>';
          $vars = [];
          foreach ($fields as $index => $field) {
            $string .= '<li>@value' . $index . '</li>';
            $vars['@value' . $index] = $field;
          }
          $sring .= '</ul>';
          $list = new FormattableMarkup($string, $vars);
          $form_state
            ->setErrorByName('enable_color_field', $this
            ->t('The following fields are Color fields, so the Color Field cannot be disabled until they have been deleted: @field', [
            '@field' => $list,
          ]));
        }
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this->configFactory
      ->getEditable('colorapi.settings')
      ->set('enable_color_field', (int) $form_state
      ->getValue('enable_color_field'))
      ->set('enable_color_entity', (int) $form_state
      ->getValue('enable_color_entity'))
      ->save();

    // @todo - Find a less nuclear option, ideally invalidating cache tags.
    drupal_flush_all_caches();
    parent::submitForm($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigForm::$entityFieldManager	protected	property	The entity field manager.
ConfigForm::$entityTypeManager	protected	property	The entity type manager.
ConfigForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
ConfigForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
ConfigForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
ConfigForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
ConfigForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
ConfigForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
ConfigForm::__construct	public	function	Constructs a ConfigForm Entity. Overrides ConfigFormBase::__construct
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.
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 ConfigForm in Color API 8

Hierarchy

File

Namespace

Members

API Navigation