SonataNewsBundle 技术文档

1. 安装指南

SonataNewsBundle 是一个基于 Symfony 的新闻管理bundle。在安装前，请确保您的环境满足以下要求：

• PHP 版本 7.2 或更高
• Symfony 版本 3.x 或 4.x

以下是安装 SonataNewsBundle 的步骤：

1. 使用 Composer 安装：

   composer require sonata-project/news-bundle
   

2. 在 config/bundles.php 文件中注册 Bundle：

   return [
       // ...
       Sonata\NewsBundle\SonataNewsBundle::class => ['all' => true],
       // ...
   ];
   

3. 配置数据库连接。编辑 config/packages/doctrine.yaml 文件，根据您的数据库类型设置相应的参数。

4. 执行数据库迁移：

   php bin/console doctrine:schema:update --force
   

5. 清理缓存：

   php bin/console cache:clear --env=prod --no-debug
   

2. 项目的使用说明

SonataNewsBundle 提供了新闻管理功能，包括新闻创建、编辑、删除和显示。以下是如何使用这个 Bundle：

1. 创建新闻：

   使用 Sonata\AdminBundle\Admin\Admin 类来管理新闻实体。

   // src/Admin/PostAdmin.php
   namespace App\Admin;
   
   use Sonata\AdminBundle\Admin\AbstractAdmin;
   use Sonata\AdminBundle\Datagrid\ListMapper;
   use Sonata\AdminBundle\Form\FormMapper;
   use Sonata\AdminBundle\Show\ShowMapper;
   
   class PostAdmin extends AbstractAdmin
   {
       protected function configureFormFields(FormMapper $formMapper)
       {
           $formMapper
               ->add('title')
               ->add('body')
               ->add('author')
               // ...
           ;
       }
   
       protected function configureListFields(ListMapper $listMapper)
       {
           $listMapper
               ->addIdentifier('title')
               ->add('author')
               ->add('created_at')
               // ...
           ;
       }
   
       protected function configureShowFields(ShowMapper $showMapper)
       {
           $showMapper
               ->add('title')
               ->add('body')
               ->add('author')
               ->add('created_at')
               // ...
           ;
       }
   }
   

2. 显示新闻列表：

   在控制器中，注入 Sonata\AdminBundle\Admin\AdminManager 服务，并使用它来获取新闻列表。

   // src/Controller/NewsController.php
   namespace App\Controller;
   
   use Sonata\AdminBundle\Admin\AdminManager;
   use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
   use Symfony\Component\HttpFoundation\Response;
   
   class NewsController extends AbstractController
   {
       private $adminManager;
   
       public function __construct(AdminManager $adminManager)
       {
           $this->adminManager = $adminManager;
       }
   
       public function index(): Response
       {
           $posts = $this->adminManager->getAdminByClass(PostAdmin::class)
               ->getDashboardHomepageBlocks();
   
           return $this->render('news/index.html.twig', compact('posts'));
       }
   }
   

3. 创建新闻详情页：

   使用 SonataNewsBundle 提供的 Post 实体来显示新闻详情。

   {# templates/news/show.html.twig #}
   <h1>{{ post.title }}</h1>
   <p>{{ post.body }}</p>
   <p>作者：{{ post.author }}</p>
   <p>发布时间：{{ post.created_at }}</p>
   

3. 项目API使用文档

SonataNewsBundle 没有内置的 API 功能，但您可以使用 Symfony 的 API Platform 或其他 API 构建工具来创建一个基于 SonataNewsBundle 的 API。

以下是一个简单的例子，使用 API Platform 来创建一个新闻 API：

1. 安装 API Platform：

   composer require api-platform/core
   

2. 在 config/packages/api_platform.yaml 中配置 API Platform：

   api_platform:
       title:  Sonata News API
       version:  v1
       endpoints:
           /news:
               name:  news_list
               methods:  [GET]
               normalization_context:  {'groups': ['news:read']}
           /news/{id}:
               name:  news_read
               methods:  [GET]
               normalization_context:  {'groups': ['news:read']}
   

3. 创建一个实体表示新闻，并在 config/packages/api_platform.yaml 中声明：

   api_platform:
       # ...
       models:
           App\Entity\News:
               short_name:  News
               graphql:
                   type:  Mutation
                   query:  false
                   input:  App\Entity\News
                   payload:  App\Entity\NewsInput
   

4. 创建一个控制器来处理 API 请求：

   // src/Controller/NewsController.php
   namespace App\Controller;
   
   use App\Entity\News;
   use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
   use Symfony\Component\HttpFoundation\JsonResponse;
   use Symfony\Component\HttpFoundation\Request;
   
   class NewsController extends AbstractController
   {
       public function getNews(Request $request): JsonResponse
       {
           $id = $request->get('id');
           $news = $this->getDoctrine()->getRepository(News::class)->find($id);
   
           if (!$news) {
               return new JsonResponse(['message' => 'News not found'], 404);
           }
   
           return new JsonResponse($news);
       }
   
       public function getNewsList(Request $request): JsonResponse
       {
           $news = $this->getDoctrine()->getRepository(News::class)->findAll();
   
           return new JsonResponse($news);
       }
   }
   

4. 项目安装方式

SonataNewsBundle 可以通过以下方式安装：

使用 Composer

推荐使用 Composer 来安装 SonataNewsBundle。在命令行中执行以下命令：

composer require sonata-project/news-bundle

然后按照上文提到的步骤完成安装。

手动安装

1. 下载 SonataNewsBundle 的最新稳定版本。
2. 将下载的文件解压到项目的 bundles 目录下。
3. 在 config/bundles.php 文件中注册 Bundle。
4. 执行数据库迁移和清理缓存操作。