步骤 9: 设置管理后台

5.2 version
Maintained Unmaintained
5.0

设置管理后台

把将要举办的会议录入到数据库是项目管理员的工作。所谓的 管理后台 是网站中一个受保护的区域,用来让 项目管理员 管理网站数据,处理提交的反馈和做其它一些事。

我们如何快速做一个后台呢?通过用一个 bundle,它可以根据项目的数据模型来生成后台!EasyAdmin 最适合不过了。

配置 EasyAdmin

首先,把 EasyAdmin 加进项目的依赖中。

1
$ symfony composer req "admin:^3"

EasyAdmin 会基于一些特定的控制器,来为你的应用程序自动生成一个管理后台。新建 src/Controller/Admin/ 目录,我们会在此存放这些控制器。

1
$ mkdir src/Controller/Admin/

作为使用 EasyAdmin 的第一步,我们来创建一个“网站管理仪表盘”,它将是管理网站数据的主入口。

1
$ symfony console make:admin:dashboard

接受默认的答案,这会创建如下的控制器:

src/Controller/Admin/DashboardController.php
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
namespace App\Controller\Admin;

use EasyCorp\Bundle\EasyAdminBundle\Config\Dashboard;
use EasyCorp\Bundle\EasyAdminBundle\Config\MenuItem;
use EasyCorp\Bundle\EasyAdminBundle\Controller\AbstractDashboardController;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;

class DashboardController extends AbstractDashboardController
{
    /**
     * @Route("/admin", name="admin")
     */
    public function index(): Response
    {
        return parent::index();
    }

    public function configureDashboard(): Dashboard
    {
        return Dashboard::new()
            ->setTitle('Guestbook');
    }

    public function configureMenuItems(): iterable
    {
        yield MenuItem::linktoDashboard('Dashboard', 'fa fa-home');
        // yield MenuItem::linkToCrud('The Label', 'icon class', EntityClass::class);
    }
}

按照约定,所有的管理控制器都放在它们自己的 App\Controller\Admin 命名空间下。

/admin 路径访问这个生成的后台,该路径是由 index() 方法来配置的;你可以把这个 URL 改成任何你想要的形式:

哇!我们有了一个很好看的管理界面外壳,可以根据我们的需要对它进行定制。

接下去的步骤是创建控制器来管理会议和评论。

在仪表盘的控制器里,你可能已经注意到了 configureMenuItems() 方法,它带有一条有关增加链接到 “CRUD” 类的注释。CRUD 是英文中“增、查、改、删”的首字母缩略词,它们是你想要对任何实体做的 4 个基本操作。这也正是我们希望管理后台为我们去做的;EasyAdmin 甚至更进一步,为我们处理了搜索和过滤。

我们来为会议生成一个 CRUD 类:

1
$ symfony console make:admin:crud

选择 1 来为会议创建一个管理界面,其余的问题都选择默认答案。这会生成如下文件:

src/Controller/Admin/ConferenceCrudController.php
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
namespace App\Controller\Admin;

use App\Entity\Conference;
use EasyCorp\Bundle\EasyAdminBundle\Controller\AbstractCrudController;

class ConferenceCrudController extends AbstractCrudController
{
    public static function getEntityFqcn(): string
    {
        return Conference::class;
    }

    /*
    public function configureFields(string $pageName): iterable
    {
        return [
            IdField::new('id'),
            TextField::new('title'),
            TextEditorField::new('description'),
        ];
    }
    */
}

对评论也一样处理:

1
$ symfony console make:admin:crud

最后一步是把会议和评论的 CRUD 管理类链接到仪表盘:

patch_file
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
--- a/src/Controller/Admin/DashboardController.php
+++ b/src/Controller/Admin/DashboardController.php
@@ -2,6 +2,8 @@

 namespace App\Controller\Admin;

+use App\Entity\Comment;
+use App\Entity\Conference;
 use EasyCorp\Bundle\EasyAdminBundle\Config\Dashboard;
 use EasyCorp\Bundle\EasyAdminBundle\Config\MenuItem;
 use EasyCorp\Bundle\EasyAdminBundle\Controller\AbstractDashboardController;
@@ -26,7 +28,8 @@ class DashboardController extends AbstractDashboardController

     public function configureMenuItems(): iterable
     {
-        yield MenuItem::linktoDashboard('Dashboard', 'fa fa-home');
-        // yield MenuItem::linkToCrud('The Label', 'fas fa-list', EntityClass::class);
+        yield MenuItem::linktoRoute('Back to the website', 'fas fa-home', 'homepage');
+        yield MenuItem::linkToCrud('Conferences', 'fas fa-map-marker-alt', Conference::class);
+        yield MenuItem::linkToCrud('Comments', 'fas fa-comments', Comment::class);
     }
 }

我们改写了 configureMenuItems() 方法,加了配有相关图标的会议和评论菜单项,也加了一个回到网站首页的链接。

EasyAdmin 通过 MenuItem::linkToRoute() 方法来暴露出一个 API 接口,便于链接到实体对应的 CRUD 类。

主仪表盘页面目前还是空的。该页面可以用来展示一些统计信息,或是任何相关的信息。由于我们没有什么重要的内容要展示,我们把它重定向到会议列表页:

patch_file
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
--- a/src/Controller/Admin/DashboardController.php
+++ b/src/Controller/Admin/DashboardController.php
@@ -7,6 +7,7 @@ use App\Entity\Conference;
 use EasyCorp\Bundle\EasyAdminBundle\Config\Dashboard;
 use EasyCorp\Bundle\EasyAdminBundle\Config\MenuItem;
 use EasyCorp\Bundle\EasyAdminBundle\Controller\AbstractDashboardController;
+use EasyCorp\Bundle\EasyAdminBundle\Router\CrudUrlGenerator;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Annotation\Route;

@@ -17,7 +18,10 @@ class DashboardController extends AbstractDashboardController
      */
     public function index(): Response
     {
-        return parent::index();
+        $routeBuilder = $this->get(CrudUrlGenerator::class)->build();
+        $url = $routeBuilder->setController(ConferenceCrudController::class)->generateUrl();
+
+        return $this->redirect($url);
     }

     public function configureDashboard(): Dashboard

当展示实体间的关系时(和评论关联的一场会议),EasyAdmin 会尝试用会议实体的字符串表示。默认情况下,如果实体没有定义 __toString() 这个“魔术”方法,它的惯例就是使用实体名和主键(比如 Conference #1)。为了使展示的内容更具意义,我们来为 Conference 类定义这个方法:

patch_file
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
--- a/src/Entity/Conference.php
+++ b/src/Entity/Conference.php
@@ -44,6 +44,11 @@ class Conference
         $this->comments = new ArrayCollection();
     }

+    public function __toString(): string
+    {
+        return $this->city.' '.$this->year;
+    }
+
     public function getId(): ?int
     {
         return $this->id;

Comment 类也做同样的处理:

patch_file
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
--- a/src/Entity/Comment.php
+++ b/src/Entity/Comment.php
@@ -48,6 +48,11 @@ class Comment
      */
     private $photoFilename;

+    public function __toString(): string
+    {
+        return (string) $this->getEmail();
+    }
+
     public function getId(): ?int
     {
         return $this->id;

现在你可以在管理后台里直接添加/修改/删除会议。你可以玩玩看,并且添加至少一个会议。

添加几个不带照片的评论。现在先手工设置下日期;在后面的步骤中,我们会让 createdAt 列自动填充。

定制 EasyAdmin

默认的后台运行得很好,但是我们可以在许多方面对它进行定制,以提高使用体验。我们来对 Comment 实体类做一些简单的改动,以此演示一些可能的定制方式:

patch_file
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
--- a/src/Controller/Admin/CommentCrudController.php
+++ b/src/Controller/Admin/CommentCrudController.php
@@ -3,7 +3,15 @@
 namespace App\Controller\Admin;

 use App\Entity\Comment;
+use EasyCorp\Bundle\EasyAdminBundle\Config\Crud;
+use EasyCorp\Bundle\EasyAdminBundle\Config\Filters;
 use EasyCorp\Bundle\EasyAdminBundle\Controller\AbstractCrudController;
+use EasyCorp\Bundle\EasyAdminBundle\Field\AssociationField;
+use EasyCorp\Bundle\EasyAdminBundle\Field\DateTimeField;
+use EasyCorp\Bundle\EasyAdminBundle\Field\EmailField;
+use EasyCorp\Bundle\EasyAdminBundle\Field\TextareaField;
+use EasyCorp\Bundle\EasyAdminBundle\Field\TextField;
+use EasyCorp\Bundle\EasyAdminBundle\Filter\EntityFilter;

 class CommentCrudController extends AbstractCrudController
 {
@@ -12,14 +20,44 @@ class CommentCrudController extends AbstractCrudController
         return Comment::class;
     }

-    /*
+    public function configureCrud(Crud $crud): Crud
+    {
+        return $crud
+            ->setEntityLabelInSingular('Conference Comment')
+            ->setEntityLabelInPlural('Conference Comments')
+            ->setSearchFields(['author', 'text', 'email'])
+            ->setDefaultSort(['createdAt' => 'DESC']);
+        ;
+    }
+
+    public function configureFilters(Filters $filters): Filters
+    {
+        return $filters
+            ->add(EntityFilter::new('conference'))
+        ;
+    }
+
     public function configureFields(string $pageName): iterable
     {
-        return [
-            IdField::new('id'),
-            TextField::new('title'),
-            TextEditorField::new('description'),
-        ];
+        yield AssociationField::new('conference');
+        yield TextField::new('author');
+        yield EmailField::new('email');
+        yield TextareaField::new('text')
+            ->hideOnIndex()
+        ;
+        yield TextField::new('photoFilename')
+            ->onlyOnIndex()
+        ;
+
+        $createdAt = DateTimeField::new('createdAt')->setFormTypeOptions([
+            'html5' => true,
+            'years' => range(date('Y'), date('Y') + 5),
+            'widget' => 'single_text',
+        ]);
+        if (Crud::PAGE_EDIT === $pageName) {
+            yield $createdAt->setFormTypeOption('disabled', true);
+        } else {
+            yield $createdAt;
+        }
     }
-    */
 }

为了定制 Comment 这部分,要在 configureFields() 方法中明确列出字段,这让我们能以想要的次序来对它们进行排列。有些字段要更多配置下,比如在列表页隐藏文本字段。

configureFilters() 方法定义了在搜索之外还要暴露哪些过滤器。

这些改动只是对于 EasyAdmin 定制可能性的一个小小介绍。

在后台里玩玩,比如可以用会议来过滤评论,或者根据邮件来搜索评论。目前唯一的问题是任何人都可以进入后台。别担心,我们会在以后的步骤中将它保护起来。

1
$ symfony run psql -c "TRUNCATE conference RESTART IDENTITY CASCADE"

This work, including the code samples, is licensed under a Creative Commons BY-NC-SA 4.0 license.