Your Entity, Your Code
2 likes890 views
The document discusses creating custom entities in Drupal, outlining the differences between Drupal 7 and Drupal 8 in terms of entity types and their implementation. It details the structure and coding necessary for setting up custom entities, including code snippets and references to relevant Drupal modules. Additionally, it provides links to resources for further exploration of Drupal entities and their management.
![me.yml
users:
mavimo:
name: Marco Vito Moscaritolo
email: mavimo-at-gmail.com
twitter: @mavimo
technologies: [ php, drupal, symfony ]
role: [ developer, teacher, architect ]
work: freelance
founder: @sparkfabrik](https://image.slidesharecdn.com/druaplday-it2015-build-your-own-entity-151219092846-151221092800/85/Your-Entity-Your-Code-3-320.jpg)
![D7 - Entity
Bla bla…
class CustomEntity extends Entity {
public function __construct(array $values = [], $entity_type = NULL) {}
public function identifier() {}
public function bundle() {}
public function uri() {}
public function hasStatus($status) {}
public function save() {}
public function delete() {}
public function view($view_mode = 'full', $lang = NULL, $page = NULL) {}
public function buildContent($view_mode = 'full', $langcode = NULL) {}
// ...
}](https://image.slidesharecdn.com/druaplday-it2015-build-your-own-entity-151219092846-151221092800/85/Your-Entity-Your-Code-10-320.jpg)
![D7 - EntityAPIController
class CustomEntityController extends EntityAPIController {
public function __construct($entityType) {}
public function query($ids, $conditions, $revision_id = FALSE) {}
public function load($ids = array(), $conditions = array()) {}
public function invoke($hook, $entity) {}
public function delete($ids, DatabaseTransaction $trans = NULL) {}
public function save($entity, DatabaseTransaction $trans = NULL) {}
public function create(array $values = array()) {}
public function buildContent($entity, $view_mode = 'full’,
$lang = NULL, $content = []) {}
public function view($entities, $view_mode = 'full’,
$langcode = NULL, $page = NULL) {}
// ...
}](https://image.slidesharecdn.com/druaplday-it2015-build-your-own-entity-151219092846-151221092800/85/Your-Entity-Your-Code-12-320.jpg)
![D7 - EntityDefaultUIController
Bla bla…class CustomEntityUIController extends EntityDefaultUIController {
public function __construct($entity_type, $entity_info) {}
public function hook_menu() {}
public function hook_forms() {}
public function overviewTable($conditions = array()) {}
public function overviewForm($form, &$form_state) {}
public function operationForm($form, &$form_state, $entity, $op) {}
// and also [overview|operation]Form[Submit|Validate] methods.
public function applyOperation($op, $entity) {}
// ...
}](https://image.slidesharecdn.com/druaplday-it2015-build-your-own-entity-151219092846-151221092800/85/Your-Entity-Your-Code-13-320.jpg)
![EntityFieldQuery
$query = new EntityFieldQuery();
$query->entityCondition('entity_type', 'custom_entity')
->entityCondition('bundle', 'my_bundle')
->propertyCondition('uid', $user->uid, '=')
->fieldCondition('field_faculty_tag', 'tid', 10)
->fieldOrderBy('field_faculty_tag', 'tid', 'DESC')
->range(0, 10);
$result = $query->execute();
if (isset($result['custom_entity'])) {
$items = entity_load('custom_entity’, array_keys($result['custom_entity']));
}](https://image.slidesharecdn.com/druaplday-it2015-build-your-own-entity-151219092846-151221092800/85/Your-Entity-Your-Code-19-320.jpg)
![EntityMetadataWrapper
$wrapper = entity_metadata_wrapper('custom_entity', $entity);
$wrapper->author->mail->set('demo@drupalday.it');
$wrapper->description->value('This is a demo!');
$labels = array();
foreach ($wrapper->field_faculty_tag->getIterator()
as $delta => $term_wrapper) {
$labels[] = $term_wrapper->label->value();
}
$wrapper->save();](https://image.slidesharecdn.com/druaplday-it2015-build-your-own-entity-151219092846-151221092800/85/Your-Entity-Your-Code-20-320.jpg)
![D7 - Create Custom Entity… Fast!(1)
drush entity-scaffold entity_name dday
File dday/entity_name/includes/entity_name.admin.inc created. [ok]
File dday/entity_name/includes/entity_name.class.inc created. [ok]
File dday/entity_name/includes/entity_name.controller.inc created. [ok]
File dday/entity_name/includes/entity_name.type.controller.inc created. [ok]
File dday/entity_name/includes/entity_name_type.admin.inc created. [ok]
File dday/entity_name/entity_name.info created. [ok]
File dday/entity_name/entity_name.install created. [ok]
File dday/entity_name/entity_name.tpl.php created. [ok]
File dday/entity_name/entity_name.module created. [ok]
https://www.drupal.org/project/entity_scaffold](https://image.slidesharecdn.com/druaplday-it2015-build-your-own-entity-151219092846-151221092800/85/Your-Entity-Your-Code-21-320.jpg)
![D8 - ContentEntityType
Require database definition
hook_schema()
Can be fildable/REVISIONABLE
baseFieldDefinition()
CAN HAVE CUSTOM BEHAVIOR
redefine [pre|post][Save|Load|Delete] methods
CAN PROVIDE CUSTOM ACCESS RULES
checkAccess() and checkCreateAccess()
CAN PROVIDE CUSTOM HANDLERS
strorage, view_builder, route_provider, form, translation, config_export...](https://image.slidesharecdn.com/druaplday-it2015-build-your-own-entity-151219092846-151221092800/85/Your-Entity-Your-Code-27-320.jpg)
Your Entity, Your Code
- 2. Your Entity Your Code Marco Vito Moscaritolo @mavimo@gmail.com
- 3. me.yml users: mavimo: name: Marco Vito Moscaritolo email: mavimo-at-gmail.com twitter: @mavimo technologies: [ php, drupal, symfony ] role: [ developer, teacher, architect ] work: freelance founder: @sparkfabrik
- 5. …right?
- 6. • D6 & 5 $node = new stdClass(); // Sad L • D7 $node = new stdClass(); // DrupalEntityControllerInterface // EntityFieldQuery, … • D8 $node = new DrupalnodeEntityNode(); // Yah yahhhh!!! J A bit of history
- 7. • Entity (Node, User, Comment, Taxonomy, …) • Bundle (Node type, Vocabularies, …) • Property (Node id, node title, vocabulary name, …) • Field (Body, Image field, Term references, …) Core elements
- 8. D7 - hook_entity_info() return array( ’entity_name' => array( 'label' => t(’Custom entity'), 'controller class' => ’CustomEntityController', 'base table' => ’custom_entity', 'uri callback' => ’custom_entity_uri', 'fieldable' => TRUE, 'entity keys' => array( /* ... */ ) 'bundle keys' => array( 'bundle' => 'machine_name', ), 'bundles' => array( /* ... */ ), 'view modes' => array( /* ... */ ), ), );
- 9. D7 - Entity API
- 10. D7 - Entity Bla bla… class CustomEntity extends Entity { public function __construct(array $values = [], $entity_type = NULL) {} public function identifier() {} public function bundle() {} public function uri() {} public function hasStatus($status) {} public function save() {} public function delete() {} public function view($view_mode = 'full', $lang = NULL, $page = NULL) {} public function buildContent($view_mode = 'full', $langcode = NULL) {} // ... }
- 11. D7 - hook_entity_info() extended by Entity API return array( ’entity_name' => array( // ... ’entity class' => ’CustomEntity', // ... 'views controller class' => ’CustomEntityViewsController', // ... 'exportable’ => TRUE, // ... 'admin ui' => array( // ... 'controller class' => ’CustomEntityUIController', ), ), );
- 12. D7 - EntityAPIController class CustomEntityController extends EntityAPIController { public function __construct($entityType) {} public function query($ids, $conditions, $revision_id = FALSE) {} public function load($ids = array(), $conditions = array()) {} public function invoke($hook, $entity) {} public function delete($ids, DatabaseTransaction $trans = NULL) {} public function save($entity, DatabaseTransaction $trans = NULL) {} public function create(array $values = array()) {} public function buildContent($entity, $view_mode = 'full’, $lang = NULL, $content = []) {} public function view($entities, $view_mode = 'full’, $langcode = NULL, $page = NULL) {} // ... }
- 13. D7 - EntityDefaultUIController Bla bla…class CustomEntityUIController extends EntityDefaultUIController { public function __construct($entity_type, $entity_info) {} public function hook_menu() {} public function hook_forms() {} public function overviewTable($conditions = array()) {} public function overviewForm($form, &$form_state) {} public function operationForm($form, &$form_state, $entity, $op) {} // and also [overview|operation]Form[Submit|Validate] methods. public function applyOperation($op, $entity) {} // ... }
- 17. Too much work… why??? Integration view, rules, features Code testability easy to isolate Reusability code once, use more Remote entity social network, webservices Drupal 8 ;-)
- 19. EntityFieldQuery $query = new EntityFieldQuery(); $query->entityCondition('entity_type', 'custom_entity') ->entityCondition('bundle', 'my_bundle') ->propertyCondition('uid', $user->uid, '=') ->fieldCondition('field_faculty_tag', 'tid', 10) ->fieldOrderBy('field_faculty_tag', 'tid', 'DESC') ->range(0, 10); $result = $query->execute(); if (isset($result['custom_entity'])) { $items = entity_load('custom_entity’, array_keys($result['custom_entity'])); }
- 20. EntityMetadataWrapper $wrapper = entity_metadata_wrapper('custom_entity', $entity); $wrapper->author->mail->set('demo@drupalday.it'); $wrapper->description->value('This is a demo!'); $labels = array(); foreach ($wrapper->field_faculty_tag->getIterator() as $delta => $term_wrapper) { $labels[] = $term_wrapper->label->value(); } $wrapper->save();
- 21. D7 - Create Custom Entity… Fast!(1) drush entity-scaffold entity_name dday File dday/entity_name/includes/entity_name.admin.inc created. [ok] File dday/entity_name/includes/entity_name.class.inc created. [ok] File dday/entity_name/includes/entity_name.controller.inc created. [ok] File dday/entity_name/includes/entity_name.type.controller.inc created. [ok] File dday/entity_name/includes/entity_name_type.admin.inc created. [ok] File dday/entity_name/entity_name.info created. [ok] File dday/entity_name/entity_name.install created. [ok] File dday/entity_name/entity_name.tpl.php created. [ok] File dday/entity_name/entity_name.module created. [ok] https://www.drupal.org/project/entity_scaffold
- 23. …Drupal 8 ?
- 24. Thanks!
- 26. D8 - Entity Type Module namespaced Drupalmy_moduleEntityMyCustomeEntity() Defined folder in module src/Entity/MyCustomEntity.php INFORMATION MANAGED BY ANNOTATION /** * @XyzEntityType( … ) */ Can be “code only” config/install/my_custom_entity.sample_1.yml Unit testable class MyCustomEntityTest extends DrupalTestsUnitTestCase {}
- 27. D8 - ContentEntityType Require database definition hook_schema() Can be fildable/REVISIONABLE baseFieldDefinition() CAN HAVE CUSTOM BEHAVIOR redefine [pre|post][Save|Load|Delete] methods CAN PROVIDE CUSTOM ACCESS RULES checkAccess() and checkCreateAccess() CAN PROVIDE CUSTOM HANDLERS strorage, view_builder, route_provider, form, translation, config_export...
- 28. D8 - ContentEntityType /** * @ContentEntityType( * id = "my_content", * label = @Translation("My Content"), * bundle_label = @Translation("My Content type"), * handlers = { ... }, * base_table = "my_entity", * data_table = "my_entity_field_data", * revision_table = "my_entity_revision", * revision_data_table = "my_entity_field_revision", * translatable = TRUE, * entity_keys = { ... }, * bundle_entity_type = "my_entity_type", * field_ui_base_route = "entity.my_entity_type.edit_form", * common_reference_target = TRUE, * permission_granularity = "bundle", * links = { ... } * ) */ class MyContentEntity extends ContentEntityBase implements MyContentEntityInterface { }
- 29. D8 - ConfigEntityType Difference compared to ContentEntityType: • Schema file definition Instead of database schema definition, using: config/schema/my_entity.schema.yml • INTEGRATED with CMI API for exportability See dedicated talk. • No field
- 30. D8 - ConfigEntityType /** * @ConfigEntityType( * id = "my_config", * label = @Translation("My config"), * handlers = { * "list_builder" = "Drupalmy_moduleControllerMyConfigListBuilder", * "form" = { ... } * }, * config_prefix = "my_config", * admin_permission = "administer site configuration", * entity_keys = { ... }, * links = { ... } * ) */ class MyConfigEntity extends ConfigEntityBase implements MyConfigEntityInterface { ... }
- 31. my_module/config/schema/my_config.schema.yml my_module.my_config.*: type: config_entity label: My config’ mapping: id: type: string label: 'ID’ label: type: label label: 'Label'
- 32. D8 - Create Custom Entity… Fast! drupal generate:entity:content --module=dday --entity-name=my_content_entity --entity-class=MyContentEntity --label="My Content Entity” Generated or updated files Site path: ~/dday 1 - modules/custom/dday/dday.routing.yml 2 - modules/custom/dday/dday.permissions.yml 3 - modules/custom/dday/dday.links.menu.yml 4 - modules/custom/dday/dday.links.task.yml . . . 13 - modules/custom/dday/src/Entity/Form/MyContentEntityDeleteForm.php 14 - modules/custom/dday/my_content_entity.page.inc 15 - modules/custom/dday/templates/My Content Entity.html.twig https://www.drupal.org/project/console