friendsofsulu/maker-bundle

Package to generate configuration and boilerplate code in Sulu

dev-master 2025-01-14 17:22 UTC

Requires

• php: >=8.2
• symfony/maker-bundle: ^v1.60.0
• webmozart/assert: ^1.11.0

Requires (Dev)

• php-cs-fixer/shim: ^3.14
• phpstan/phpstan: ^1.11.7
• phpstan/phpstan-webmozart-assert: ^1.2.7
• phpunit/phpunit: ^9.6.20

MIT

• mamazu

• sulu
• maker-bundle

README

This package adds code generators for Sulu configurations and other features of Sulu to get you started quicker. This bundle is based on the Symfony maker bundle

How to install

Installing it with composer is very easy:

composer require --dev friendsofsulu/maker-bundle

Example Usage

Create an entity (either manually or with make:entity).

<?php

declare(strict_types=1);

namespace App\Entity;

class Changelog
{
    public static $RESOURCE_KEY = 'changelog';
    // or...
    public const RESOURCE_KEY = 'changelog';

    public ?int $id = null;
    public string $name = '';
    public string $description = '';
}

Then you can create a list configuration for this entity bin/console make:sulu:list App\\Entity\\Changelog. This will ask for every property if it should be visible and if it is should be searchable. Looking like this:

Most of the values have defaults so just hitting enter on most of them works.

Feature List

Here is a list of features this maker provides.

✅ Generating a new page type sulu:make:page-type

You can generate an XML file in the Sulu pages directory and an example template in the Twig directory.

✅ Generating the List XML Configruation make:sulu:list

The basics for this are working. This can't generate a configuration for entities with join columns.

❗ Generating form XML configuration make:sulu:form

TODO

✅ Generating an admin class for an entity sulu:make:admin

Basic generation is working. You can also disable parts of the view generation (generating a view without the edit form).

✅ Generating a controller sulu:make:controller

You can generate a controller with get, delete and update actions or any combination of those. And it even has some helpful tips on avoiding pitfalls with _ in the resource key.

❗ Generate all of the above sulu:make:resource

TODO

✅ Generate a Trash handler sulu:make:trash_handler

Generates a Trash handler with the option to also implement restoring functionality for the resource.

✅ Generate a Sulu fixture sulu:make:fixture

Generates an example fixture to create a Sulu document