class BulkUpdateExcludeForm in Bulk Update Fields 8.2

Class BulkUpdateExcludeForm.

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\bulk_update_fields\Form\BulkUpdateExcludeForm

Expanded class hierarchy of BulkUpdateExcludeForm

1 string reference to 'BulkUpdateExcludeForm'

bulk_update_fields.routing.yml in ./bulk_update_fields.routing.yml: bulk_update_fields.routing.yml

File

src/Form/BulkUpdateExcludeForm.php, line 15

Namespace

Drupal\bulk_update_fields\Form

View source

class BulkUpdateExcludeForm extends ConfigFormBase {

  /**
   * EntityFieldManager.
   *
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  private $entityFieldManager;

  /**
   * EntityTypeBundleInfo.
   *
   * @var \Drupal\Core\Entity\EntityTypeBundleInfo
   */
  private $entityTypeBundleInfo;

  /**
   * EntityTypeManager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  private $entityTypeManager;

  /**
   * Constructor.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entityTypeManager.
   * @param \Drupal\Core\Entity\EntityTypeBundleInfo $entity_type_bundle_info
   *   The EntityTypeBundleInfo.
   * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager
   *   The EntityFieldManagerInterface.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, EntityTypeBundleInfo $entity_type_bundle_info, EntityFieldManagerInterface $entity_field_manager) {
    $this->entityTypeManager = $entity_type_manager;
    $this->entityTypeBundleInfo = $entity_type_bundle_info;
    $this->entityFieldManager = $entity_field_manager;
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('bulk_update_fields.settings');
    $excluded_base_fields = [
      'nid',
      'uuid',
      'vid',
      'type',
      'revision_uid',
      'title',
      'menu_link',
      'status',
      'uid',
      'default_langcode',
      'revision_timestamp',
      'revision_log',
      'created',
      'changed',
      'pass',
      'name',
      'mail',
      'init',
    ];
    $options = [];
    $bundles = $this
      ->getFields('node');
    foreach ($bundles as $bundle) {
      foreach ($bundle as $field) {
        if (!in_array($field
          ->getName(), $excluded_base_fields) && !isset($options[$field
          ->getName()])) {
          $options[$field
            ->getName()]['field_name'] = $field
            ->getLabel() . ' (' . $field
            ->getName() . ')';
        }
      }
    }
    $header = [
      'field_name' => $this
        ->t('Field Name'),
    ];
    $form['table'] = [
      '#type' => 'tableselect',
      '#header' => $header,
      '#options' => $options,
      '#default_value' => $config
        ->get('exclude') ? $config
        ->get('exclude') : '',
      '#empty' => $this
        ->t('No fields found'),
    ];
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Submit'),
    ];
    return $form;
  }

  /**
   * Get All fields.
   *
   * @param string $entity_type_id
   *   Entity type id.
   *
   * @return array
   *   Return all fields.
   */
  protected function getFields($entity_type_id) {

    // Get all bundles.
    $bundles = $this->entityTypeBundleInfo
      ->getBundleInfo($entity_type_id);
    foreach ($bundles as $k => $bundle) {
      $fields[$k] = $this->entityFieldManager
        ->getFieldDefinitions($entity_type_id, $k);
    }
    return $fields;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('bulk_update_fields.settings')
      ->set('exclude', $form_state
      ->getValue('table'))
      ->save();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BulkUpdateExcludeForm::$entityFieldManager	private	property	EntityFieldManager.
BulkUpdateExcludeForm::$entityTypeBundleInfo	private	property	EntityTypeBundleInfo.
BulkUpdateExcludeForm::$entityTypeManager	private	property	EntityTypeManager.
BulkUpdateExcludeForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
BulkUpdateExcludeForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
BulkUpdateExcludeForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
BulkUpdateExcludeForm::getFields	protected	function	Get All fields.
BulkUpdateExcludeForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
BulkUpdateExcludeForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
BulkUpdateExcludeForm::__construct	public	function	Constructor. 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.
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 BulkUpdateExcludeForm in Bulk Update Fields 8.2

Hierarchy

File

Namespace

Members

API Navigation