Custom entities in d8

Custom entities in D8
DrupalDay Santiago de compostela 2016
Samuel Solís (@estoyausente)

Drupalday Santiago 2017 @estoyausente

¿Qué vamos a ver?
¿Qué es un tipo de entidad?
De contenido vs de conﬁguración
Algo de terminología
Deﬁnición del tipo de entidad en bd
Formularios
Validaciones
Renderizar entidades

Un tipo de entidad es una clase
que tiene métodos y manejadores
deﬁnidos para almacenar, listar,
cargar y mostrar una estructura de
datos de forma uniﬁcada.
“

Un tipo de entidad es una clase
que tiene métodos y manejadores
deﬁnidos para almacenar, listar,
cargar y mostrar una estructura de
datos de forma uniﬁcada.
“
WTF????

Config Content
Entities
Content types
Views
Contact forms
Image styles
Nodes
Comments
Profiles
Terms
.yml files
CMI

Algo de terminología
Bundle Field
PropertyEntity type
node author
Page Imagen

Definición del Tipo de Entidad
Anotación
Definición de la clase
método baseFieldDefinitions

MiDrupal$
/**
* @ContentEntityType(
* id = "galician",
* label = @Translation(“Galician"),
* handlers = {
* },
* },
* base_table = “galicians",
* admin_permission = "administer galician
people",
* fieldable = FALSE,
* entity_keys = {
* "id" = "id",
* },
* admin_permission = “administer galicians”
* )
*/
vim src/Entity/Galician.php

MiDrupal$ vim src/Entity/MyEntity.php
namespace DrupalgalicianEntity;
use DrupalCoreFieldBaseFieldDefinition;
use DrupalCoreEntityContentEntityBase;
. . .
class Galician extends ContentEntityBase {
use StringTranslationTrait;
}

public static function
baseFieldDefinitions(EntityTypeInterface $entity_type) {
$fields['id'] = BaseFieldDefinition::create('integer')
->setLabel(t('ID'))
->setDescription(t('The ID of the galician person.'))
->setReadOnly(TRUE);
$fields['clothing'] = BaseFieldDefinition::create('string')
->setLabel(t('From'))
->setDescription(t(‘Galician clothing.’)
->setSettings(array(
'default_value' => 'Raincoat',
))
->setRequired(true);
$fields['created'] = BaseFieldDefinition::create('created')
->setLabel(t('Created'))
->setDescription(t('The time that the entity was
created.'));
}

MiDrupal$
$fields['province'] =
BaseFieldDefinition::create('entity_reference')
->setLabel(t('Province id.'))
->setDescription(t('The Pid of the associated
province.'))
->setSetting('target_type', 'province')
->setSetting('handler', 'default');

MiDrupal$
public function getClothing() {}
public function setClothing() {}
public function getOwner() {}
public function preSave() {}
public function postSave() {}
public function preCreate() {}
. . .

MiDrupal$
public function eatPrawns($num) {
//eat a boat of prawns.
return true;
}

drush en miModulo
drush entity-updates

MiDrupal$ vim any/other/Place.php
$galicianIds = Drupal::entityQuery('galician')
->condition(‘clothing’,’raincoat' , '<>')
->sort('date', 'DESC')
->execute();
}
//Dirty and easy way
$galicians = Drupal::entityTypeManager()
->getStorage(‘galician')->loadMultiple($galicianIds);
//Dependency Injection way
$galicians = $this->GalicianStorageController
—>loadMultiple($orderIds);
foreach($galicians as $galician) {
$galician->eatPrawns(100000);
}
$galician->save();

Formularios

MiDrupal$
/**
* id = "galician",
* … some stuff
* handlers = {
* "form" = {
* "add" = "DrupalgaliciaFormGalicianForm",
* "edit" = "DrupalgaliciaFormGalicianForm",
* "delete" = “DrupalCoreEntityContentEntityDeleteForm",
* },
* },
* },
* some stuff …
* )
*/

->setDescription(t(‘Galician clothing.’)
->setSettings([(
])
->setDisplayConfigurable('Form', true)
->setDisplayOptions('Form', [
'weigth' => 2,
])
}

MiDrupal$
namespace DrupalgalicianForm;
use DrupalCoreEntityContentEntityForm;
use DrupalCoreFormFormStateInterface;
class GalicianForm extends ContentEntityForm {
public function buildForm(array $form, FormStateInterface
$form_state) {
$form = parent::buildForm($form, $form_state);
if(isSunny()) { // <— if(false)
$form[‘clothing']['widget'][0]['default_value'] = ‘heat';
}
return $form;
}
public function submitForm(array &$form, FormStateInterface
$form_state) {
parent::submitForm($form, $form_state);
}
}
vim src/Form/GalicianForm.php

MiDrupal$
entity.galician.galician_add: 
path: '/galician/add' 
defaults: 
_entity_form: galician.add 
_title: ‘Create a new Galician person' 
requirements: 
_entity_create_access: 'galician' 
 
entity.galician.galician_add: 
path: '/galician/{galician}/edit' 
defaults: 
_entity_form: galician.edit 
_title: 'Edit Galician' 
requirements: 
_permission: 'administer galician entity' 
vim galician.routing.yml

Algunos gallegos creados …
Mario Casas

Rouco Varela
Mario Casas

Rouco Varela
Mario Casas
Mariano Rajoy

Rouco Varela
Mario Conde
Mario Casas
Mariano Rajoy

Validaciones
Campos
Entidad

->setDescription($this->t('Galician clothing.')
->setSettings(array(
))
->addConstrain('Length', ['mas' => 20])
}
Campos

MiDrupal$
* id = "galician",
* constraints = {
* "Galician" = {}
* }
* )
Entidad

MiDrupal$
namespace DrupalgalicianPluginValidationConstraint;
use SymfonyComponentValidatorConstraint;
/**
* Supports validating comment author names.
*
* @Constraint(
* id = "Galician",
* label = @Translation("Galician validation", context =
"Validation"),
* type = "entity:galician"
* )
*/
class GalicianConstraint extends Constraint {
public $messageDate = ‘Date must be 12-11-2016’;
public $messageClothing = ‘You aren’t a real Galician!!’;
}
vim src/Plugin/Validation/Contraint/GalicianConstraint.php

MiDrupal$ vim src/Plugin/Validation/Contraint/GalicianConstraintValidator.php
namespace DrupalgalicianPluginValidationConstraint;
use SymfonyComponentValidatorConstraint;
use SymfonyComponentValidatorConstraintValidator;
class GalicianConstraintValidator extends ConstraintValidator {
public function validate($entity, Constraint $constraint) {
if($entity->date != ’12-11-2016’) {
$this->context->buildViolation($constraint->messageDate)
->addViolation();
}
if($entity->clothing != ‘raincoat’) {
$this->context->buildViolation($constraint->messageClothing)
->addViolation();
}
}
}

Renderizar entidades
Completas
Listados

MiDrupal$
->setDescription($this->t('Galician clothing.')
->addConstrain('Length', ['mas' => 20])
->setDisplayConfigurable('view', TRUE)
->setDisplayOptions('view', [
'label' => 'above',
'type' => 'string',
'weight' => 1,
]);
Completas

MiDrupal$
/**
* id = "galician",
* … some stuff
* handlers = {
* "list_builder” = “DrupalgalicianController
GalicianListBuilder”,
* “view_builder” = “DrupalCoreEntityEntityViewBuilder”
* },
* },
* some stuff …
* )
*/
Listados

MiDrupal$ vim src/GalicianListBuilder.php
namespace DrupalgalicianEntityController;
use DrupalCoreEntityEntityInterface;
use DrupalCoreEntityEntityListBuilder;
class GalicianListBuilder extends EntityListBuilder {
public function render() {
$build['description'] = array(
'#markup' => $this->t('Galician list.'),
);
$build['table'] = parent::render();
return $build;
}
public function buildHeader() {
$header['id'] = $this->t('Order id');
$header['clothing'] = $this->t('Clothing');
return $header + parent::buildHeader();
}
public function buildRow(EntityInterface $entity) {
$row['id'] = $entity->id();
$row['clothing'] = $entity->clothing->value;
return $row + parent::buildRow($entity);
}
}
Listados

Michel Salgado

Rosalía de Castro
Michel Salgado

Rosalía de Castro
Michel Salgado
Camilo José Cela

Rosalía de Castro
Michel Salgado
Camilo José Cela
Agustín Jimenez

Rosalía de Castro
Michel Salgado
Camilo José Cela Adolfo Dominguez

Para otro día
Otros maneadores disponibles
(storage, access, …)
Bundles y ﬁelds
Traducciones
Revisiones
Extensión de entidades existentes
…

Referencias
Core
La documentación de
drupal.org
Módulo Examples
Drupal console (Aunque suele generar
bastante más de lo que necesitamos)Utilidad

Coffee break!
@estoyausenteSamuel Solís
Nos vemos en IRC #drupal-es

Custom entities in d8

Recomendados

Recomendados

Más contenido relacionado

Destacado

Destacado (8)

Similar a Custom entities in d8

Similar a Custom entities in d8 (20)

Más de Samuel Solís Fuentes

Más de Samuel Solís Fuentes (17)

Último

Último (20)

Custom entities in d8