Drupal Entities - Emerging Patterns of Usage

Code & Coders

Entities - Emerging Patterns of Usage

Presented by Ronald Ashri (ronald_istos)

Wednesday, August 24, 11

@ronald_istos
Web App Development
Travel / Semantic Web
www.istos.it

Solutions for hotels,
villas, B&Bs
drupalrooms.com
w/ Bluespark Labs

Drupal Trainer network
drupalteachers.com
w/ Brightlemon


Building with
Entities

✤ How we got to entities

✤ What do they look like, what
can we do, what’s missing

✤ When and how should we
use them

✤ Learning from how they
are used so far

✤ Questions / Next Steps


slice up a drupal
and you will find nodes

drupalistas love making lots of nodes and
mixing them up in different ways
... much like pasta

they love them so much they nearly turned
everything into a node

user pro les = drupal.org/project/content_pro le


taxonomy = drupal.org/project/taxonomy_node


comments = drupal.org/project/comment_nodes


nodes come in different shapes but still tied to
the same methods and db structure
=> need for a more generic core-based solution

but the core development process
is never simple

Huge driver turned out to be the
Field API work -
attaching elds to core “stuff” came rst
and the need to streamline followed


“loadable thingies,
that can be optionally eldable”
(http://drupal.org/node/460320)


entities


Entities in Drupal 7 are the nodes we really
wanted but didn’t know it yet

The stuff / content that makes up our site
nodes, users, taxonomy terms, comments, les

User Node

Taxonomy Term Comment

Taxonomy File
Vocabulary


one day drupal
will have a yeah... sure
smallcore and it will all
be OO

Drupal Core Developers Summit 2040

Entities bring us closer to Drupal the framework
No mention in UI - almost no mention in changelog


CHANGELOG.TXT...

“In addition, any other object
type may register with Field API
and allow custom data elds to
be attached to itself.”

object type = entity


The relationships between Entities - the ways
entities can interact with each other - de ne our
Drupal application

nodes can have comments
users author nodes
taxonomy terms are attached to nodes
these relationships are implicit -
perhaps they could be made explicit?


how to cook - (or build entities)

Your Table

PostIt
postit_id name property1 property2 property3

+ elds
(drupal worries about elds)


you de ne an entity via a hook_entity_info (big array!):
function postit_entity_info(){
$postit_info['postit'] = array(
'label' => t('PostIt Note'),
'controller class' => 'PostItController',
'base table' => 'postit',
'uri callback' => 'postit_uri',
'fieldable' => TRUE,
'entity keys' => array(
'id' => 'pid',
),
'static cache' => TRUE,
'bundles' => array(
'postit'=> array(
'label' => 'PostIt',
'admin' => array(
'path' => 'admin/structure/postit/manage',
'access arguments' => array('administer postits'),
),
),
),
'view modes' => array(
'full' => array(
'label' => t('Full PostIt'),
'custom settings' => FALSE,
),
)
);
return $postit_info;
}

You can provide you own controller class - typically
'id' => 'pid',
), extending the default DrupalDefaultEntityController
which worries about caching, querying, revisioning and
'bundles' => array(
'postit'=> array(
attaching elds to entities
'admin' => array(
),
),
),
'full' => array(
),
)
);
}


'id' => 'pid',
),
base table = where our main entity data lives
'bundles' => array(
uri callback = where to look up - view entities
'postit'=> array(
eldable = are elds to be attached to our entity
'admin' => array(
),
),
),
'full' => array(
),
)
);
}


'id' => 'pid',
),
'bundles' => array(
'postit'=> array(
'admin' => array(
),
),
),
'full' => array(
Bundle = Entity + Con guration + Fields
),
)
1 entity (Node) can have many bundles (Article, Page)
);
}

tell drupal how to load your entity

function postit_load($pid = NULL, $reset = FALSE){
$pids = (isset ($pid) ? array($pid) : array());
$postit = postit_load_multiple($pids, $reset);
return $postit ? reset ($postit) : FALSE;
}

function postit_load_multiple($pids = array(), $conditions = array(), $reset = FALSE){
return entity_load('postit', $pids, $conditions, $reset);
}

function entity_load($entity_type, $ids = FALSE, $conditions = array(), $reset = FALSE) {
if ($reset) {
entity_get_controller($entity_type)->resetCache();
}
return entity_get_controller($entity_type)->load($ids, $conditions);
}


ready to cook!
✤ we also get a query API
EntityFieldQuery

✤ conditions on properties
and elds
✤ queries across entity types

✤ and we get hooks

✤ hook_entity_load()
✤ hook_entity_presave()
✤ hook_entity_insert()
✤ hook_entity_update()
✤ hook_entity_delete()
✤ hook_entity_prepare_view
✤ hook_entity_view()


Young module developer : Where is full CRUD, UI,
Views integration, Tokens, Search, etc?

Drupal Core: What? Am I supposed to
do everything around here?


+ Entity Module
(drupal.org/project/entity)

✤ Supports full CRUD
✤ Quickly provide new entity
types
✤ Standardised way of
working with entity data
✤ Integration into drupal
ecosystem (Tokens, Views,
Rules, Exportables, Search
API, RestWS, VBO)
✤ Full Tests


so what are we cooking - and how?
and why?


entities are a uniquely drupaly concept

your stuff
(your db table or something like that)
+
Field API
+
hooks in the drupal world


if your module / app is introducing data
you should really be asking yourself
why not via entities

you get plugged in to the drupal world
for (almost) zero cost and
your data can remains as is (almost)


emerging patterns


Commerce

✤ Great example as there is
also historical perspective
✤ D6 Ubercart did almost
everything “outside” of
Drupal
✤ D7 Commerce is a fully
signed up member to the
Drupal ecosystem


in order to add commerce capabilities we need to
introduce a whole set of concepts (and their supporting
data structures)

Drupal Commerce de nes

Customer Pro les
Lines Items
Orders
Payment Transactions
Products

as entities


Drupal Commerce defines only as much as it
needs in terms of fields attached to these entities -

Application core concepts (e.g. sku for product)
live in entity base table not via field

More complex core data (e.g. price) gets added via
a locked field

Allows the user add extra fields where it makes
sense


local action entity types

Entity
operational links
Listing as a View


Contains Line
Order Entity
Item Entities

Related to
payment entities

address eld eld

looks familiar!


use entities to introduce new data types that can
be user-extensible

provide minimum conf required - easily
customisable in install proﬁles or via custom
modules

ps: did I mention - you really, really, really need a good reason not to use
entities when introducing new data (and data tables) to Drupal


Profile 2

✤ Separates users from
descriptions of users

✤ Uses different bundles to
describe different aspects of
the same user

✤ Use entities to provide pro le
level type permissions


placed under Entity Module UI
admin/structure for handling types

per type
con guration


use new entity relationships to extend the
application

provide conﬁguration via entity types


Organic Groups

✤ Organic Groups uses
Entities because via the
Entity API it gets CRUD,
Views, Rules integration
etc for free
✤ Groups are still attached
to nodes
✤ Automatically created via
an indirect user action


Group Entity

when you create a
node as a Group
Type this triggers
the creation of the
Group Entity

separation of concerns opens up interesting possibilities
and enables things that were not possible before like
better internationalization support


Group Membership Entity

content group


because relationships are entities we can
add elds to them

e.g. date eld indicating relationship
expiration


use Entities to separate concerns
-
using the Field API as a way to exibly add
access to con guration options
-

Site builder can decide how much con g to make
available to Site Admins


Rooms

✤ Hotel booking application
✤ Introduces Bookable
Units and Bookings as
entities
✤ Relates entities to non
entify-able data
✤ Uses entity types for
default values settings as
well as a source of
common data across all
entities instances

Bookable Unit Entity


Bookable Unit Availability


Entity Types de ne default property values


Rooms

interact via entities

Commerce


Kickstarting
Development
entities in a jar


Model Entities

drupal.org/project/model

Implementation of a
generic Entity and Entity
Administration interface
that you can use to
kickstart your own project.


experiment and
learn from
others
doing it your way is great...
but also need to study and share patterns
for doing things


Summary

✤ Drupalize your data with
entities
✤ Improves distinction
between drupal the
framework and drupal the
CMS impoving app
development
✤ Leverage the entity
module
✤ Learn from examples


@ronald_istos

Web App Development
Travel / Semantic Web
www.istos.it

Solutions for hotels,
villas, B&Bs
drupalrooms.com
w/ Bluespark Labs

Drupal Trainer network
drupalteachers.com
w/ Brightlemon


What did you think?
Locate this session on the
DrupalCon London website:
http://london2011.drupal.org/conference/schedule

Click the “Take the survey” link

THANK YOU!


Drupal Entities - Emerging Patterns of Usage

Recommended

More Related Content

What's hot (20)

Viewers also liked (7)

Similar to Drupal Entities - Emerging Patterns of Usage (20)

Recently uploaded (20)

Drupal Entities - Emerging Patterns of Usage