Skip to content

Value Objects

O TCPDF-Next usa value objects imutáveis para todos os dados geométricos e cromáticos. Todo value object é declarado final readonly — uma vez criado, não pode ser modificado. Crie novas instâncias em vez de mutar as existentes.

PageSize

Representa as dimensões de uma página em pontos (1 pt = 1/72 polegada).

php
use Yeeefang\TcpdfNext\ValueObjects\PageSize;

// Série A ISO 216
$a4 = PageSize::A4();             // 595.28 x 841.89 pt

// Alteração de orientação (retorna nova instância)
$landscape = PageSize::A4()->landscape();   // 841.89 x 595.28 pt
$portrait = PageSize::A4()->portrait();     // 595.28 x 841.89 pt

// A partir de nome string
$letter = PageSize::fromName('Letter');

// Tamanho personalizado em pontos
$custom = new PageSize(400.0, 600.0, 'custom');

Métodos Factory

SérieMétodos
ISO AA0(), A1(), A2(), A3(), A4(), A5(), A6()
ISO BB0(), B1(), B2(), B3(), B4(), B5()
Norte-americanoLetter(), Legal(), Tabloid()

Margin

Define as margens da página em milímetros.

php
use Yeeefang\TcpdfNext\ValueObjects\Margin;

// Mesmo valor em todos os quatro lados
$uniform = Margin::uniform(10.0);               // 10mm todos os lados

// Simétrico: vertical e horizontal
$symmetric = Margin::symmetric(15.0, 10.0);     // 15mm cima/baixo, 10mm esquerda/direita

// Sem margens
$zero = Margin::zero();

// Explícito: cima, direita, baixo, esquerda
$explicit = new Margin(20.0, 15.0, 25.0, 15.0);

Acesse lados individuais via propriedades públicas readonly: $margin->top, $margin->right, $margin->bottom, $margin->left.

Position e Dimension

Pares simples de coordenada e tamanho com propriedades públicas readonly.

php
use Yeeefang\TcpdfNext\ValueObjects\{Position, Dimension};

$pos = new Position(50.0, 100.0);   // $pos->x, $pos->y
$dim = new Dimension(210.0, 297.0); // $dim->width, $dim->height

Unit

Manipula definições de unidade e conversões entre pontos, milímetros, centímetros e polegadas.

php
use Yeeefang\TcpdfNext\ValueObjects\Unit;

$mm = Unit::mm();  // Também: Unit::pt(), Unit::cm(), Unit::in()

// Converter entre unidades
$points = Unit::convert(25.4, Unit::mm(), Unit::pt());   // 25.4mm = 72pt
$inches = Unit::convert(72.0, Unit::pt(), Unit::in());   // 72pt = 1in

Referência de Conversão

DePara Pontos
1 pt1.0
1 mm2.8346
1 cm28.3465
1 in72.0

Color

A classe Color reside no namespace Graphics e suporta modelos de cor RGB, CMYK, escala de cinza e cores spot. Como todos os value objects, é imutável.

php
use Yeeefang\TcpdfNext\Graphics\Color;

// RGB (0-255)
$red = Color::rgb(255, 0, 0);
$orange = Color::rgb(255, 102, 0);

// CMYK (0-100)
$processBlack = Color::cmyk(0, 0, 0, 100);
$cyan = Color::cmyk(100, 0, 0, 0);

// Escala de cinza (0-255, onde 0 = preto, 255 = branco)
$gray = Color::gray(128);

// Cor spot (nome + fallback CMYK)
$pantone = Color::spot('Pantone 151 C', 0, 60, 100, 0);

Juntando Tudo

php
use Yeeefang\TcpdfNext\Core\Document;
use Yeeefang\TcpdfNext\ValueObjects\{PageSize, Margin, Unit};
use Yeeefang\TcpdfNext\Graphics\Color;

$landscape = PageSize::A4()->landscape();
$margins = Margin::symmetric(15.0, 10.0);
$orange = Color::rgb(255, 102, 0);

$pdf = Document::create()
    ->addPage($landscape, margin: $margins)
    ->setFont('Helvetica', '', 12)
    ->setTextColor($orange)
    ->cell(0, 10, 'Styled with value objects')
    ->save('styled.pdf');

Todos os value objects são final readonly. Métodos como landscape() e portrait() retornam novas instâncias -- eles nunca mutam o original. Isso torna value objects seguros para compartilhar entre páginas, threads e limites de função sem cópia defensiva.

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