Test Failed
Pull Request — master (#455)
by
unknown
04:45 queued 02:09
created

Page::getPageNumber()   A

Complexity

Conditions 3
Paths 3

Size

Total Lines 11
Code Lines 6

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 12

Importance

Changes 0
Metric Value
cc 3
eloc 6
c 0
b 0
f 0
nc 3
nop 0
dl 0
loc 11
ccs 0
cts 4
cp 0
crap 12
rs 10
1
<?php
2
3
/**
4
 * @file
5
 *          This file is part of the PdfParser library.
6
 *
7
 * @author  Sébastien MALOT <[email protected]>
8
 * @date    2017-01-03
9
 *
10
 * @license LGPLv3
11
 * @url     <https://github.com/smalot/pdfparser>
12
 *
13
 *  PdfParser is a pdf library written in PHP, extraction oriented.
14
 *  Copyright (C) 2017 - Sébastien MALOT <[email protected]>
15
 *
16
 *  This program is free software: you can redistribute it and/or modify
17
 *  it under the terms of the GNU Lesser General Public License as published by
18
 *  the Free Software Foundation, either version 3 of the License, or
19
 *  (at your option) any later version.
20
 *
21
 *  This program is distributed in the hope that it will be useful,
22
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
23
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
24
 *  GNU Lesser General Public License for more details.
25
 *
26
 *  You should have received a copy of the GNU Lesser General Public License
27
 *  along with this program.
28
 *  If not, see <http://www.pdfparser.org/sites/default/LICENSE.txt>.
29
 */
30
31
namespace Smalot\PdfParser;
32
33
use Smalot\PdfParser\Element\ElementArray;
34
use Smalot\PdfParser\Element\ElementMissing;
35
use Smalot\PdfParser\Element\ElementNull;
36
use Smalot\PdfParser\Element\ElementXRef;
37
38
class Page extends PDFObject
39
{
40
    /**
41
     * @var Font[]
42
     */
43
    protected $fonts = null;
44
45
    /**
46
     * @var PDFObject[]
47
     */
48
    protected $xobjects = null;
49
50
    /**
51
     * @var array
52
     */
53
    protected $dataTm = null;
54
55
    /**
56
     * @return Font[]
57
     */
58 23
    public function getFonts()
59
    {
60 23
        if (null !== $this->fonts) {
61 19
            return $this->fonts;
62
        }
63
64 23
        $resources = $this->get('Resources');
65
66 23
        if (method_exists($resources, 'has') && $resources->has('Font')) {
67 20
            if ($resources->get('Font') instanceof ElementMissing) {
0 ignored issues
show
Bug introduced by
The method get() does not exist on Smalot\PdfParser\Element. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

67
            if ($resources->/** @scrutinizer ignore-call */ get('Font') instanceof ElementMissing) {

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
68 1
                return [];
69
            }
70
71 19
            if ($resources->get('Font') instanceof Header) {
72 13
                $fonts = $resources->get('Font')->getElements();
73
            } else {
74 8
                $fonts = $resources->get('Font')->getHeader()->getElements();
75
            }
76
77 19
            $table = [];
78
79 19
            foreach ($fonts as $id => $font) {
80 19
                if ($font instanceof Font) {
81 19
                    $table[$id] = $font;
82
83
                    // Store too on cleaned id value (only numeric)
84 19
                    $id = preg_replace('/[^0-9\.\-_]/', '', $id);
85 19
                    if ('' != $id) {
86 19
                        $table[$id] = $font;
87
                    }
88
                }
89
            }
90
91 19
            return $this->fonts = $table;
92
        }
93
94 5
        return [];
95
    }
96
97 21
    public function getFont(string $id): ?Font
98
    {
99 21
        $fonts = $this->getFonts();
100
101 21
        if (isset($fonts[$id])) {
102 18
            return $fonts[$id];
103
        }
104
105
        // According to the PDF specs (https://www.adobe.com/content/dam/acom/en/devnet/pdf/pdfs/PDF32000_2008.pdf, page 238)
106
        // "The font resource name presented to the Tf operator is arbitrary, as are the names for all kinds of resources"
107
        // Instead, we search for the unfiltered name first and then do this cleaning as a fallback, so all tests still pass.
108
109 4
        if (isset($fonts[$id])) {
110
            return $fonts[$id];
111
        } else {
112 4
            $id = preg_replace('/[^0-9\.\-_]/', '', $id);
113 4
            if (isset($fonts[$id])) {
114 1
                return $fonts[$id];
115
            }
116
        }
117
118 3
        return null;
119
    }
120
121
    /**
122
     * Support for XObject
123
     *
124
     * @return PDFObject[]
125
     */
126 4
    public function getXObjects()
127
    {
128 4
        if (null !== $this->xobjects) {
129 3
            return $this->xobjects;
130
        }
131
132 4
        $resources = $this->get('Resources');
133
134 4
        if (method_exists($resources, 'has') && $resources->has('XObject')) {
135 4
            if ($resources->get('XObject') instanceof Header) {
136 4
                $xobjects = $resources->get('XObject')->getElements();
137
            } else {
138
                $xobjects = $resources->get('XObject')->getHeader()->getElements();
139
            }
140
141 4
            $table = [];
142
143 4
            foreach ($xobjects as $id => $xobject) {
144 4
                $table[$id] = $xobject;
145
146
                // Store too on cleaned id value (only numeric)
147 4
                $id = preg_replace('/[^0-9\.\-_]/', '', $id);
148 4
                if ('' != $id) {
149 4
                    $table[$id] = $xobject;
150
                }
151
            }
152
153 4
            return $this->xobjects = $table;
154
        }
155
156
        return [];
157
    }
158
159 4
    public function getXObject(string $id): ?PDFObject
160
    {
161 4
        $xobjects = $this->getXObjects();
162
163 4
        if (isset($xobjects[$id])) {
164 4
            return $xobjects[$id];
165
        }
166
167
        return null;
168
        /*$id = preg_replace('/[^0-9\.\-_]/', '', $id);
169
170
        if (isset($xobjects[$id])) {
171
            return $xobjects[$id];
172
        } else {
173
            return null;
174
        }*/
175
    }
176
177 13
    public function getText(self $page = null): string
178
    {
179 13
        if ($contents = $this->get('Contents')) {
180 13
            if ($contents instanceof ElementMissing) {
181
                return '';
182 13
            } elseif ($contents instanceof ElementNull) {
183
                return '';
184 13
            } elseif ($contents instanceof PDFObject) {
0 ignored issues
show
introduced by
$contents is never a sub-type of Smalot\PdfParser\PDFObject.
Loading history...
185 10
                $elements = $contents->getHeader()->getElements();
186
187 10
                if (is_numeric(key($elements))) {
188
                    $new_content = '';
189
190
                    foreach ($elements as $element) {
191
                        if ($element instanceof ElementXRef) {
192
                            $new_content .= $element->getObject()->getContent();
193
                        } else {
194
                            $new_content .= $element->getContent();
195
                        }
196
                    }
197
198
                    $header = new Header([], $this->document);
199 10
                    $contents = new PDFObject($this->document, $header, $new_content, $this->config);
200
                }
201 3
            } elseif ($contents instanceof ElementArray) {
202
                // Create a virtual global content.
203 3
                $new_content = '';
204
205 3
                foreach ($contents->getContent() as $content) {
206 3
                    $new_content .= $content->getContent()."\n";
207
                }
208
209 3
                $header = new Header([], $this->document);
210 3
                $contents = new PDFObject($this->document, $header, $new_content, $this->config);
211
            }
212
213 13
            /*
214
             * Elements referencing each other on the same page can cause endless loops during text parsing.
215
             * To combat this we keep a recursionStack containing already parsed elements on the page.
216
             * The stack is only emptied here after getting text from a page.
217
             */
218
            $contentsText = $contents->getText($this);
0 ignored issues
show
Bug introduced by
The method getText() does not exist on Smalot\PdfParser\Element. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

218
            /** @scrutinizer ignore-call */ 
219
            $contentsText = $contents->getText($this);

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
219 4
            PDFObject::$recursionStack = [];
220
221 4
            return $contentsText;
222 4
        }
223
224 4
        return '';
225
    }
226 4
227 4
    /**
228
     * Return true if the current page is a (setasign\Fpdi\Fpdi) FPDI/FPDF document
229 4
     *
230
     * @return bool true is the current page is a FPDI/FPDF document
231
     */
232
    public function isFpdf(): bool
233
    {
234
        if (\array_key_exists('Producer', $this->document->getDetails()) &&
235
            \is_string($this->document->getDetails()['Producer']) &&
236
            str_starts_with($this->document->getDetails()['Producer'], 'FPDF')) {
237
            return true;
238
        }
239
240
        return false;
241
    }
242
243
    /**
244
     * Return the page number of the PDF document of the page object
245 4
     *
246 1
     * @return int the page number
247 4
     */
248
    public function getPageNumber(): int
249
    {
250
        $pages = $this->document->getPages();
251
        $numOfPages = \count($pages);
252
        for ($pageNum = 0; $pageNum < $numOfPages; ++$pageNum) {
253
            if ($pages[$pageNum] === $this) {
254
                break;
255
            }
256
        }
257
258
        return $pageNum;
259
    }
260
261
    public function getTextArray(self $page = null): array
262
    {
263 3
        if ($this->isFpdf()) {
264
            /**
265
             * This code is for the (setasign\Fpdi\Fpdi) FPDI-FPDF documents.
266
             * The page number is important for getting the PDF Commands and Text Matrix
267
             */
268
            $pageNum = $this->getPageNumber();
269
            $xObjects = $this->getXObjects();
270
            /** The correct page info is in $xObject[$pageNum] */
271
            $xObject = $xObjects[$pageNum];
272
            $new_content = $xObject->getContent();
273
            $header = $xObject->getHeader();
274 8
            $config = $xObject->config;
275
            /** Now we create the PDFObject object with the correct info */
276
            $contents = new PDFObject($xObject->document, $header, $new_content, $config);
277
278
            return $contents->getTextArray($xObject);
279 8
        }
280 8
        if ($contents = $this->get('Contents')) {
281 8
            if ($contents instanceof ElementMissing) {
282 8
                return [];
283
            } elseif ($contents instanceof ElementNull) {
284
                return [];
285
            } elseif ($contents instanceof PDFObject) {
0 ignored issues
show
introduced by
$contents is never a sub-type of Smalot\PdfParser\PDFObject.
Loading history...
286
                $elements = $contents->getHeader()->getElements();
287
288
                if (is_numeric(key($elements))) {
289
                    $new_content = '';
290
291
                    /** @var PDFObject $element */
292
                    foreach ($elements as $element) {
293
                        if ($element instanceof ElementXRef) {
294
                            $new_content .= $element->getObject()->getContent();
295 8
                        } else {
296 8
                            $new_content .= $element->getContent();
297 8
                        }
298
                    }
299 8
300 8
                    $header = new Header([], $this->document);
301 8
                    $contents = new PDFObject($this->document, $header, $new_content, $this->config);
302
                } else {
303
                    try {
304
                        $contents->getTextArray($this);
305
                    } catch (\Throwable $e) {
306 8
                        return $contents->getTextArray();
307
                    }
308
                }
309
            } elseif ($contents instanceof ElementArray) {
310
                // Create a virtual global content.
311
                $new_content = '';
312
313
                /** @var PDFObject $content */
314
                foreach ($contents->getContent() as $content) {
315
                    $new_content .= $content->getContent()."\n";
316
                }
317 7
318
                $header = new Header([], $this->document);
319 7
                $contents = new PDFObject($this->document, $header, $new_content, $this->config);
320 7
            }
321
322 7
            return $contents->getTextArray($this);
0 ignored issues
show
Bug introduced by
The method getTextArray() does not exist on Smalot\PdfParser\Element. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

322
            return $contents->/** @scrutinizer ignore-call */ getTextArray($this);

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
323 7
        }
324 7
325 7
        return [];
326 7
    }
327 7
328 5
    /**
329 5
     * Gets all the text data with its internal representation of the page.
330 5
     *
331
     * Returns an array with the data and the internal representation
332
     */
333 5
    public function extractRawData(): array
334 5
    {
335 5
        /*
336
         * Now you can get the complete content of the object with the text on it
337
         */
338 5
        $extractedData = [];
339 5
        $content = $this->get('Contents');
340 5
        $values = $content->getContent();
341
        if (isset($values) && \is_array($values)) {
342 5
            $text = '';
343 5
            foreach ($values as $section) {
344
                $text .= $section->getContent();
345 7
            }
346 7
            $sectionsText = $this->getSectionsText($text);
347 7
            foreach ($sectionsText as $sectionText) {
348 5
                $commandsText = $this->getCommandsText($sectionText);
349
                foreach ($commandsText as $command) {
350 7
                    $extractedData[] = $command;
351 7
                }
352 7
            }
353 7
        } else {
354 7
            if ($this->isFpdf()) {
355
                /*
356
                 * This code is for the (setasign\Fpdi\Fpdi) FPDI-FPDF documents.
357 7
                 * The page number is important for getting the PDF Commands and Text Matrix
358 7
                 */
359 5
                $pageNum = $this->getPageNumber();
360
                $xObjects = $this->getXObjects();
361 7
                // The correct page info is in $xObject[$pageNum]
362 7
                $content = $xObjects[$pageNum];
363
            }
364 7
            $sectionsText = $content->getSectionsText($content->getContent());
0 ignored issues
show
Bug introduced by
The method getSectionsText() does not exist on Smalot\PdfParser\Element. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

364
            /** @scrutinizer ignore-call */ 
365
            $sectionsText = $content->getSectionsText($content->getContent());

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
365 7
            foreach ($sectionsText as $sectionText) {
366 7
                $extractedData[] = ['t' => '', 'o' => 'BT', 'c' => ''];
367 7
368 7
                $commandsText = $content->getCommandsText($sectionText);
0 ignored issues
show
Bug introduced by
The method getCommandsText() does not exist on Smalot\PdfParser\Element. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

368
                /** @scrutinizer ignore-call */ 
369
                $commandsText = $content->getCommandsText($sectionText);

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
369
                foreach ($commandsText as $command) {
370 7
                    $extractedData[] = $command;
371
                }
372
            }
373
        }
374
375 7
        return $extractedData;
376
    }
377
378
    /**
379
     * Gets all the decoded text data with it internal representation from a page.
380
     *
381
     * @param array $extractedRawData the extracted data return by extractRawData or
382
     *                                null if extractRawData should be called
383
     *
384
     * @return array An array with the data and the internal representation
385
     */
386
    public function extractDecodedRawData(array $extractedRawData = null): array
387
    {
388
        if (!isset($extractedRawData) || !$extractedRawData) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $extractedRawData of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
389
            $extractedRawData = $this->extractRawData();
390 5
        }
391
        $currentFont = null; /** @var Font $currentFont */
392 5
        $clippedFont = null;
393 5
        $xObject = null;
394
        if ($this->isFpdf()) {
395 5
            /*
396 5
             * This code is for the (setasign\Fpdi\Fpdi) FPDI-FPDF documents.
397 5
             * The page number is important for getting the PDF Commands and Text Matrix
398
             */
399
            $pageNum = $this->getPageNumber();
400
            $xObjects = $this->getXObjects();
401
            /** The correct font page info is in $xObject[$pageNum] */
402 5
            $xObject = $xObjects[$pageNum];
403 5
        }
404 5
        foreach ($extractedRawData as &$command) {
405
            if ('Tj' == $command['o'] || 'TJ' == $command['o']) {
406
                $data = $command['c'];
407
                if (!\is_array($data)) {
408
                    $tmpText = '';
409
                    if (isset($currentFont)) {
410 5
                        $tmpText = $currentFont->decodeOctal($data);
411
                        //$tmpText = $currentFont->decodeHexadecimal($tmpText, false);
412
                    }
413
                    $tmpText = str_replace(
414
                            ['\\\\', '\(', '\)', '\n', '\r', '\t', '\ '],
415
                            ['\\', '(', ')', "\n", "\r", "\t", ' '],
416
                            $tmpText
417
                    );
418
                    $tmpText = utf8_encode($tmpText);
419 5
                    if (isset($currentFont)) {
420 3
                        $tmpText = $currentFont->decodeContent($tmpText);
421 3
                    }
422
                    $command['c'] = $tmpText;
423
                    continue;
424
                }
425
                $numText = \count($data);
426
                for ($i = 0; $i < $numText; ++$i) {
427
                    if (0 != ($i % 2)) {
428 5
                        continue;
429 5
                    }
430 5
                    $tmpText = $data[$i]['c'];
431
                    $decodedText = isset($currentFont) ? $currentFont->decodeOctal($tmpText) : $tmpText;
432
                    $decodedText = str_replace(
433
                            ['\\\\', '\(', '\)', '\n', '\r', '\t', '\ '],
434
                            ['\\', '(', ')', "\n", "\r", "\t", ' '],
435
                            $decodedText
436
                    );
437
                    $decodedText = utf8_encode($decodedText);
438
                    if (isset($currentFont)) {
439
                        $decodedText = $currentFont->decodeContent($decodedText);
440
                    }
441 5
                    $command['c'][$i]['c'] = $decodedText;
442
                    continue;
443
                }
444
            } elseif ('Tf' == $command['o'] || 'TF' == $command['o']) {
445
                $fontId = explode(' ', $command['c'])[0];
446
                /** If document is a FPDI/FPDF the $xObject has the correct font */
447
                $currentFont = isset($xObject) ? $xObject->getFont($fontId) : $this->getFont($fontId);
0 ignored issues
show
Bug introduced by
The method getFont() does not exist on Smalot\PdfParser\PDFObject. It seems like you code against a sub-type of Smalot\PdfParser\PDFObject such as Smalot\PdfParser\Page. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

447
                $currentFont = isset($xObject) ? $xObject->/** @scrutinizer ignore-call */ getFont($fontId) : $this->getFont($fontId);
Loading history...
448
                continue;
449
            } elseif ('Q' == $command['o']) {
450
                $currentFont = $clippedFont;
451 5
            } elseif ('q' == $command['o']) {
452 3
                $clippedFont = $currentFont;
453 3
            }
454
        }
455
456
        return $extractedRawData;
457
    }
458
459
    /**
460
     * Gets just the Text commands that are involved in text positions and
461
     * Text Matrix (Tm)
462 5
     *
463 3
     * It extract just the PDF commands that are involved with text positions, and
464 3
     * the Text Matrix (Tm). These are: BT, ET, TL, Td, TD, Tm, T*, Tj, ', ", and TJ
465
     *
466
     * @param array $extractedDecodedRawData The data extracted by extractDecodeRawData.
467
     *                                       If it is null, the method extractDecodeRawData is called.
468
     *
469
     * @return array An array with the text command of the page
470 5
     */
471 4
    public function getDataCommands(array $extractedDecodedRawData = null): array
472 4
    {
473
        if (!isset($extractedDecodedRawData) || !$extractedDecodedRawData) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $extractedDecodedRawData of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
474
            $extractedDecodedRawData = $this->extractDecodedRawData();
475
        }
476
        $extractedData = [];
477
        foreach ($extractedDecodedRawData as $command) {
478
            switch ($command['o']) {
479
                /*
480
                 * BT
481 5
                 * Begin a text object, inicializind the Tm and Tlm to identity matrix
482
                 */
483
                case 'BT':
484
                    $extractedData[] = $command;
485
                    break;
486
487
                /*
488
                 * ET
489
                 * End a text object, discarding the text matrix
490
                 */
491
                case 'ET':
492
                    $extractedData[] = $command;
493
                    break;
494
495
                /*
496 5
                 * leading TL
497
                 * Set the text leading, Tl, to leading. Tl is used by the T*, ' and " operators.
498
                 * Initial value: 0
499
                 */
500
                case 'TL':
501
                    $extractedData[] = $command;
502
                    break;
503
504
                /*
505
                 * tx ty Td
506
                 * Move to the start of the next line, offset form the start of the
507
                 * current line by tx, ty.
508
                 */
509
                case 'Td':
510
                    $extractedData[] = $command;
511
                    break;
512 5
513 5
                /*
514 5
                 * tx ty TD
515
                 * Move to the start of the next line, offset form the start of the
516
                 * current line by tx, ty. As a side effect, this operator set the leading
517
                 * parameter in the text state. This operator has the same effect as the
518
                 * code:
519 5
                 * -ty TL
520
                 * tx ty Td
521
                 */
522
                case 'TD':
523
                    $extractedData[] = $command;
524
                    break;
525
526
                /*
527
                 * a b c d e f Tm
528
                 * Set the text matrix, Tm, and the text line matrix, Tlm. The operands are
529
                 * all numbers, and the initial value for Tm and Tlm is the identity matrix
530
                 * [1 0 0 1 0 0]
531
                 */
532
                case 'Tm':
533
                    $extractedData[] = $command;
534
                    break;
535
536 4
                /*
537
                 * T*
538 4
                 * Move to the start of the next line. This operator has the same effect
539 4
                 * as the code:
540
                 * 0 Tl Td
541
                 * Where Tl is the current leading parameter in the text state.
542
                 */
543
                case 'T*':
544
                    $extractedData[] = $command;
545 4
                    break;
546
547
                /*
548
                 * string Tj
549
                 * Show a Text String
550 4
                 */
551
                case 'Tj':
552
                    $extractedData[] = $command;
553
                    break;
554
555 4
                /*
556 4
                 * string '
557 4
                 * Move to the next line and show a text string. This operator has the
558 4
                 * same effect as the code:
559
                 * T*
560 4
                 * string Tj
561 4
                 */
562
                case "'":
563 4
                    $extractedData[] = $command;
564 4
                    break;
565 4
566 4
                /*
567 4
                 * aw ac string "
568
                 * Move to the next lkine and show a text string, using aw as the word
569
                 * spacing and ac as the character spacing. This operator has the same
570
                 * effect as the code:
571
                 * aw Tw
572 4
                 * ac Tc
573 4
                 * string '
574 4
                 * Tw set the word spacing, Tw, to wordSpace.
575 4
                 * Tc Set the character spacing, Tc, to charsSpace.
576 4
                 */
577 4
                case '"':
578
                    $extractedData[] = $command;
579
                    break;
580
581
                /*
582
                 * array TJ
583 4
                 * Show one or more text strings allow individual glyph positioning.
584
                 * Each lement of array con be a string or a number. If the element is
585
                 * a string, this operator shows the string. If it is a number, the
586
                 * operator adjust the text position by that amount; that is, it translates
587
                 * the text matrix, Tm. This amount is substracted form the current
588
                 * horizontal or vertical coordinate, depending on the writing mode.
589
                 * in the default coordinate system, a positive adjustment has the effect
590
                 * of moving the next glyph painted either to the left or down by the given
591
                 * amount.
592
                 */
593
                case 'TJ':
594
                    $extractedData[] = $command;
595 4
                    break;
596 2
                default:
597 2
            }
598
        }
599
600
        return $extractedData;
601
    }
602
603
    /**
604 4
     * Gets the Text Matrix of the text in the page
605 4
     *
606 4
     * Return an array where every item is an array where the first item is the
607 4
     * Text Matrix (Tm) and the second is a string with the text data.  The Text matrix
608 4
     * is an array of 6 numbers. The last 2 numbers are the coordinates X and Y of the
609 4
     * text. The first 4 numbers has to be with Scalation, Rotation and Skew of the text.
610 4
     *
611
     * @param array $dataCommands the data extracted by getDataCommands
612
     *                            if null getDataCommands is called
613
     *
614
     * @return array an array with the data of the page including the Tm information
615
     *               of any text in the page
616
     */
617
    public function getDataTm(array $dataCommands = null): array
618
    {
619
        if (!isset($dataCommands) || !$dataCommands) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $dataCommands of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
620
            $dataCommands = $this->getDataCommands();
621 4
        }
622
623
        /*
624
         * At the beginning of a text object Tm is the identity matrix
625
         */
626
        $defaultTm = ['1', '0', '0', '1', '0', '0'];
627
628
        /*
629
         *  Set the text leading used by T*, ' and " operators
630
         */
631
        $defaultTl = 0;
632
633
        /*
634
         * Setting where are the X and Y coordinates in the matrix (Tm)
635
         */
636 4
        $x = 4;
637 2
        $y = 5;
638 2
        $Tx = 0;
639 2
        $Ty = 0;
640 2
641
        $Tm = $defaultTm;
642
        $Tl = $defaultTl;
643
644
        $extractedTexts = $this->getTextArray();
645
        $extractedData = [];
646
        foreach ($dataCommands as $command) {
647
            $currentText = $extractedTexts[\count($extractedData)];
648
            switch ($command['o']) {
649 4
                /*
650 2
                 * BT
651 2
                 * Begin a text object, inicializind the Tm and Tlm to identity matrix
652 2
                 */
653
                case 'BT':
654
                    $Tm = $defaultTm;
655
                    $Tl = $defaultTl; //review this.
656
                    $Tx = 0;
657
                    $Ty = 0;
658 4
                    break;
659 3
660 3
                /*
661
                 * ET
662
                 * End a text object, discarding the text matrix
663
                 */
664
                case 'ET':
665
                    $Tm = $defaultTm;
666
                    $Tl = $defaultTl;  //review this
667
                    $Tx = 0;
668
                    $Ty = 0;
669 4
                    break;
670
671
                /*
672
                 * leading TL
673
                 * Set the text leading, Tl, to leading. Tl is used by the T*, ' and " operators.
674
                 * Initial value: 0
675
                 */
676
                case 'TL':
677
                    $Tl = (float) $command['c'];
678
                    break;
679
680
                /*
681
                 * tx ty Td
682
                 * Move to the start of the next line, offset form the start of the
683
                 * current line by tx, ty.
684
                 */
685
                case 'Td':
686 4
                    $coord = explode(' ', $command['c']);
687
                    $Tx += (float) $coord[0];
688
                    $Ty += (float) $coord[1];
689
                    $Tm[$x] = (string) $Tx;
690
                    $Tm[$y] = (string) $Ty;
691
                    break;
692
693
                /*
694
                 * tx ty TD
695
                 * Move to the start of the next line, offset form the start of the
696
                 * current line by tx, ty. As a side effect, this operator set the leading
697
                 * parameter in the text state. This operator has the same effect as the
698
                 * code:
699
                 * -ty TL
700
                 * tx ty Td
701
                 */
702
                case 'TD':
703
                    $coord = explode(' ', $command['c']);
704
                    $Tl = (float) $coord[1];
705 4
                    $Tx += (float) $coord[0];
706 4
                    $Ty -= (float) $coord[1];
707 4
                    $Tm[$x] = (string) $Tx;
708
                    $Tm[$y] = (string) $Ty;
709
                    break;
710
711 4
                /*
712
                 * a b c d e f Tm
713 4
                 * Set the text matrix, Tm, and the text line matrix, Tlm. The operands are
714
                 * all numbers, and the initial value for Tm and Tlm is the identity matrix
715
                 * [1 0 0 1 0 0]
716
                 */
717
                case 'Tm':
718
                    $Tm = explode(' ', $command['c']);
719
                    $Tx = (float) $Tm[$x];
720
                    $Ty = (float) $Tm[$y];
721
                    break;
722
723
                /*
724
                 * T*
725
                 * Move to the start of the next line. This operator has the same effect
726
                 * as the code:
727
                 * 0 Tl Td
728
                 * Where Tl is the current leading parameter in the text state.
729
                 */
730
                case 'T*':
731
                    $Ty -= $Tl;
732
                    $Tm[$y] = (string) $Ty;
733
                    break;
734 1
735
                /*
736 1
                 * string Tj
737 1
                 * Show a Text String
738
                 */
739
                case 'Tj':
740 1
                    $extractedData[] = [$Tm, $currentText];
741 1
                    break;
742
743
                /*
744 1
                 * string '
745 1
                 * Move to the next line and show a text string. This operator has the
746
                 * same effect as the code:
747
                 * T*
748 1
                 * string Tj
749
                 */
750
                case "'":
751
                    $Ty -= $Tl;
752 1
                    $Tm[$y] = (string) $Ty;
753 1
                    $extractedData[] = [$Tm, $currentText];
754
                    break;
755 1
756 1
                /*
757 1
                 * aw ac string "
758 1
                 * Move to the next line and show a text string, using aw as the word
759 1
                 * spacing and ac as the character spacing. This operator has the same
760 1
                 * effect as the code:
761 1
                 * aw Tw
762
                 * ac Tc
763
                 * string '
764
                 * Tw set the word spacing, Tw, to wordSpace.
765
                 * Tc Set the character spacing, Tc, to charsSpace.
766
                 */
767
                case '"':
768 1
                    $data = explode(' ', $currentText);
769
                    $Ty -= $Tl;
770
                    $Tm[$y] = (string) $Ty;
771
                    $extractedData[] = [$Tm, $data[2]]; //Verify
772
                    break;
773
774
                /*
775 1
                 * array TJ
776 1
                 * Show one or more text strings allow individual glyph positioning.
777 1
                 * Each lement of array con be a string or a number. If the element is
778 1
                 * a string, this operator shows the string. If it is a number, the
779 1
                 * operator adjust the text position by that amount; that is, it translates
780 1
                 * the text matrix, Tm. This amount is substracted form the current
781
                 * horizontal or vertical coordinate, depending on the writing mode.
782
                 * in the default coordinate system, a positive adjustment has the effect
783
                 * of moving the next glyph painted either to the left or down by the given
784 1
                 * amount.
785
                 */
786
                case 'TJ':
787
                    $extractedData[] = [$Tm, $currentText];
788
                    break;
789
                default:
790
            }
791
        }
792
        $this->dataTm = $extractedData;
793
794
        return $extractedData;
795
    }
796
797
    /**
798
     * Gets text data that are around the given coordinates (X,Y)
799
     *
800
     * If the text is in near the given coordinates (X,Y) (or the TM info),
801
     * the text is returned.  The extractedData return by getDataTm, could be use to see
802
     * where is the coordinates of a given text, using the TM info for it.
803
     *
804
     * @param float $x      The X value of the coordinate to search for. if null
805
     *                      just the Y value is considered (same Row)
806
     * @param float $y      The Y value of the coordinate to search for
807
     *                      just the X value is considered (same column)
808
     * @param float $xError The value less or more to consider an X to be "near"
809
     * @param float $yError The value less or more to consider an Y to be "near"
810
     *
811
     * @return array An array of text that are near the given coordinates. If no text
812
     *               "near" the x,y coordinate, an empty array is returned. If Both, x
813
     *               and y coordinates are null, null is returned.
814
     */
815
    public function getTextXY(float $x = null, float $y = null, float $xError = 0, float $yError = 0): array
816
    {
817
        if (!isset($this->dataTm) || !$this->dataTm) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $this->dataTm of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
818
            $this->getDataTm();
819
        }
820
821
        if (null !== $x) {
822
            $x = (float) $x;
823
        }
824
825
        if (null !== $y) {
826
            $y = (float) $y;
827
        }
828
829
        if (null === $x && null === $y) {
830
            return [];
831
        }
832
833
        $xError = (float) $xError;
834
        $yError = (float) $yError;
835
836
        $extractedData = [];
837
        foreach ($this->dataTm as $item) {
838
            $tm = $item[0];
839
            $xTm = (float) $tm[4];
840
            $yTm = (float) $tm[5];
841
            $text = $item[1];
842
            if (null === $y) {
843
                if (($xTm >= ($x - $xError)) &&
844
                    ($xTm <= ($x + $xError))) {
845
                    $extractedData[] = [$tm, $text];
846
                    continue;
847
                }
848
            }
849
            if (null === $x) {
850
                if (($yTm >= ($y - $yError)) &&
851
                    ($yTm <= ($y + $yError))) {
852
                    $extractedData[] = [$tm, $text];
853
                    continue;
854
                }
855
            }
856
            if (($xTm >= ($x - $xError)) &&
857
                ($xTm <= ($x + $xError)) &&
858
                ($yTm >= ($y - $yError)) &&
859
                ($yTm <= ($y + $yError))) {
860
                $extractedData[] = [$tm, $text];
861
                continue;
862
            }
863
        }
864
865
        return $extractedData;
866
    }
867
}
868