The Mystery In The Models: The Basics of Adding a Model to your EE Add-on
Download as PPTX, PDF0 likes479 views
The document discusses adding models to ExpressionEngine add-ons to provide data abstraction and management. It explains that models represent data structures and handle CRUD operations. The document then walks through creating a model called "Vote" to manage an upvote/downvote system, including defining the data structure, initiating the model, scaffolding it, and making the model support CRUD operations. It also lists some additional capabilities of models like relationships, events, validation and collections.
The Mystery In The Models: The Basics of Adding a Model to your EE Add-on
- 1. The Mystery In The Models Adding a Model to Your EE Add-on
- 2. Current Pittsburgher I lead tripleNERDscore I build in EE I love my fam I drink more coffee than I should I’m here to serve!
- 3. Models Made Me Wanna….
- 4. What Are Models And What Do They Do?
- 5. How EE Uses Models
- 8. Get a File and Filter on Relationship system/ee/EllisLab/ExpressionEngine/Controller/Files/Files.php
- 9. Let’s Build!
- 10. Create Our Data Structure
- 11. Data Structure Model: Vote Table: upvotedownvote_votes id - our primary key entry_id - Associated entry upvotes - Count of upvotes downvotes - Count of upvotes
- 15. Let's Make it CRUDdy
- 16. What Else Can Models Do? Relationships Events Validation Metadata Many to Many Relationships Collections
- 18. Questions?
Editor's Notes
- #5: A model is class that represents a logical structure and associated database table. In other words, models manage data. EE has a number of models already there, like Channel, ChannelEntry, Member, Template, etc.
- #6: - Create an Entry system/ee/EllisLab/ExpressionEngine/Controller/Publish/Publish.php - Read a Member system/ee/EllisLab/ExpressionEngine/Controller/Members/Members.php - Get a File with Relationship system/ee/EllisLab/ExpressionEngine/Controller/Files/Files.php
- #10: Let’s help E720 change their site so people can upvote and downvote their content
- #11: ### Create our Data and DB Tables - Models don't create your database tables by default, so we'll need to use the DBForge to create them. 1. Map our data first 2. Create schema in `upd` file
- #12: ### Create our Data and DB Tables - Models don't create your database tables by default, so we'll need to use the DBForge to create them. 1. Map our data first 2. Create schema in `upd` file
- #13: ### Initiate Our Model Models are registerd in your addon.setup.php file Add it to your add-on setup 1. `models` array 2. Lots of ways to extend this, we'll go through one way later
- #14: ### Initiate Our Model Models are registerd in your addon.setup.php file Add it to your add-on setup 1. `models` array 2. Lots of ways to extend this, we'll go through one way later
- #15: ### Scaffolding - Let's look at the basics of the model 1. Extend the EE Model class 2. Primary Key and Table Name are required 3. Protected Elements of the Model are your data points
- #16: ### Let's Make it CRUDdy! 1. `votes` method: Reading the votes, Creating a new one 2. `cast_vote` method: Updating the votes
- #17: ### Relationships - By nature of our Votes model, it's connected to a ChannelEntry. - Only problem is that we have not defined this relationship, so we would need multiple DB calls to get it. - Relationships relate entries 1. Define the relationship 2. Define the inverse (addon.setup and Vote model) 3. `top` method: Getting entries by the top voted ## What Else Can Models Do? - Events (i.e. update another model when your model is updated) - Validation (i.e. check to make sure data coming in is good and will save) - Metadata (i.e. setting variables re: whether model was updated) - Relationships with pivot tables (i.e. tagging entries, multiple entries can have multiple tags) - Collections (manage multiple items in your data)