suminagashi/orchestra

Sleek admin for your symfony projects

dev-master 2020-08-19 11:22 UTC

Requires

• php: >=7.1
• ext-ctype: *
• ext-iconv: *
• ext-json: *
• doctrine/annotations: ^1.0
• symfony/asset: 5.1.*
• symfony/console: 5.1.*
• symfony/dotenv: 5.1.*
• symfony/finder: 5.1.*
• symfony/flex: ^1.3.1
• symfony/framework-bundle: 5.1.*
• symfony/property-access: 5.1.*
• symfony/property-info: 5.1.*
• symfony/twig-bundle: 5.1.*
• symfony/webpack-encore-bundle: ^1.7
• symfony/yaml: 5.1.*
• twig/extra-bundle: ^2.12|^3.0
• twig/twig: ^2.12|^3.0

MIT

• Louis Harang
• Hugo Knorr

• admin
• backoffice
• SPA

README

Sleek symfony admin boilerplate

Install the bundle :

Flex recipe incoming...

Register the bundle :

// config/bundles.php

return [
    ...
    Suminagashi\OrchestraBundle\OrchestraBundle::class => ['all' => true],
];

Register the route :

// config/routes/orchestra.yaml

orchestra_admin:
  resource: "@OrchestraBundle/Resources/config/routes.xml"
  prefix: /admin

Usage :

• Orchestra provide 2 new annotations :
  • @Resource for class
  • @Field for properties
• The data validation use Symfony\Component\Validator\Constraints annotation

Examples :

// src/Entity/Dummy.php

<?php

namespace App\Entity;

use Suminagashi\OrchestraBundle\Annotation\Resource;
use Suminagashi\OrchestraBundle\Annotation\Field;

use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Serializer\Annotation\Groups;
use Symfony\Component\Validator\Constraints as Assert;

/**
 * @Resource(
 *  name="Dummy"
 * )
 */
class Dummy
{
    /**
     * @var string
     * @ORM\Column(type="string")
     * @Groups({"read", "write"})
     * @Field(label="Test")
     * @Assert\NotNull()
     */
    private $test;

    public function getTest(): ?string
    {
        return $this->test;
    }

    public function setTest(string $test): self
    {
        $this->test = $test;

        return $this;
    }
}

API Reference

@Resource

Attribute	Description
label	Used to set the label displayed in the menu
name	Override default name of the resource
actions	WIP : Set available CRUD operations