fpdi_pdf_parser - Code Metrics - FTwex/fpdf-symfony2 - Measure and Improve Code Quality continuously with Scrutinizer

fpdi_pdf_parser C
last analyzed 2016-02-03 11:53 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	359
Duplicated Lines	11.42 %

Coupling/Cohesion

Components	1
Dependencies	1

Metric	Value
wmc	55
lcom	1
cbo	1
dl	41
loc	359
rs	6.8

16 Methods

Rating	Name	Duplication	Size	Complexity
A	fpdi_pdf_parser()	0	15	1
A	error()	0	3	1
A	getPageCount()	0	3	1
A	setPageno()	0	9	3
A	getPageResources()	0	3	1
B	_getPageResources()	23	23	5
A	getContent()	0	12	3
B	_getPageContent()	0	18	5
C	_rebuildContentStream()	0	47	13
C	getPageBox()	0	23	7
A	getPageBoxes()	0	3	1
A	_getPageBoxes()	0	11	3
A	getPageRotation()	0	3	1
B	_getPageRotation()	18	18	5
A	read_pages()	0	17	4
A	getPDFVersion()	0	4	1

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like fpdi_pdf_parser often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use fpdi_pdf_parser, and based on these observations, apply Extract Interface, too.

<?php

//
//  FPDI - Version 1.2.1
//
//    Copyright 2004-2008 Setasign - Jan Slabon
//
//  Licensed under the Apache License, Version 2.0 (the "License");
//  you may not use this file except in compliance with the License.
//  You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS,
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//  See the License for the specific language governing permissions and
//  limitations under the License.
//

require_once("pdf_parser.php");

class fpdi_pdf_parser extends pdf_parser {
namespace YourVendor;

class YourClass { }

    /**
     * Pages
     * Index beginns at 0
     *
     * @var array
     */
    var $pages;
class A {
    var $property;
}
    
    /**
     * Page count
     * @var integer
     */
    var $page_count;
class A {
    var $property;
}
    
    /**
     * actual page number
     * @var integer
     */
    var $pageno;
class A {
    var $property;
}
    
    /**
     * PDF Version of imported Document
     * @var string
     */
    var $pdfVersion;
class A {
    var $property;
}
    
    /**
     * FPDI Reference
     * @var object
     */
    var $fpdi;
class A {
    var $property;
}
    
    /**
     * Available BoxTypes
     *
     * @var array
     */
    var $availableBoxes = array("/MediaBox","/CropBox","/BleedBox","/TrimBox","/ArtBox");
class A {
    var $property;
}
        
    /**
     * Constructor
     *
     * @param string $filename  Source-Filename
     * @param object $fpdi      Object of type fpdi
     */
    function fpdi_pdf_parser($filename,&$fpdi) {

        $this->fpdi =& $fpdi;
		$this->filename = $filename;

		
        parent::pdf_parser($filename);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}

        // resolve Pages-Dictonary
        $pages = $this->pdf_resolve_object($this->c, $this->root[1][1]['/Pages']);


        // Read pages
        $this->read_pages($this->c, $pages, $this->pages);

        
        // count pages;
        $this->page_count = count($this->pages);
    }
    
    /**
     * Overwrite parent::error()
     *
     * @param string $msg  Error-Message
     */
    function error($msg) {

    	$this->fpdi->error($msg);	
    }
    
    /**
     * Get pagecount from sourcefile
     *
     * @return int
     */
    function getPageCount() {

        return $this->page_count;
    }


    /**
     * Set pageno
     *
     * @param int $pageno Pagenumber to use
     */
    function setPageno($pageno) {

        $pageno = ((int) $pageno) - 1;

        if ($pageno < 0 || $pageno >= $this->getPageCount()) {
            $this->fpdi->error("Pagenumber is wrong!");
        }

        $this->pageno = $pageno;
    }
    
    /**
     * Get page-resources from current page
     *
     * @return array
     */
    function getPageResources() {

        return $this->_getPageResources($this->pages[$this->pageno]);
    }
    
    /**
     * Get page-resources from /Page
     *
     * @param array $obj Array of pdf-data
     */
    function _getPageResources ($obj) { // $obj = /Page

    	$obj = $this->pdf_resolve_object($this->c, $obj);


        // If the current object has a resources
    	// dictionary associated with it, we use
    	// it. Otherwise, we move back to its
    	// parent object.
        if (isset ($obj[1][1]['/Resources'])) {
    		$res = $this->pdf_resolve_object($this->c, $obj[1][1]['/Resources']);

    		if ($res[0] == PDF_TYPE_OBJECT)
                return $res[1];
            return $res;
    	} else {
    		if (!isset ($obj[1][1]['/Parent'])) {
    			return false;
    		} else {
                $res = $this->_getPageResources($obj[1][1]['/Parent']);
                if ($res[0] == PDF_TYPE_OBJECT)
                    return $res[1];
                return $res;
    		}
    	}
    }


    /**
     * Get content of current page
     *
     * If more /Contents is an array, the streams are concated
     *
     * @return string
     */
    function getContent() {

        $buffer = "";
        
        if (isset($this->pages[$this->pageno][1][1]['/Contents'])) {
            $contents = $this->_getPageContent($this->pages[$this->pageno][1][1]['/Contents']);
            foreach($contents AS $tmp_content) {
                $buffer .= $this->_rebuildContentStream($tmp_content).' ';
            }
        }
        
        return $buffer;
    }
    
    
    /**
     * Resolve all content-objects
     *
     * @param array $content_ref
     * @return array
     */
    function _getPageContent($content_ref) {

        $contents = array();
        
        if ($content_ref[0] == PDF_TYPE_OBJREF) {
            $content = $this->pdf_resolve_object($this->c, $content_ref);

            if ($content[1][0] == PDF_TYPE_ARRAY) {
                $contents = $this->_getPageContent($content[1]);
            } else {
                $contents[] = $content;
            }
        } else if ($content_ref[0] == PDF_TYPE_ARRAY) {
            foreach ($content_ref[1] AS $tmp_content_ref) {
                $contents = array_merge($contents,$this->_getPageContent($tmp_content_ref));
            }
        }

        return $contents;
    }


    /**
     * Rebuild content-streams
     *
     * @param array $obj
     * @return string
     */
    function _rebuildContentStream($obj) {

        $filters = array();
        
        if (isset($obj[1][1]['/Filter'])) {
            $_filter = $obj[1][1]['/Filter'];

            if ($_filter[0] == PDF_TYPE_TOKEN) {
                $filters[] = $_filter;
            } else if ($_filter[0] == PDF_TYPE_ARRAY) {
                $filters = $_filter[1];
            }
        }

        $stream = $obj[2][1];

        foreach ($filters AS $_filter) {
            switch ($_filter[1]) {
                case "/FlateDecode":
                    if (function_exists('gzuncompress')) {
                        $stream = (strlen($stream) > 0) ? @gzuncompress($stream) : '';                        
                    } else {
                        $this->fpdi->error(sprintf("To handle %s filter, please compile php with zlib support.",$_filter[1]));
                    }
                    if ($stream === false) {
                        $this->fpdi->error("Error while decompressing stream.");
                    }
                break;
                case null:
                    $stream = $stream;

                break;
                default:
                    if (preg_match("/^\/[a-z85]*$/i", $_filter[1], $filterName) && @include_once('decoders'.$_filter[1].'.php')) {
                        $filterName = substr($_filter[1],1);
                        if (class_exists($filterName)) {
    	                	$decoder =& new $filterName($this->fpdi);
    	                    $stream = $decoder->decode(trim($stream));
                        } else {
                        	$this->fpdi->error(sprintf("Unsupported Filter: %s",$_filter[1]));
                        }
                    } else {
                        $this->fpdi->error(sprintf("Unsupported Filter: %s",$_filter[1]));
                    }
            }
        }
        
        return $stream;
    }
    
    
    /**
     * Get a Box from a page
     * Arrayformat is same as used by fpdf_tpl
     *
     * @param array $page a /Page
     * @param string $box_index Type of Box @see $availableBoxes
     * @return array
     */
    function getPageBox($page, $box_index) {

        $page = $this->pdf_resolve_object($this->c,$page);

        $box = null;
        if (isset($page[1][1][$box_index]))
            $box =& $page[1][1][$box_index];
        
        if (!is_null($box) && $box[0] == PDF_TYPE_OBJREF) {
            $tmp_box = $this->pdf_resolve_object($this->c,$box);

            $box = $tmp_box[1];
        }
            
        if (!is_null($box) && $box[0] == PDF_TYPE_ARRAY) {
            $b =& $box[1];
            return array("x" => $b[0][1]/$this->fpdi->k,
                         "y" => $b[1][1]/$this->fpdi->k,
                         "w" => abs($b[0][1]-$b[2][1])/$this->fpdi->k,
                         "h" => abs($b[1][1]-$b[3][1])/$this->fpdi->k);
        } else if (!isset ($page[1][1]['/Parent'])) {
            return false;
        } else {
            return $this->getPageBox($this->pdf_resolve_object($this->c, $page[1][1]['/Parent']), $box_index);

        }
    }

    function getPageBoxes($pageno) {

        return $this->_getPageBoxes($this->pages[$pageno-1]);
    }
    
    /**
     * Get all Boxes from /Page
     *
     * @param array a /Page
     * @return array
     */
    function _getPageBoxes($page) {

        $boxes = array();

        foreach($this->availableBoxes AS $box) {
            if ($_box = $this->getPageBox($page,$box)) {
                $boxes[$box] = $_box;
            }
        }

        return $boxes;
    }

    /**
     * Get the page rotation by pageno
     *
     * @param integer $pageno
     * @return array
     */
    function getPageRotation($pageno) {

        return $this->_getPageRotation($this->pages[$pageno-1]);
    }
    
    function _getPageRotation ($obj) { // $obj = /Page

    	$obj = $this->pdf_resolve_object($this->c, $obj);

    	if (isset ($obj[1][1]['/Rotate'])) {
    		$res = $this->pdf_resolve_object($this->c, $obj[1][1]['/Rotate']);

    		if ($res[0] == PDF_TYPE_OBJECT)
                return $res[1];
            return $res;
    	} else {
    		if (!isset ($obj[1][1]['/Parent'])) {
    			return false;
    		} else {
                $res = $this->_getPageRotation($obj[1][1]['/Parent']);
                if ($res[0] == PDF_TYPE_OBJECT)
                    return $res[1];
                return $res;
    		}
    	}
    }
    
    /**
     * Read all /Page(es)
     *
     * @param object pdf_context
     * @param array /Pages
     * @param array the result-array
     */
    function read_pages (&$c, &$pages, &$result) {

        // Get the kids dictionary
    	$kids = $this->pdf_resolve_object ($c, $pages[1][1]['/Kids']);

        if (!is_array($kids))
            $this->fpdi->Error("Cannot find /Kids in current /Page-Dictionary");
        foreach ($kids[1] as $v) {
    		$pg = $this->pdf_resolve_object ($c, $v);
            if ($pg[1][1]['/Type'][1] === '/Pages') {
                // If one of the kids is an embedded
    			// /Pages array, resolve it as well.
                $this->read_pages ($c, $pg, $result);
    		} else {
    			$result[] = $pg;
    		}
    	}
    }

    
    
    /**
     * Get PDF-Version
     *
     * And reset the PDF Version used in FPDI if needed
     */
    function getPDFVersion() {

        parent::getPDFVersion();
        $this->fpdi->PDFVersion = max($this->fpdi->PDFVersion, $this->pdfVersion);
    }
    
}

1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2016-02-03 11:39 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 22 and the first side effect is on line 20. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2			//
3			// FPDI - Version 1.2.1
4			//
5			// Copyright 2004-2008 Setasign - Jan Slabon
6			//
7			// Licensed under the Apache License, Version 2.0 (the "License");
8			// you may not use this file except in compliance with the License.
9			// You may obtain a copy of the License at
10			//
11			// http://www.apache.org/licenses/LICENSE-2.0
12			//
13			// Unless required by applicable law or agreed to in writing, software
14			// distributed under the License is distributed on an "AS IS" BASIS,
15			// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16			// See the License for the specific language governing permissions and
17			// limitations under the License.
18			//
19
20			require_once("pdf_parser.php");
21
22			class fpdi_pdf_parser extends pdf_parser {
			0 ignored issues – show Coding Style Compatibility introduced 2016-02-03 11:39 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
23
24			/**
25			* Pages
26			* Index beginns at 0
27			*
28			* @var array
29			*/
30			var $pages;
			0 ignored issues – show Coding Style introduced 2016-02-03 11:39 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$pages`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...
31
32			/**
33			* Page count
34			* @var integer
35			*/
36			var $page_count;
			0 ignored issues – show Coding Style introduced 2016-02-03 11:39 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$page_count`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...

FTwex / fpdf-symfony2

fpdi_pdf_parser C last analyzed 2016-02-03 11:53 UTC