czim/laravel-cms-models

There is no license information available for the latest version (1.7.3) of this package.

Laravel CMS: Main Models Module Generator

1.7.3 2020-04-02 13:05 UTC

README

Latest Version on Packagist Software License Build Status Coverage Status

CMS for Laravel - Main Models Module

This module offers the means to edit Eloquent models through the Laravel CMS.

Features:

  • Model listings
  • Edit forms for creating and updating model records
  • Elaborate (optional) module configuration and customization.
    • Customizable listing columns, scopes, filters, sorting, etc.
    • Customizable edit form html, fields, validation rules, create vs. edit forms, etc.
    • Customizable model references, display labels, etc.
  • Support for Translatable models
  • Support for Listify'd models, with drag/drop reordering
  • Support for nested child-parent listings and breadcrumb trails

To be used to with the Laravel CMS Core.

For a better end-user experience when using file uploads, installing the Laravel CMS Upload Module is recommended.

Version Compatibility

Laravel Package
5.3 1.3
5.4 1.4
5.5 1.5
5.6 1.6
5.7 1.7

Changelog

View the changelog.

Installation

Add the module class to your cms-modules.php configuration file:

    'modules' => [
        // ...
        Czim\CmsModels\Modules\ModelModuleGenerator::class,
    ],

Add the service provider to your cms-modules.php configuration file:

    'providers' => [
        // ...
        Czim\CmsModels\Providers\CmsModelsServiceProvider::class,
        // ...
    ],

To publish the config:

php artisan vendor:publish

Configuration

Models may be added with basic functionality by simply registering them in the cms-models config, or special CMS model configuration files may be created for them to customize them as needed.

Adding and Configuring Models

To register models with the CMS module, you can either:

  • Add their full class name to the cms-models.models config array:

    <?php
          'models' => [
              App\Models\YourModel::class,
          ],
  • Create a model configuration file for them in the configured directory.
    By default, this is in the app/Cms/Models/ directory; this is defined under the cms-models.collector.source.dir key.

For more details about customizing how models are configured, see the documentation on Model Configuration.

Troubleshooting

If you run into problems, please consult the CMS core troubleshooting section.

Further information

Contributing

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.