class DomainEntityUi in Domain Access Entity 8

Provides a form to configure domain field mappings.

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\domain_entity\Form\DomainEntityUi

Expanded class hierarchy of DomainEntityUi

1 string reference to 'DomainEntityUi'

domain_entity.routing.yml in ./domain_entity.routing.yml: domain_entity.routing.yml

File

src/Form/DomainEntityUi.php, line 15

Namespace

Drupal\domain_entity\Form

View source

class DomainEntityUi extends ConfigFormBase {

  /**
   * The domain entity mapper.
   *
   * @var \Drupal\domain_entity\DomainEntityMapper
   */
  protected $mapper;

  /**
   * Creates a new DomainEntityUi object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\domain_entity\DomainEntityMapper $mapper
   *   The domain entity mapper.
   */
  public function __construct(ConfigFactoryInterface $config_factory, DomainEntityMapper $mapper) {
    parent::__construct($config_factory);
    $this->mapper = $mapper;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('domain_entity.mapper'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('domain_entity.settings');
    $form['bypass_access_conditions'] = [
      '#title' => $this
        ->t('Disable access rules from this module. (You can use this settings to disable the query alter, for troubleshooting)'),
      '#type' => 'checkbox',
      '#description' => $this
        ->t('When this checkbox is checked, your entities must be accessible on all domains'),
      '#default_value' => $config
        ->get('bypass_access_conditions'),
      '#weight' => -50,
    ];
    $default_values = [];
    foreach ($this->mapper
      ->getEnabledEntityTypes() as $type_id => $entity_type) {
      $default_values[$type_id] = $type_id;
    }
    $form['entity_types'] = [
      '#type' => 'tableselect',
      '#title' => $this
        ->t('Activate domain access on entity types'),
      '#header' => [
        'type' => $this
          ->t('Entity type'),
        'operations' => $this
          ->t('Operations'),
      ],
      '#default_value' => $default_values,
      '#js_select' => FALSE,
    ];
    $rows = [];
    $entity_types = $this->mapper
      ->getEntityTypes();
    foreach ($entity_types as $entity_type_id => $definition) {
      $enabled = !empty($default_values[$entity_type_id]);
      $links = [];
      if ($enabled) {
        $links = [
          'configure' => [
            'title' => $this
              ->t('Configure'),
            'url' => Url::fromRoute('domain_entity.settings', [
              'entity_type_id' => $entity_type_id,
            ]),
          ],
        ];
      }
      $rows[$entity_type_id] = [
        'type' => $definition
          ->getLabel(),
        'operations' => [
          'data' => [
            '#type' => 'operations',
            '#links' => $links,
          ],
        ],
      ];
    }
    $form['entity_types']['#options'] = $rows;

    // @Todo Port active domain UI effects.
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('domain_entity.settings');
    $config
      ->set('bypass_access_conditions', $form_state
      ->getValue('bypass_access_conditions'))
      ->save();
    $entity_types = $form_state
      ->getValue('entity_types');
    $all_types = $this->mapper
      ->getEntityTypes();
    $enabled_types = $this->mapper
      ->getEnabledEntityTypes();
    $results = [
      'create' => [],
      'delete' => [],
    ];
    foreach ($all_types as $entity_type_id => $entity_type) {
      if (empty($entity_types[$entity_type_id])) {
        if (isset($enabled_types[$entity_type_id])) {
          $results['delete'][] = $entity_type_id;
        }
      }
      elseif (!isset($enabled_types[$entity_type_id])) {
        $results['create'][] = $entity_type_id;
      }
    }

    // Process results.
    // @todo Add batch to create/delete field storage configs.
    foreach ($results as $action => $types) {
      if ($action == 'delete') {
        foreach ($types as $type) {
          $this->mapper
            ->deleteFieldStorage($type);
        }
      }
      elseif ($action == 'create') {
        foreach ($types as $type) {
          $this->mapper
            ->createFieldStorage($type);
        }
      }
    }
    parent::submitForm($form, $form_state);
  }

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

}

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
DomainEntityUi::$mapper	protected	property	The domain entity mapper.
DomainEntityUi::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
DomainEntityUi::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
DomainEntityUi::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
DomainEntityUi::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
DomainEntityUi::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
DomainEntityUi::__construct	public	function	Creates a new DomainEntityUi object. 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	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 DomainEntityUi in Domain Access Entity 8

Hierarchy

File

Namespace

Members

API Navigation