alexander-schranz / sulu-backend-bundle

A Sulu Bundle to make it easier to create new Backend Bundles.

SULU Backend Bundle

Inspired by doctrine crud generator.

A Sulu Bundle to make it easier to create a new Backend Bundle.

With this Bundle it should be possible to create a Backend Bundles without the knowledge of husky the sulu javascript framework.

Installation

composer require l91/sulu-backend-bundle

Add Bundle to AdminKernel

$bundles[] = new L91\Sulu\Bundle\BackendBundle\L91SuluBackendBundle();

Usage

As example we will create a API for an entity called Vehicle.

1. Create Entity

First create the doctrine entity with a .orm.xml.

2. Create Repository

Create a Repository for loading entities from the database. The BackendRepository have a default implementation for them:

• findById
• findAll
• count

Create the functions in your repository or extend from the BackendRepository.

<?php

namespace YourBundle\Entity\Repository;

use L91\Sulu\Bundle\BackendBundle\Entity\Repository\BackendRepository;

class VehicleRepository extends BackendRepository
{
    // Add your custom repository functions here
}

Register Repository

services:
    your.repository.vehicle:
        class: YourBundle\Entity\VehicleRepository
        factory_service: doctrine.orm.entity_manager
        factory_method: getRepository
        arguments:
            - YourBundle\Entity\Vehicle

4. Generate Controller, Manager, Admin Navigation or Tab, JSBundle

You can easily generate them with following command:

app/console l91:sulu:backend:generate:crud YourBundle:Vehicle --route-format yml --service-format yml

Add --extended to have no requirements to this Bundle. This will generate a complete own Controller, Manager, ... when use the extended generation you could remove this bundle from your requirements after you generated your bundle.

Command List

You can also just generate a specific part with the following commands:

• app/console l91:sulu:backend:generate:controller
• app/console l91:sulu:backend:generate:manager
• app/console l91:sulu:backend:generate:admin
• app/console l91:sulu:backend:generate:js
• app/console l91:sulu:backend:generate:navigation-provider

sulu-backend-bundle's Issues

Admin JSBundle Generator

Subentities Support

1. One-To-One entities can have their own tab (own xml)
2. One-To-Many/Many-To-Many will shown as list in own tab

New way to handle crud process

Read

Controller:cGet -> Repository:load <-> Serialize

List

Controller:cGet -> Controller:getFieldDescriptors

Create

Controller:post -> Manager:create <-> Mapper:bind <-> Manager:save <-> Serialize

Update

Controller:put -> Repository:load <-> Mapper:bind <-> Manager:save <-> Serialize

Delete

Controller:delete -> Manager:delete

Backend Repository

Will have a default implementation for get, getBy, countBy

Add dependency only to dev requirements

In the README it's suggested to add the package to the general requirements of a project. However most often, one just want's to add it as a dev-requirement.

Manager Generator

General Rest Controller

• cget
• get
• post
• put
• delete

Field with type text should be a texteditor in template

The template generation should support textarea for fields with type TEXT

500 error when datefield is nullable

Code should be this then

       $date = self::getValue($data, 'date');

       if ($date) {
            $date = new \DateTime($date);
        } else {
            $date = null;
        }

        $test->setDate($date);

Improve output of commands

It should be more obvious that something has to be done, e.g. add a sentence after the generation of the controller "Add the following to the admin routing of your bundle:".

Maybe you could even include instructions to generate an admin routing file if not already existent:

client_website_admin:
    type: rest
    resource: "@ClientWebsiteBundle/Resources/config/routing_admin.yml"
    prefix: /admin/api

Admin Navigation Class

a class with can be easy registered as service to add new items to the admin navigation

Automatically register Controller

Extend none specific entity files from CRUD generator

• Bundle Admin
• JS Main Routes
• Services Registration
• Routes Registration

Improve documentation

• I would add the dependency as require-dev instead of require composer require --dev l91/sulu-backend-bundle instead of composer require l91/sulu-backend-bundle
• Bundle must be added to the AdminKernel
• Explain the --extended option more detailed.

ListBuilder changed and use request stack

Use the list builder service.

Controller Exception Handling

Permissions Tab Generator

Editing a text editor does not activate the save button

The save button is still disabled after editing a text field.

Add filters based on class in repository

The BackendRepository should allow filters based on the class.
This means filters based on int and string values.

Seo Tab Generator

Time entity properties are not handled correctly

• manager
• template

Automatically register Admin

Settings Tab Generator

Symfon Form Support

Maybe easier way todo when this feature request is included: sulu/sulu#2275

Form View Component

Needs #32

Repository Generator

Boolean entity properties are not handled correctly

• manager
• template

Automatically register Navigation Provider

Add support for xml files

Add an option to define whether the output should be in xml or in yml format.

Excerpt Tab Generator

JS error in edit/save form

Automatically register Manager

Admin Navigation Generator

Controller Generator

Locale in List missing

Use the RequestParametersTrait to get the required parameters. Also the JS locale should be app.sandbox.sulu.getDefaultContentLocale()

Content Type generator

Entity selection content type generator.

Provide a hint for setting "minimum-stability"

When executing the require command listed in the README composer errors with the message:

[InvalidArgumentException]
Could not find package l91/sulu-backend-bundle at any version for your mini
mum-stability (stable). Check the package spelling or your minimum-stability

Either create a stable version, or provide a hint that the composer property "minimu-stability" has to be set to "dev".

Editing an entry immediately after inserting it leads to multiple entries

Steps to reproduce:

• Add a new entry
• Click on save
• Edit a field
• Save again

Now there are two entries in the database. I think this happens because the URL is still "add/general" instead of "edit:/general" after the first save.

Content Navigation Provider Generator

Error in GenerateAdminCommand

The following lines in L91\Sulu\Bundle\BackendBundle\Command\GenerateAdminCommand.php lead to errors ("Argument mode "sf" is not valid.") as addArgument() expects the second parameter to be the mode, not a shortcut.

->addArgument('service-format', 'sf', InputArgument::REQUIRED, 'Set the format of service registrations.')
->addArgument('route-format', 'rf', InputArgument::REQUIRED, 'Set the format of route registrations.')

List View Component

Needs #32

Command to create Controller, Manager, Repository, Admin Navigation

Inspired by: http://symfony.com/doc/current/bundles/SensioGeneratorBundle/commands/generate_doctrine_crud.html

Add new JS Structure

Remove the tabs.js and component.js. And link directly to form.js and list.js

Abstract Backend Manager

The abstract Backend Manager will have a default implementation for the get , getBy, countBy implementation based on a BackendRepository.

Can't find path error for PSR-4 Bundles

Doctrine don't support to use there generator for PSR-4 namespaces.
As this generator is based on Doctrine the Doctrine Generator it will fail.

Rename Repository functions

• findById
• findAll

Support Entity Translations