class EntityUsageSettingsForm in Entity Usage 8.3

Same name and namespace in other branches

8.4 src/Form/EntityUsageSettingsForm.php \Drupal\entity_usage\Form\EntityUsageSettingsForm
8 src/Form/EntityUsageSettingsForm.php \Drupal\entity_usage\Form\EntityUsageSettingsForm
8.2 src/Form/EntityUsageSettingsForm.php \Drupal\entity_usage\Form\EntityUsageSettingsForm

Form to configure entity_usage 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\entity_usage\Form\EntityUsageSettingsForm

Expanded class hierarchy of EntityUsageSettingsForm

1 string reference to 'EntityUsageSettingsForm'

entity_usage.routing.yml in ./entity_usage.routing.yml: entity_usage.routing.yml

File

src/Form/EntityUsageSettingsForm.php, line 19

Namespace

Drupal\entity_usage\Form

View source

class EntityUsageSettingsForm extends ConfigFormBase {

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

  /**
   * The router builder.
   *
   * @var \Drupal\Core\Routing\RouteBuilderInterface
   */
  protected $routerBuilder;

  /**
   * The Cache Render.
   *
   * @var \Drupal\Core\Cache\CacheBackendInterface
   */
  protected $cacheRender;

  /**
   * The Entity Usage Track Manager service.
   *
   * @var \Drupal\entity_usage\EntityUsageTrackManager
   */
  protected $usageTrackManager;

  /**
   * {@inheritdoc}
   */
  public function __construct(ConfigFactoryInterface $config_factory, EntityTypeManagerInterface $entity_type_manager, RouteBuilderInterface $router_builder, CacheBackendInterface $cache_render, EntityUsageTrackManager $usage_track_manager) {
    parent::__construct($config_factory);
    $this->entityTypeManager = $entity_type_manager;
    $this->routerBuilder = $router_builder;
    $this->cacheRender = $cache_render;
    $this->usageTrackManager = $usage_track_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('entity_type.manager'), $container
      ->get('router.builder'), $container
      ->get('cache.render'), $container
      ->get('plugin.manager.entity_usage.track'));
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('entity_usage.settings');
    $all_entity_types = $this->entityTypeManager
      ->getDefinitions();
    $content_entity_types = [];

    // Filter the entity types.

    /** @var \Drupal\Core\Entity\EntityTypeInterface[] $entity_type_options */
    $entity_type_options = [];
    $tabs_options = [];
    foreach ($all_entity_types as $entity_type) {
      if ($entity_type instanceof ContentEntityTypeInterface) {
        $content_entity_types[$entity_type
          ->id()] = $entity_type
          ->getLabel();
      }
      $entity_type_options[$entity_type
        ->id()] = $entity_type
        ->getLabel();
      if ($entity_type
        ->hasLinkTemplate('canonical') || $entity_type
        ->hasLinkTemplate('edit-form')) {
        $tabs_options[$entity_type
          ->id()] = $entity_type
          ->getLabel();
      }
    }

    // Files and users shouldn't be tracked by default.
    unset($content_entity_types['file']);
    unset($content_entity_types['user']);

    // Tabs configuration.
    $form['local_task_enabled_entity_types'] = [
      '#type' => 'details',
      '#open' => TRUE,
      '#title' => $this
        ->t('Enabled local tasks'),
      '#description' => $this
        ->t('Check in which entity types there should be a tab (local task) linking to the usage page.'),
      '#tree' => TRUE,
    ];
    $form['local_task_enabled_entity_types']['entity_types'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Local task entity types'),
      '#options' => $tabs_options,
      '#default_value' => $config
        ->get('local_task_enabled_entity_types') ?: [],
    ];

    // Entity types (source).
    $form['track_enabled_source_entity_types'] = [
      '#type' => 'details',
      '#open' => FALSE,
      '#title' => $this
        ->t('Enabled source entity types'),
      '#description' => $this
        ->t('Check which entity types should be tracked when source.'),
      '#tree' => TRUE,
    ];
    $form['track_enabled_source_entity_types']['entity_types'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Source entity types'),
      '#options' => $entity_type_options,
      // If no custom settings exist, content entities are tracked by default.
      '#default_value' => $config
        ->get('track_enabled_source_entity_types') ?: array_keys($content_entity_types),
      '#required' => TRUE,
    ];

    // Entity types (target).
    $form['track_enabled_target_entity_types'] = [
      '#type' => 'details',
      '#open' => FALSE,
      '#title' => $this
        ->t('Enabled target entity types'),
      '#description' => $this
        ->t('Check which entity types should be tracked when target.'),
      '#tree' => TRUE,
    ];
    $form['track_enabled_target_entity_types']['entity_types'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Target entity types'),
      '#options' => $entity_type_options,
      // If no custom settings exist, content entities are tracked by default.
      '#default_value' => $config
        ->get('track_enabled_target_entity_types') ?: array_keys($content_entity_types),
      '#required' => TRUE,
    ];

    // Plugins to enable.
    $form['track_enabled_plugins'] = [
      '#type' => 'details',
      '#open' => TRUE,
      '#title' => $this
        ->t('Enabled tracking plugins'),
      '#description' => $this
        ->t('The following plugins were found in the system and can provide usage tracking. Check all plugins that should be active.'),
      '#tree' => TRUE,
    ];
    $plugins = $this->usageTrackManager
      ->getDefinitions();
    $plugin_options = [];
    foreach ($plugins as $plugin) {
      $plugin_options[$plugin['id']] = $plugin['label'];
    }
    $form['track_enabled_plugins']['plugins'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Tracking plugins'),
      '#options' => $plugin_options,
      '#default_value' => $config
        ->get('track_enabled_plugins') ?: array_keys($plugin_options),
      '#required' => TRUE,
    ];

    // Add descriptions to all plugins that defined it.
    foreach ($plugins as $plugin) {
      if (!empty($plugin['description'])) {
        $form['track_enabled_plugins']['plugins'][$plugin['id']]['#description'] = $plugin['description'];
      }
    }

    // Edit warning message.
    $form['edit_warning_message_entity_types'] = [
      '#type' => 'details',
      '#open' => FALSE,
      '#title' => $this
        ->t('Warning message on edit form'),
      '#description' => $this
        ->t('Check which entity types should show a message when being edited with recorded references to it.'),
      '#tree' => TRUE,
    ];
    $form['edit_warning_message_entity_types']['entity_types'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Entity types to show warning on edit form'),
      '#options' => $entity_type_options,
      '#default_value' => $config
        ->get('edit_warning_message_entity_types') ?: [],
      '#required' => FALSE,
    ];

    // Delete warning message.
    $form['delete_warning_message_entity_types'] = [
      '#type' => 'details',
      '#open' => FALSE,
      '#title' => $this
        ->t('Warning message on delete form'),
      '#description' => $this
        ->t('Check which entity types should show a message when being deleted with recorded references to it.'),
      '#tree' => TRUE,
    ];
    $form['delete_warning_message_entity_types']['entity_types'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Entity types to show warning on delete form'),
      '#options' => $entity_type_options,
      '#default_value' => $config
        ->get('delete_warning_message_entity_types') ?: [],
      '#required' => FALSE,
    ];

    // Only allow to opt-in on target entities being tracked.
    foreach (array_keys($entity_type_options) as $entity_type_id) {
      $form['edit_warning_message_entity_types']['entity_types'][$entity_type_id]['#states'] = [
        'enabled' => [
          ':input[name="track_enabled_target_entity_types[entity_types][' . $entity_type_id . ']"]' => [
            'checked' => TRUE,
          ],
        ],
      ];
      $form['delete_warning_message_entity_types']['entity_types'][$entity_type_id]['#states'] = [
        'enabled' => [
          ':input[name="track_enabled_target_entity_types[entity_types][' . $entity_type_id . ']"]' => [
            'checked' => TRUE,
          ],
        ],
      ];
    }

    // Miscellaneous settings.
    $form['generic_settings'] = [
      '#type' => 'details',
      '#open' => TRUE,
      '#title' => $this
        ->t('Generic'),
    ];
    $form['generic_settings']['track_enabled_base_fields'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Track referencing basefields'),
      '#description' => $this
        ->t('If enabled, relationships generated through non-configurable fields (basefields) will also be tracked.'),
      '#default_value' => (bool) $config
        ->get('track_enabled_base_fields'),
    ];
    $form['generic_settings']['site_domains'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Domains for this website'),
      '#description' => $this
        ->t("A comma or new-line separated list of domain names for this website. Absolute URL's in content will be checked against these domains to allow usage tracking."),
      '#default_value' => implode("\r\n", $config
        ->get('site_domains') ?: []),
    ];
    $form['generic_settings']['usage_controller_items_per_group'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Items per group'),
      '#description' => $this
        ->t('Referencing (source) entities on the usage page are grouped by entity type. Define here the number of items per group that should be shown on the usage page.'),
      '#default_value' => $config
        ->get('usage_controller_items_per_group') ?: ListUsageController::ITEMS_PER_GROUP_DEFAULT,
      '#min' => 1,
      '#step' => 1,
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $form_state
      ->cleanValues();
    $config = $this
      ->config('entity_usage.settings');
    $local_tasks_updated = array_filter($config
      ->get('local_task_enabled_entity_types')) !== array_filter($form_state
      ->getValue('local_task_enabled_entity_types')['entity_types']);
    $site_domains = preg_replace('/[\\s, ]/', ',', $form_state
      ->getValue('site_domains'));
    $site_domains = array_values(array_filter(explode(',', $site_domains)));
    $config
      ->set('track_enabled_base_fields', (bool) $form_state
      ->getValue('track_enabled_base_fields'))
      ->set('local_task_enabled_entity_types', array_values(array_filter($form_state
      ->getValue('local_task_enabled_entity_types')['entity_types'])))
      ->set('track_enabled_source_entity_types', array_values(array_filter($form_state
      ->getValue('track_enabled_source_entity_types')['entity_types'])))
      ->set('track_enabled_target_entity_types', array_values(array_filter($form_state
      ->getValue('track_enabled_target_entity_types')['entity_types'])))
      ->set('edit_warning_message_entity_types', array_values(array_filter($form_state
      ->getValue('edit_warning_message_entity_types')['entity_types'])))
      ->set('delete_warning_message_entity_types', array_values(array_filter($form_state
      ->getValue('delete_warning_message_entity_types')['entity_types'])))
      ->set('track_enabled_plugins', array_values(array_filter($form_state
      ->getValue('track_enabled_plugins')['plugins'])))
      ->set('site_domains', $site_domains)
      ->set('usage_controller_items_per_group', $form_state
      ->getValue('usage_controller_items_per_group'))
      ->save();
    if ($local_tasks_updated) {
      $this->routerBuilder
        ->rebuild();
      $this->cacheRender
        ->invalidateAll();
    }
    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
EntityUsageSettingsForm::$cacheRender	protected	property	The Cache Render.
EntityUsageSettingsForm::$entityTypeManager	protected	property	The Entity type manager.
EntityUsageSettingsForm::$routerBuilder	protected	property	The router builder.
EntityUsageSettingsForm::$usageTrackManager	protected	property	The Entity Usage Track Manager service.
EntityUsageSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
EntityUsageSettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
EntityUsageSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
EntityUsageSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
EntityUsageSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
EntityUsageSettingsForm::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase 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 EntityUsageSettingsForm in Entity Usage 8.3

Hierarchy

File

Namespace

Members

API Navigation