You are here

Home » API reference » Profile 8 » ProfileFormWidget.php

class ProfileFormWidget in Profile 8

Plugin implementation of the 'profile_form' widget.

Plugin annotation


@FieldWidget(
  id = "profile_form",
  label = @Translation("Profile form"),
  field_types = {
    "entity_reference"
  }
)

Hierarchy

Expanded class hierarchy of ProfileFormWidget

File

src/Plugin/Field/FieldWidget/ProfileFormWidget.php, line 28

Namespace

Drupal\profile\Plugin\Field\FieldWidget
View source 
class ProfileFormWidget extends WidgetBase implements ContainerFactoryPluginInterface {

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

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

  /**
   * The entity display repository.
   *
   * @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface
   */
  protected $entityDisplayRepository;

  /**
   * Constructs a new ProfileFormWidget object.
   *
   * @param string $plugin_id
   *   The plugin_id for the widget.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the widget is associated.
   * @param array $settings
   *   The widget settings.
   * @param array $third_party_settings
   *   Any third party settings.
   * @param \Drupal\core\Entity\EntityFieldManagerInterface $entity_field_manager
   *   The entity field manager.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Entity\EntityDisplayRepositoryInterface $entity_display_repository
   *   The entity display repository.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, array $third_party_settings, EntityFieldManagerInterface $entity_field_manager, EntityTypeManagerInterface $entity_type_manager, EntityDisplayRepositoryInterface $entity_display_repository) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $third_party_settings);
    $this->entityFieldManager = $entity_field_manager;
    $this->entityTypeManager = $entity_type_manager;
    $this->entityDisplayRepository = $entity_display_repository;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['third_party_settings'], $container
      ->get('entity_field.manager'), $container
      ->get('entity_type.manager'), $container
      ->get('entity_display.repository'));
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'form_mode' => 'default',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form_modes = $this->entityDisplayRepository
      ->getFormModeOptions($this
      ->getFieldSetting('target_type'));
    $element['form_mode'] = [
      '#type' => 'select',
      '#options' => $form_modes,
      '#title' => $this
        ->t('Form mode'),
      '#default_value' => $this
        ->getSetting('form_mode'),
      '#required' => TRUE,
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $form_modes = $this->entityDisplayRepository
      ->getFormModeOptions($this
      ->getFieldSetting('target_type'));
    $form_mode = $this
      ->getSetting('form_mode');
    $form_mode = isset($form_modes[$form_mode]) ? $form_modes[$form_mode] : $form_mode;
    $summary = [];
    $summary[] = $this
      ->t('Form mode: @mode', [
      '@mode' => $form_mode,
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function form(FieldItemListInterface $items, array &$form, FormStateInterface $form_state, $get_delta = NULL) {

    // Do not allow this widget to be used as a default value widget.
    if ($this
      ->isDefaultValueWidget($form_state)) {
      return [];
    }
    return parent::form($items, $form, $form_state, $get_delta);
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {

    /** @var \Drupal\user\UserInterface $account */
    $account = $items
      ->getEntity();

    /** @var \Drupal\profile\ProfileStorageInterface $profile_storage */
    $profile_storage = $this->entityTypeManager
      ->getStorage('profile');
    $profile_type_storage = $this->entityTypeManager
      ->getStorage('profile_type');

    /** @var \Drupal\profile\Entity\ProfileTypeInterface $profile_type */
    $profile_type = $profile_type_storage
      ->load($this
      ->getFieldSetting('profile_type'));
    $property = [
      'profiles',
      $profile_type
        ->id(),
    ];
    $profile = $form_state
      ->get($property);
    if (!$profile) {
      if (!$account
        ->isAnonymous()) {
        $profile = $profile_storage
          ->loadByUser($account, $profile_type
          ->id());
      }
      if (!$profile) {
        $profile = $profile_storage
          ->create([
          'type' => $profile_type
            ->id(),
        ]);
      }
      $form_state
        ->set($property, $profile);
    }

    // Adding/editing profiles for existing users needs to respect access.
    if (!$account
      ->isNew()) {
      $access_control_handler = $this->entityTypeManager
        ->getAccessControlHandler('profile');
      if ($profile
        ->isNew()) {
        $access = $access_control_handler
          ->createAccess($profile_type
          ->id(), NULL, [
          'profile_owner' => $account,
        ]);
      }
      else {
        $access = $access_control_handler
          ->access($profile, 'update');
      }
      if (!$access) {
        $element['#access'] = FALSE;
        return $element;
      }
    }
    $element = [
      '#type' => 'details',
      '#description' => '',
      '#open' => TRUE,
      // Remove the "required" clue, it's display-only and confusing.
      '#required' => FALSE,
      '#field_title' => $profile_type
        ->getDisplayLabel() ?: $profile_type
        ->label(),
      '#after_build' => [
        [
          get_class($this),
          'removeTranslatabilityClue',
        ],
      ],
    ] + $element;
    $form_mode = $this
      ->getSetting('form_mode');
    $element['entity'] = [
      '#parents' => array_merge($element['#field_parents'], [
        $items
          ->getName(),
        $delta,
        'entity',
      ]),
      '#bundle' => $profile
        ->bundle(),
      '#element_validate' => [
        [
          get_class($this),
          'validateProfileForm',
        ],
      ],
      '#form_mode' => $form_mode,
    ];
    if (function_exists('field_group_attach_groups')) {
      $context = [
        'entity_type' => $profile
          ->getEntityTypeId(),
        'bundle' => $profile
          ->bundle(),
        'entity' => $profile,
        'context' => 'form',
        'display_context' => 'form',
        'mode' => $form_mode,
      ];
      field_group_attach_groups($element['entity'], $context);
      $element['entity']['#process'][] = 'field_group_form_process';
    }
    $form_display = EntityFormDisplay::collectRenderDisplay($profile, $form_mode);
    $form_display
      ->removeComponent('revision_log_message');
    $form_display
      ->buildForm($profile, $element['entity'], $form_state);
    $form_process_callback = [
      get_class($this),
      'attachSubmit',
    ];

    // Make sure the #process callback doesn't get added more than once
    // if the widget is used on multiple fields.
    if (!isset($form['#process']) || !in_array($form_process_callback, $form['#process'])) {
      $form['#process'][] = [
        get_class($this),
        'attachSubmit',
      ];
    }
    return $element;
  }

  /**
   * After-build callback for removing the translatability clue from the widget.
   *
   * @see ContentTranslationHandler::addTranslatabilityClue()
   */
  public static function removeTranslatabilityClue(array $element, FormStateInterface $form_state) {
    $element['#title'] = $element['#field_title'];
    return $element;
  }

  /**
   * Process callback: Adds the widget's submit handler.
   */
  public static function attachSubmit(array $form, FormStateInterface $form_state) {
    $form['actions']['submit']['#submit'][] = [
      static::class,
      'saveProfiles',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function extractFormValues(FieldItemListInterface $items, array $form, FormStateInterface $form_state) {
    if ($this
      ->isDefaultValueWidget($form_state)) {
      $items
        ->filterEmptyItems();
      return;
    }
    $property = [
      'profiles',
      $this
        ->getFieldSetting('profile_type'),
    ];
    $profile = $form_state
      ->get($property);
    if (!empty($profile)) {
      $values = [
        [
          'entity' => $profile,
        ],
      ];
      $items
        ->setValue($values);
      $items
        ->filterEmptyItems();
    }
  }

  /**
   * Validates the profile form.
   *
   * @param array $element
   *   The profile form element.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public static function validateProfileForm(array &$element, FormStateInterface $form_state) {

    /** @var \Drupal\profile\Entity\ProfileInterface $profile */
    $property = [
      'profiles',
      $element['#bundle'],
    ];
    $profile = $form_state
      ->get($property);
    if (!empty($profile)) {
      assert($profile instanceof ProfileInterface);
      $form_display = EntityFormDisplay::collectRenderDisplay($profile, $element['#form_mode']);
      $form_display
        ->extractFormValues($profile, $element, $form_state);
      $form_display
        ->validateFormValues($profile, $element, $form_state);
    }
  }

  /**
   * Completes and saves all profiles.
   *
   * @param array $form
   *   The complete form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public static function saveProfiles(array $form, FormStateInterface $form_state) {

    /** @var \Drupal\Core\Session\AccountInterface $account */
    $account = $form_state
      ->getFormObject()
      ->getEntity();
    if (!$account) {
      return;
    }
    $profiles = $form_state
      ->get('profiles');
    foreach ($profiles as $profile) {
      assert($profile instanceof ProfileInterface);
      $profile
        ->setOwnerId($account
        ->id());
      $profile
        ->setPublished();
      $profile
        ->save();
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) {
    $entity_type = $field_definition
      ->getTargetEntityTypeId();
    return $entity_type == 'user' && $field_definition
      ->getSetting('target_type') == 'profile' && $field_definition
      ->isComputed();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AllowedTagsXssTrait::allowedTags public function Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss().
AllowedTagsXssTrait::displayAllowedTags public function Returns a human-readable list of allowed tags for display in help texts.
AllowedTagsXssTrait::fieldFilterXss public function Filters an HTML string to prevent XSS vulnerabilities.
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
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ProfileFormWidget::$entityDisplayRepository protected property The entity display repository.
ProfileFormWidget::$entityFieldManager protected property The entity field manager.
ProfileFormWidget::$entityTypeManager protected property The entity type manager.
ProfileFormWidget::attachSubmit public static function Process callback: Adds the widget's submit handler.
ProfileFormWidget::create public static function Creates an instance of the plugin. Overrides WidgetBase::create
ProfileFormWidget::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
ProfileFormWidget::extractFormValues public function Extracts field values from submitted form values. Overrides WidgetBase::extractFormValues
ProfileFormWidget::form public function Creates a form element for a field. Overrides WidgetBase::form
ProfileFormWidget::formElement public function Returns the form for a single field widget. Overrides WidgetInterface::formElement
ProfileFormWidget::isApplicable public static function Returns if the widget can be used for the provided field. Overrides WidgetBase::isApplicable
ProfileFormWidget::removeTranslatabilityClue public static function After-build callback for removing the translatability clue from the widget.
ProfileFormWidget::saveProfiles public static function Completes and saves all profiles.
ProfileFormWidget::settingsForm public function Returns a form to configure settings for the widget. Overrides WidgetBase::settingsForm
ProfileFormWidget::settingsSummary public function Returns a short summary for the current widget settings. Overrides WidgetBase::settingsSummary
ProfileFormWidget::validateProfileForm public static function Validates the profile form.
ProfileFormWidget::__construct public function Constructs a new ProfileFormWidget object. Overrides WidgetBase::__construct
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.
WidgetBase::$fieldDefinition protected property The field definition.
WidgetBase::$settings protected property The widget settings. Overrides PluginSettingsBase::$settings
WidgetBase::addMoreAjax public static function Ajax callback for the "Add another item" button.
WidgetBase::addMoreSubmit public static function Submission handler for the "Add another item" button.
WidgetBase::afterBuild public static function After-build handler for field elements in a form.
WidgetBase::errorElement public function Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement 8
WidgetBase::flagErrors public function Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface::flagErrors 2
WidgetBase::formMultipleElements protected function Special handling to create form elements for multiple values. 1
WidgetBase::formSingleElement protected function Generates the form element for a single copy of the widget.
WidgetBase::getFieldSetting protected function Returns the value of a field setting.
WidgetBase::getFieldSettings protected function Returns the array of field settings.
WidgetBase::getFilteredDescription protected function Returns the filtered field description.
WidgetBase::getWidgetState public static function Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface::getWidgetState
WidgetBase::getWidgetStateParents protected static function Returns the location of processing information within $form_state.
WidgetBase::handlesMultipleValues protected function Returns whether the widget handles multiple values.
WidgetBase::isDefaultValueWidget protected function Returns whether the widget used for default value form.
WidgetBase::massageFormValues public function Massages the form values into the format expected for field values. Overrides WidgetInterface::massageFormValues 7
WidgetBase::setWidgetState public static function Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState