Header::init() - Code Metrics - Inspection of "revived #257: Properly decode ANSI encodings" - smalot/pdfparser - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#349)

unknown

created 2020-10-06 10:18 UTC

Header::init() A

↳ Parent: Header

Complexity

Conditions	2
Paths	2

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2

Importance

Changes

Metric	Value
cc	2
eloc	2
c	0
b	0
f	0
nc	2
nop	0
dl	0
loc	4
ccs	3
cts	3
cp	1
crap	2
rs	10

<?php

/**
 * @file
 *          This file is part of the PdfParser library.
 *
 * @author  Sébastien MALOT <[email protected]>
 * @date    2017-01-03
 *
 * @license LGPLv3
 * @url     <https://github.com/smalot/pdfparser>
 *
 *  PdfParser is a pdf library written in PHP, extraction oriented.
 *  Copyright (C) 2017 - Sébastien MALOT <[email protected]>
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with this program.
 *  If not, see <http://www.pdfparser.org/sites/default/LICENSE.txt>.
 */

namespace Smalot\PdfParser;

use Smalot\PdfParser\Element\ElementArray;
use Smalot\PdfParser\Element\ElementMissing;
use Smalot\PdfParser\Element\ElementStruct;
use Smalot\PdfParser\Element\ElementXRef;

/**
 * Class Header
 */
class Header
{
    /**
     * @var Document
     */
    protected $document = null;

    /**
     * @var Element[]
     */
    protected $elements = null;

    /**
     * @param Element[] $elements list of elements
     * @param Document  $document document
     */
    public function __construct($elements = [], Document $document = null)
    {
        $this->elements = $elements;
        $this->document = $document;
    }

    public function init()
    {
        foreach ($this->elements as $name => $element) {
            $element->init();
        }
    }

    /**
     * Returns all elements.
     */
    public function getElements()
    {
        foreach ($this->elements as $name => $element) {
            $this->resolveXRef($name);
        }

        return $this->elements;
    }

    /**
     * Used only for debug.
     *
     * @return array
     */
    public function getElementTypes()
    {
        $types = [];

        foreach ($this->elements as $key => $element) {
            $types[$key] = \get_class($element);
        }

        return $types;
    }

    /**
     * @param bool $deep
     *
     * @return array
     */
    public function getDetails($deep = true)
    {
        $values = [];
        $elements = $this->getElements();

        foreach ($elements as $key => $element) {
            if ($element instanceof self && $deep) {
                $values[$key] = $element->getDetails($deep);
            } elseif ($element instanceof PDFObject && $deep) {
                $values[$key] = $element->getDetails(false);
            } elseif ($element instanceof ElementArray) {
                if ($deep) {
                    $values[$key] = $element->getDetails();
                }
            } elseif ($element instanceof Element) {
                $values[$key] = (string) $element;
            }
        }

        return $values;
    }

    /**
     * Indicate if an element name is available in header.
     *
     * @param string $name The name of the element
     *
     * @return bool
     */
    public function has($name)
    {
        return \array_key_exists($name, $this->elements);
    }

    /**
     * @param string $name
     *
     * @return Element|PDFObject
     */
    public function get($name)
    {
        if (\array_key_exists($name, $this->elements)) {
            return $this->resolveXRef($name);
        }

        return new ElementMissing();
    }

    /**
     * Resolve XRef to object.
     *
     * @param string $name
     *
     * @return Element|PDFObject
     *
     * @throws \Exception
     */
    protected function resolveXRef($name)
    {
        if (($obj = $this->elements[$name]) instanceof ElementXRef && null !== $this->document) {
            /** @var ElementXRef $obj */
            $object = $this->document->getObjectById($obj->getId());

            if (null === $object) {
                return new ElementMissing();
            }

            // Update elements list for future calls.
            $this->elements[$name] = $object;
        }

        return $this->elements[$name];
    }

    /**
     * @param string   $content  The content to parse
     * @param Document $document The document
     * @param int      $position The new position of the cursor after parsing
     *
     * @return Header
     */
    public static function parse($content, Document $document, &$position = 0)
    {
        /* @var Header $header */
        if ('<<' == substr(trim($content), 0, 2)) {
            $header = ElementStruct::parse($content, $document, $position);
        } else {
            $elements = ElementArray::parse($content, $document, $position);
            $header = new self([], $document);

            if ($elements) {
                $header = new self($elements->getRawContent(), null);
            }
        }

        if ($header) {
            return $header;
        }

        // Build an empty header.
        return new self([], $document);
    }
}


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\ElementStruct;
36		use Smalot\PdfParser\Element\ElementXRef;
37
38		/**
39		* Class Header
40		*/
41		class Header
42		{
43		/**
44		* @var Document
45		*/
46		protected $document = null;
47
48		/**
49		* @var Element[]
50		*/
51		protected $elements = null;
52
53		/**
54		* @param Element[] $elements list of elements
55		* @param Document $document document
56		*/
57	44	public function __construct($elements = [], Document $document = null)
58		{
59	44	$this->elements = $elements;
60	44	$this->document = $document;
61	44	}
62
63	30	public function init()
64		{
65	30	foreach ($this->elements as $name => $element) {
66	30	$element->init();
67		}
68	30	}
69
70		/**
71		* Returns all elements.
72		*/
73	25	public function getElements()
74		{
75	25	foreach ($this->elements as $name => $element) {
76	25	$this->resolveXRef($name);
77		}
78
79	25	return $this->elements;
80		}
81
82		/**
83		* Used only for debug.
84		*
85		* @return array
86		*/
87	1	public function getElementTypes()
88		{
89	1	$types = [];
90
91	1	foreach ($this->elements as $key => $element) {
92	1	$types[$key] = \get_class($element);
93		}
94
95	1	return $types;
96		}
97
98		/**
99		* @param bool $deep
100		*
101		* @return array
102		*/
103	23	public function getDetails($deep = true)
104		{
105	23	$values = [];
106	23	$elements = $this->getElements();
107
108	23	foreach ($elements as $key => $element) {
109	23	if ($element instanceof self && $deep) {
110		$values[$key] = $element->getDetails($deep);
111	23	} elseif ($element instanceof PDFObject && $deep) {
112	1	$values[$key] = $element->getDetails(false);
113	23	} elseif ($element instanceof ElementArray) {
114	2	if ($deep) {
115	2	$values[$key] = $element->getDetails();
116		}
117	23	} elseif ($element instanceof Element) {
118	23	$values[$key] = (string) $element;
119		}
120		}
121
122	23	return $values;
123		}
124
125		/**
126		* Indicate if an element name is available in header.
127		*
128		* @param string $name The name of the element
129		*
130		* @return bool
131		*/
132	31	public function has($name)
133		{
134	31	return \array_key_exists($name, $this->elements);
135		}
136
137		/**
138		* @param string $name
139		*
140		* @return Element\|PDFObject
141		*/
142	32	public function get($name)
143		{
144	32	if (\array_key_exists($name, $this->elements)) {
145	32	return $this->resolveXRef($name);
146		}
147
148	29	return new ElementMissing();
149		}
150
151		/**
152		* Resolve XRef to object.
153		*
154		* @param string $name
155		*
156		* @return Element\|PDFObject
157		*
158		* @throws \Exception
159		*/
160	34	protected function resolveXRef($name)
161		{
162	34	if (($obj = $this->elements[$name]) instanceof ElementXRef && null !== $this->document) {
163		/** @var ElementXRef $obj */
164	26	$object = $this->document->getObjectById($obj->getId());
165
166	26	if (null === $object) {
167	2	return new ElementMissing();
168		}
169
170		// Update elements list for future calls.
171	26	$this->elements[$name] = $object;
172		}
173
174	34	return $this->elements[$name];
175		}
176
177		/**
178		* @param string $content The content to parse
179		* @param Document $document The document
180		* @param int $position The new position of the cursor after parsing
181		*
182		* @return Header
183		*/
184	18	public static function parse($content, Document $document, &$position = 0)
185		{
186		/* @var Header $header */
187	18	if ('<<' == substr(trim($content), 0, 2)) {
188	17	$header = ElementStruct::parse($content, $document, $position);
189		} else {
190	5	$elements = ElementArray::parse($content, $document, $position);
191	5	$header = new self([], $document);
192
193	5	if ($elements) {
194	4	$header = new self($elements->getRawContent(), null);
195		}
196		}
197
198	18	if ($header) {
199	18	return $header;
200		}
201
202		// Build an empty header.
203		return new self([], $document);
204		}
205		}
206

smalot / pdfparser

Pull Request — master (#349)

Header::init() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like