gammamatrix/playground-cms

Playground: Provide the CMS models for the Playground Content Management System.

dev-develop / 73.x-dev 2024-08-05 18:47 UTC

Requires

• php: ^8.2
• gammamatrix/playground: *

Requires (Dev)

• gammamatrix/playground-test: *

Suggests

• gammamatrix/playground-cms-api: Provides an API, without a UI, to interact with the models provided in this package.
• gammamatrix/playground-cms-resource: Provides a resource API and optional Blade UI to interact with the models provided in this package.

MIT

• Jeremy Postlethwaite

• cms
• laravel
• playground
• gammamatrix

README

The Playground CMS is a package for Laravel applications.

This application provides the models to use the Playground CMS, a Content Management System.

Read more on using Playground CMS at Read the Docs: Playground Documentation.

Installation

NOTE: This package is required by:

• Playground CMS API: API without UI
• Playground CMS Resource: API with UI

Install this package, with composer, to get access to the CMS Models:

composer require gammamatrix/playground-cms

artisan:about

Playground CMS provides information in the artisan about command.

Configuration

Migrations are disabled by default. This package may sometimes be installed where another system handles the migrations.

See the contents of the published config file: config/playground-cms.php

You can publish the config file with:

php artisan vendor:publish --provider="Playground\Cms\ServiceProvider" --tag="playground-config"

Environment Variables

env()	config()	Default
PLAYGROUND_CMS_ABOUT	playground-cms.about	true
PLAYGROUND_CMS_LOAD_MIGRATIONS	playground-cms.load.migrations	false

• The loading option for migrations does not take effect if the migrations have been exported to your app. The control for loading is handled in the package ServiceProvider.

Models

This package includes factories, models and migrations for:

• Pages
• Page Revisions
• Snippets
• Snippet Revisions

Migrations

All migrations are disabled by default.

See the contents of the published config file: database/migrations

• NOTE: There are 4 tables that will be created, they do have indexes and unique constraints defined; however, this release does not have the foreign key constraint migrations included at this time.

You can publish the migrations file with:

php artisan vendor:publish --provider="Playground\Cms\ServiceProvider" --tag="playground-migrations"

Cloc

composer cloc

➜  playground-cms git:(feature/GH-9) ✗ composer cloc
> cloc --exclude-dir=node_modules,output,vendor .
      46 text files.
      43 unique files.
       5 files ignored.

github.com/AlDanial/cloc v 1.98  T=0.09 s (453.6 files/s, 159004.1 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
JSON                             6              0              0          11017
PHP                             29            264            838           2281
YAML                             1              5              0            275
XML                              3              0              7            215
Markdown                         3             44              0            111
INI                              1              3              0             12
-------------------------------------------------------------------------------
SUM:                            43            316            845          13911
-------------------------------------------------------------------------------

PHPStan

Tests at level 9 on:

• config/
• database/
• src/
• tests/Feature/
• tests/Unit/

composer analyse

Coding Standards

composer format

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Credits

• Jeremy Postlethwaite

License

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