ElemBitmap::getBase64() - Code Metrics - Inspection of "readme" - mrcnpdlk/grandstream-xmlapp - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 261d31...f53ed5 )

by Marcin

created 2017-09-27 15:35 UTC

ElemBitmap::getBase64() A

↳ Parent: ElemBitmap

Complexity

Conditions	3
Paths	4

Size

Total Lines	12
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
dl	0
loc	12
ccs	0
cts	6
cp	0
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	7
nc	4
nop	0
crap	12

<?php
/**
 * Grandstream-XMLApp
 *
 * Copyright (c) 2017 pudelek.org.pl
 *
 * @license MIT License (MIT)
 *
 * For the full copyright and license information, please view source file
 * that is bundled with this package in the file LICENSE
 *
 * @author  Marcin Pudełek <[email protected]>
 */

namespace mrcnpdlk\Grandstream\XMLApp\Application\Model\Components;


use mrcnpdlk\Grandstream\XMLApp\Application\ModelInterface;
use mrcnpdlk\Grandstream\XMLApp\Exception;
use mrcnpdlk\Grandstream\XMLApp\Helper\Rectangle;
use mrcnpdlk\Grandstream\XMLApp\MyXML;

/**
 * Class ElemBitmap
 *
 * This element is to display a bitmap picture on the screen. Inside the <Bitmap> tag of the XML document,
 * the picture must be encoded in base64 format already. There are plenty of base64 encoder online
 * provided for encoding the .bmp picture. Please make sure the original .bmp picture is in monochrome grey
 * level 8 before encoding
 *
 * <ElemBitmap isfile="true/false" isflash=”true/false”>
 * <Bitmap> Bitmap file encoded in base64 format </Bitmap>
 * <X> X location </X>
 * <Y> Y location </Y>
 * </ElemBitmap
 *
 * @package mrcnpdlk\Grandstream\XMLApp\Application\Model\Components
 */
class ElemBitmap extends ElemAbstract implements ModelInterface, ElemInterface
{
    /**
     * @var boolean
     */
    private $isFile;
    /**
     * @var boolean
     */
    private $isFlash;
    /**
     * @var string
     */
    private $sImgPath;

    /**
     * @var Rectangle
     */
    private $oCanvas;

    /**
     * ElemBitmap constructor.
     *
     * @param string $sImgUrl
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    public function __construct(string $sImgPath, Rectangle $oRectangle)
    {
        parent::__construct();
        $this->sImgPath = $sImgPath;
        $this->oCanvas  = $oRectangle;
        $this->isFile   = "false";
$answer = 42;

$correct = false;

$correct = (bool) $answer;
        $this->isFlash  = "false";
$answer = 42;

$correct = false;

$correct = (bool) $answer;

    }

    /**
     * @return \mrcnpdlk\Grandstream\XMLApp\MyXML
     */
    function getXml(): MyXML

    {
        $oXml = new MyXML('DisplayBitmap');

        $oXml->asObject()->addAttribute('isfile', $this->isFile);
        $oXml->asObject()->addAttribute('isflash', $this->isFlash);
        $oXml->asObject()->addChild('X', $this->getPoint()->getX());
        $oXml->asObject()->addChild('Y', $this->getPoint()->getY());
        $oXml->asObject()->addChild('Bitmap', $this->getBase64());

        return $oXml;
    }

    /**
     * @return string
     */
    private function getBase64()
    {
        try {
            if (!extension_loaded('imagick')) {
                throw new \Exception('No imagick loaded');
            }

            return base64_encode($this->resizeImage($this->oCanvas->getWidth(), $this->oCanvas->getHeight())->getImageBlob());
        } catch (\Exception $e) {
            return '';
        }
    }

    /**
     * @param int      $width
     * @param int|null $height
     *
     * @return \Imagick
     * @throws \mrcnpdlk\Grandstream\XMLApp\Exception
     */
    private function resizeImage(int $width = 100, int $height = null)
    {
        if (!file_exists($this->sImgPath) || !is_readable($this->sImgPath)) {
            throw new Exception('Image not exists');
        }

        if (is_null($height)) {
            $height = $width;
        }
        $imagick = new \Imagick(realpath($this->sImgPath));

        $canvasFactor = $width / $height;

        $origWidth  = $imagick->getImageWidth();
        $origHeight = $imagick->getImageHeight();
        $origFactor = $origWidth / $origHeight;
        if ($origFactor > $canvasFactor) {//za rozciągniety
            $imgWidth  = $width;
            $imgHeight = intval($width / $origFactor);

        } else {//za wysoki
            $imgHeight = $height;
            $imgWidth  = intval($height * $origFactor);
        }


        $imagick = $imagick->flattenImages();
        $imagick->setImageBackgroundColor(new \ImagickPixel('white'));
        $imagick->setImageAlphaChannel(\Imagick::ALPHACHANNEL_DEACTIVATE);
        $imagick->mergeImageLayers(\Imagick::LAYERMETHOD_FLATTEN);

        $colors = min(255, $imagick->getImageColors());
        $imagick->quantizeImage($colors, \Imagick::COLORSPACE_GRAY, 0, false, false);
        $imagick->setImageDepth(8 /* bits */);
        $imagick->resizeImage($imgWidth, $imgHeight, \Imagick::FILTER_LANCZOS, 1, false);
        $imagick->stripImage();

        $canvas = new \Imagick();
        $canvas->newImage($width, $height, new \ImagickPixel('white'));
        $canvas->compositeImage($imagick, \Imagick::COMPOSITE_DEFAULT, intval(($width - $imgWidth) / 2), intval(($height - $imgHeight) / 2));
        $canvas->setImageFormat('BMP');

        return $canvas;
    }

}


1			<?php
2			/**
3			* Grandstream-XMLApp
4			*
5			* Copyright (c) 2017 pudelek.org.pl
6			*
7			* @license MIT License (MIT)
8			*
9			* For the full copyright and license information, please view source file
10			* that is bundled with this package in the file LICENSE
11			*
12			* @author Marcin Pudełek <[email protected]>
13			*/
14
15			namespace mrcnpdlk\Grandstream\XMLApp\Application\Model\Components;
16
17
18			use mrcnpdlk\Grandstream\XMLApp\Application\ModelInterface;
19			use mrcnpdlk\Grandstream\XMLApp\Exception;
20			use mrcnpdlk\Grandstream\XMLApp\Helper\Rectangle;
21			use mrcnpdlk\Grandstream\XMLApp\MyXML;
22
23			/**
24			* Class ElemBitmap
25			*
26			* This element is to display a bitmap picture on the screen. Inside the <Bitmap> tag of the XML document,
27			* the picture must be encoded in base64 format already. There are plenty of base64 encoder online
28			* provided for encoding the .bmp picture. Please make sure the original .bmp picture is in monochrome grey
29			* level 8 before encoding
30			*
31			* <ElemBitmap isfile="true/false" isflash=”true/false”>
32			* <Bitmap> Bitmap file encoded in base64 format </Bitmap>
33			* <X> X location </X>
34			* <Y> Y location </Y>
35			* </ElemBitmap
36			*
37			* @package mrcnpdlk\Grandstream\XMLApp\Application\Model\Components
38			*/
39			class ElemBitmap extends ElemAbstract implements ModelInterface, ElemInterface
40			{
41			/**
42			* @var boolean
43			*/
44			private $isFile;
45			/**
46			* @var boolean
47			*/
48			private $isFlash;
49			/**
50			* @var string
51			*/
52			private $sImgPath;
53
54			/**
55			* @var Rectangle
56			*/
57			private $oCanvas;
58
59			/**
60			* ElemBitmap constructor.
61			*
62			* @param string $sImgUrl
			0 ignored issues – show Bug introduced 2017-09-27 15:37 UTC by Report Bug Copy Issue Report There is no parameter named `$sImgUrl`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
63			*/
64			public function __construct(string $sImgPath, Rectangle $oRectangle)
65			{
66			parent::__construct();
67			$this->sImgPath = $sImgPath;
68			$this->oCanvas = $oRectangle;
69			$this->isFile = "false";
			0 ignored issues – show Documentation Bug introduced 2017-09-25 15:56 UTC by Report Bug Copy Issue Report The property `$isFile` was declared of type `boolean`, but `'false'` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
70			$this->isFlash = "false";
			0 ignored issues – show Documentation Bug introduced 2017-09-25 15:56 UTC by Report Bug Copy Issue Report The property `$isFlash` was declared of type `boolean`, but `'false'` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
71
72			}
73
74			/**
75			* @return \mrcnpdlk\Grandstream\XMLApp\MyXML
76			*/
77			function getXml(): MyXML
			0 ignored issues – show Best Practice introduced 2017-09-27 15:37 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
78			{
79			$oXml = new MyXML('DisplayBitmap');
80
81			$oXml->asObject()->addAttribute('isfile', $this->isFile);
82			$oXml->asObject()->addAttribute('isflash', $this->isFlash);
83			$oXml->asObject()->addChild('X', $this->getPoint()->getX());
84			$oXml->asObject()->addChild('Y', $this->getPoint()->getY());
85			$oXml->asObject()->addChild('Bitmap', $this->getBase64());
86
87			return $oXml;
88			}
89
90			/**
91			* @return string
92			*/
93			private function getBase64()
94			{
95			try {
96			if (!extension_loaded('imagick')) {
97			throw new \Exception('No imagick loaded');
98			}
99
100			return base64_encode($this->resizeImage($this->oCanvas->getWidth(), $this->oCanvas->getHeight())->getImageBlob());
101			} catch (\Exception $e) {
102			return '';
103			}
104			}
105
106			/**
107			* @param int $width
108			* @param int\|null $height
109			*
110			* @return \Imagick
111			* @throws \mrcnpdlk\Grandstream\XMLApp\Exception
112			*/
113			private function resizeImage(int $width = 100, int $height = null)
114			{
115			if (!file_exists($this->sImgPath) \|\| !is_readable($this->sImgPath)) {
116			throw new Exception('Image not exists');
117			}
118
119			if (is_null($height)) {
120			$height = $width;
121			}
122			$imagick = new \Imagick(realpath($this->sImgPath));
123
124			$canvasFactor = $width / $height;
125
126			$origWidth = $imagick->getImageWidth();
127			$origHeight = $imagick->getImageHeight();
128			$origFactor = $origWidth / $origHeight;
129			if ($origFactor > $canvasFactor) {//za rozciągniety
130			$imgWidth = $width;
131			$imgHeight = intval($width / $origFactor);
132
133			} else {//za wysoki
134			$imgHeight = $height;
135			$imgWidth = intval($height * $origFactor);
136			}
137
138
139			$imagick = $imagick->flattenImages();
140			$imagick->setImageBackgroundColor(new \ImagickPixel('white'));
141			$imagick->setImageAlphaChannel(\Imagick::ALPHACHANNEL_DEACTIVATE);
142			$imagick->mergeImageLayers(\Imagick::LAYERMETHOD_FLATTEN);
143
144			$colors = min(255, $imagick->getImageColors());
145			$imagick->quantizeImage($colors, \Imagick::COLORSPACE_GRAY, 0, false, false);
146			$imagick->setImageDepth(8 /* bits */);
147			$imagick->resizeImage($imgWidth, $imgHeight, \Imagick::FILTER_LANCZOS, 1, false);
148			$imagick->stripImage();
149
150			$canvas = new \Imagick();
151			$canvas->newImage($width, $height, new \ImagickPixel('white'));
152			$canvas->compositeImage($imagick, \Imagick::COMPOSITE_DEFAULT, intval(($width - $imgWidth) / 2), intval(($height - $imgHeight) / 2));
153			$canvas->setImageFormat('BMP');
154
155			return $canvas;
156			}
157
158			}
159

mrcnpdlk / grandstream-xmlapp

Push — master ( 261d31...f53ed5 )

ElemBitmap::getBase64() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like