EasyPdf::setFooterMargin() - Code Metrics - Inspection of "Laravel 11 support" - tarfin-labs/easy-pdf - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#22)

unknown

created 2024-04-03 06:28 UTC

EasyPdf::setFooterMargin() A

↳ Parent: EasyPdf

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	2
c	1
b	0
f	0
dl	0
loc	5
rs	10
cc	1
nc	1
nop	1

<?php

namespace TarfinLabs\EasyPdf;

use TCPDF;
use TCPDF_FONTS;

class EasyPdf
{
    /**
     * Tcpdf instance.
     *
     * @var TCPDF
     */
    public $pdf;

    /**
     * Pdf header data.
     *
     * @var bool
     */
    protected $header = false;

    /**
     * Pdf footer data.
     *
     * @var bool
     */
    protected $footer = false;

    /**
     * Barcode style.
     *
     * @var array
     */
    private $style = [
        'border' => false,
        'padding' => 0,
        'fgcolor' => [0, 0, 0],
        'bgcolor' => false,
    ];

    /**
     * EasyPdf constructor.
     */
    public function __construct(?string $imagePath = null)
    {
        if ($imagePath !== null) {
            define('K_PATH_IMAGES', $imagePath);
        }

        $this->pdf = new TCPDF();
        $this->pdf->setPrintHeader($this->header);
        $this->pdf->setPrintFooter($this->footer);
    }

    /**
     * Add an array of information to the pdf instance.
     *
     * @param  array  $information
     * @return EasyPdf
     */
    public function withInformation(array $information)
    {
        foreach ($information as $key => $value) {
            $this->setInformation($key, $value);
        }

        return $this;
    }

    /**
     * Set an information on the pdf instance.
     *
     * @param  $information
     * @param  $value
     * @return EasyPdf
     */
    protected function setInformation($information, $value)
    {
        $fn = 'Set'.$information;

        if (is_array($value)) {
            call_user_func([$this->pdf, $fn], ...$value);
        } else {
            call_user_func([$this->pdf, $fn], $value);
        }

        return $this;
    }

    /**
     * Add an array of configurations on the pdf instance.
     *
     * @param  array  $config
     * @return $this
     */
    public function withConfig(array $config)
    {
        foreach ($config as $key => $value) {
            $this->setConfig($key, $value);
        }

        return $this;
    }

    /**
     * Set a configuration on the pdf instance.
     *
     * @param  $config
     * @param  $value
     * @return $this
     */
    protected function setConfig($config, $value)
    {
        $fn = 'set'.$config;

        if (is_array($value)) {
            call_user_func([$this->pdf, $fn], ...$value);
        } else {
            call_user_func([$this->pdf, $fn], $value);
        }

        return $this;
    }

    /**
     * Add custom font on the pdf instance.
     *
     * @param  string  $font
     * @param  int|null  $size
     * @return EasyPdf
     */
    public function addFont(string $font, int $size = null)
    {
        $tcpdfFont = TCPDF_FONTS::addTTFfont($font);

        $this->pdf->SetFont($tcpdfFont, '', $size);

        return $this;
    }

    /**
     * Set given font as default font.
     *
     * @param  string  $font
     * @param  int|null  $size
     * @return $this
     */
    public function setFont(string $font, int $size = null)
    {
        $this->pdf->SetFont($font, '', $size);

        return $this;
    }

    /**
     * Set page margins.
     *
     * @param  float|int  $left
     * @param  float|int  $top
     * @param  float|int  $right
     * @param  bool  $keepMargins
     * @return $this
     */
    public function setMargins($left, $top, $right = null, bool $keepMargins = false)
    {
        $this->pdf->setMargins($left, $top, $right, $keepMargins);

        return $this;
    }

    /**
     * Add image to header.
     *
     * @param  string  $image
     * @param  int  $width
     * @param  array  $textColor
     * @param  array  $lineColor
     * @return $this
     */
    public function setHeaderData(string $image, int $width, array $textColor = [], array $lineColor = [])
    {
        $this->pdf->setHeaderData($image, $width, '', '', $textColor, $lineColor);

        return $this;
    }

    /**
     * Set header margin.
     *
     * @param  int  $margin
     * @return $this
     */
    public function setHeaderMargin(int $margin)
    {
        $this->pdf->setHeaderMargin($margin);

        return $this;
    }

    /**
     * Set footer text and line colors.
     *
     * @param  array  $textColor
     * @param  array  $lineColor
     * @return $this
     */
    public function setFooterData(array $textColor = [], array $lineColor = [])
    {
        $this->pdf->setFooterData($textColor, $lineColor);

        return $this;
    }

    /**
     * Set footer margin.
     *
     * @param  int  $margin
     * @return $this
     */
    public function setFooterMargin(int $margin)
    {
        $this->pdf->setFooterMargin($margin);

        return $this;
    }

    /**
     * Set footer font size.
     *
     * @param  int|null  $size
     * @return $this
     */
    public function setFooterFontSize(?int $size = null)
    {
        $this->pdf->setFooterFont([PDF_FONT_NAME_DATA, '', $size ?? PDF_FONT_SIZE_DATA]);

        return $this;
    }

    /**
     * Write html content.
     *
     * @param  $html
     * @return EasyPdf
     */
    public function loadHtml($html)
    {
        $this->pdf->AddPage();
        $this->pdf->writeHTML($html);

        return $this;
    }

    /**
     * Add image to the pdf with given position and size.
     *
     * @param  $image
     * @param  $x
     * @param  $y
     * @param  $width
     * @param  $height
     * @return EasyPdf
     */
    public function addImage($image, $x, $y, $width, $height)
    {
        if (stripos(substr($image, -5), '.svg') !== false) {
            $this->pdf->ImageSvg($image, $x, $y, $width, $height);
        } else {
            $this->pdf->Image($image, $x, $y, $width, $height);
        }

        return $this;
    }

    /**
     * Override default style for barcode.
     *
     * @param  array  $style
     * @return $this
     */
    public function setBarcodeStyle(array $style)
    {
        $this->style = $style;

        return $this;
    }

    /**
     * Add qrcode with best error correction to the pdf with given position and size.
     *
     * @param  $text
     * @param  $x
     * @param  $y
     * @param  $width
     * @param  $height
     * @param  string  $position
     * @return EasyPdf
     */
    public function addQrcode($text, $x, $y, $width, $height, $position = 'N')
    {
        $this->pdf->write2DBarcode($text, 'QRCODE,H', $x, $y, $width, $height, $this->style, $position);

        return $this;
    }

    /**
     * Add RAW2 barcode to the pdf with given position and size.
     *
     * @param  $code
     * @param  $x
     * @param  $y
     * @param  $width
     * @param  $height
     * @param  string  $position
     * @return EasyPdf
     */
    public function addBarcode($code, $x, $y, $width, $height, $position = 'N')
    {
        $this->pdf->write2DBarcode($code, 'RAW2', $x, $y, $width, $height, $this->style, $position);

        return $this;
    }

    /**
     * Set Tcpdf print header.
     *
     * @param  null  $header

     * @return EasyPdf
     */
    public function setHeader($header = null)
    {
        if (! is_null($header)) {
            $this->header = $header;
        }

        $this->pdf->setPrintHeader($this->header);

        return $this;
    }

    /**
     * Set Tcpdf print footer.
     *
     * @param  null  $footer

     * @return EasyPdf
     */
    public function setFooter($footer = null)
    {
        if (! is_null($footer)) {
            $this->footer = $footer;
        }

        $this->pdf->setPrintFooter($this->footer);

        return $this;
    }

    /**
     * Sets the active page of PDF.
     *
     * @param  int  $page
     * @return $this
     */
    public function setPage(int $page): self
    {
        $this->pdf->setPage($page);

        return $this;
    }

    /**
     * Save pdf to given path..
     *
     * @param  string  $filename
     * @return mixed
     */
    public function save(string $filename)
    {
        $this->pdf->Output($filename, 'F');

        return $this;
    }

    /**
     * Output the generated PDF to browser.
     *
     * @return $this
     */
    public function stream()
    {
        $this->pdf->Output('doc.pdf', 'I');

        return $this;
    }

    /**
     * Return pdf as a string.
     *
     * @return string
     */
    public function content()
    {
        return $this->pdf->Output('doc.pdf', 'S');
    }

    /**
     * Create a new TCPDF instance.
     *
     * @return $this
     */
    public function reset()
    {
        $this->pdf = new TCPDF();

        return $this;
    }

    /**
     * Create a new Merge instance.
     *
     * @param  array  $files
     * @return Merge
     */
    public static function merge(array $files)
    {
        return new Merge($files);
    }

    /**
     * Create a new Parser instance.
     *
     * @param  string  $path
     * @return Parser
     *
     * @throws Exceptions\UnableToOpen
     */
    public static function parser(string $path): Parser
    {
        return new Parser($path);
    }

    /**
     * Set string for duplex attribute.
     *
     * @return EasyPdf
     */
    public function setDuplex($name)
    {
        $this->pdf->setViewerPreferences(['Duplex' => $name]);

        return $this;
    }
}


1			<?php
2
3			namespace TarfinLabs\EasyPdf;
4
5			use TCPDF;
6			use TCPDF_FONTS;
7
8			class EasyPdf
9			{
10			/**
11			* Tcpdf instance.
12			*
13			* @var TCPDF
14			*/
15			public $pdf;
16
17			/**
18			* Pdf header data.
19			*
20			* @var bool
21			*/
22			protected $header = false;
23
24			/**
25			* Pdf footer data.
26			*
27			* @var bool
28			*/
29			protected $footer = false;
30
31			/**
32			* Barcode style.
33			*
34			* @var array
35			*/
36			private $style = [
37			'border' => false,
38			'padding' => 0,
39			'fgcolor' => [0, 0, 0],
40			'bgcolor' => false,
41			];
42
43			/**
44			* EasyPdf constructor.
45			*/
46			public function __construct(?string $imagePath = null)
47			{
48			if ($imagePath !== null) {
49			define('K_PATH_IMAGES', $imagePath);
50			}
51
52			$this->pdf = new TCPDF();
53			$this->pdf->setPrintHeader($this->header);
54			$this->pdf->setPrintFooter($this->footer);
55			}
56
57			/**
58			* Add an array of information to the pdf instance.
59			*
60			* @param array $information
61			* @return EasyPdf
62			*/
63			public function withInformation(array $information)
64			{
65			foreach ($information as $key => $value) {
66			$this->setInformation($key, $value);
67			}
68
69			return $this;
70			}
71
72			/**
73			* Set an information on the pdf instance.
74			*
75			* @param $information
76			* @param $value
77			* @return EasyPdf
78			*/
79			protected function setInformation($information, $value)
80			{
81			$fn = 'Set'.$information;
82
83			if (is_array($value)) {
84			call_user_func([$this->pdf, $fn], ...$value);
85			} else {
86			call_user_func([$this->pdf, $fn], $value);
87			}
88
89			return $this;
90			}
91
92			/**
93			* Add an array of configurations on the pdf instance.
94			*
95			* @param array $config
96			* @return $this
97			*/
98			public function withConfig(array $config)
99			{
100			foreach ($config as $key => $value) {
101			$this->setConfig($key, $value);
102			}
103
104			return $this;
105			}
106
107			/**
108			* Set a configuration on the pdf instance.
109			*
110			* @param $config
111			* @param $value
112			* @return $this
113			*/
114			protected function setConfig($config, $value)
115			{
116			$fn = 'set'.$config;
117
118			if (is_array($value)) {
119			call_user_func([$this->pdf, $fn], ...$value);
120			} else {
121			call_user_func([$this->pdf, $fn], $value);
122			}
123
124			return $this;
125			}
126
127			/**
128			* Add custom font on the pdf instance.
129			*
130			* @param string $font
131			* @param int\|null $size
132			* @return EasyPdf
133			*/
134			public function addFont(string $font, int $size = null)
135			{
136			$tcpdfFont = TCPDF_FONTS::addTTFfont($font);
137
138			$this->pdf->SetFont($tcpdfFont, '', $size);
139
140			return $this;
141			}
142
143			/**
144			* Set given font as default font.
145			*
146			* @param string $font
147			* @param int\|null $size
148			* @return $this
149			*/
150			public function setFont(string $font, int $size = null)
151			{
152			$this->pdf->SetFont($font, '', $size);
153
154			return $this;
155			}
156
157			/**
158			* Set page margins.
159			*
160			* @param float\|int $left
161			* @param float\|int $top
162			* @param float\|int $right
163			* @param bool $keepMargins
164			* @return $this
165			*/
166			public function setMargins($left, $top, $right = null, bool $keepMargins = false)
167			{
168			$this->pdf->setMargins($left, $top, $right, $keepMargins);
169
170			return $this;
171			}
172
173			/**
174			* Add image to header.
175			*
176			* @param string $image
177			* @param int $width
178			* @param array $textColor
179			* @param array $lineColor
180			* @return $this
181			*/
182			public function setHeaderData(string $image, int $width, array $textColor = [], array $lineColor = [])
183			{
184			$this->pdf->setHeaderData($image, $width, '', '', $textColor, $lineColor);
185
186			return $this;
187			}
188
189			/**
190			* Set header margin.
191			*
192			* @param int $margin
193			* @return $this
194			*/
195			public function setHeaderMargin(int $margin)
196			{
197			$this->pdf->setHeaderMargin($margin);
198
199			return $this;
200			}
201
202			/**
203			* Set footer text and line colors.
204			*
205			* @param array $textColor
206			* @param array $lineColor
207			* @return $this
208			*/
209			public function setFooterData(array $textColor = [], array $lineColor = [])
210			{
211			$this->pdf->setFooterData($textColor, $lineColor);
212
213			return $this;
214			}
215
216			/**
217			* Set footer margin.
218			*
219			* @param int $margin
220			* @return $this
221			*/
222			public function setFooterMargin(int $margin)
223			{
224			$this->pdf->setFooterMargin($margin);
225
226			return $this;
227			}
228
229			/**
230			* Set footer font size.
231			*
232			* @param int\|null $size
233			* @return $this
234			*/
235			public function setFooterFontSize(?int $size = null)
236			{
237			$this->pdf->setFooterFont([PDF_FONT_NAME_DATA, '', $size ?? PDF_FONT_SIZE_DATA]);
238
239			return $this;
240			}
241
242			/**
243			* Write html content.
244			*
245			* @param $html
246			* @return EasyPdf
247			*/
248			public function loadHtml($html)
249			{
250			$this->pdf->AddPage();
251			$this->pdf->writeHTML($html);
252
253			return $this;
254			}
255
256			/**
257			* Add image to the pdf with given position and size.
258			*
259			* @param $image
260			* @param $x
261			* @param $y
262			* @param $width
263			* @param $height
264			* @return EasyPdf
265			*/
266			public function addImage($image, $x, $y, $width, $height)
267			{
268			if (stripos(substr($image, -5), '.svg') !== false) {
269			$this->pdf->ImageSvg($image, $x, $y, $width, $height);
270			} else {
271			$this->pdf->Image($image, $x, $y, $width, $height);
272			}
273
274			return $this;
275			}
276
277			/**
278			* Override default style for barcode.
279			*
280			* @param array $style
281			* @return $this
282			*/
283			public function setBarcodeStyle(array $style)
284			{
285			$this->style = $style;
286
287			return $this;
288			}
289
290			/**
291			* Add qrcode with best error correction to the pdf with given position and size.
292			*
293			* @param $text
294			* @param $x
295			* @param $y
296			* @param $width
297			* @param $height
298			* @param string $position
299			* @return EasyPdf
300			*/
301			public function addQrcode($text, $x, $y, $width, $height, $position = 'N')
302			{
303			$this->pdf->write2DBarcode($text, 'QRCODE,H', $x, $y, $width, $height, $this->style, $position);
304
305			return $this;
306			}
307
308			/**
309			* Add RAW2 barcode to the pdf with given position and size.
310			*
311			* @param $code
312			* @param $x
313			* @param $y
314			* @param $width
315			* @param $height
316			* @param string $position
317			* @return EasyPdf
318			*/
319			public function addBarcode($code, $x, $y, $width, $height, $position = 'N')
320			{
321			$this->pdf->write2DBarcode($code, 'RAW2', $x, $y, $width, $height, $this->style, $position);
322
323			return $this;
324			}
325
326			/**
327			* Set Tcpdf print header.
328			*
329			* @param null $header
			0 ignored issues – show Documentation Bug introduced 2021-06-03 09:04 UTC by Report Bug Copy Issue Report Are you sure the doc-type for parameter `$header` is correct as it would always require `null` to be passed? Loading history...
330			* @return EasyPdf
331			*/
332			public function setHeader($header = null)
333			{
334			if (! is_null($header)) {
335			$this->header = $header;
336			}
337
338			$this->pdf->setPrintHeader($this->header);
339
340			return $this;
341			}
342
343			/**
344			* Set Tcpdf print footer.
345			*
346			* @param null $footer
			0 ignored issues – show Documentation Bug introduced 2021-06-03 09:04 UTC by Report Bug Copy Issue Report Are you sure the doc-type for parameter `$footer` is correct as it would always require `null` to be passed? Loading history...
347			* @return EasyPdf
348			*/
349			public function setFooter($footer = null)
350			{
351			if (! is_null($footer)) {
352			$this->footer = $footer;
353			}
354
355			$this->pdf->setPrintFooter($this->footer);
356
357			return $this;
358			}
359
360			/**
361			* Sets the active page of PDF.
362			*
363			* @param int $page
364			* @return $this
365			*/
366			public function setPage(int $page): self
367			{
368			$this->pdf->setPage($page);
369
370			return $this;
371			}
372
373			/**
374			* Save pdf to given path..
375			*
376			* @param string $filename
377			* @return mixed
378			*/
379			public function save(string $filename)
380			{
381			$this->pdf->Output($filename, 'F');
382
383			return $this;
384			}
385
386			/**
387			* Output the generated PDF to browser.
388			*
389			* @return $this
390			*/
391			public function stream()
392			{
393			$this->pdf->Output('doc.pdf', 'I');
394
395			return $this;
396			}
397
398			/**
399			* Return pdf as a string.
400			*
401			* @return string
402			*/
403			public function content()
404			{
405			return $this->pdf->Output('doc.pdf', 'S');
406			}
407
408			/**
409			* Create a new TCPDF instance.
410			*
411			* @return $this
412			*/
413			public function reset()
414			{
415			$this->pdf = new TCPDF();
416
417			return $this;
418			}
419
420			/**
421			* Create a new Merge instance.
422			*
423			* @param array $files
424			* @return Merge
425			*/
426			public static function merge(array $files)
427			{
428			return new Merge($files);
429			}
430
431			/**
432			* Create a new Parser instance.
433			*
434			* @param string $path
435			* @return Parser
436			*
437			* @throws Exceptions\UnableToOpen
438			*/
439			public static function parser(string $path): Parser
440			{
441			return new Parser($path);
442			}
443
444			/**
445			* Set string for duplex attribute.
446			*
447			* @return EasyPdf
448			*/
449			public function setDuplex($name)
450			{
451			$this->pdf->setViewerPreferences(['Duplex' => $name]);
452
453			return $this;
454			}
455			}
456

tarfin-labs / easy-pdf

Pull Request — master (#22)

EasyPdf::setFooterMargin() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like