Enterprise PHPArchitecture throughDesign Patterns and   Modularization     by Aaron Saray
Why trust this guy?                      ● Programming for                        over 2 decades                      ● We...
Why are we here?● Focus on Enterprise Development● Understand decoupling● See real reasons for doing things to pattern
Why is this important?● PHP is everywhere● PHP runs organizations● IT changes faster than any other area● Long term invest...
Lets get into itDisclaimer:● There are many ways to refer to the  concepts discussed next● Dont get stuck on names  ○ Get ...
What are the main topics?● Data Models● Domain Logic Models● Mappers● Services
Data Model● This class represents a real entity in the  organization● Examples of entities:   ○   Visitor of the website  ...
Data Model (cont)● Data models contain properties that are  unique/descriptive to that entity  ○ Harddrive for sale: has p...
Data Model (cont)● Very dumb● Harddrive example:  ○ has a property called suggested sale price  ○ has a property called so...
Sneak peek: Domain Logic Model● Validation of the sale price would be done in  the domain model● What about string length?...
To Summarize Data Model● Represents some sort of entity● Has properties of that entity● Has methods that understand its ow...
Domain Logic Model● Represents the logical steps and decisions  that make your app (business) unique● Handles simple data ...
Domain Logic Model (cont)● Has relationships with Data Models  ○ Can be 1-1, 1-N, N-1, N-N, depending on your    choices a...
Domain Logic Model (cont)● Going back to harddrive example  ○ Harddrive data object has suggested price of $40  ○ Input ha...
Domain Logic Model (cont)● Another example  ○ Blog Entry Model has a title  ○ Business says Blog entry titles should not b...
Why is the separation important?● Two reasons  ○ Reuse    ■ 100 different items for sale, but they dont have a      common...
Why is the separation important? (cont) ● Two reasons   ○ Data models should just represent an entity, not the     logic b...
Summarize Domain Logic Models● Understands the business logic● Comprehends data models● The Gatekeeper of valid data
Data Mapper Object● Data mappers map data from a Data Access  Object to Data Models● Data Access Object  ○ not covered too...
Data Mapper Object (cont)● Not particularly smart  ○ will work to retrieve data based on parameters  ○ will populate a Dat...
Data Mapper Object (cont)● Harddrive example  ○ Can take a Harddrive Data Model and save it in the    proper format to MyS...
Why is Data Mapper Important?● Data Models are dumb   ○ Dont care what their data is or where it came from● Domain Logic M...
Summarize Data Mapper Model● Works directly with Data Model and Data  Access Objects● Retrieves and Persists Data Models● ...
Services● A lot of confusion with this term   ○ Sometimes theyre the public interface of your app   ○ Other times they ref...
Services (cont)● Services are responsible for providing the  Data Model or collection to the consumer● Services act as the...
Services (cont)● Harddrive example!  ○ Service::save() would accept a harddrive model,    grab the proper mapper (perhaps ...
Services (cont)● Harddrive example (cont)  ○ Service::validateUpdate() - would take user input in,    validate that it is ...
Why are Services Important?● Services are the public interfaces to the rest  of the classes in your app● Things that you a...
Summarize Services● Public interface to the rest of your code● Understand Data Models, Domain Models,  Mappers● Execute pr...
Example Code● Lets see this in action. Things to remember:● This is not a whole app - dont treat it as one● It is example ...
Just trying to demonstrate the concepts  with the least amount of distraction!
Layout - Overview                    Main layout of files                    We will cover each                    code se...
Retrieval Options (A Controller)
Retrieve one by ID
Other retrieval code
The Mapper
The Mapper (cont)
More Mapper
Mapper (populating / mapping)
Data Model
Next Up...Retrieval is done...Lets look at persistence
Persistence Controller (1 of 2)
Persistence Controller (2 of 2)
Creating a User
Creating User (cont)
Domain User Model
Mapper DB - Save
Apply Update From User
Persistence DoneYayNow - lets introduce the value!
Users must be syncd to AS400● Previously was from mysql db● Need to change as little code as possible● The only thing chan...
Modify User Service  This is the ONLY change to your code.  All else is NEW code.
What does this mapper look like?
AS400 Mapper Continued
AS400 Mapper Continued
AS400 Mapper Continued
Whew! Done!Check it out athttp://aaronsaray.com/midwestphpTweet at @aaronsaray
Upcoming SlideShare
Loading in...5
×

Enterprise PHP Architecture through Design Patterns and Modularization (MidwestPHP 2013)

20,998
-1

Published on

Object Oriented Programming in enterprise level PHP is incredibly important. In this presentation, concepts like MVC architecture, data mappers, services, and domain and data models will be discussed. Simple demonstrations will be used to show patterns and best practices. In addition, using tools like Doctrine or integration with Salesforce or the AS/400 will also be discussed. There will be an emphasis on the practical application of these techniques as well - this isn't just a theoretical talk! This presentation is great for those just beginning to create enterprise applications as well as those who have had years of experience.

Published in: Technology

Enterprise PHP Architecture through Design Patterns and Modularization (MidwestPHP 2013)

  1. 1. Enterprise PHPArchitecture throughDesign Patterns and Modularization by Aaron Saray
  2. 2. Why trust this guy? ● Programming for over 2 decades ● Web Development Manager ● Author of WROX Professional PHP Design Patterns ● MKEPUG CoFounder
  3. 3. Why are we here?● Focus on Enterprise Development● Understand decoupling● See real reasons for doing things to pattern
  4. 4. Why is this important?● PHP is everywhere● PHP runs organizations● IT changes faster than any other area● Long term investment ○ Do things the right way, and be valuable - longer ■ quality ■ speed ■ maintainability
  5. 5. Lets get into itDisclaimer:● There are many ways to refer to the concepts discussed next● Dont get stuck on names ○ Get stuck on the ideas
  6. 6. What are the main topics?● Data Models● Domain Logic Models● Mappers● Services
  7. 7. Data Model● This class represents a real entity in the organization● Examples of entities: ○ Visitor of the website ○ Product for sale: computer ○ Mail message ○ Blog entry, Comment
  8. 8. Data Model (cont)● Data models contain properties that are unique/descriptive to that entity ○ Harddrive for sale: has property of: ■ size ■ suggested sale price ■ speed ○ Does not have property of: ■ favorite song● Data models contain methods that understand their properties ○ User has methods: ■ fullname() - brings together properties
  9. 9. Data Model (cont)● Very dumb● Harddrive example: ○ has a property called suggested sale price ○ has a property called sold price ○ What happens if the sold price is less than the suggested sale price? ■ This model does not care. Its a dumb data store
  10. 10. Sneak peek: Domain Logic Model● Validation of the sale price would be done in the domain model● What about string length? ○ Understand that your limits should be on your domain product ■ Is it true that your limit for a product is 255 chars - just cuz its a varchar(255) column? ● Your data provider should handle your requirements, not the other way around
  11. 11. To Summarize Data Model● Represents some sort of entity● Has properties of that entity● Has methods that understand its own properties only● Dumb● Could be really messed up if it doesnt have a relationship with a Domain Object
  12. 12. Domain Logic Model● Represents the logical steps and decisions that make your app (business) unique● Handles simple data validation● Handles complex business rules● The gatekeeper of the Data Model
  13. 13. Domain Logic Model (cont)● Has relationships with Data Models ○ Can be 1-1, 1-N, N-1, N-N, depending on your choices and architecture. Probably is a hybrid● Has methods that comprehend and understand Data Models● Has properties or constants from the business configuration ○ Maximum amount of discount on sale
  14. 14. Domain Logic Model (cont)● Going back to harddrive example ○ Harddrive data object has suggested price of $40 ○ Input has the sale price coming in at $30 ○ Domain Logic Model to the rescue!● Data Logic Model validates the sale ○ Property says maximum discount is 20% ○ Input discount is 25% ○ Rejects input, does not allow Data Model to accept $30 as the sale price ○ Perhaps maximum discount is 0% & must be exact ○ Rejects input if input is not exactly $40
  15. 15. Domain Logic Model (cont)● Another example ○ Blog Entry Model has a title ○ Business says Blog entry titles should not be longer than 100 characters ○ Domain Logic Model will validate that the input ready for this Blog Entry model is <= 100
  16. 16. Why is the separation important?● Two reasons ○ Reuse ■ 100 different items for sale, but they dont have a common ancestor (ie, you cant extend a class. In this example, we choose not to use traits) ■ Each one must sell for the exact sale price ■ Only ONE object is required to validate that each time - instead of duplicating that code in each model ■ ** Design patterns - there are more options than just extending forever!!
  17. 17. Why is the separation important? (cont) ● Two reasons ○ Data models should just represent an entity, not the logic behind it ■ Your car has a maximum load. The steel doesnt know that ■ Harddrive example! ● Harddrive is for sale at main warehouse. It is the same harddrive for 10 resellers. ● Each reseller has different properties that determine the final sale price ● The harddrive ITSELF never changes - so that class should be exactly the same for all retailers
  18. 18. Summarize Domain Logic Models● Understands the business logic● Comprehends data models● The Gatekeeper of valid data
  19. 19. Data Mapper Object● Data mappers map data from a Data Access Object to Data Models● Data Access Object ○ not covered too much in this talk ○ provides access to a data source like a database, salesforce, as400, REST, via a predictable interface● Concerned with retrieving or persisting a single Data Model (or collection)
  20. 20. Data Mapper Object (cont)● Not particularly smart ○ will work to retrieve data based on parameters ○ will populate a Data Model generally without validation ■ ** caveat: sometimes a hybrid is created when working with remote sources to introduce Domain Logic Models here... but thats another talk● Works directly with the Data Model ○ Creates new instances ○ Understands properties ○ Determines what to persist
  21. 21. Data Mapper Object (cont)● Harddrive example ○ Can take a Harddrive Data Model and save it in the proper format to MySQL ■ Remember, the object has the data, but perhaps the database is normalized ○ Has a method to find a harddrive by serial number ■ Internally, determines what db field is the serial number, runs the query, and then populates the model with the full properties ○ Build collection ■ findAll() - parameter where size is > 250gb
  22. 22. Why is Data Mapper Important?● Data Models are dumb ○ Dont care what their data is or where it came from● Domain Logic Models only care about decisions ○ They dont care about the source● Something needs to retrieve and persist● Data Mapper is still not your "public" interface ○ (thats a service) - can swap out Data Mappers
  23. 23. Summarize Data Mapper Model● Works directly with Data Model and Data Access Objects● Retrieves and Persists Data Models● Understands properties of Data Models ○ Can map data source to properties ○ Can determine retrieval method based on properties
  24. 24. Services● A lot of confusion with this term ○ Sometimes theyre the public interface of your app ○ Other times they reflect connections to third parties, like Amazon or Salesforce ○ Doesnt matter - lets just move to the concept● Services are the public face to your controllers ○ These classes allow for calling methods that create, persist, modify, and retrieve data ○ Used to translate and process information from user input or other helper classes
  25. 25. Services (cont)● Services are responsible for providing the Data Model or collection to the consumer● Services act as the layer to work with your external consumer or framework● Services do processing that is the same no matter what Data Model, Data Mapper, or other Service is involved ○ retrieving data from a helper model, filtering search term and city/state, etc.
  26. 26. Services (cont)● Harddrive example! ○ Service::save() would accept a harddrive model, grab the proper mapper (perhaps the harddrive mapper associated with mysql), and introduce those two. It would then reintroduce the saved model ○ Service::findBySerialNumber() would accept a serial number parameter, translate that into a parameter for the mapper, get the mapper, retrieve the collection, and pass that back to the consumer
  27. 27. Services (cont)● Harddrive example (cont) ○ Service::validateUpdate() - would take user input in, validate that it is valid and could match up with the Data Model, and return whether the input was acceptable or not ○ Service::populateModel() - takes that validated user input and the model, calls the mapper with this information to populate it (mapper knows fields, not services), and returns it
  28. 28. Why are Services Important?● Services are the public interfaces to the rest of the classes in your app● Things that you allow the consumer to do are only defined in the service layer● If data sources, mappers, models change, your service stays the same, and so does the consumer side of your app
  29. 29. Summarize Services● Public interface to the rest of your code● Understand Data Models, Domain Models, Mappers● Execute processing that is always the same, never differs no matter what objects are in use
  30. 30. Example Code● Lets see this in action. Things to remember:● This is not a whole app - dont treat it as one● It is example code● This is not a whole app● Dont forget, this is not a completed app
  31. 31. Just trying to demonstrate the concepts with the least amount of distraction!
  32. 32. Layout - Overview Main layout of files We will cover each code section
  33. 33. Retrieval Options (A Controller)
  34. 34. Retrieve one by ID
  35. 35. Other retrieval code
  36. 36. The Mapper
  37. 37. The Mapper (cont)
  38. 38. More Mapper
  39. 39. Mapper (populating / mapping)
  40. 40. Data Model
  41. 41. Next Up...Retrieval is done...Lets look at persistence
  42. 42. Persistence Controller (1 of 2)
  43. 43. Persistence Controller (2 of 2)
  44. 44. Creating a User
  45. 45. Creating User (cont)
  46. 46. Domain User Model
  47. 47. Mapper DB - Save
  48. 48. Apply Update From User
  49. 49. Persistence DoneYayNow - lets introduce the value!
  50. 50. Users must be syncd to AS400● Previously was from mysql db● Need to change as little code as possible● The only thing changing is how we map data ○ to / from the data source ○ "map"... mapper● Lets substitute in a different mapper
  51. 51. Modify User Service This is the ONLY change to your code. All else is NEW code.
  52. 52. What does this mapper look like?
  53. 53. AS400 Mapper Continued
  54. 54. AS400 Mapper Continued
  55. 55. AS400 Mapper Continued
  56. 56. Whew! Done!Check it out athttp://aaronsaray.com/midwestphpTweet at @aaronsaray
  1. A particular slide catching your eye?

    Clipping is a handy way to collect important slides you want to go back to later.

×