Skip to content

gammamatrix/playground

Repository files navigation

Playground

Playground CI Workflow Test Coverage PHPStan Level 9 src and tests

This is the base package for Playground.

This package provides model handling for Laravel packages.

  • Playground allows using Laravel ordered UUIDs for primary keys.
  • The configuration in Playground and subpackages permits defining the user model, table and primary key type: increments or uuid.
  • Packages are compatible and tested with and without: middleware, roles, policies, privileges, Sanctum...

Read more on using Playground at the Read the Docs for Playground.

Installation

You can install the package via composer:

composer require gammamatrix/playground

Configuration

You can publish the configuration file with:

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

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

artisan about

Playground provides information in the artisan about command.

screenshot of artisan about command with Playground.

Environment Variables

env() config()
PLAYGROUND_LOAD_MIGRATIONS playground.load.migrations
  • 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.

Migrations

The migrations provided in this package are used for PHPunit 11 feature testing with Orchestra Testbench.

  • They will not be exported in software builds.

Cloc

composer cloc
➜  playground git:(develop) ✗ composer cloc
> cloc --exclude-dir=output,vendor .
      98 text files.
      62 unique files.
      38 files ignored.

github.com/AlDanial/cloc v 1.98  T=0.11 s (582.6 files/s, 57515.8 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
PHP                             52            921            856           3591
YAML                             1              5              0            275
XML                              3              0              9            222
JSON                             2              0              0            103
Markdown                         3             42              0             82
INI                              1              3              0             12
-------------------------------------------------------------------------------
SUM:                            62            971            865           4285
-------------------------------------------------------------------------------

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

License

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

Releases

No releases published

Languages