Presentación sobre Entidades en Drupal 8 realizada por Luis Ortiz Ramos en la Drupal Camp Spain 2017

1. Entidades en Drupal 8
DrupalCamp Spain 2017

2. Luis Ortiz Ramos
CTO de Atenea tech
luis@ateneatech.com
@luisortizramos

4. Somos expertos en Drupal desde 2007
Somos Siddharta, Oriol, Robert, David, Patricia, Xavi, Rubén y Luis.
Trabajamos para La Vanguardia, Thermomix, Ayuntamiento de Barcelona,
Bodegas Torres, Clínica Dexeus, Amnistía Internacional, Médicos Sin
Fronteras, Infojobs, Estrella Damm, Greenpeace, Chupa Chups, la CUP…
Estamos en Barcelona
Puedes contactar con nosotros en hola@ateneatech.com

6. Dos tipos de entidades

7. Configuration entities:
Views, Blocks, Image styles, Menus, Rols…
Forman parte de CMI
Se exportan en archivos Yaml
Content entities

8. Historia

9. Drupal 3 y anteriores: solo nodos
Drupal 4: flexinode
Drupal 5: nodos con campos con Content Construction Kit
Drupal 6: nodificamos todo con módulos contribuidos y añadimos campos con
Content Construction Kit
Drupal 7: entidades limitadas en core
Drupal 8: ¡entidades completas en core!

10. ¿Qué es una entidad?

11. “Entities, in Drupal, are objects that are used for persistent storage of content and
configuration information.”
̶ Entity API

12. “Loadable thingy, that can optionally be fieldable”
̶ Frando http://dgo.to/460320

13. Así que… ¿qué es una entidad?

14. A thingy …
Una unidad de información estructurada:
Un contenido
Un usuario
Un término de un vocabulario
Otra estructura de datos que creemos

15. … loadable ...
Dispone de un conjunto de funciones para gestionar la información:
Funciones comunes para crear, leer, actualizar y borrar entidades
Propiedades comunes
Integración con Views y otros servicios

16. … and optionally fieldable
Cada tipo de entidad tiene un conjunto de propiedades.
Cada tipo de entidad puede tener subtipos llamados bundles. Podemos adjuntar
un conjunto de campos diferenciados a cada uno.

17. Glosario

18. “contenido” es un tipo de entidad
“artículo” es un tipo de contenido (un bundle)
“Integración Continua y trabajo en equipo en Pantheon” es una entidad

19. Entidades relevantes en el núcleo de
Drupal 8

20. Contenido
Cada entidad de este tipo tiene:
ID y UUID
Idioma,
Título
Tipo
Autor
Estado de publicación, promovido a la página de inicio y al principio de las listas
Fecha de creación y del último cambio

21. Usuario
Cada entidad de este tipo tiene:
ID y UUID
Idioma
Nombre
Clave
Correo electrónico
Idioma predefinido y idioma predefinido de administración
Zona horaria

22. Bloques personalizados
Cada entidad de este tipo tiene:
ID y UUID
Idioma
Info
Tipo
Fecha de creación
Información de la última revisión

23. Término
Cada entidad de este tipo tiene:
ID y UUID
Idioma
Nombre
Vocabulario
Descripción
Término padre
Peso

24. Comentario
Cada entidad de este tipo tiene:
ID y UUID
Idioma
Tipo
Asunto
Comentario padre
Entidad que se comenta y campo
Autor

25. Archivos
Cada entidad de este tipo tiene:
ID y UUID
Idioma
Nombre del archivo
Usuario del archivo
URI
Tipo MIME
Tamaño del archivo

26. Trabajando con entidades

27. Acceso a entidades

28. $manager = Drupal::entityTypeManager();
$entity = $manager
->getStorage('comment')
->load($id);
$entity = Comment::load($id);
$user = User::create(array('name' => 'me'));
$entity->getEntityTypeId();
$entity->label();
$entity->id();

29. Acceso a campos

30. echo $entity->subject->value;
$term_id = $entity
->field_tags[2]
->target_id;
$entity->hasField($field_name);
$entity = $field_item->getEntity();
$entity->title->value = 'new Title';
$entity->save();

31. if ($node->isPromoted()) {
$title = $node->getTitle();
} elseif ($node->isPublished()) {
$node->setTitle(
$node->getAuthor()
->getUsername()
);
}

32. Acceso a traducciones

33. echo $entity
->getTranslation('de')
->title->value;
$translation = $entity->getTranslation('de');
$translation->language()->id == 'de';
$translation->title->value = 'German title';
$translation = $manager
->getTranslationFromContext($entity);
echo $translation->label();
$entity = $translation->getUntranslated();

34. Acceso a definiciones

35. echo $entity
->getTranslation('de')
->title->value;
$translation = $entity->getTranslation('de');
$translation->language()->id == 'de';
$translation->title->value = 'German title';
$translation = $manager
->getTranslationFromContext($entity);
echo $translation->label();
$entity = $translation->getUntranslated();

36. Acceso a definiciones

37. $entity_type = $entity_manager
->getDefinition('node');
$entity_type->id() == 'node'
$entity_type
->getClass()
$entity_type
->hasKey('label')
$entity_type
->isSubclassOf('ContentEntityInterface')

38. $field_definition = $entity->
getFieldDefinition($field_name);
$field_definition->getName();
$field_definition->getPropertyDefinitions();
$entity_manager
->getFieldDefinitions('node', 'article');

39. Tipos de entidad personalizados

40. Son plugins
Deben estar en Drupal/module/Entity
Deben cumplir la anotación @ContentEntityType
Deben implementar ContentEntityBase

41. /**
* Defines the comment entity class.
*
* @ContentEntityType(
* id = "comment",
* label = @Translation("Comment"),
* bundle_label = @Translation("Comment type"),
...

42. ...
* handlers = {
* "storage" = "DrupalcommentCommentStorage",
* "storage_schema" = "DrupalcommentCommentStorageSchema",
* "access" = "DrupalcommentCommentAccessControlHandler",
* "list_builder" = "DrupalCoreEntityEntityListBuilder",
* "view_builder" = "DrupalcommentCommentViewBuilder",
* "views_data" = "DrupalcommentCommentViewsData",
* "form" = {
* "default" = "DrupalcommentCommentForm",
* "delete" = "DrupalcommentFormDeleteForm"
* },
* "translation" = “DrupalcommentCommentTranslationHandler"
* },
...

43. ...
* base_table = "comment",
* data_table = "comment_field_data",
* uri_callback = "comment_uri",
* translatable = TRUE,
* entity_keys = {
* "id" = "cid",
* "bundle" = "comment_type",
* "label" = "subject",
* "langcode" = "langcode",
* "uuid" = "uuid"
* },
...

44. ...
* links = {
* "canonical" = "/comment/{comment}",
* "delete-form" = "/comment/{comment}/delete",
* "edit-form" = "/comment/{comment}/edit",
* },
* bundle_entity_type = "comment_type",
* field_ui_base_route = "entity.comment_type.edit_form",
* constraints = {
* "CommentName" = {}
* }
* )
*/

45. Definen sus campos base
Implementan la función baseFieldDefinitions
Usan BaseFieldDefinition::create para añadir campos:
Tipo de campo
Propiedades
Formateadores

46. ...
public static function baseFieldDefinitions(EntityTypeInterface
$entity_type) {
$fields = parent::baseFieldDefinitions($entity_type);
$fields['subject'] = BaseFieldDefinition::create('string')
->setLabel(t('Subject'))
->setTranslatable(TRUE)
->setSetting('max_length', 64)
->setDisplayOptions('form', array(
'type' => 'string_textfield',
'weight' => 10,
))
->setDisplayConfigurable('form', TRUE);
return $fields;
}
...

47. ...
$fields['title'] = FieldDefinition::create('string')
->setLabel(t('Title'))
...
->setDisplayOptions('view', array(
'label' => 'hidden',
'type' => 'string',
'weight' => -5,
))
->setDisplayOptions('form', array(
'type' => 'string',
'weight' => -5,
))
->setDisplayConfigurable('form', TRUE);
...

48. Implementan handlers
Son clases independientes del tipo de entidad
Definen:
Storage
Access
List and view builder
Views data
Forms

49. ...
* handlers = {
* "storage" = "DrupalcommentCommentStorage",
* "storage_schema" = "DrupalcommentCommentStorageSchema",
* "access" = "DrupalcommentCommentAccessControlHandler",
* "list_builder" = "DrupalCoreEntityEntityListBuilder",
* "view_builder" = "DrupalcommentCommentViewBuilder",
* "views_data" = "DrupalcommentCommentViewsData",
* "form" = {
* "default" = "DrupalcommentCommentForm",
* "delete" = "DrupalcommentFormDeleteForm"
* },
* "translation" =
“DrupalcommentCommentTranslationHandler"
* },
...

50. Handler de ejemplo: Storage
Se utiliza para gestionar la persistencia de la entidad.
Implementa EntityStorageInterface
Implementaciones base:
SqlContentEntityStorage
ContentEntityNullStorage

51. class CommentStorage extends SqlContentEntityStorage implements
CommentStorageInterface {
...
public function loadThread(...) {
...
}
...
}

52. Entity keys
Definen las claves que se usarán para cargar las entidades
ContentEntityBase::baseFieldDefinitions crea campos para ellas automáticamente

53. ...
* entity_keys = {
* "id" = "cid",
* "bundle" = "comment_type",
* "label" = "subject",
* "langcode" = "langcode",
* "uuid" = "uuid"
* },
...

54. Links
Define la forma de los enlaces:
canonical
add-form
edit-form
delete-form
...

55. ...
* links = {
* "canonical" = "/comment/{comment}",
* "delete-form" = "/comment/{comment}/delete",
* "edit-form" = "/comment/{comment}/edit",
* },
...

56. Routing
Se debe implementar el routing de los enlaces
Dos formas:
Es posible definir las rutas en el archivo *.routing.yml
Es mejor usar un handler route_provider como DefaultHtmlRouteProvider

57. ¿Por qué crear nuevos tipos de
entidades?

58. Cuando necesitas un tipo de entidad específico: propiedades, métodos, acceso,
almacenamiento…
Cuando no quieres usar un tipo existente: puedes clonar uno y los demás
módulos no sabrán de él
Cuando necesitas control total sobre él: los campos base no pueden
modificarse usando la interfaz
Cuando el modelo de datos es muy complicado: como pasa con Commerce,
Flag o Paragraphs

59. Modificar tipos de entidades existentes

60. Entity API
Funciones para alterar:
Campos base, de bundle y extras
Control de acceso
CRUD
Visualización
Formularios
https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Entity%21enti

61. ¡Gracias!
¿Preguntas?