PHPackages michaeljoyner/edible - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. michaeljoyner/edible ActiveLibrary michaeljoyner/edible ==================== Maps a basic content structure outlined in a yaml file to Eloquent models in your Laravel app. v0.1.19(9y ago)038MITPHPPHP ^5.5|^7.0 Since Mar 3Pushed 9y ago1 watchersCompare [ Source](https://github.com/michaeljoyner/edible)[ Packagist](https://packagist.org/packages/michaeljoyner/edible)[ RSS](/packages/michaeljoyner-edible/feed)WikiDiscussions master Synced 2mo ago READMEChangelogDependencies (7)Versions (18)Used By (0) Edible ====== [](#edible) Maps a content structure (consisting of pages with textblocks and galleries) to Eloquent models in your Laravel application. The user, usually in some sort of admin section, can then edit the contents of the textblocks and galleries, but have no control over the creation and deletion of them. Assumptions ----------- [](#assumptions) This package is very opinionated, as it is structured to work with how I set up my workflow/site structure. Due to that it makes several large assumptions, which I hopefully can get rid of in the future. However, for now, this package assumes: - Vue.js, along with vue-resource are included in your scripts. Additionally, the vue components included in this package are registered with Vue - TinyMCE is included and available - The css included in the css directory is included in any of the applicable pages Installation and Setup ---------------------- [](#installation-and-setup) Install the package via composer: `composer require michaeljoyner/edible` Add the service provider: ``` //config/app.php $providers = [ ... Michaeljoyner\Edible\EdibleServiceProvider::class, ... ]; ``` Publish the migrations and views: `php artisan vendor:publish --provider="Michaeljoyner\Edible\EdibleServiceProvider"` You will have to go to your `resources/views/vendor` folder to adjust the views to work with your view structure. Run the migrations: `php artisan migrate` Your edible.yaml file --------------------- [](#your-edibleyaml-file) You need to create a file named `edible.yaml` in the root directory of your application. The file must adhere to the structure shown in this example: ``` pages: home: description: The homepage textblocks: intro: description: The homepage intro allows_html: false spiel: description: Company story allows_html: true galleries: slider: description: Homepage banner slide images is_single: false about: description: The about page textblocks: intro: description: The about page intro allows_html: false spiel: description: My story allows_html: true galleries: slider: description: About page banner slide images is_single: false ``` The edible.yaml file describes a collection of pages. Each page has a description and a collection of textblocks and galleries. Each textblock has a description and a boolean flag to determine if the text will be edited as HTML (i.e. with a WYSIWYG editor) or as plain text. Each gallery has a description and a boolean flag to determine if it is a single image or a collection of images. If is\_\_single is true, each image uploaded will overwrite the previous ones. Mapping to models ----------------- [](#mapping-to-models) Once your edible.yaml file is complete, you may run `php artisan edible:map`. You will be shown a summary of the changes that will be made, and asked to confirm before proceeding. If you choose to proceed, the contents of your edible file will be mapped to Eloquent models and stored in your database. Updating the edible.yaml file ----------------------------- [](#updating-the-edibleyaml-file) To add a new page, textblock or gallery, just add it into your edible.yaml file as normal. Next time you run `php artisan edible:map`, they will be added. Existing content will be untouched. To remove a page, textblock or gallery, simply delete it from the edible.yaml file. Obviously this will also delete the associated content. *DO NOT* modify the name of an existing page, textblock or gallery as *YOU WILL LOSE THE EXISTING CONTENT*. Rather ensure you get the names and descriptions correct before pushing your changes live. By editing the name of an existing page, textblock or gallery, when you next map, it will treat that as a new instance, and delete the "old" one along with its contents. Editing content --------------- [](#editing-content) The service provider registers routes to point to each page described in your edible file from where you can edit/manage each textblock or gallery. What I normally do, and hope to include automatically soon, is make a view composer for my admin section's navbar to provide a list of the pages and their urls to the navbar view so I can create the menu links. The `ContentRepository->getPageListWithUrls()` method exists for this reason. Using content in the views -------------------------- [](#using-content-in-the-views) The `Michaeljoyner\Edible\ContentRepository` class is how you access the content to include in your views. Typically in your controller you would use the ContentRepository method `getPageByName` to retrieve the desired page. This will return an instance of `Michaeljoyner\Edible\Models\Page` which can be used to get contents. Below should give an example ``` // $page is an instance of Michaeljoyner\Edible\Models\Page // to get the contents of a textblock $page->textFor('name-of-textblock', 'default string'); // returns a string // to get the images of a gallery $page->imagesOf('gallery-name') // returns a laravel collection of Spatie's Laravel-MediaLibrary Media objects ``` ### Health Score 25 — LowBetter than 37% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity7 Limited adoption so far Community7 Small or concentrated contributor base Maturity57 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~11 days Recently: every ~41 days Total 17 Last Release 3552d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/3e338b7fb560ae5f882c2232eb0c84714a802b758d57c10c1f27c1cfc811644d?d=identicon)[michael joyner](/maintainers/michael%20joyner) --- Top Contributors [![michaeljoyner](https://avatars.githubusercontent.com/u/5893483?v=4)](https://github.com/michaeljoyner "michaeljoyner (43 commits)") ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/michaeljoyner-edible/health.svg) ``` [![Health](https://phpackages.com/badges/michaeljoyner-edible/health.svg)](https://phpackages.com/packages/michaeljoyner-edible) ``` ### Alternatives [laravel/sail Docker files for running a basic Laravel application. 1.9k186.9M1.0k](/packages/laravel-sail)[craftcms/cms Craft CMS 3.6k3.6M2.6k](/packages/craftcms-cms)[laravel/vapor-cli The Laravel Vapor CLI 31310.7M8](/packages/laravel-vapor-cli)[orchestra/canvas Code Generators for Laravel Applications and Packages 21017.2M158](/packages/orchestra-canvas)[laravel/roster Detect packages & approaches in use within a Laravel project 15410.4M7](/packages/laravel-roster)[ryangjchandler/orbit A flat-file database driver for Eloquent. 922256.2k5](/packages/ryangjchandler-orbit) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)