README

为 Sonata Admin 添加注解。

目的是减少噪音，应该避免创建大量仅包含映射而不做其他操作的 Admin 类。将注解添加到您的模型中即可。如果您需要此 Bundle 未涵盖的功能，请创建 Admin 类。

此 Bundle 是对已归档的 KunicMarko\SonataAnnotationBundle 的分支。

文档

安装
配置
如何使用
注解
扩展 Admin

安装

1. 使用 Composer 添加依赖

composer require neimheadh/sonata-annotation-bundle

2. 在您的 Kernel 中注册 Bundle

return [
    //...
    Neimheadh\SonataAnnotationBundle\SonataAnnotationBundle::class => ['all' => true],
];

配置

默认情况下，我们扫描您 src 目录中的所有文件，如果您将实体保存到其他地方，您可以更改目录

sonata_annotation:
    directory: '%kernel.project_dir%/src/'

如何使用

无需创建 Admin 类，只需在您的实体上添加注解即可。

<?php

namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;
use Neimheadh\SonataAnnotationBundle\Annotation\Sonata;

/**
 * @Sonata\Admin("Category")
 *
 * @ORM\Table
 * @ORM\Entity
 */
class Category
{
    /**
     * @Sonata\FormField()
     * @Sonata\ListField()
     * @Sonata\ShowField()
     * @Sonata\DatagridField()
     *
     * @ORM\Column(name="name", type="string", length=255)
     */
    private $name;
}

清除缓存

bin/console cache:clear

然后您将在侧边栏中看到 Admin。

注意，您还可以使用类属性

<?php

namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;
use Neimheadh\SonataAnnotationBundle\Annotation\Sonata;

#[ORM\Table]
#[ORM\Entity]
#[Sonata\Admin("Category")]
class Category
{
    #[ORM\Column(name: "name", type: "string", length: 255)]
    #[Sonata\FormField()]
    #[Sonata\ListField()]
    #[Sonata\ShowField()]
    #[Sonata\DatagridField()]
    private $name;
}

注解

Admin

<?php

namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;
use Neimheadh\SonataAnnotationBundle\Annotation\Sonata;
use App\Controller\YourCRUDController;
use App\Admin\YourAdmin;

/**
 * @Sonata\Admin(
 *     label="Category",
 *     managerType="orm",
 *     group="Category",
 *     showInDashboard=true,
 *     keepOpen=true,
 *     onTop=true,
 *     icon="<i class='fa fa-user'></i>",
 *     labelTranslatorStrategy="sonata.admin.label.strategy.native",
 *     labelCatalogue="App",
 *     pagerType="simple",
 *     controller=YourCRUDController::class,
 *     serviceId="app.admin.category",
 *     admin=YourAdmin::class,
 *     code="admin_code",
*      defaultSort="id",
*      defaultPage=1,
*      defaultOrder="DESC",
*      defaultPageSize=10,
 * )
 *
 * @ORM\Table
 * @ORM\Entity
 */
class Category
{
}

访问

如果您正在使用此处描述的角色处理器 here，您可以使用此注解为每个角色添加权限。

此注解可以在没有 Admin 注解的情况下使用。如果您为您的实体有 Admin 类，您仍然可以使用此注解。

<?php

namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;
use Neimheadh\SonataAnnotationBundle\Annotation\Sonata;

/**
 * @Sonata\Admin("Category")
 *
 * @Sonata\Access("ROLE_CLIENT", permissions={"LIST", "VIEW", "EXPORT"})
 *
 * @ORM\Table
 * @ORM\Entity
 */
class Category
{
}

添加子项

您可以在此处了解更多关于此信息。

此注解可以在没有 Admin 注解的情况下使用。如果您为您的实体有 Admin 类，您仍然可以使用此注解。

<?php

namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;
use Neimheadh\SonataAnnotationBundle\Annotation\Sonata;

/**
 * @Sonata\Admin("Category")
 * @Sonata\AddChild(class=Post::class, field="category")
 *
 * @ORM\Table
 * @ORM\Entity
 */
class Category
{
}

<?php

namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;
use Neimheadh\SonataAnnotationBundle\Annotation\Sonata;

/**
 * @Sonata\Admin("Post")
 *
 * @ORM\Table
 * @ORM\Entity
 */
class Post
{
    /**
     * @ORM\ManyToOne(targetEntity="Category")
     * @ORM\JoinColumn(name="category_id", referencedColumnName="id")
     */
    private $category;
}

表单字段

您可以使用 action 选项指定不同的字段或为创建和编辑操作相同的字段提供不同的配置。如果没有设置，字段将用于创建和编辑。除此之外，您还可以设置字段的顺序。位置 1 将是第一个渲染的字段，之后是更高的数字。如果字段没有位置，它将在所有具有位置的字段之后渲染。

<?php

namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;
use Neimheadh\SonataAnnotationBundle\Annotation\Sonata;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\Extension\Core\Type\TextareaType;

/**
 * @Sonata\Admin("Category")
 *
 * @ORM\Table
 * @ORM\Entity
 */
class Category
{
    /**
     * @Sonata\FormField(
     *      action="create",
     *      type="",
     *      options={},
     *      fieldDescriptionOptions={},
     *      position=1 
     * )
     *
     * @ORM\Column(name="name", type="string", length=255)
     */
    private $name;

    /**
     * @Sonata\FormField(
     *      type="",
     *      options={},
     *      fieldDescriptionOptions={},
     *      position=2
     * )
     *
     * @ORM\Column(name="description", type="string", length=255)
     */
    private $description;
    
    /**
     * @Sonata\FormField(
     *      action="create",
     *      type=TextType::class
     * )
     *
     * @Sonata\FormField(
     *      action="edit",
     *      type=TextareaType::class
     * )
     *
     * @ORM\Column(name="something", type="string", length=255)
     */
    private $something;
}

表单字段也可以通过 formFields 类 Admin 注解属性在类级别添加

// ...

/**
 * @Sonata\Admin(
 *    name="Category",
 *    formFields={
 *      "name": @Sonata\FormField (
 *          action="create",
 *          type="",
 *          options={},
 *          fieldDescriptionOptions={},
 *          position=1     
 *     ),
 *     "description": @Sonata\FormField (
 *          type="",
 *          options={},
 *          fieldDescriptionOptions={},
 *          position=2
 *     ),
 * )
 */
class Category {
//...
}

默认情况下，如果配置了任何字段，则所有字段都将可用。