gammamatrix / playground-directory

dev-develop / 75.x-dev 2026-10-23 17:46 UTC

Requires

• php: ^8.4
• gammamatrix/playground: *

Requires (Dev)

• gammamatrix/playground-test: *

Suggests

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

MIT

• Jeremy Postlethwaite

• directory
• laravel
• playground
• gammamatrix

Published on Packagist.org on 2026-10-23 17:46 UTC

README

The Playground Directory is a package for Laravel applications.

Playground: Provides the Directory models for the Playground Directory System.

Read more on using Playground: Directory at Read the Docs

Installation

NOTE: This package is required by:

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

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

composer require gammamatrix/playground-directory

artisan:about

Playground Directory 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-directory.php

You can publish the config file with:

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

Environment Variables

env()	config()	Default
PLAYGROUND_DIRECTORY_ABOUT	playground-directory.about	true
PLAYGROUND_DIRECTORY_LOAD_MIGRATIONS	playground-directory.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:

• Contact
• ContactRevision
• Location
• LocationRevision
• Tag
• Tagged

Migrations

All migrations are disabled by default.

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

• NOTE: There are 6 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\Directory\ServiceProvider" --tag="playground-migrations"

Cloc

composer cloc

-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
JSON                            39              0              0          15484
PHP                             39            432            969           2755
XML                              3              0              7            215
YAML                             1              4              0            187
Markdown                         3             45              0            105
INI                              1              3              0             12
-------------------------------------------------------------------------------
SUM:                            86            484            976          18758
-------------------------------------------------------------------------------

PHPStan

Tests at level 10 on:

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

composer analyse

Coding Standards

composer format

Testing

Unit tests

composer test

Unit and feature tests

composer test-dev

Run unit and feature tests in parallel:

composer test-parallel

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.