panlatent/craft-enums

dev-main 2024-04-12 12:44 UTC

Requires

• php: >=8.2
• craftcms/cms: ^4.0|^5.0
• craftcms/generator: ^1.3|^2.0

MIT

• panlatent

README

The Craft Enum is a PHP enum generator. It generates all Fields, Section, Volume ... handles write to code as cases.

// Replace string handle
$section = Craft::$app->secionts->getSectionByHandle(Section::Posts);
// Get a section
$section = Section::Posts->self() 
// Create a entry with sectionId
$entry = Section::Posts->new()
// Entry query with section
$entryQuery = Section::Post->find();

Requirements

• PHP 8.2
• Craft CMS 4.3.5 or later.

Installation

composer require panlatent/craft-enum --dev

If you started your project with a version of Craft earlier than 4.3.5, update and run:

composer require craftcms/generator --dev

Registering Enums generator:

use craft\events\RegisterComponentTypesEvent;
use craft\generator\Command;
use panlatent\craft\enums\Enums;
use yii\base\Event;

// CraftCMS 5.x
Event::on(
    Command::class,
    Command::EVENT_REGISTER_GENERATORS,
    function(RegisterComponentTypesEvent $e) {
        $e->types[] = Enums::class;
    }
);

// CraftCMS 4.x
Event::on(
    Command::class,
    Command::EVENT_REGISTER_GENERATOR_TYPES,
    function(RegisterComponentTypesEvent $e) {
        $e->types[] = Enums::class;
    }
);

Usage

Generate

Reference: CraftCMS Docs

php craft make enums

Generate enums to src/enums

ddev craft make enums --path=src

Coding

See generate codes.

References

License

The Element Messages is open-sourced software licensed under the MIT license.