1	<?php
2	/**
3	* Pop PHP Framework (https://www.popphp.org/)
4	*
5	* @link       https://github.com/popphp/popphp-framework
6	* @author     Nick Sagona, III <dev@noladev.com>
7	* @copyright  Copyright (c) 2009-2025 NOLA Interactive, LLC.
8	* @license    https://www.popphp.org/license     New BSD License
9	*/
10
11	/**
12	* @namespace
13	*/
14	namespace Pop\Pdf\Build;
15
16	use Pop\Pdf\Document;
17
18	/**
19	* Compiler interface
20	*
21	* @category   Pop
22	* @package    Pop\Pdf
23	* @author     Nick Sagona, III <dev@noladev.com>
24	* @copyright  Copyright (c) 2009-2025 NOLA Interactive, LLC.
25	* @license    https://www.popphp.org/license     New BSD License
26	* @version    5.2.2
27	*/
28	interface CompilerInterface
29	{
30
31	/**
32	* Get the document object
33	*
34	* @return ?Document
35	*/
36	public function getDocument(): ?Document;
37
38	/**
39	* Get the root object
40	*
41	* @return ?PdfObject\RootObject
42	*/
43	public function getRoot(): ?PdfObject\RootObject;
44
45	/**
46	* Get the parent object
47	*
48	* @return ?PdfObject\ParentObject
49	*/
50	public function getParent(): ?PdfObject\ParentObject;
51
52	/**
53	* Get the info object
54	*
55	* @return ?PdfObject\InfoObject
56	*/
57	public function getInfo(): ?PdfObject\InfoObject;
58
59	/**
60	* Return the last object index.
61	*
62	* @return int
63	*/
64	public function lastIndex(): int;
65
66	/**
67	* Get the compiled output
68	*
69	* @return string
70	*/
71	public function getOutput(): string;
72
73	/**
74	* Set the document object
75	*
76	* @param  Document\AbstractDocument $document
77	* @return Compiler
78	*/
79	public function setDocument(Document\AbstractDocument $document): Compiler;
80
81	/**
82	* Compile and finalize the PDF document
83	*
84	* @param  Document\AbstractDocument $document
85	* @return void
86	*/
87	public function finalize(Document\AbstractDocument $document): void;
88
89	}