class FieldInheritanceSettingsForm in Field Inheritance 8

Same name and namespace in other branches

2.0.x src/Form/FieldInheritanceSettingsForm.php \Drupal\field_inheritance\Form\FieldInheritanceSettingsForm

Provides a form for configuring field inheritance settings.

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\field_inheritance\Form\FieldInheritanceSettingsForm

Expanded class hierarchy of FieldInheritanceSettingsForm

1 string reference to 'FieldInheritanceSettingsForm'

field_inheritance.routing.yml in ./field_inheritance.routing.yml: field_inheritance.routing.yml

File

src/Form/FieldInheritanceSettingsForm.php, line 18

Namespace

Drupal\field_inheritance\Form

View source

class FieldInheritanceSettingsForm extends ConfigFormBase {

  /**
   * Returns a unique string identifying the form.
   *
   * @return string
   *   The unique string identifying the form.
   */
  public function getFormId() {
    return 'field_inheritance_settings';
  }

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

  /**
   * The messenger service.
   *
   * @var \Drupal\Core\Messenger\Messenger
   */
  protected $messenger;

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

  /**
   * The entity type bundle info service.
   *
   * @var \Drupal\Core\Entity\EntityTypeBundleInfo
   */
  protected $entityTypeBundleInfo;

  /**
   * Construct an FieldInheritanceForm.
   *
   * @param \Drupal\Core\Messenger\Messenger $messenger
   *   The messenger service.
   * @param \Drupal\Core\Entity\EntityTypeManager $entity_type_manager
   *   The entity type manager service.
   * @param \Drupal\Core\Entity\EntityTypeBundleInfo $entity_type_bundle_info
   *   The entity type bundle info service.
   */
  public function __construct(Messenger $messenger, EntityTypeManager $entity_type_manager, EntityTypeBundleInfo $entity_type_bundle_info) {
    $this->messenger = $messenger;
    $this->entityTypeManager = $entity_type_manager;
    $this->entityTypeBundleInfo = $entity_type_bundle_info;
  }

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

  /**
   * Form submission handler.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param Drupal\Core\Form\FormStateInterface $form_state
   *   An associative array containing the current state of the form.
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('field_inheritance.config')
      ->set('included_entities', implode(',', array_filter($form_state
      ->getValue('included_entities'))))
      ->set('included_bundles', implode(',', array_filter($form_state
      ->getValue('included_bundles'))))
      ->save();
    parent::submitForm($form, $form_state);
  }

  /**
   * Define the form used for Field Inheritance settings.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param Drupal\Core\Form\FormStateInterface $form_state
   *   An associative array containing the current state of the form.
   *
   * @return array
   *   Form definition array.
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('field_inheritance.config');
    $entity_types = $this->entityTypeManager
      ->getDefinitions();
    $entity_types = array_keys(array_filter($entity_types, function ($type) {
      return $type
        ->entityClassImplements(FieldableEntityInterface::CLASS);
    }));
    $entity_types = array_combine($entity_types, $entity_types);
    $form['included_entities'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Included Entity Types'),
      '#description' => $this
        ->t('Select the entity types that should be able to inherit data'),
      '#options' => $entity_types,
      '#default_value' => explode(',', $config
        ->get('included_entities')),
    ];
    $entity_bundles = [];
    foreach ($entity_types as $entity_type) {
      $bundles = $this->entityTypeBundleInfo
        ->getBundleInfo($entity_type);
      foreach (array_keys($bundles) as $bundle) {
        $entity_bundles[] = $entity_type . ':' . $bundle;
      }
    }
    $entity_bundles = array_combine($entity_bundles, $entity_bundles);
    $form['included_bundles'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Included Entity Bundles'),
      '#description' => $this
        ->t('Select the entity bundles that should be able to inherit data'),
      '#options' => $entity_bundles,
      '#default_value' => explode(',', $config
        ->get('included_bundles')),
    ];
    return parent::buildForm($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
FieldInheritanceSettingsForm::$entityTypeBundleInfo	protected	property	The entity type bundle info service.
FieldInheritanceSettingsForm::$entityTypeManager	protected	property	The entity type manager service.
FieldInheritanceSettingsForm::$messenger	protected	property	The messenger service. Overrides MessengerTrait::$messenger
FieldInheritanceSettingsForm::buildForm	public	function	Define the form used for Field Inheritance settings. Overrides ConfigFormBase::buildForm
FieldInheritanceSettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
FieldInheritanceSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
FieldInheritanceSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
FieldInheritanceSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
FieldInheritanceSettingsForm::__construct	public	function	Construct an FieldInheritanceForm. Overrides ConfigFormBase::__construct
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	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 FieldInheritanceSettingsForm in Field Inheritance 8

Hierarchy

File

Namespace

Members

API Navigation