CraftBase

Shared Craft CMS base plugin for QD extensions. Provides reusable utilities, configuration helpers, control panel enhancements, logging helpers, and integrations used across multiple QD Craft projects.

---

Requirements

Dependency	Version
PHP	^8.0
Craft CMS	^4.0

---

Installation

Via Composer (recommended)

Add the package to your project's composer.json:

{
    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/quantity-digital/craft-base"
        }
    ]
}

Then require the package:

composer require quantity-digital/craft-base

Finally, install the plugin in Craft:

php craft plugin/install craft-base

Or through the Craft control panel:

Craft CP → Settings → Plugins → Craft Base → Install

---

Configuration

Copy the default config file into your project's config/ directory:

cp vendor/quantity-digital/craft-base/src/config.php config/craft-base.php

Then adjust config/craft-base.php to suit your environment. Only the keys you wish to override need to be present.

Setting	Default	Description
enableCpAccessGuard	false	Enables the optional CP access recovery page for logged-in users without control panel access.

---

Intended Usage

This package is a foundation layer — it does not add end-user features by itself. Other QD plugins depend on it for shared infrastructure:

Future Module	Description
CpAccess	Optional control panel access recovery, disabled by default
Logging	Centralised, structured logging helpers
Config	Environment-aware configuration utilities
Utilities	Craft Utilities CP section

---

Directory Structure

src/
├── CraftBase.php          # Main plugin class
├── Settings.php           # Plugin settings model
├── config.php             # Default configuration values
├── modules/               # Reusable CraftBase modules
└── templates/             # Shared plugin settings templates

---

Development

# Install dependencies
composer install

# Validate composer.json
composer validate

---

Changelog

See CHANGELOG.md.

---

License

MIT — see LICENSE.