class UserNameItem

Same name in other branches
  1. 9 core/modules/user/src/UserNameItem.php \Drupal\user\UserNameItem
  2. 8.9.x core/modules/user/src/UserNameItem.php \Drupal\user\UserNameItem
  3. 11.x core/modules/user/src/UserNameItem.php \Drupal\user\UserNameItem

Defines a custom field item class for the 'name' user entity field.

Hierarchy

Expanded class hierarchy of UserNameItem

2 files declare their use of UserNameItem
EntityUser.php in core/modules/user/src/Plugin/migrate/destination/EntityUser.php
UserNameItemTest.php in core/modules/user/tests/src/Unit/UserNameItemTest.php

File

core/modules/user/src/UserNameItem.php, line 12

Namespace

Drupal\user
View source
class UserNameItem extends StringItem {
    
    /**
     * {@inheritdoc}
     */
    public function isEmpty() {
        $value = $this->get('value')
            ->getValue();
        // Take into account that the name of the anonymous user is an empty string.
        if ($this->getEntity()
            ->isAnonymous()) {
            return $value === NULL;
        }
        return $value === NULL || $value === '';
    }
    
    /**
     * {@inheritdoc}
     */
    public static function generateSampleValue(FieldDefinitionInterface $field_definition) {
        $random = new Random();
        $max_length = min(UserInterface::USERNAME_MAX_LENGTH, $field_definition->getSetting('max_length'));
        // Generate a list of words, which can be used to generate a string.
        $words = explode(' ', $random->sentences(8));
        // Begin with a username that is either 2 or 3 words.
        $count = mt_rand(2, 3);
        // Capitalize the words used in usernames 50% of the time.
        $words = mt_rand(0, 1) ? array_map('ucfirst', $words) : $words;
        // Username is a single long word 50% of the time. In the case of a single
        // long word, sometimes the generated username may also contain periods in
        // the middle of the username.
        $separator = ' ';
        if (mt_rand(0, 1)) {
            $separator = '';
            $count = mt_rand(2, 8);
            // The username will start with a capital letter 50% of the time.
            $words = mt_rand(0, 1) ? array_map('strtolower', $words) : $words;
        }
        $string = implode($separator, array_splice($words, 0, $count));
        // Normalize the string to not be longer than the maximum length, and to not
        // end with a space or a period.
        $values['value'] = rtrim(mb_substr($string, 0, $max_length), ' .');
        return $values;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FieldItemBase::calculateDependencies public static function Overrides FieldItemInterface::calculateDependencies 2
FieldItemBase::calculateStorageDependencies public static function Overrides FieldItemInterface::calculateStorageDependencies
FieldItemBase::defaultFieldSettings public static function Overrides FieldItemInterface::defaultFieldSettings 6
FieldItemBase::delete public function Overrides FieldItemInterface::delete 2
FieldItemBase::deleteRevision public function Overrides FieldItemInterface::deleteRevision
FieldItemBase::fieldSettingsForm public function Overrides FieldItemInterface::fieldSettingsForm 6
FieldItemBase::fieldSettingsFromConfigData public static function Overrides FieldItemInterface::fieldSettingsFromConfigData 1
FieldItemBase::fieldSettingsSummary public static function Overrides FieldItemInterface::fieldSettingsSummary
FieldItemBase::fieldSettingsToConfigData public static function Overrides FieldItemInterface::fieldSettingsToConfigData 1
FieldItemBase::getEntity public function Overrides FieldItemInterface::getEntity
FieldItemBase::getFieldDefinition public function Overrides FieldItemInterface::getFieldDefinition
FieldItemBase::getLangcode public function 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::mainPropertyName public static function Overrides FieldItemInterface::mainPropertyName 8
FieldItemBase::onDependencyRemoval public static function Overrides FieldItemInterface::onDependencyRemoval
FieldItemBase::postSave public function Overrides FieldItemInterface::postSave 2
FieldItemBase::preSave public function Overrides FieldItemInterface::preSave 6
FieldItemBase::setValue public function Overrides Map::setValue 3
FieldItemBase::storageSettingsFromConfigData public static function Overrides FieldItemInterface::storageSettingsFromConfigData 2
FieldItemBase::storageSettingsSummary public static function Overrides FieldItemInterface::storageSettingsSummary
FieldItemBase::storageSettingsToConfigData public static function Overrides FieldItemInterface::storageSettingsToConfigData 2
FieldItemBase::view public function 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 Overrides TypedData::__construct 2
FieldItemBase::__get public function Overrides FieldItemInterface::__get 2
FieldItemBase::__isset public function Overrides FieldItemInterface::__isset
FieldItemBase::__set public function Overrides FieldItemInterface::__set 1
FieldItemBase::__unset public function 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 Overrides TypedData::applyDefaultValue 4
Map::get public function Overrides ComplexDataInterface::get
Map::getIterator public function
Map::getProperties public function Overrides ComplexDataInterface::getProperties
Map::getString public function Overrides TypedData::getString
Map::getValue public function Overrides TypedData::getValue
Map::onChange public function Overrides TraversableTypedDataInterface::onChange 3
Map::set public function Overrides ComplexDataInterface::set
Map::toArray public function Overrides ComplexDataInterface::toArray 1
Map::__clone public function Magic method: Implements a deep clone.
StringItem::defaultStorageSettings public static function Overrides StringItemBase::defaultStorageSettings 2
StringItem::getConstraints public function Overrides TypedData::getConstraints
StringItem::schema public static function Overrides FieldItemInterface::schema 2
StringItem::storageSettingsForm public function Overrides FieldItemBase::storageSettingsForm
StringItemBase::propertyDefinitions public static function Overrides FieldItemInterface::propertyDefinitions 5
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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.
TypedData::$name protected property The property name.
TypedData::$parent protected property The parent typed data object.
TypedData::createInstance public static function Overrides TypedDataInterface::createInstance
TypedData::getDataDefinition public function Overrides TypedDataInterface::getDataDefinition
TypedData::getName public function Overrides TypedDataInterface::getName
TypedData::getParent public function Overrides TypedDataInterface::getParent
TypedData::getPluginDefinition public function Overrides PluginInspectionInterface::getPluginDefinition
TypedData::getPluginId public function Overrides PluginInspectionInterface::getPluginId
TypedData::getPropertyPath public function Overrides TypedDataInterface::getPropertyPath
TypedData::getRoot public function Overrides TypedDataInterface::getRoot
TypedData::setContext public function Overrides TypedDataInterface::setContext
TypedData::validate public function 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
UserNameItem::generateSampleValue public static function Overrides StringItem::generateSampleValue
UserNameItem::isEmpty public function Overrides StringItemBase::isEmpty

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.