Api-Platform：为资源集成自定义PDF文档下载功能

// src/Entity/Invoice.php
#[ApiResource(
    itemOperations: [
        'get', 'put', 'patch', 'delete',
        'get_document' => [
            'method' => 'GET',
            'path' => '/invoices/{id}/document',
            'controller' => DocumentController::class,
            'output_formats' => ['application/pdf'],
            'read' => false, // 避免Api-Platform尝试序列化整个Invoice对象
        ],
    ]
)]
class Invoice
{
    // ...
}

// src/Controller/DocumentController.php
#[AsController]
class DocumentController extends AbstractController
{
    private InvoiceDocumentService $documentService;

    public function __construct(InvoiceDocumentService $invoiceDocumentService)
    {
        $this->documentService = $invoiceDocumentService;
    }

    public function __invoke(Invoice $data): string
    {
        // 返回PDF内容字符串
        return $this->documentService->createDocumentForInvoice($data);
    }
}

// src/Entity/Invoice.php

use ApiPlatform\Metadata\ApiResource;
use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Serializer\Annotation\Groups;

#[ORM\Entity]
#[ApiResource(
    // ... 其他ApiResource配置
    normalizationContext: ['groups' => ['invoice:read']]
)]
class Invoice
{
    #[ORM\Id]
    #[ORM\GeneratedValue]
    #[ORM\Column(type: 'integer')]
    private ?int $id = null;

    // ... 其他Invoice属性

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

    /**
     * 获取此发票PDF文档的下载URL。
     *
     * @Groups({"invoice:read"}) // 确保此属性在序列化时被包含
     */
    public function getDocumentUrl(): string
    {
        // 假设您的PDF下载路由是 /invoices/{id}/document
        return "/invoices/{$this->id}/document";
    }

    // ... 其他getter/setter
}

// src/Controller/InvoiceDocumentController.php

namespace App\Controller;

use App\Entity\Invoice;
use App\Service\InvoiceDocumentService;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\BinaryFileResponse;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\ResponseHeaderBag;
use Symfony\Component\Routing\Annotation\Route;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter; // 如果使用旧版Symfony或手动配置

class InvoiceDocumentController extends AbstractController
{
    private InvoiceDocumentService $documentService;

    public function __construct(InvoiceDocumentService $invoiceDocumentService)
    {
        $this->documentService = $invoiceDocumentService;
    }

    /**
     * 下载指定发票的PDF文档。
     *
     * @Route("/invoices/{id}/document", name="app_invoice_document_download", methods={"GET"})
     * @ParamConverter("invoice", class="App\Entity\Invoice") // 自动将{id}转换为Invoice对象
     */
    public function downloadDocument(Invoice $invoice): Response
    {
        // 1. 调用服务生成PDF文件路径或内容
        // 假设InvoiceDocumentService::createDocumentForInvoice返回一个文件路径
        $pdfFilePath = $this->documentService->createDocumentForInvoice($invoice);

        // 2. 创建BinaryFileResponse响应
        $response = new BinaryFileResponse($pdfFilePath);

        // 3. 设置响应头，强制浏览器下载文件
        $response->setContentDisposition(
            ResponseHeaderBag::DISPOSITION_ATTACHMENT,
            'invoice_' . $invoice->getId() . '.pdf'
        );

        // 4. 设置内容类型
        $response->headers->set('Content-Type', 'application/pdf');

        // 5. 可选：删除临时文件（如果服务生成的是临时文件）
        // $response->deleteFileAfterSend(true);

        return $response;
    }
}

// ...
use Symfony\Component\HttpFoundation\Response;

// ...
public function downloadDocument(Invoice $invoice): Response
{
    $pdfContent = $this->documentService->createDocumentContentForInvoice($invoice); // 假设返回二进制字符串

    $response = new Response($pdfContent);
    $response->headers->set('Content-Type', 'application/pdf');
    $response->headers->set('Content-Disposition', 'attachment; filename="invoice_' . $invoice->getId() . '.pdf"');

    return $response;
}

// src/Controller/InvoiceDocumentController.php
// ...
use OpenApi\Attributes as OA; // 假设您使用nelmio/api-doc-bundle 和 openapi-php

class InvoiceDocumentController extends AbstractController
{
    // ...

    /**
     * 下载指定发票的PDF文档。
     */
    #[Route("/invoices/{id}/document", name="app_invoice_document_download", methods={"GET"})]
    #[ParamConverter("invoice", class="App\Entity\Invoice")]
    #[OA\Response(
        response: 200,
        description: 'Returns the PDF document for the invoice',
        content: new OA\MediaType(mediaType: 'application/pdf')
    )]
    #[OA\Parameter(
        name: 'id',
        in: 'path',
        required: true,
        description: 'ID of the invoice',
        schema: new OA\Schema(type: 'integer')
    )]
    #[OA\Tag(name: 'Invoices')] // 将此端点归类到Invoices标签下
    public function downloadDocument(Invoice $invoice): Response
    {
        // ...
    }
}

// src/Controller/InvoiceDocumentController.php
// ...
use Symfony\Component\Security\Http\Attribute\IsGranted; // Symfony 6.2+

class InvoiceDocumentController extends AbstractController
{
    // ...

    #[Route("/invoices/{id}/document", name="app_invoice_document_download", methods={"GET"})]
    #[ParamConverter("invoice", class="App\Entity\Invoice")]
    #[IsGranted('VIEW', subject: 'invoice', message: 'You are not authorized to view this invoice document.')]
    public function downloadDocument(Invoice $invoice): Response
    {
        // ...
    }
}