PageBoxType

Backed enum for the PDF page boundary box names.

Table of contents

Namespace: Com\Tecnick\Pdf\Page

enum PageBoxType: string

Source: src/PageBoxType.php:37

Backed enum for the PDF page boundary box names. The backing value of each case matches an entry of Box::BOX validated by Box::setBox().

Cases

  • MediaBox = 'MediaBox'
  • CropBox = 'CropBox'
  • BleedBox = 'BleedBox'
  • TrimBox = 'TrimBox'
  • ArtBox = 'ArtBox'

Methods

fromLoose()

Resolve a loose page box value to the matching enum case.

Accepts the exact box name (as validated by Box::setBox) or an enum instance (returned unchanged). Unknown values throw.

public static fromLoose(string|self $value): self

Parameters:

  • $value (string|self): Page box name or enum case.

Returns: self

Throws:

  • Exception: if the value does not match a known page box.

Source: src/PageBoxType.php:59