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