The document discusses various approaches to architecting Drupal modules. It provides examples related to structuring files, naming conventions, storing data, and outlines some important guidelines. These include separating concerns, creating decoupled and consistent modules, defining problems independently of Drupal, and using proven patterns like Entity API and Services. The conclusion emphasizes the need for methodology, documenting patterns, and discussing conventions.

1. Architecting Drupal Modules
Report from the Frontlines

2. Ronald Ashri
Directory of Technology
t: @ronald_istos

3. Ronald Ashri
Directory of Technology
t: @ronald_istos

4. Ronald Ashri
Directory of Technology
t: @ronald_istos

5. Ronald Ashri
Directory of Technology
actSMART
t: @ronald_istos

6. building modules
path not always clear
drupal
you
http://www.flickr.com/photos/hesketh/2249658529

7. example 1
I want my module to use a javascript library

8. example 1
I want my module to use a javascript library
http://drupal.org/node/304255
The PHP function drupal_add_js() lets you add a JavaScript file,
setting or inline code to the page and it takes 5 parameters (see
the api reference).

9. example 1
I want my module to use a javascript library
http://drupal.org/node/304255
http://drupal.org/node/304255
The PHP function drupal_add_js() lets you add a JavaScript file,
setting or inline code to the page and it takes 5 parameters (see
the api reference).

10. example 1
I want my module to use a javascript library

11. example 1
I want my module to use a javascript library

12. example 1
I want my module to use a javascript library

13. http://www.flickr.com/photos/42302655@N02/4064741545

14. let’s take a step back
what are we trying to do here
APIs (FAPI, DBTNG, ...)
Hooks (Events)
DRUPAL
Library Functions (e.g. check_plain)
Systems (Menu, Search, Node Access)
MY
MODULE

15. Building Software
Methodology, Framework, Patterns, Architecture

16. Building Software
Methodology, Framework, Patterns, Architecture
Methodology
A set of guidelines /
processes that accompany
you from problem definition
to solution

17. Building Software
Methodology, Framework, Patterns, Architecture
Methodology Framework
A set of guidelines / Provides reusable elements
processes that accompany and underlying structure you
you from problem definition plug into
to solution

18. Building Software
Methodology, Framework, Patterns, Architecture
Methodology Framework
A set of guidelines / Provides reusable elements
processes that accompany and underlying structure you
you from problem definition plug into
to solution
Patterns
Proven reusable solutions

19. Building Software
Methodology, Framework, Patterns, Architecture
Methodology Framework
A set of guidelines / Provides reusable elements
processes that accompany and underlying structure you
you from problem definition plug into
to solution
Patterns
Proven reusable solutions
Your Architecture
Elements and relationships
between them

20. Building Software
Methodology, Framework, Patterns, Architecture
Methodology Framework
A set of guidelines / Provides reusable elements
processes that accompany and underlying structure you
you from problem definition plug into
to solution
Patterns
Proven reusable solutions
Your Architecture
Elements and relationships
between them

21. Building Software
Methodology, Framework, Patterns, Architecture
Methodology Framework
A set of guidelines / Provides reusable elements
processes that accompany and underlying structure you
you from problem definition plug into
to solution
Patterns
Proven reusable solutions
Your Architecture
Elements and relationships
between them

22. Building Software
Methodology, Framework, Patterns, Architecture
Methodology Framework
A set of guidelines / Provides reusable elements
processes that accompany and underlying structure you
you from problem definition plug into
to solution
Patterns
Proven reusable solutions
Your Architecture
Elements and relationships
between them

23. Building Drupal Modules
Methodology, Framework, Patterns, Architecture
Drupal
Methodology ?
A set of guidelines /
Framework
Provides reusable elements
processes that accompany and underlying structure you
you from problem definition plug into
to solution
Patterns ?
Proven reusable solutions
Your Drupal Module
Architecture
Elements and relationships

24. example 2
how should I structure my files?

25. example 2
how should I structure my files?
everything in the root of your module
directory

26. example 2
how should I structure my files?
everything in the root of your module
directory
.module, .info in root, images in images, js
in js, inc in includes, views in views

27. example 2
how should I structure my files?
everything in the root of your module
directory
.module, .info in root, images in images, js
in js, inc in includes, views in views
some in root, some in directories based on
history, module evolution, style changes,
etc

28. example 3
how should I name my files

29. example 3
how should I name my files
.module, .info, .inc, .install, .test

30. example 3
how should I name my files
.module, .info, .inc, .install, .test
occasionaly throw in: .theme, .install.inc

31. example 3
how should I name my files
.module, .info, .inc, .install, .test
occasionaly throw in: .theme, .install.inc
sometimes: .<modulename>.<thing>.inc,
ClassName.inc

32. example 3
how should I name my files
.module, .info, .inc, .install, .test
occasionaly throw in: .theme, .install.inc
sometimes: .<modulename>.<thing>.inc,
ClassName.inc
myconventionisbetter.me

33. example 3
how should I name my files
.module, .info, .inc, .install, .test
occasionaly throw in: .theme, .install.inc
sometimes: .<modulename>.<thing>.inc,
ClassName.inc
myconventionisbetter.me
no! MyConventionIsBetter.class.inc

34. example 4
I need to store data

35. example 4
I need to store data
my table via hook_schema + DBTNG

36. example 4
I need to store data
my table via hook_schema + DBTNG
entities are the way to go - always!
(maybe?)

37. example 4
I need to store data
my table via hook_schema + DBTNG
entities are the way to go - always!
(maybe?)
fields, then a fieldgroup entity (or node)
to add what you are missing

38. example 4
I need to store data
my table via hook_schema + DBTNG
entities are the way to go - always!
(maybe?)
fields, then a fieldgroup entity (or node)
to add what you are missing
is your data content or configuration?

39. Guidelines
what is important in general

40. Guidelines
what is important in general
Drupal is a complex system of many interlinked parts
There are always many ways to skin a cat...

41. Guidelines
what is important in general
Drupal is a complex system of many interlinked parts
what the...?
There are always many ways to skin a cat...

42. Guidelines
what is important in general
Drupal is a complex system of many interlinked parts
what the...?
There are always many ways to skin a cat...
It’s not about the recipes
- it’s about the principles
Guidelines + Patterns

43. Guidelines
what is important in general

44. Guidelines
what is important in general
Separation of concerns - (e.g. logic in
modules, presentation that can fully by
managed by themes, flexible admin)

45. Guidelines
what is important in general
Separation of concerns - (e.g. logic in
modules, presentation that can fully by
managed by themes, flexible admin)
Decoupled - more smaller modules that
incrementally add functionality, OO where
possible

46. Guidelines
what is important in general
Separation of concerns - (e.g. logic in
modules, presentation that can fully by
managed by themes, flexible admin)
Decoupled - more smaller modules that
incrementally add functionality, OO where
possible
Consistent - similar things always happen and
are described in the same way

47. Define Problem and Design
not in a Drupal specific way

48. Define Problem and Design
not in a Drupal specific way
You module solves a problem - you should be
able to describe that in generic terms.

49. Define Problem and Design
not in a Drupal specific way
You module solves a problem - you should be
able to describe that in generic terms.
A hotel owner needs to be able to display a
list of available rooms with their associated
descriptions given an arrival and departure
date

50. Define Problem and Design
not in a Drupal specific way
You module solves a problem - you should be
able to describe that in generic terms.
A hotel owner needs to be able to display a
list of available rooms with their associated
descriptions given an arrival and departure
date
Vs: I need to get all bookable unit entities
and attach a field entity reference to them
pointing to Room Description nodes that I
can then render in Rooms view mode

51. Define Problem and Design
not in a Drupal specific way

52. Define Problem and Design
not in a Drupal specific way
Describe your architecture in generic terms
first and then in specific Drupal terms

53. Define Problem and Design
not in a Drupal specific way
Describe your architecture in generic terms
first and then in specific Drupal terms
Allows you to focus on what’s important
and not get distracted by how Drupal does
things

54. Define Problem and Design
not in a Drupal specific way
Describe your architecture in generic terms
first and then in specific Drupal terms
Allows you to focus on what’s important
and not get distracted by how Drupal does
things
Enables you to better choose what Drupal
way to use subsequently

55. Patterns - OO Patterns
Entity API, Subdomain

56. Patterns - OO Patterns
Entity API, Subdomain
Entity API offers interfaces and implementation of
those interfaces as well as helper “procedural” style
functions

57. Patterns - OO Patterns
Entity API, Subdomain
Entity API offers interfaces and implementation of
those interfaces as well as helper “procedural” style
functions
Subdomain offers all of its core functionality via a
class - you can extend/replace via your own module

58. Patterns - OO Patterns
Entity API, Subdomain
Entity API offers interfaces and implementation of
those interfaces as well as helper “procedural” style
functions
Subdomain offers all of its core functionality via a
class - you can extend/replace via your own module
Allows us to plug into “known” generic ways of
doing things - reduces the burden of Drupal to
define new styles

59. Patterns - Drupal Patterns
Views, Commerce

60. Patterns - Drupal Patterns
Views, Commerce
Separate UI from core module functionality

61. Patterns - Drupal Patterns
Views, Commerce
Separate UI from core module functionality
Allows us to focus on each and replace

62. Patterns - Drupal Patterns
Views, Commerce
Separate UI from core module functionality
Allows us to focus on each and replace
Form submit handlers, etc should use you
“core engine” functions - avoid stuffing a lot of
logic there

63. Patterns - Drupal Patterns
Views, Commerce
Separate UI from core module functionality
Allows us to focus on each and replace
Form submit handlers, etc should use you
“core engine” functions - avoid stuffing a lot of
logic there
Can switch UI off for performace gains

64. Patterns - Service Patterns
Rooms

65. Patterns - Service Patterns
Rooms
Where possible decouple interaction points
within same module

66. Patterns - Service Patterns
Rooms
Where possible decouple interaction points
within same module
Rooms produces all availability data in JSON
following a callback

67. Patterns - Service Patterns
Rooms
Where possible decouple interaction points
within same module
Rooms produces all availability data in JSON
following a callback
Allows us to use any number of display
techinques such as the FullCalendar JS
library

68. Patterns - Service Patterns
Rooms
Where possible decouple interaction points
within same module
Rooms produces all availability data in JSON
following a callback
Allows us to use any number of display
techinques such as the FullCalendar JS
library
Can easily abstract and connect to non-
Drupal site

69. in conclusion

70. in conclusion
need to work on methodology

71. in conclusion
need to work on methodology
start collecting and documenting
patterns

72. in conclusion
need to work on methodology
start collecting and documenting
patterns
discuss conventions

73. in conclusion
need to work on methodology
start collecting and documenting
patterns
discuss conventions
talk to me if interested - @ronald_istos