Download the PHP package tdwesten/statamic-builder without Composer

Statamic Builder

The Statamic Builder speeds up building Statamic sites. It offers a clear method to define sites, blueprints, fieldsets, collections, navigations and taxonomies using PHP classes. This approach enhances code readability and maintainability compared to writing YAML files.

Features

• Fluent API: Define Statamic components using a clean, chainable PHP API.
• Auto-discovery: Automatically discover and register your components from the filesystem.
• Navigation Support: Easily define and manage Statamic Navigations in PHP.
• Global Sets & Taxonomies: Full support for Global Sets and Taxonomies.
• Multi-site Support: Define and manage multiple sites through PHP classes.
• Artisan Commands: Generate blueprints, fieldsets, collections, and more with dedicated commands.
• YAML Export: Export your PHP-defined components to standard Statamic YAML files.
• Eloquent Support: Full support for Statamic Eloquent Driver for Global Sets, Navigations and Collections (mount).

Installation

You can install this addon with composer:

Requirements

• PHP 8.3+
• Statamic 6.0+
• Laravel 12+

Configuration

You can publish the configuration file using:

The configuration file allows you to manually register components or enable auto-discovery.

Options

Auto Registration & Discovery

Enable auto_registration in config/statamic/builder.php to automatically find components in your app/ directory.

Discovery Requirements

For components to be auto-discovered, they must implement certain static methods:

• Blueprints: Must implement static function handle() and static function blueprintNamespace().
• Collections, Taxonomies, Globals, Navigations, Asset Containers: Must implement static function handle().
• Sites: Must implement function handle().

Blueprints and Fieldsets

Creating a Blueprint

1. Generate a blueprint:

2. Define your fields in the registerTabs method:

Creating a Fieldset

1. Generate a fieldset:

2. Define fields:

Collections, Taxonomies, and Globals

Collections

Generate a collection:

Most methods in BaseCollection now have default implementations, so you only need to override what you want to change (e.g., route(), sites(), template()).

Taxonomies

Generate a taxonomy:

Global Sets

Global sets can be defined as PHP classes. This allows you to manage global variables and their localization through PHP classes.

1. Generate a global set:

2. Configure your global set:

By default, the global set will use the default site. You can override the sites() method to support multiple sites.

Blueprint for Global Sets

To define fields for your global set, create a blueprint with the same handle in the globals namespace:

Asset Containers

Generate an asset container:

Most methods in BaseAssetContainer have default implementations, so you only need to override what you want to change (e.g., disk(), allowUploads(), createFolders()).

Navigations

Generate a navigation:

Multi-site Support

Generate a site:

Working with Foreign Fieldsets

When working with a mixed codebase or utilizing other Statamic addons, you can import their fieldsets using ForeignFieldset and ForeignField.

Supported Field Types

Statamic Builder supports all core Statamic field types. Use the make($handle) method to instantiate them.

Custom Fields

You can create a custom field by extending the Field class or using the generator:

Artisan Commands

Exporting to YAML

If you need to generate standard Statamic YAML files from your PHP definitions:

Changes

Version 1.1.0 (Refactoring & Auto-discovery)

• Base Classes: BaseCollection, BaseGlobalSet, and BaseNavigation now provide default implementations for several methods that were previously abstract. While this simplifies new components, ensure your existing components still behave as expected if they were relying on the previous abstract structure.
• Search Index: BaseCollection::searchIndex() return type is now nullable (?string).
• Blueprints: Blueprints now prefer static handle() and blueprintNamespace() methods for better auto-discovery support.

Version 1.2.0 (Enhanced Components & Commands)

• Global Sets & Navigations: Fully integrated with Statamic repositories, allowing for saving and better multi-site support.
• New Commands: Added make:site and make:asset-container for faster development.
• Generator Refactoring: Unified logic for all generator commands.
• Field Types: Added several new field types including Color, Hidden, Money, Number, Password, Rating, Time, and Video.