class NameItem in Name Field 8

Same name in this branch

8 src/Plugin/Field/FieldType/NameItem.php \Drupal\name\Plugin\Field\FieldType\NameItem
8 src/Plugin/migrate/cckfield/NameItem.php \Drupal\name\Plugin\migrate\cckfield\NameItem

Plugin implementation of the 'name' field type.

Majority of the settings handling is delegated to the traits so that these can be reused.

Plugin annotation


@FieldType(
  id = "name",
  label = @Translation("Name"),
  description = @Translation("Stores real name."),
  default_widget = "name_default",
  default_formatter = "name_default"
)

Hierarchy

class \Drupal\Core\TypedData\TypedData implements PluginInspectionInterface, TypedDataInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
- class \Drupal\Core\TypedData\Plugin\DataType\Map implements \Drupal\Core\TypedData\Plugin\DataType\IteratorAggregate, ComplexDataInterface
  - class \Drupal\Core\Field\FieldItemBase implements FieldItemInterface
    class \Drupal\name\Plugin\Field\FieldType\NameItem implements TrustedCallbackInterface uses NameAdditionalPreferredTrait, NameFieldSettingsTrait, NameFormDisplaySettingsTrait, NameFormSettingsHelperTrait

Expanded class hierarchy of NameItem

File

src/Plugin/Field/FieldType/NameItem.php, line 33

Namespace

Drupal\name\Plugin\Field\FieldType

View source

class NameItem extends FieldItemBase implements TrustedCallbackInterface {
  use NameFieldSettingsTrait;
  use NameFormDisplaySettingsTrait;
  use NameFormSettingsHelperTrait;
  use NameAdditionalPreferredTrait;

  /**
   * Definition of name field components.
   *
   * @var array
   */
  protected static $components = [
    'title',
    'given',
    'middle',
    'family',
    'generational',
    'credentials',
  ];

  /**
   * {@inheritdoc}
   */
  public static function trustedCallbacks() {
    return [
      'fieldSettingsFormPreRender',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function schema(FieldStorageDefinitionInterface $field_definition) {
    $columns = [];
    foreach (static::$components as $key) {
      $columns[$key] = [
        'type' => 'varchar',
        'length' => 255,
        'not null' => FALSE,
      ];
    }
    return [
      'columns' => $columns,
      'indexes' => [
        'given' => [
          'given',
        ],
        'family' => [
          'family',
        ],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultFieldSettings() {
    $settings = self::getDefaultNameFieldSettings();
    $settings += self::getDefaultNameFormDisplaySettings();
    $settings += self::getDefaultAdditionalPreferredSettings();
    $settings['override_format'] = 'default';
    return $settings + parent::defaultFieldSettings();
  }

  /**
   * {@inheritdoc}
   */
  public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
    $properties = [];
    $properties['title'] = DataDefinition::create('string')
      ->setLabel(t('Title'));
    $properties['given'] = DataDefinition::create('string')
      ->setLabel(t('Given'));
    $properties['middle'] = DataDefinition::create('string')
      ->setLabel(t('Middle name(s)'));
    $properties['family'] = DataDefinition::create('string')
      ->setLabel(t('Family'));
    $properties['generational'] = DataDefinition::create('string')
      ->setLabel(t('Generational'));
    $properties['credentials'] = DataDefinition::create('string')
      ->setLabel(t('Credentials'));
    return $properties;
  }

  /**
   * {@inheritdoc}
   */
  public static function mainPropertyName() {

    // There is no main property for this field item.
    return NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function isEmpty() {
    foreach ($this->properties as $property) {
      $definition = $property
        ->getDataDefinition();
      if (!$definition
        ->isComputed() && $property
        ->getValue() !== NULL) {
        return FALSE;
      }
    }
    if (isset($this->values)) {
      foreach ($this->values as $name => $value) {

        // Title & generational have no meaning by themselves.
        if ($name == 'title' || $name == 'generational') {
          continue;
        }
        if (isset($value) && strlen($value) && !isset($this->properties[$name])) {
          return FALSE;
        }
      }
    }
    return TRUE;
  }

  /**
   * Returns active components only.
   *
   * @return array
   *   Array of filtered name component values.
   */
  public function filteredArray() {
    $values = [];
    $field = $this
      ->getFieldDefinition();
    $settings = $field
      ->getSettings();
    $active_components = array_filter($settings['components']);
    foreach ($this
      ->getProperties() as $name => $property) {
      if (isset($active_components[$name]) && $active_components[$name]) {
        $values[$name] = $property
          ->getValue();
      }
    }
    return $values;
  }

  /**
   * Get a list of active components.
   *
   * @return array
   *   Keyed array of active component labels.
   */
  public function activeComponents() {
    $settings = $this
      ->getFieldDefinition()
      ->getSettings();
    $components = [];
    foreach (_name_translations() as $key => $label) {
      if (!empty($settings['components'][$key])) {
        $components[$key] = empty($settings['labels'][$key]) ? $label : $settings['labels'][$key];
      }
    }
    return $components;
  }

  /**
   * {@inheritdoc}
   */
  public function fieldSettingsForm(array $form, FormStateInterface $form_state) {
    $settings = $this
      ->getSettings();
    $element = $this
      ->getDefaultNameFieldSettingsForm($settings, $form, $form_state);
    $element += $this
      ->getDefaultNameFormDisplaySettingsForm($settings, $form, $form_state);
    foreach ($this
      ->getNameAdditionalPreferredSettingsForm($form, $form_state) as $key => $value) {
      $element[$key] = $value;
      $element[$key]['#table_group'] = 'none';
      $element[$key]['#weight'] = 50;
    }
    $element['#pre_render'][] = [
      $this,
      'fieldSettingsFormPreRender',
    ];

    // Add the overwrite user name option.
    if ($this
      ->getFieldDefinition()
      ->getTargetEntityTypeId() == 'user') {
      $preferred_field = \Drupal::config('name.settings')
        ->get('user_preferred');
      $element['name_user_preferred'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t("Use this field to override the user's login name?"),
        '#description' => $this
          ->t('You may need to clear the @cache_link before this change is seen everywhere.', [
          '@cache_link' => Link::fromTextAndUrl('Performance cache', Url::fromRoute('system.performance_settings'))
            ->toString(),
        ]),
        '#default_value' => $preferred_field == $this
          ->getFieldDefinition()
          ->getName() ? 1 : 0,
        '#table_group' => 'above',
        '#weight' => -100,
      ];

      // Store the machine name of the Name field.
      $element['name_user_preferred_fieldname'] = [
        '#type' => 'hidden',
        '#default_value' => $this
          ->getFieldDefinition()
          ->getName(),
        '#table_group' => 'above',
        '#weight' => -99,
      ];
      $element['override_format'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('User name override format to use'),
        '#default_value' => $this
          ->getSetting('override_format'),
        '#options' => name_get_custom_format_options(),
        '#table_group' => 'above',
        '#weight' => -98,
      ];
      $element['#element_validate'] = [
        [
          get_class($this),
          'validateUserPreferred',
        ],
      ];
    }
    else {

      // We may extend this feature to Profile2 latter.
      $element['override_format'] = [
        '#type' => 'value',
        '#value' => $this
          ->getSetting('override_format'),
        '#table_group' => 'none',
      ];
    }
    return $element;
  }

  /**
   * Manage whether the name field should override a user's login name.
   */
  public static function validateUserPreferred(&$element, FormStateInterface $form_state, &$complete_form) {
    $value = NULL;
    $config = \Drupal::configFactory()
      ->getEditable('name.settings');

    // Ensure the name field value should override a user's login name.
    if (!empty($element['name_user_preferred']) && $element['name_user_preferred']['#value'] == 1) {

      // Retrieve the name field's machine name.
      $value = $element['name_user_preferred_fieldname']['#default_value'];
    }

    // Ensure that the login-name-override configuration has changed.
    if ($config
      ->get('user_preferred') != $value) {

      // Update the configuration with the new value.
      $config
        ->set('user_preferred', $value)
        ->save();

      // Retrieve the ID of all existing users.
      $query = \Drupal::entityQuery('user');
      $uids = $query
        ->execute();
      foreach ($uids as $uid) {

        // Invalidate the cache for each user so that
        // the appropriate login name will be displayed.
        Cache::invalidateTags([
          'user:' . $uid,
        ]);
      }
      \Drupal::logger('name')
        ->notice('Cache cleared for data tagged as %tag.', [
        '%tag' => 'user:{$uid}',
      ]);
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function generateSampleValue(FieldDefinitionInterface $field_definition) {

    // Single reused generation of 100 random names.
    $names =& drupal_static(__FUNCTION__, []);
    if (empty($names)) {
      $names = \Drupal::service('name.generator')
        ->generateSampleNames(100, $field_definition);
    }
    return $names[array_rand($names)];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
FieldItemBase::calculateDependencies	public static	function	Calculates dependencies for field items. Overrides FieldItemInterface::calculateDependencies	2
FieldItemBase::calculateStorageDependencies	public static	function	Calculates dependencies for field items on the storage level. Overrides FieldItemInterface::calculateStorageDependencies	1
FieldItemBase::defaultStorageSettings	public static	function	Defines the storage-level settings for this plugin. Overrides FieldItemInterface::defaultStorageSettings	10
FieldItemBase::delete	public	function	Defines custom delete behavior for field values. Overrides FieldItemInterface::delete	2
FieldItemBase::deleteRevision	public	function	Defines custom revision delete behavior for field values. Overrides FieldItemInterface::deleteRevision
FieldItemBase::fieldSettingsFromConfigData	public static	function	Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface::fieldSettingsFromConfigData	1
FieldItemBase::fieldSettingsToConfigData	public static	function	Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface::fieldSettingsToConfigData	1
FieldItemBase::getEntity	public	function	Gets the entity that field belongs to. Overrides FieldItemInterface::getEntity
FieldItemBase::getFieldDefinition	public	function	Gets the field definition. Overrides FieldItemInterface::getFieldDefinition
FieldItemBase::getLangcode	public	function	Gets the langcode of the field values held in the object. Overrides FieldItemInterface::getLangcode
FieldItemBase::getSetting	protected	function	Returns the value of a field setting.
FieldItemBase::getSettings	protected	function	Returns the array of field settings.
FieldItemBase::onDependencyRemoval	public static	function	Informs the plugin that a dependency of the field will be deleted. Overrides FieldItemInterface::onDependencyRemoval	1
FieldItemBase::postSave	public	function	Defines custom post-save behavior for field values. Overrides FieldItemInterface::postSave	2
FieldItemBase::preSave	public	function	Defines custom presave behavior for field values. Overrides FieldItemInterface::preSave	7
FieldItemBase::setValue	public	function	Sets the data value. Overrides Map::setValue	4
FieldItemBase::storageSettingsForm	public	function	Returns a form for the storage-level settings. Overrides FieldItemInterface::storageSettingsForm	8
FieldItemBase::storageSettingsFromConfigData	public static	function	Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface::storageSettingsFromConfigData	2
FieldItemBase::storageSettingsToConfigData	public static	function	Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface::storageSettingsToConfigData	2
FieldItemBase::view	public	function	Returns a renderable array for a single field item. Overrides FieldItemInterface::view
FieldItemBase::writePropertyValue	protected	function	Different to the parent Map class, we avoid creating property objects as far as possible in order to optimize performance. Thus we just update $this->values if no property object has been created yet. Overrides Map::writePropertyValue
FieldItemBase::__construct	public	function	Constructs a TypedData object given its definition and context. Overrides TypedData::__construct	1
FieldItemBase::__get	public	function	Magic method: Gets a property value. Overrides FieldItemInterface::__get	2
FieldItemBase::__isset	public	function	Magic method: Determines whether a property is set. Overrides FieldItemInterface::__isset
FieldItemBase::__set	public	function	Magic method: Sets a property value. Overrides FieldItemInterface::__set	1
FieldItemBase::__unset	public	function	Magic method: Unsets a property. Overrides FieldItemInterface::__unset
Map::$definition	protected	property	The data definition. Overrides TypedData::$definition
Map::$properties	protected	property	The array of properties.
Map::$values	protected	property	An array of values for the contained properties.
Map::applyDefaultValue	public	function	Applies the default value. Overrides TypedData::applyDefaultValue	4
Map::get	public	function	Gets a property object. Overrides ComplexDataInterface::get
Map::getIterator	public	function
Map::getProperties	public	function	Gets an array of property objects. Overrides ComplexDataInterface::getProperties
Map::getString	public	function	Returns a string representation of the data. Overrides TypedData::getString
Map::getValue	public	function	Gets the data value. Overrides TypedData::getValue	1
Map::onChange	public	function	Overrides TraversableTypedDataInterface::onChange	4
Map::set	public	function	Sets a property value. Overrides ComplexDataInterface::set
Map::toArray	public	function	Returns an array of all property values. Overrides ComplexDataInterface::toArray	1
Map::__clone	public	function	Magic method: Implements a deep clone.
NameAdditionalPreferredTrait::getAdditionalSources	protected	function	Helper function to find attached fields to use as alternative sources.
NameAdditionalPreferredTrait::getDefaultAdditionalPreferredSettings	protected static	function	Gets the default settings for alternative and preferred fields.
NameAdditionalPreferredTrait::getEmptyOption	protected	function
NameAdditionalPreferredTrait::getNameAdditionalPreferredSettingsForm	protected	function	Returns a form for the default settings defined above.
NameAdditionalPreferredTrait::getTraitUsageIsField	protected	function
NameAdditionalPreferredTrait::settingsNameAdditionalPreferredSummary	protected	function
NameFieldSettingsTrait::getDefaultNameFieldSettings	protected static	function	Gets the default settings for controlling a name element.
NameFieldSettingsTrait::getDefaultNameFieldSettingsForm	protected	function	Returns a form for the default settings defined above.
NameFieldSettingsTrait::validateGenerationalOptions	public static	function	Helper function to validate minimum components.
NameFieldSettingsTrait::validateMinimumComponents	public static	function	Helper function to validate minimum components.
NameFieldSettingsTrait::validateTitleOptions	public static	function	Helper function to validate minimum components.
NameFormDisplaySettingsTrait::getDefaultNameFormDisplaySettings	protected static	function	Gets the default settings for controlling a name element.
NameFormDisplaySettingsTrait::getDefaultNameFormDisplaySettingsForm	protected	function	Returns a form for the default settings defined above.
NameFormSettingsHelperTrait::extractAllowedValues	protected static	function	Helper function to get the allowed values.
NameFormSettingsHelperTrait::fieldSettingsFormPreRender	public	function	Themes up the field settings into a table.
NameFormSettingsHelperTrait::validateOptions	protected static	function	Helper function to validate minimum components.
NameItem::$components	protected static	property	Definition of name field components.
NameItem::activeComponents	public	function	Get a list of active components.
NameItem::defaultFieldSettings	public static	function	Defines the field-level settings for this plugin. Overrides FieldItemBase::defaultFieldSettings
NameItem::fieldSettingsForm	public	function	Returns a form for the field-level settings. Overrides FieldItemBase::fieldSettingsForm
NameItem::filteredArray	public	function	Returns active components only.
NameItem::generateSampleValue	public static	function	Generates placeholder field values. Overrides FieldItemBase::generateSampleValue
NameItem::isEmpty	public	function	Determines whether the data structure is empty. Overrides Map::isEmpty
NameItem::mainPropertyName	public static	function	Returns the name of the main property, if any. Overrides FieldItemBase::mainPropertyName
NameItem::propertyDefinitions	public static	function	Defines field item properties. Overrides FieldItemInterface::propertyDefinitions
NameItem::schema	public static	function	Returns the schema for the field. Overrides FieldItemInterface::schema
NameItem::trustedCallbacks	public static	function	Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks
NameItem::validateUserPreferred	public static	function	Manage whether the name field should override a user's login name.
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.
TrustedCallbackInterface::THROW_EXCEPTION		constant	Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION		constant	Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING		constant	Untrusted callbacks trigger E_USER_WARNING errors.
TypedData::$name	protected	property	The property name.
TypedData::$parent	protected	property	The parent typed data object.
TypedData::createInstance	public static	function	Constructs a TypedData object given its definition and context. Overrides TypedDataInterface::createInstance
TypedData::getConstraints	public	function	Gets a list of validation constraints. Overrides TypedDataInterface::getConstraints	9
TypedData::getDataDefinition	public	function	Gets the data definition. Overrides TypedDataInterface::getDataDefinition
TypedData::getName	public	function	Returns the name of a property or item. Overrides TypedDataInterface::getName
TypedData::getParent	public	function	Returns the parent data structure; i.e. either complex data or a list. Overrides TypedDataInterface::getParent
TypedData::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
TypedData::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
TypedData::getPropertyPath	public	function	Returns the property path of the data. Overrides TypedDataInterface::getPropertyPath
TypedData::getRoot	public	function	Returns the root of the typed data tree. Overrides TypedDataInterface::getRoot
TypedData::setContext	public	function	Sets the context of a property or item via a context aware parent. Overrides TypedDataInterface::setContext
TypedData::validate	public	function	Validates the currently set data value. Overrides TypedDataInterface::validate
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	2
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	2

You are here

class NameItem in Name Field 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation