Skip to content

Construindo Extensões

A arquitetura do TCPDF-Next é aberta por design. As seis extensões oficiais (Artisan, Pro, Laravel, Symfony, CodeIgniter, Adaptation) usam as mesmas interfaces e pontos de extensão disponíveis para qualquer desenvolvedor terceiro.

Contratos de Interface

Sua extensão deve implementar uma ou mais destas interfaces:

PdfDocumentInterface

O contrato core do documento. Implemente se você está construindo uma engine de documento alternativa.

php
namespace Yeeefang\TcpdfNext\Contracts;

interface PdfDocumentInterface
{
    public function addPage(?PageSize $size = null, Orientation $orientation = Orientation::Portrait): static;
    public function setMargins(Margin $margin): static;
    public function setFont(string $family, string $style = '', float $size = 12.0): static;
    public function cell(float $width, float $height, string $text = '', ...): static;
    public function multiCell(float $width, float $height, string $text, ...): static;
    public function writeHtml(string $html): static;
    public function image(string $file, ...): static;
    public function output(?string $filename = null, OutputDestination $dest = OutputDestination::Inline): string;
    public function save(string $path): void;
}

SignerInterface

Implemente para backends de assinatura personalizados (cloud HSMs, serviços de assinatura remota, etc.).

php
namespace Yeeefang\TcpdfNext\Contracts;

interface SignerInterface
{
    public function sign(string $data): SignatureResult;
    public function timestamp(string $signatureValue): string;
    public function supportsLtv(): bool;
}

HsmSignerInterface

Para integração com módulos de segurança de hardware:

php
namespace Yeeefang\TcpdfNext\Contracts;

interface HsmSignerInterface
{
    public function sign(string $data, string $algorithm = 'sha256WithRSAEncryption'): string;
    public function getCertificateDer(): string;
    public function getCertificateChainDer(): array;
    public function getPublicKeyAlgorithm(): string;
}

FontManagerInterface

Para estratégias personalizadas de carregamento de fontes:

php
namespace Yeeefang\TcpdfNext\Contracts;

interface FontManagerInterface
{
    public function registerFont(string $fontFile, string $alias = '', int $fontIndex = 0): FontInfo;
    public function getFont(string $family, string $style = ''): ?FontInfo;
    public function subset(FontInfo $font, string $text): string;
    public function getRegisteredFonts(): array;
    public function addFontDirectory(string $directory): void;
}

Esqueleto de Extensão

Aqui está uma extensão de terceiro mínima:

composer.json

json
{
    "name": "your-vendor/tcpdf-next-watermark",
    "description": "Advanced watermark extension for TCPDF-Next",
    "type": "library",
    "require": {
        "php": "^8.5",
        "yeeefang/tcpdf-next": "^1.7"
    },
    "autoload": {
        "psr-4": {
            "YourVendor\\TcpdfNextWatermark\\": "src/"
        }
    }
}

Classe da Extensão

php
namespace YourVendor\TcpdfNextWatermark;

use Yeeefang\TcpdfNext\Core\Document;
use Yeeefang\TcpdfNext\Graphics\Color;

final class WatermarkExtension
{
    public function apply(
        Document $document,
        string $text,
        float $angle = 45.0,
        float $opacity = 0.15,
    ): Document {
        return $document
            ->startTransform()
            ->setAlpha($opacity)
            ->rotate($angle, $document->getPageWidth() / 2, $document->getPageHeight() / 2)
            ->setFontSize(60)
            ->setTextColor(200, 200, 200)
            ->text(
                $document->getPageWidth() / 4,
                $document->getPageHeight() / 2,
                $text,
            )
            ->stopTransform();
    }
}

Como Extensões Oficiais se Conectam

Funcional

Artisan -> Core

O renderizador Chrome é injetado via setChromeRendererConfig() na classe Document. O Core armazena o renderizador como ?object -- sem dependência de tipo do Artisan.

Pro -> Core

Classes Pro como LtvManager e PdfAManager operam em BinaryBuffer e ObjectRegistry -- as mesmas APIs internas que o Core usa. O PadesOrchestrator aceita parâmetros opcionais exclusivos do Pro (CertificateChainValidator, OcspResponseVerifier).

Integração com Frameworks

Laravel -> Core

O ServiceProvider cria um binding factory para PdfDocumentInterface que retorna uma instância Document configurada. O Facade faz proxy de chamadas estáticas para a instância resolvida no container.

Symfony -> Core

O TcpdfNextBundle registra PdfFactory como um serviço. Injete via injeção de construtor ou o atributo #[Autowire]. A integração Messenger despacha GeneratePdfMessage para geração assíncrona.

CodeIgniter -> Core

O TcpdfNextService registra no container de serviços do CodeIgniter. Use service('tcpdfnext') ou injete via PdfLibrary nos controllers. A integração de queue usa o task scheduler do CodeIgniter.

Compatibilidade

Adaptation -> Core

A classe adaptadora TCPDF estende uma base non-final, mapeando todos os 252 métodos legados para equivalentes do TCPDF-Next. Overrides de Header() e Footer() funcionam como estão. Classes helper legadas (TCPDF_STATIC, TCPDF_FONTS, TCPDF_COLORS, TCPDF_IMAGES) delegam para a API moderna.

Convenções de Namespace

Siga o padrão do ecossistema:

YourVendor\TcpdfNext{ExtensionName}\
├── YourMainClass.php
├── Config\
├── Exception\
└── ...

Use interfaces de Yeeefang\TcpdfNext\Contracts\, nunca classes internas de Core\, para os limites de sua API pública.

Distribuído sob a licença LGPL-3.0-or-later.