PDFTK

MMO\pdf · 1 symbol · generated 30 Sep 2026

class

PDFTK

WARNING: Need Module PHP IMagick PHP wrapper for the pdftk command line utility using fdf standard https://opensource.adobe.com/dc-acrobat-sdk-docs/pdfstandards/PDF32000_2008.pdf

class MMO\pdf\PDFTK extends MMO\core\classes\aModule

Namespace: MMO\pdf
Extends: aModule

Index

	FDF_FOOTER
	FDF_HEADER	Constants for FDF generation *
	FLAGS
	bin	Scale multiplier of the resolution of the stamp file to generate change this if images looks significantly worse after being stamped
	throwOnEnum
	throwOnMaxLength
	throwOnMinLength
	throwOnRequired
	execute($cmd, $input, $verbose)	interact with binary.
	fill($filename, $data, $templates, $coercer, $options, $flatten)	Fill a pdf using the fields in the PDF.
	force()	Remove all exception from generation
	getInfo($in, $directInput)	Obtain information about the pdf, its number of page and dimensions and its fields

Constants3

FDF_HEADER

Constants for FDF generation *

const FDF_HEADER = '%FDF-1.2 1 0 obj<</FDF<< /Fields['

FLAGS

const FLAGS = […19 items]

Properties5

bin

Scale multiplier of the resolution of the stamp file to generate change this if images looks significantly worse after being stamped

string $bin = 'pdftk'

Type: string

throwOnEnum

bool $throwOnEnum = true

Type: bool

throwOnMaxLength

bool $throwOnMaxLength = false

Type: bool

throwOnMinLength

bool $throwOnMinLength = true

Type: bool

throwOnRequired

bool $throwOnRequired = true

Type: bool

Methods4

execute($cmd, $input, $verbose)

PDFTK.php:118

interact with binary.

protected function execute(string $cmd, ?string $input = null, bool $verbose = false): string

$cmd	string	command as you would type it in a tty
$input = null	null \| string	input to pipe in
$verbose = false	bool	activate verbose mode (fairly useless with pdftk in case of error)
returns	string
throws

fill($filename, $data, $templates, $coercer, $options, $flatten)

PDFTK.php:408

Fill a pdf using the fields in the PDF.

function fill( string $filename, ArrayAccess|array $data, array $templates, ?callable $coercer = null, array $options = [], bool $flatten = false ): string

Rules to generate the field's value: - If a placeholder in a template is missing and not optional, the field becomes empty. - If a field's value is empty but required, it will trigger an exception

$filename	string	the pdf filename containaing field with template in the name
$data	ArrayAccess \| array	the data to use to inject in the template
$templates	array	map of MMO templates (`loopTpl()`) indexed by the field's name: "{path:type} xxxx {path:type}..."
$coercer = null	null \| callable	the function to call to coerce the data fn($value, $options, $type)
$options = []	array	options to pass to the coercer
$flatten = false	bool	if true flatten the pdf
returns	string

force()

PDFTK.php:100

Remove all exception from generation

function force(): void

returns

void

getInfo($in, $directInput)

PDFTK.php:146

Obtain information about the pdf, its number of page and dimensions and its fields

function getInfo(string $in, bool $directInput = false): array

$in	string	filename or content to read from
$directInput = false	bool	if true $in is not a filename but the content to read
returns	array

Inherited members (48)

Constants	Declared by	Description
`ALERT`	iLogLevel	Alert: Action must be taken immediately.
`ALL`	iLogLevel	Mask for all
`ALL_PLUS`	iLogLevel	debug everything
`BACKTRACE`	iLogLevel
`CRITICAL`	iLogLevel	Critical: Critical conditions.
`DEBUG`	iLogLevel	Debug: Detailed debug information.
`DEEP`	iLogLevel	debug everything with arguments
`EMERGENCY`	iLogLevel	Emergency: System is unusable.
`ERROR`	iLogLevel	Error: Runtime errors that do not require immediate action but should typically be logged and monitored.
`ERROR_PLUS`	iLogLevel	Mask for all error
`FATAL`	iLogLevel	Mask for all fatal error
`INFO`	iLogLevel	Info: Interesting events.
`INFO_PLUS`	iLogLevel	Mask for all errors/warning/notices/info
`MEMORY`	iLogLevel	include backtrace object
`NOTICE`	iLogLevel	Notice: Normal but significant events.
`NOTICE_PLUS`	iLogLevel	Mask for all errors/warning/notices/info
`TRACE`	iLogLevel	include backtrace as origins
`WARNING`	iLogLevel	Warning: Exceptional occurrences that are not errors.
`WARNING_PLUS`	iLogLevel	Mask for all errors and warnings

	Properties	Declared by	Description
	`verbosity`	aModule

Methods	Declared by	Description
`alert($message, $context)`	aModule	Action must be taken immediately.
`backtraces($message, $context)`	aModule	Force-log a message at INFO level together with a full stack trace/memory snapshot (`iLogLevel::BACKTRACE`), bypassing the verbosity mask entirely (any non-zero verbosity is enough to trigger it).
`Configure($config)`	aModule	Merge $config into this module's configuration in the shared `Configuration`.
`critical($message, $context)`	aModule	Critical conditions. No-op if CRITICAL is currently filtered out by the verbosity mask.
`debug($message, $context)`	aModule	Detailed debug information.
`debugName()`	aModule	Human-readable identifier used as the default `{origin}` in this instance's log messages.
`DefaultConfig()`	aModule	The config a module starts from before anything loaded via `Configuration` is merged in.
`emergency($message, $context)`	aModule	System is unusable. No-op if EMERGENCY is currently filtered out by the verbosity mask.
`error($message, $context)`	aModule	Runtime errors that do not require immediate action but should typically be logged and monitored.
`getVerbosity()`	aModule
`info($message, $context)`	aModule	Interesting events. No-op if INFO is currently filtered out by the verbosity mask.
`Instantiate($config)`	aModule	(Re)create the shared instance immediately, configured with $config merged into the class's existing config.
`IsShared()`	aModule
`log($level, $message, $context)`	aModule	Logs with an arbitrary level.
`notice($message, $context)`	aModule	Normal but significant events.
`offsetExists($key)`	aModule	\ArrayAccess::offsetExists -- tells whether $key is a declared property at all, regardless of whether it is currently readable/writable through array access.
`offsetGet($key)`	aModule	\ArrayAccess::offsetGet -- reads a property directly, unless it has a `#[Serialize(serialize: 'methodName')]` attribute, in which case that zero-argument method is called instead (e.g.
`offsetSet($key, $value)`	aModule	\ArrayAccess::offsetSet -- sets a property directly, unless it has a `#[Serialize(unserialize: 'methodName')]` attribute, in which case that method is called with $value instead (e.g.
`offsetUnset($key)`	aModule	\ArrayAccess::offsetUnset -- equivalent to `$module[$key] = null`.
`serialize($path, $serializer)`	aModule	\MMO\core\interfaces\iSerializable::serialize -- exports every property (via
`setVerbosity($verb)`	aModule	Set the current verbosity mask, replacing whatever it was before.
`Shared()`	aModule	Get the shared instance, creating (and configuring) it on first call.
`testVerbosity($level)`	aModule	Test whether a given level (or set of levels) is currently enabled by this instance's verbosity mask.
`traitUnshare($serialize)`	aModule	Remove the shared instance, so the next `Shared()` call creates a fresh one.
`unserialize($data, $path, $instances)`	aModule	\MMO\core\interfaces\iSerializable::unserialize -- merges $data onto `DefaultConfig`, runs it through the (possibly overridden) constructor, then applies each resulting value to its property (via
`Unshare($serialize)`	aModule	Like `tSingleton::Unshare`, but also disconnects this module's instance from every event it was listening to (via `Event::DisconnectListeners`) before dropping it.
`warning($message, $context)`	aModule	Exceptional occurrences that are not errors.
`__construct($config)`	aModule	protected constructor, so it is not possible to do `new Module(...)` called by the serialization process just before being injected with data.