PHPackages sinclairt/magic-views - 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. sinclairt/magic-views ActiveLibrary sinclairt/magic-views ===================== Magic CRUD views that takes the hassle out of repetitive blades. Useful for RAD 1.0.29(9y ago)1601MITPHP Since Dec 14Pushed 9y agoCompare [ Source](https://github.com/sinclairt/magic-views)[ Packagist](https://packagist.org/packages/sinclairt/magic-views)[ RSS](/packages/sinclairt-magic-views/feed)WikiDiscussions master Synced 1mo ago READMEChangelogDependencies (3)Versions (31)Used By (1) Magic Views =========== [](#magic-views) Magic views are a quick and simple way to implement crud views with as little or as much customisation as you want. ### Installation [](#installation) `composer require sinclairt/magic-views` `composer install` Add the service provider to your `app/config` ``` Sinclair\MagicViews\MagicViewsServiceProvider::class ``` `composer dump-autoload` ### Usage [](#usage) Use the trait in your controller `use HasMagicViews;`. As it stands, there are four views: index, create, edit, and show. The edit and update views require a `$model` variable, the index view requires a `$rows` variable which should be an instance of `Illuminate\Pagination\Paginator`. You can get a paginated object by using `paginate()` on the end of your query instead of `get()` i.e. ``` $users = User::where('votes', '>', 100)->paginate(15); ``` So an index method might look something like this: ``` public function index() { $rows = User::where('votes', '>', 100)->paginate(15); return $this->indexView(compact('rows')); } ``` Create like this... ``` public function create() { return $this->createView(); } ``` Edit... ``` public function edit($model) { return $this->editView(compact('model')); } ``` Show... ``` public function show($model) { return $this->showView(compact('model')); } ``` ### Assumptions [](#assumptions) Magic Views makes a few assumptions to ensure your views are rendered with as little configuration as possible: - You are using resourceful routing where your route names are the same as the model i.e. `User` model means `Route::resource('user', 'UserController');` - You are following a naming convention with your models and controllers i.e. a `User` model has a controller of `UserController` - You have registered the model in the IoC container by its short name i.e. `App\Models\User` is registered in the IoC container as `User` `$this->app->bind('User', 'App\Models\User'); // or an interface if you are following the SOLID principles` ### Settings [](#settings) The index view will use the `$fillable` array and the `$hidden` array to decide which columns to show, but you can over ride this by setting the `$indexColumns` variable on your model: ``` public $indexColumns = [ 'username', 'email', 'created_at']; ``` The create and edit views use the `$fillable` array to display fields on the forms, these will default to text but you can over ride this by setting the `$fields` variable on your model: ``` public $fields = [ 'username' => 'text', 'password' => 'password', 'email' => 'email', 'password_confirmation' => 'password' ]; ``` The key is the field name, the value is the field type. ##### Available field types: [](#available-field-types) - text - plain-text - email - password - radio - select - checkbox - text-area - submit - text-disabled You can extend this of course. Publish the assets, and then add your own blade in the partials/form directory and list the view in the fields array i.e. let's say you need a particular input when creating a user to assign roles, so you might have a `roles.blade.php` and then set `'role_id' => 'roles'`, hey presto your custom input is used in the form. This can be a quicker way of adding content to your forms then using the `$additionalFormContentBefore` and `$additionalFormContentAfter` hooks. ##### Field Notes [](#field-notes) A select requires options, set the options by passing in a variable with the naming convention of *fieldname*Options i.e. role would be `$roleOptions`. This variable should an associative array with the key as the value to submit from the form i.e. the id, and the value as the display value for the option i.e. the name. ``` $roleOptions = [ 3 => 'admin', 5 => 'standard', 10 => 'supervisor' ]; ``` ##### Buttons [](#buttons) On the index view are some buttons: show, edit, delete, and where your model uses soft deletes restore. By default all buttons are on ( when an object is trashed only restore and show are visible, and when its not restore is hidden, and edit and delete are added. You can configure the buttons you want to show by passing in a `$buttons` variable with the buttons you wish to show: ``` // this will enable the show and edit buttons only $buttons = ['show', 'edit']; return $this->indexView(compact('rows', 'buttons')); ``` Sometimes you might want to disable the creation of objects, to do this set the variable `$new = false;` and pass into your view and this will remove the new button. The buttons can be formatted for a drop menu instead by setting the variable `$dropdown = true` and passing into your view. ##### Display Values [](#display-values) There are three ways to approach this, as the value is, using Laravel's mutators, or using a Presenter. If your happy using the first two, then there is nothing more to do, then to read up on Eloquent Mutators if necessary. If you would like to use a Presenter, Magic Views will look for this so that it can be used in the view, it will assume the method on the presenter is the field name studly cased with 'present' in front i.e. `user_id` becomes `presentUserId`. If you would like to over ride the name of the presenter method to use then pass in a variable with the naming convention of present*FieldName* i.e `user_id` would become `$presentUserId`; you would then pass this a string of the method name you would like to use e.g. let's say you want to present the username instead of the user\_id, and your method on your presenter is `userName` you would do the following: ``` $presentUserId = 'userName'; return $this->indexView(compact('model', 'presentUserId')); ``` Now Magic Views will load the userName method instead. If you do not have a method in the presenter for your method it will revert to the column value or mutator if set. ##### Other Variables [](#other-variables) Magic views creates the following variables to put into the view, you can over ride them by passing in the variable(s) yourself: - breadcrumbs - action (this is the action on forms) - pageTitle - pageSubTitle - panelTitle ##### Additional Content [](#additional-content) Magic Views allows you to add additional content to both the forms and the pages. To do this, create a view and pass the view name to one of the following variables and inject to the view: - `$additionalFormContentBefore` Adds content before the form fields but inside the form - `$additionalFormContentAfter` Adds content after the form field but inside the form - `$additionalContentBefore` Adds content before the panel of content - `$additionalContentAfter` Adds content after the panel of content ``` $additionalContentAfter = 'partials.product.options'; return $this->indexView(compact('rows', 'additionalContentAfter')); ``` ##### Further Customisation [](#further-customisation) You can further customise the views by changing the config values, the language values, or the editing the views themselves. To do this publish the assets of the package by running `php artisan vendor:publish`. All values displayed outside of model and presenter values, are passed through a language file first, there is an example for users in the language file already. The term `user` sits on the top level of the array, but the fields of the `user`, including the column names in the index view, sit inside the fields array. Placeholders can also be set here where applicable just add `_placeholder` onto the end of the column/field name. If you would like to swap out any of the partials for your own, you can change the value in the config file. You can also change the title tag, brand image, nav-links, form-action assumptions, and any breadcrumb prefix you may want i.e. home or dashboard. There is also a fallback option for language files. If you supply a dot notation string to the `trans('general.responses.success')` method in Laravel and it doesn't find a value it will return the dot notation string ( `general.responses.success`), the logic behind this is that it is easier to spot a missing language value if it is displayed like this. If you switch on the fallback (default is true), then it will find the last element in your dot notation and return that instead of the full string i.e. `general.responses.success` becomes `success`. If want to turn this off, change the `use-trans-fallback` to `false`. The method is `get_trans()` if you would like to use in your own code. Beyond this, you can edit the views themselves. ### Finally [](#finally) You can extend the Magic Views so long as you create them. For example, lets take a stats page for a user, create a `stats.blade.php`, which might extend the `magic-views::layout.master` (or use the config value `config('magic-views.master')`), and add a section `content` with your content inside. Now you can call `return $this->myView(['blade' => 'path.to.stats']);` in your controller. Or, if you publish the assets (`php artisan vendor:publish` ), and put your view inside `resources/views/vendor/magic-views/crud` you can call `$this->statsView();` There are two yield methods in the layout for code to go into the `head` and the `foot` should you need it. ### Health Score 31 — LowBetter than 68% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity10 Limited adoption so far Community8 Small or concentrated contributor base Maturity74 Established project with proven stability 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 ~16 days Recently: every ~73 days Total 30 Last Release 3328d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/a0dc010eef4e76d1eb705b4f2257422302ada2164add753976f7998d9203b19a?d=identicon)[sinclairt](/maintainers/sinclairt) --- Top Contributors [![sinclairt](https://avatars.githubusercontent.com/u/16877448?v=4)](https://github.com/sinclairt "sinclairt (4 commits)") ### Embed Badge ![Health badge](/badges/sinclairt-magic-views/health.svg) ``` [![Health](https://phpackages.com/badges/sinclairt-magic-views/health.svg)](https://phpackages.com/packages/sinclairt-magic-views) ``` ### Alternatives [laravel/cashier Laravel Cashier provides an expressive, fluent interface to Stripe's subscription billing services. 2.5k25.9M106](/packages/laravel-cashier)[laravel/pulse Laravel Pulse is a real-time application performance monitoring tool and dashboard for your Laravel application. 1.7k12.1M99](/packages/laravel-pulse)[graham-campbell/markdown Markdown Is A CommonMark Wrapper For Laravel 1.3k7.1M63](/packages/graham-campbell-markdown)[laravel-doctrine/orm An integration library for Laravel and Doctrine ORM 8425.3M87](/packages/laravel-doctrine-orm)[akaunting/laravel-money Currency formatting and conversion package for Laravel 7825.3M18](/packages/akaunting-laravel-money)[proengsoft/laravel-jsvalidation Validate forms transparently with Javascript reusing your Laravel Validation Rules, Messages, and FormRequest 1.1k2.3M49](/packages/proengsoft-laravel-jsvalidation) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)