class EntityTestUuidId

Defines a test entity class with UUIDs as IDs.

Plugin annotation

@ContentEntityType(
  id = "entity_test_uuid_id",
  label = @Translation("Test entity with UUIDs as IDs"),
  handlers = {
    "access" = "Drupal\entity_test\EntityTestAccessControlHandler",
    "form" = {
      "default" = "Drupal\entity_test\EntityTestForm"
    },
    "route_provider" = {
      "html" = "Drupal\Core\Entity\Routing\DefaultHtmlRouteProvider",
    },
  },
  translatable = TRUE,
  base_table = "entity_test_uuid_id",
  data_table = "entity_test_uuid_id_data",
  admin_permission = "administer entity_test content",
  entity_keys = {
    "id" = "uuid",
    "uuid" = "uuid",
    "bundle" = "type",
    "langcode" = "langcode",
    "label" = "name",
  },
  links = {
    "canonical" = "/entity_test_uuid_id/manage/{entity_test_uuid_id}",
    "add-form" = "/entity_test_uuid_id/add",
    "edit-form" = "/entity_test_uuid_id/manage/{entity_test_uuid_id}/edit",
  },
)

Hierarchy

• class \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Entity\EntityInterface uses \Drupal\Core\Cache\RefinableCacheableDependencyTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait
  • class \Drupal\Core\Entity\ContentEntityBase extends \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Entity\IteratorAggregate, \Drupal\Core\Entity\ContentEntityInterface, \Drupal\Core\TypedData\TranslationStatusInterface uses \Drupal\Core\Entity\EntityChangesDetectionTrait, \Drupal\Core\Entity\SynchronizableEntityTrait
    • class \Drupal\entity_test\Entity\EntityTest extends \Drupal\Core\Entity\ContentEntityBase implements \Drupal\user\EntityOwnerInterface
      • class \Drupal\entity_test\Entity\EntityTestUuidId extends \Drupal\entity_test\Entity\EntityTest

Expanded class hierarchy of EntityTestUuidId

File

core/modules/system/tests/modules/entity_test/src/Entity/EntityTestUuidId.php, line 45

Namespace

class EntityTestUuidId extends EntityTest {
    
    /**
     * {@inheritdoc}
     */
    public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
        $fields = parent::baseFieldDefinitions($entity_type);
        // Configure a string field to match the UUID field configuration and use it
        // for both the ID and the UUID key. The UUID field type cannot be used
        // because it would add a unique key to the data table.
        $fields[$entity_type->getKey('uuid')] = BaseFieldDefinition::create('string')->setLabel(new TranslatableMarkup('UUID'))
            ->setSetting('max_length', 128)
            ->setSetting('is_ascii', TRUE)
            ->setDefaultValueCallback(static::class . '::generateUuid');
        return $fields;
    }
    
    /**
     * Statically generates a UUID.
     *
     * @return string
     *   A newly generated UUID.
     */
    public static function generateUuid() : string {
        $uuid = \Drupal::service('uuid');
        assert($uuid instanceof UuidInterface);
        return $uuid->generate();
    }

}