class UserNameItem

Same name and namespace in other branches
  1. 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

File

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

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) {
    $values = parent::generateSampleValue($field_definition);
    // User names larger than 60 characters won't pass validation.
    $values['value'] = substr($values['value'], 0, UserInterface::USERNAME_MAX_LENGTH);
    return $values;
  }

}

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