SID Camp 2015 presentation on how to create custom entity on Drupal CMF.

1. Buildyourown
EntityinDrupal
Marco Vito Moscaritolo

2. hook_user_info()
return [
‘name’ => ‘Marco Vito Moscaritolo’,
‘username’ => ‘mavimo’,
‘mail’ => ‘mavimo@gmail.com’,
‘twitter’ => ‘@mavimo’,
‘field_tags’ => [
‘drupal’, ‘php’, ‘developer’,
‘associazione drupal italia’,
],
‘field_companies’ => [
‘agavee’, ‘sparkfabrik’, ‘freelance’,
],
];

3. We can create custom
node type… right?
Why entities ?

4. Elements
• Entity (Node, User, Comment, Taxonomy, …)
• Bundle (Node type, Vocabularies, …)
• Property (Node id, node title, vocabulary name, …)
• Field (Body, Imagefield, Term references, …)

5. 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( /* ... */ ),
),
);

6. EntityAPI

7. hook_entity_info()–extendedbyEntityAPI
return array(
’entity_name' => array(
// ...
’entity class' => ’CustomEntity',
// ...
'views controller class' => ’CustomEntityViewsController',
// ...
'exportable’ => TRUE,
// ...
'admin ui' => array(
// ...
'controller class' => ’CustomEntityUIController',
),
),
);

8. Entity
Blabla…
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) {}
// ...
}

9. EntityUImanagement

10. 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) {}
// ...
}

11. AutomaticallycreateEntityUI

12. EntityDefaultUIController
Blabla…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) {}
// ...
}

13. AutomaticallycreateAdminUI

14. Toomuchwork…why???
• Integration (view, rules, feature, …)
• Code testability (see dedicated session, …)
• Reusability (feature on different projects, …)
• Remote entity (social network, WS,…)
• Drupal 8 “is coming” ;)

15. Integration(eg:views)

16. 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']));
}

17. EntityMetadataWrapper
$wrapper = entity_metadata_wrapper('custom_entity', $entity);
$wrapper->author->mail->set('demo@sidcamp.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();

18. …Drupal8?

19. CreateCustomEntity…Fast!(1)
drush entity-scaffold entity_name sidcamp
File sidcamp/entity_name/includes/entity_name.admin.inc created. [ok]
File sidcamp/entity_name/includes/entity_name.class.inc created. [ok]
File sidcamp/entity_name/includes/entity_name.controller.inc created. [ok]
File sidcamp/entity_name/includes/entity_name.type.controller.inc created. [ok]
File sidcamp/entity_name/includes/entity_name_type.admin.inc created. [ok]
File sidcamp/entity_name/entity_name.info created. [ok]
File sidcamp/entity_name/entity_name.install created. [ok]
File sidcamp/entity_name/entity_name.tpl.php created. [ok]
File sidcamp/entity_name/entity_name.module created. [ok]
https://www.drupal.org/project/entity_scaffold

20. CreateCustomEntity…Fast!(2)
https://www.drupal.org/project/eck

21. Question?
Thankyou!

22. References
http://joshaust.in/wp-content/uploads/2012/06/Entities-and-Bundles-
in-Drupal-7.pdf
https://www.drupal.org/project/entity
https://www.drupal.org/project/eck
https://www.drupal.org/project/entity_scaffold
http://www.bluespark.com/blog/drupal-entities-part-1-moving-beyond-
nodes
http://www.sitepoint.com/build-custom-entities-drupal-setup/