Merger::addFromFile() - Code Metrics - Inspection of "Merger::addFile() instead of addFromFile()" - hanneskod/libmergepdf - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 286185...fd9d07 )

by Hannes

created 2017-10-31 15:57 UTC

Merger::addFromFile() A

↳ Parent: Merger

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	5
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	3

<?php

namespace iio\libmergepdf;

use setasign\Fpdi\Fpdi;
use Symfony\Component\Finder\Finder;

/**
 * Merge existing pdfs into one
 */
class Merger
{
    /**
     * List of pdf sources to merge
     *
     * @var SourceInterface[]
     */
    private $sources = [];

    /**
     * @var Fpdi Fpdi object
     */
    private $fpdi;

    /**
     * @var string Directory path used for temporary files
     */
    private $tempDir;

    /**
     * Constructor
     *
     * @param Fpdi $fpdi
     */
    public function __construct(Fpdi $fpdi = null)
    {
        $this->fpdi = $fpdi ?: new Fpdi;
    }

    /**
     * Add raw PDF from string
     *
     * Note that your PDFs are merged in the order that you add them
     *
     * @param  string $content Raw pdf content
     * @param  Pages  $pages   Specification of the pages to add
     * @return void
     */
    public function addRaw($content, Pages $pages = null)
    {
        $this->sources[] = new RawSource($content, $pages ?: new Pages);
    }

    /**
     * Add PDF from file
     *
     * Note that your PDFs are merged in the order that you add them
     *
     * @param  string    $filename Name of file to add
     * @param  Pages     $pages    Pages to add from file
     * @return void
     * @throws Exception If $filename is not a valid file
     */
    public function addFile($filename, Pages $pages = null)
    {
        // TODO vad h'nder egentligen annars...
        if (!is_file($filename) || !is_readable($filename)) {
            throw new Exception("'$filename' is not a valid file");
        }

        $this->sources[] = new FileSource($filename, $pages ?: new Pages);
    }

    /**
     * Add PDF from file
     *
     * @deprecated Since version 3.1
     */
    public function addFromFile($fname, Pages $pages = null, $cleanup = null)

    {
        trigger_error('addFromFile() is deprecated, use addFile() instead', E_USER_DEPRECATED);
        $this->addFile($fname, $pages);
    }

    /**
     * Add files using iterator
     *
     * @param  iterable  $iterator Iterator or array with names of files to merge
     * @param  Pages     $pages    Optional pages constraint used for every added pdf
     * @return void
     * @throws Exception If $iterator is not valid
     */
    public function addIterator($iterator, Pages $pages = null)
    {
        if (!is_array($iterator) && !$iterator instanceof \Traversable) {
            throw new Exception("\$iterator must be traversable");
        }

        foreach ($iterator as $filename) {
            $this->addFile($filename, $pages);
        }
    }

    /**
     * Add files using a symfony finder
     *
     * @param  Finder $finder
     * @param  Pages  $pages  Optional pages constraint used for every added pdf
     * @return void
     */
    public function addFinder(Finder $finder, Pages $pages = null)
    {
        foreach ($finder as $fileInfo) {
            $this->addFile($fileInfo->getRealpath(), $pages);
        }
    }

    /**
     * Merges your provided PDFs and get raw string
     *
     * @return string
     * @throws Exception If no PDFs were added
     * @throws Exception If a specified page does not exist
     *
     * @TODO Should $sources be emptied after a merge? Why not implement a clear() method instead?
     */
    public function merge()
    {
        if (empty($this->sources)) {
            throw new Exception("Unable to merge, no PDFs added");
        }

        /** @var string Name of source being processed */
        $name = '';

        try {
            $fpdi = clone $this->fpdi;

            foreach ($this->sources as $source) {
                $name = $source->getName();

                /** @var int Total number of pages in pdf */
                $nrOfPagesInPdf = $fpdi->setSourceFile($source->getStreamReader());

                /** @var Pages The set of pages to merge, defaults to all pages */
                $pagesToMerge = $source->getPages()->hasPages() ? $source->getPages() : new Pages("1-$nrOfPagesInPdf");

                // Add specified pages
                foreach ($pagesToMerge as $pageNr) {
                    $template = $fpdi->importPage($pageNr);
                    $size = $fpdi->getTemplateSize($template);
                    $fpdi->AddPage(
                        $size['width'] > $size['height'] ? 'L' : 'P',
                        [$size['width'], $size['height']]
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    );
                    $fpdi->useTemplate($template);
                }
            }

            $this->sources = [];

            return $fpdi->Output('', 'S');

        } catch (\Exception $e) {
            throw new Exception("'{$e->getMessage()}' in '{$name}'", 0, $e);
        }
    }

    /**
     * Create temporary file and return name
     *
     * @deprecated Since version 3.1
     */
    public function getTempFname()
    {
        trigger_error(
            'Use of getTempFname() is deprecated as temporare files are no longer created',
            E_USER_DEPRECATED
        );

        return tempnam($this->getTempDir(), "libmergepdf");

    }

    /**
     * Get directory path for temporary files
     *
     * @deprecated Since version 3.1
     */
    public function getTempDir()
    {
        trigger_error(
            'Use of getTempDir() is deprecated as temporare files are no longer created',
            E_USER_DEPRECATED
        );

        return $this->tempDir ?: sys_get_temp_dir();
    }

    /**
     * Set directory path for temporary files
     *
     * @deprecated Since version 3.1
     */
    public function setTempDir($dirname)
    {
        trigger_error(
            'Use of setTempDir() is deprecated as temporare files are no longer created',
            E_USER_DEPRECATED
        );

        $this->tempDir = $dirname;
    }
}


1			<?php
2
3			namespace iio\libmergepdf;
4
5			use setasign\Fpdi\Fpdi;
6			use Symfony\Component\Finder\Finder;
7
8			/**
9			* Merge existing pdfs into one
10			*/
11			class Merger
12			{
13			/**
14			* List of pdf sources to merge
15			*
16			* @var SourceInterface[]
17			*/
18			private $sources = [];
19
20			/**
21			* @var Fpdi Fpdi object
22			*/
23			private $fpdi;
24
25			/**
26			* @var string Directory path used for temporary files
27			*/
28			private $tempDir;
29
30			/**
31			* Constructor
32			*
33			* @param Fpdi $fpdi
34			*/
35			public function __construct(Fpdi $fpdi = null)
36			{
37			$this->fpdi = $fpdi ?: new Fpdi;
38			}
39
40			/**
41			* Add raw PDF from string
42			*
43			* Note that your PDFs are merged in the order that you add them
44			*
45			* @param string $content Raw pdf content
46			* @param Pages $pages Specification of the pages to add
47			* @return void
48			*/
49			public function addRaw($content, Pages $pages = null)
50			{
51			$this->sources[] = new RawSource($content, $pages ?: new Pages);
52			}
53
54			/**
55			* Add PDF from file
56			*
57			* Note that your PDFs are merged in the order that you add them
58			*
59			* @param string $filename Name of file to add
60			* @param Pages $pages Pages to add from file
61			* @return void
62			* @throws Exception If $filename is not a valid file
63			*/
64			public function addFile($filename, Pages $pages = null)
65			{
66			// TODO vad h'nder egentligen annars...
67			if (!is_file($filename) \|\| !is_readable($filename)) {
68			throw new Exception("'$filename' is not a valid file");
69			}
70
71			$this->sources[] = new FileSource($filename, $pages ?: new Pages);
72			}
73
74			/**
75			* Add PDF from file
76			*
77			* @deprecated Since version 3.1
78			*/
79			public function addFromFile($fname, Pages $pages = null, $cleanup = null)
			0 ignored issues – show Unused Code introduced 2017-10-31 15:59 UTC by Report Bug Copy Issue Report The parameter `$cleanup` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
80			{
81			trigger_error('addFromFile() is deprecated, use addFile() instead', E_USER_DEPRECATED);
82			$this->addFile($fname, $pages);
83			}
84
85			/**
86			* Add files using iterator
87			*
88			* @param iterable $iterator Iterator or array with names of files to merge
89			* @param Pages $pages Optional pages constraint used for every added pdf
90			* @return void
91			* @throws Exception If $iterator is not valid
92			*/
93			public function addIterator($iterator, Pages $pages = null)
94			{
95			if (!is_array($iterator) && !$iterator instanceof \Traversable) {
96			throw new Exception("\$iterator must be traversable");
97			}
98
99			foreach ($iterator as $filename) {
100			$this->addFile($filename, $pages);
101			}
102			}
103
104			/**
105			* Add files using a symfony finder
106			*
107			* @param Finder $finder
108			* @param Pages $pages Optional pages constraint used for every added pdf
109			* @return void
110			*/
111			public function addFinder(Finder $finder, Pages $pages = null)
112			{
113			foreach ($finder as $fileInfo) {
114			$this->addFile($fileInfo->getRealpath(), $pages);
115			}
116			}
117
118			/**
119			* Merges your provided PDFs and get raw string
120			*
121			* @return string
122			* @throws Exception If no PDFs were added
123			* @throws Exception If a specified page does not exist
124			*
125			* @TODO Should $sources be emptied after a merge? Why not implement a clear() method instead?
126			*/
127			public function merge()
128			{
129			if (empty($this->sources)) {
130			throw new Exception("Unable to merge, no PDFs added");
131			}
132
133			/** @var string Name of source being processed */
134			$name = '';
135
136			try {
137			$fpdi = clone $this->fpdi;
138
139			foreach ($this->sources as $source) {
140			$name = $source->getName();
141
142			/** @var int Total number of pages in pdf */
143			$nrOfPagesInPdf = $fpdi->setSourceFile($source->getStreamReader());
144
145			/** @var Pages The set of pages to merge, defaults to all pages */
146			$pagesToMerge = $source->getPages()->hasPages() ? $source->getPages() : new Pages("1-$nrOfPagesInPdf");
147
148			// Add specified pages
149			foreach ($pagesToMerge as $pageNr) {
150			$template = $fpdi->importPage($pageNr);
151			$size = $fpdi->getTemplateSize($template);
152			$fpdi->AddPage(
153			$size['width'] > $size['height'] ? 'L' : 'P',
154			[$size['width'], $size['height']]
			0 ignored issues – show Documentation introduced 2017-10-24 08:16 UTC by Report Bug Copy Issue Report `array($size['width'], $size['height'])` is of type `array<integer,?,{"0":"?","1":"?"}>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
155			);
156			$fpdi->useTemplate($template);
157			}
158			}
159
160			$this->sources = [];
161
162			return $fpdi->Output('', 'S');
163
164			} catch (\Exception $e) {
165			throw new Exception("'{$e->getMessage()}' in '{$name}'", 0, $e);
166			}
167			}
168
169			/**
170			* Create temporary file and return name
171			*
172			* @deprecated Since version 3.1
173			*/
174			public function getTempFname()
175			{
176			trigger_error(
177			'Use of getTempFname() is deprecated as temporare files are no longer created',
178			E_USER_DEPRECATED
179			);
180
181			return tempnam($this->getTempDir(), "libmergepdf");
			0 ignored issues – show Deprecated Code introduced 2017-10-24 07:47 UTC by Report Bug Copy Issue Report The method `iio\libmergepdf\Merger::getTempDir()` has been deprecated with message: Since version 3.1 This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
182			}
183
184			/**
185			* Get directory path for temporary files
186			*
187			* @deprecated Since version 3.1
188			*/
189			public function getTempDir()
190			{
191			trigger_error(
192			'Use of getTempDir() is deprecated as temporare files are no longer created',
193			E_USER_DEPRECATED
194			);
195
196			return $this->tempDir ?: sys_get_temp_dir();
197			}
198
199			/**
200			* Set directory path for temporary files
201			*
202			* @deprecated Since version 3.1
203			*/
204			public function setTempDir($dirname)
205			{
206			trigger_error(
207			'Use of setTempDir() is deprecated as temporare files are no longer created',
208			E_USER_DEPRECATED
209			);
210
211			$this->tempDir = $dirname;
212			}
213			}
214

hanneskod / libmergepdf

Push — master ( 286185...fd9d07 )

Merger::addFromFile() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like