VCardHelper - Code Metrics - Stefanius67/VCard - Measure and Improve Code Quality continuously with Scrutinizer

VCardHelper A
last analyzed 2025-09-05 22:26 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	277
Duplicated Lines	0 %

Importance

Changes	3
Bugs	2	Features	0

Metric	Value
wmc	33
eloc	159
c	3
b	2
f	0
dl	0
loc	277
rs	9.76

8 Methods

Rating	Name	Size	Complexity
A	buildProperty()	22	5
A	parseImageData()	10	2
A	maskString()	19	4
A	paramName()	59	2
A	explodeMaskedString()	10	2
A	unmaskString()	15	4
A	parseParams()	21	4
B	imageFromString()	54	10

<?php
declare(strict_types=1);

namespace SKien\VCard;

/**
 * Helper trait containing some methods used by multiple classes in package.
 *
 * @package VCard
 * @author Stefanius <[email protected]>
 * @copyright MIT License - see the LICENSE file for details
 * @internal
 */
trait VCardHelper
{
    /**
     * Build property to insert in vcard.
     * If line exceeds max length, data will be split into multiple lines
     * @param string    $strName
     * @param string    $strValue
     * @param bool      $bMask      have value to be masked (default: true)
     * @return string
     */
    protected function buildProperty(string $strName, string $strValue, bool $bMask = true) : string
    {
        $buffer = '';
        if (!empty($strValue)) {
            if ($bMask) {
                $strValue = $this->maskString($strValue);
            }
            $strLine = $strName . ':' . $strValue;
            if (strlen($strLine) > VCard::MAX_LINE_LENGTH) {
                $buffer = substr($strLine, 0, VCard::MAX_LINE_LENGTH) . PHP_EOL;
                $strLine = substr($strLine, VCard::MAX_LINE_LENGTH);
                $iMax = VCard::MAX_LINE_LENGTH - 1;
                while (strlen($strLine) > $iMax) {
                    $buffer .= ' ' . substr($strLine, 0, $iMax) . PHP_EOL;
                    $strLine = substr($strLine, $iMax);
                }
                $buffer .= ' ' . $strLine . PHP_EOL;
            } else {
                $buffer = $strLine . PHP_EOL;
            }
        }
        return $buffer;
    }

    /**
     * Mask delimiter and newline if inside of value.
     * @param string $strValue
     * @return string
     */
    protected function maskString(string $strValue) : string
    {
        // decode entities before ';' is replaced !!
        $strValue = html_entity_decode($strValue, ENT_HTML5);
        $strValue = str_replace("\r\n", "\n", $strValue);
        $strValue = str_replace("\r", "\n", $strValue);
        $strValue = str_replace("\n", "\\n", $strValue);
        $strValue = str_replace(",", "\\,", $strValue);
        $strValue = str_replace(";", "\\;", $strValue);

        $strFrom = mb_detect_encoding($strValue);
        if ($strFrom !== false && $strFrom != VCard::getEncoding()) {
            $strValue = iconv($strFrom, VCard::getEncoding(), $strValue);
            if ($strValue === false) {
                $strValue = '';
            }
        }

        return $strValue;
    }

    /**
     * Unmask delimiter and newline.
     * @param string $strValue
     * @return string
     */
    protected function unmaskString(string $strValue) : string
    {
        $strValue = str_replace("\\n", "\n", $strValue);
        $strValue = str_replace("\\,", ",", $strValue);
        $strValue = str_replace("\\;", ";", $strValue);

        $strFrom = mb_detect_encoding($strValue);
        if ($strFrom !== false && $strFrom != VCard::getEncoding()) {
            $strValue = iconv($strFrom, VCard::getEncoding() . "//IGNORE", $strValue);
            if ($strValue === false) {
                $strValue = '';
            }
        }

        return $strValue;
    }

    /**
     * Explode a masked string.
     * to ignore masked delimiters belonging to value
     * @param string $strDelim
     * @param string $strValue
     * @return array<string>
     */
    protected function explodeMaskedString(string $strDelim, string $strValue) : array
    {
        // save masked delimiters, tag unmasked, restore saved and explode on new taged delimiter
        $strSave = "\\" . $strDelim;
        $strValue = str_replace($strSave, "\x00", $strValue);
        $strValue = str_replace($strDelim, "\x01", $strValue);
        $strValue = str_replace("\x00", $strSave, $strValue);

        $a = explode("\x01", $strValue);
        return $a == false ? [] : $a;
    }

    /**
     * Parse image date (base64) to extract type and raw data.
     * @param string $blobImage
     * @param string $strType
     * @param string $strImage
     */
    protected function parseImageData(string $blobImage, string &$strType, string &$strImage) : void
    {
        // extract image type from binary data (e.g. data:image/jpg;base64,)
        $i = strpos($blobImage, ',');
        if ($i > 0) {
            $strType = substr($blobImage, 0, $i);
            $iFrom = strpos($strType, '/');
            $iTo = strpos($strType, ';');
            $strType = strtoupper(substr($strType, $iFrom + 1, $iTo - $iFrom - 1));
            $strImage = substr($blobImage, $i + 1);
        }
    }

    /**
     * Parse param string
     * @param array<string> $aParamsIn
     * @return array<string,string>
     */
    protected function parseParams(array $aParamsIn) : array
    {
        $aParams = array();
        $iCount = count($aParamsIn);
        for ($i = 1; $i < $iCount; $i++) {
            $aSplit = explode('=', $aParamsIn[$i]);
            if (count($aSplit) < 2) {
                // version 2.1 allows paramvalues without paramname
                $strName = $this->paramName($aSplit[0]);
                $strValue = strtoupper($aSplit[0]);
            } else {
                $strName = strtoupper($aSplit[0]);
                $strValue = strtoupper($aSplit[1]);
            }
            if (isset($aParams[$strName])) {
                $aParams[$strName] .= ',' . $strValue;
            } else {
                $aParams[$strName] = $strValue;
            }
        }
        return $aParams;
    }

    /**
     * Find paramname to paramvalue.
     * vcard version 2.1 allows params without name of the param
     * e.g.    TEL;HOME: short for TEL;TYPE=HOME:
     * @param string $strValue
     * @return string
     */
    protected function paramName(string $strValue) : string
    {
        static $aNames = array(
            'INLINE'            => 'VALUE',
            'URI'               => 'VALUE',
            'URL'               => 'VALUE',
            'CID'               => 'VALUE',
            '7BIT'              => 'ENCODING',
            'QUOTED-PRINTABLE'  => 'ENCODING',
            'BASE64'            => 'ENCODING',
            'DOM'               => 'TYPE',
            'INTL'              => 'TYPE',
            'POSTAL'            => 'TYPE',
            'PARCEL'            => 'TYPE',
            'HOME'              => 'TYPE',
            'WORK'              => 'TYPE',
            'PREF'              => 'TYPE',
            'VOICE'             => 'TYPE',
            'FAX'               => 'TYPE',
            'MSG'               => 'TYPE',
            'CELL'              => 'TYPE',
            'PAGER'             => 'TYPE',
            'BBS'               => 'TYPE',
            'MODEM'             => 'TYPE',
            'CAR'               => 'TYPE',
            'ISDN'              => 'TYPE',
            'VIDEO'             => 'TYPE',
            'ATTMAIL'           => 'TYPE',
            'CIS'               => 'TYPE',
            'EWORLD'            => 'TYPE',
            'INTERNET'          => 'TYPE',
            'PRODIGY'           => 'TYPE',
            'TLX'               => 'TYPE',
            'X400'              => 'TYPE',
            'GIF'               => 'TYPE',
            'CGM'               => 'TYPE',
            'WMF'               => 'TYPE',
            'BMP'               => 'TYPE',
            'MET'               => 'TYPE',
            'PMB'               => 'TYPE',
            'DIB'               => 'TYPE',
            'PICT'              => 'TYPE',
            'TIFF'              => 'TYPE',
            'PDF'               => 'TYPE',
            'PS'                => 'TYPE',
            'JPEG'              => 'TYPE',
            'QTIME'             => 'TYPE',
            'MPEG'              => 'TYPE',
            'MPEG2'             => 'TYPE',
            'AVI'               => 'TYPE',
            'WAVE'              => 'TYPE',
            'PCM'               => 'TYPE'
        );

        $strName = 'UNKNOWN';
        if (isset($aNames[$strValue])) {
            $strName = $aNames[$strValue];
        }
        return $strName;
    }

    /**
     * Create image ressource from encoded string.
     * Special processing for BMP cause there is no support in PHP before 7.2.
     * @param string    $strImage   base64 encoded image
     * @param string    $strType    image types supported by imagecreatefromstring
     * @return \GdImage|false    image resource
     */
    protected function imageFromString(string $strImage, string $strType)
    {
        $strImage = base64_decode($strImage);
        if ($strType != 'BMP') {
            $img = imagecreatefromstring($strImage);
        } else {
            // imagecreatefromstring don't supports BMP
            // ...imagecreatefrombmp() is available from PHP version >= 7.2!
            //
            // thanks to Tomáš Grasl for following code from
            // https://gist.github.com/freema/df8e7bae83c0e2a50ea4
            $temp = unpack("H*", $strImage);
            $hex = ($temp !== false ? $temp[1] : 0);
            $header = substr($hex, 0, 108);
            $width = 0;
            $height = 0;
            if (substr($header, 0, 4) == "424d") {
                $parts = str_split($header, 2);
                $width = (int)hexdec($parts[19] . $parts[18]);
                $height = (int)hexdec($parts[23] . $parts[22]);
                unset($parts);
            }
            $x = 0;
            $y = 1;
            $img = imagecreatetruecolor($width, $height);
            if ($img !== false) {
                $body = substr($hex, 108);
                $body_size = (strlen($body) / 2);
                $header_size = ($width * $height);
                $usePadding = ($body_size > ($header_size * 3) + 4);
                for ($i = 0; $i < $body_size; $i += 3) {
                    if ($x >= $width) {
                        if ($usePadding) {
                            $i += $width % 4;
                        }
                        $x = 0;
                        $y++;
                        if ($y > $height) {
                            break;
                        }
                    }
                    $i_pos = $i * 2;
                    $r = (int)hexdec($body[$i_pos + 4] . $body[$i_pos + 5]);
                    $g = (int)hexdec($body[$i_pos + 2] . $body[$i_pos + 3]);
                    $b = (int)hexdec($body[$i_pos] . $body[$i_pos + 1]);
                    $color = imagecolorallocate($img, $r, $g, $b);
                    if ($color !== false) {
                        imagesetpixel($img, $x, $height - $y, $color);
                    }
                    $x++;
                }
            }
        }
        return $img;

    }
}

1			<?php
2			declare(strict_types=1);
3
4			namespace SKien\VCard;
5
6			/**
7			* Helper trait containing some methods used by multiple classes in package.
8			*
9			* @package VCard
10			* @author Stefanius <[email protected]>
11			* @copyright MIT License - see the LICENSE file for details
12			* @internal
13			*/
14			trait VCardHelper
15			{
16			/**
17			* Build property to insert in vcard.
18			* If line exceeds max length, data will be split into multiple lines
19			* @param string $strName
20			* @param string $strValue
21			* @param bool $bMask have value to be masked (default: true)
22			* @return string
23			*/
24			protected function buildProperty(string $strName, string $strValue, bool $bMask = true) : string
25			{
26			$buffer = '';
27			if (!empty($strValue)) {
28			if ($bMask) {
29			$strValue = $this->maskString($strValue);
30			}
31			$strLine = $strName . ':' . $strValue;
32			if (strlen($strLine) > VCard::MAX_LINE_LENGTH) {
33			$buffer = substr($strLine, 0, VCard::MAX_LINE_LENGTH) . PHP_EOL;
34			$strLine = substr($strLine, VCard::MAX_LINE_LENGTH);
35			$iMax = VCard::MAX_LINE_LENGTH - 1;
36			while (strlen($strLine) > $iMax) {
37			$buffer .= ' ' . substr($strLine, 0, $iMax) . PHP_EOL;
38			$strLine = substr($strLine, $iMax);
39			}
40			$buffer .= ' ' . $strLine . PHP_EOL;
41			} else {
42			$buffer = $strLine . PHP_EOL;
43			}
44			}
45			return $buffer;
46			}
47
48			/**
49			* Mask delimiter and newline if inside of value.
50			* @param string $strValue
51			* @return string
52			*/
53			protected function maskString(string $strValue) : string
54			{
55			// decode entities before ';' is replaced !!
56			$strValue = html_entity_decode($strValue, ENT_HTML5);
57			$strValue = str_replace("\r\n", "\n", $strValue);
58			$strValue = str_replace("\r", "\n", $strValue);
59			$strValue = str_replace("\n", "\\n", $strValue);
60			$strValue = str_replace(",", "\\,", $strValue);
61			$strValue = str_replace(";", "\\;", $strValue);
62
63			$strFrom = mb_detect_encoding($strValue);
64			if ($strFrom !== false && $strFrom != VCard::getEncoding()) {
65			$strValue = iconv($strFrom, VCard::getEncoding(), $strValue);
66			if ($strValue === false) {
67			$strValue = '';
68			}
69			}
70
71			return $strValue;
72			}
73
74			/**
75			* Unmask delimiter and newline.
76			* @param string $strValue
77			* @return string
78			*/
79			protected function unmaskString(string $strValue) : string
80			{
81			$strValue = str_replace("\\n", "\n", $strValue);
82			$strValue = str_replace("\\,", ",", $strValue);
83			$strValue = str_replace("\\;", ";", $strValue);
84
85			$strFrom = mb_detect_encoding($strValue);
86			if ($strFrom !== false && $strFrom != VCard::getEncoding()) {
87			$strValue = iconv($strFrom, VCard::getEncoding() . "//IGNORE", $strValue);
88			if ($strValue === false) {
89			$strValue = '';
90			}
91			}
92
93			return $strValue;
94			}
95
96			/**
97			* Explode a masked string.
98			* to ignore masked delimiters belonging to value
99			* @param string $strDelim
100			* @param string $strValue
101			* @return array<string>
102			*/
103			protected function explodeMaskedString(string $strDelim, string $strValue) : array
104			{
105			// save masked delimiters, tag unmasked, restore saved and explode on new taged delimiter
106			$strSave = "\\" . $strDelim;
107			$strValue = str_replace($strSave, "\x00", $strValue);
108			$strValue = str_replace($strDelim, "\x01", $strValue);
109			$strValue = str_replace("\x00", $strSave, $strValue);
110
111			$a = explode("\x01", $strValue);
112			return $a == false ? [] : $a;
113			}
114
115			/**
116			* Parse image date (base64) to extract type and raw data.
117			* @param string $blobImage
118			* @param string $strType
119			* @param string $strImage
120			*/
121			protected function parseImageData(string $blobImage, string &$strType, string &$strImage) : void
122			{
123			// extract image type from binary data (e.g. data:image/jpg;base64,)
124			$i = strpos($blobImage, ',');
125			if ($i > 0) {
126			$strType = substr($blobImage, 0, $i);
127			$iFrom = strpos($strType, '/');
128			$iTo = strpos($strType, ';');
129			$strType = strtoupper(substr($strType, $iFrom + 1, $iTo - $iFrom - 1));
130			$strImage = substr($blobImage, $i + 1);
131			}
132			}
133
134			/**
135			* Parse param string
136			* @param array<string> $aParamsIn
137			* @return array<string,string>
138			*/
139			protected function parseParams(array $aParamsIn) : array
140			{
141			$aParams = array();
142			$iCount = count($aParamsIn);
143			for ($i = 1; $i < $iCount; $i++) {
144			$aSplit = explode('=', $aParamsIn[$i]);
145			if (count($aSplit) < 2) {
146			// version 2.1 allows paramvalues without paramname
147			$strName = $this->paramName($aSplit[0]);
148			$strValue = strtoupper($aSplit[0]);
149			} else {
150			$strName = strtoupper($aSplit[0]);
151			$strValue = strtoupper($aSplit[1]);
152			}
153			if (isset($aParams[$strName])) {
154			$aParams[$strName] .= ',' . $strValue;
155			} else {
156			$aParams[$strName] = $strValue;
157			}
158			}
159			return $aParams;
160			}
161
162			/**
163			* Find paramname to paramvalue.
164			* vcard version 2.1 allows params without name of the param
165			* e.g. TEL;HOME: short for TEL;TYPE=HOME:
166			* @param string $strValue
167			* @return string
168			*/
169			protected function paramName(string $strValue) : string
170			{
171			static $aNames = array(
172			'INLINE' => 'VALUE',
173			'URI' => 'VALUE',
174			'URL' => 'VALUE',
175			'CID' => 'VALUE',
176			'7BIT' => 'ENCODING',
177			'QUOTED-PRINTABLE' => 'ENCODING',
178			'BASE64' => 'ENCODING',
179			'DOM' => 'TYPE',
180			'INTL' => 'TYPE',
181			'POSTAL' => 'TYPE',
182			'PARCEL' => 'TYPE',
183			'HOME' => 'TYPE',
184			'WORK' => 'TYPE',
185			'PREF' => 'TYPE',
186			'VOICE' => 'TYPE',
187			'FAX' => 'TYPE',
188			'MSG' => 'TYPE',
189			'CELL' => 'TYPE',
190			'PAGER' => 'TYPE',
191			'BBS' => 'TYPE',
192			'MODEM' => 'TYPE',
193			'CAR' => 'TYPE',
194			'ISDN' => 'TYPE',
195			'VIDEO' => 'TYPE',
196			'ATTMAIL' => 'TYPE',
197			'CIS' => 'TYPE',
198			'EWORLD' => 'TYPE',
199			'INTERNET' => 'TYPE',
200			'PRODIGY' => 'TYPE',
201			'TLX' => 'TYPE',
202			'X400' => 'TYPE',
203			'GIF' => 'TYPE',
204			'CGM' => 'TYPE',
205			'WMF' => 'TYPE',
206			'BMP' => 'TYPE',
207			'MET' => 'TYPE',
208			'PMB' => 'TYPE',
209			'DIB' => 'TYPE',
210			'PICT' => 'TYPE',
211			'TIFF' => 'TYPE',
212			'PDF' => 'TYPE',
213			'PS' => 'TYPE',
214			'JPEG' => 'TYPE',
215			'QTIME' => 'TYPE',
216			'MPEG' => 'TYPE',
217			'MPEG2' => 'TYPE',
218			'AVI' => 'TYPE',
219			'WAVE' => 'TYPE',
220			'PCM' => 'TYPE'
221			);
222
223			$strName = 'UNKNOWN';
224			if (isset($aNames[$strValue])) {
225			$strName = $aNames[$strValue];
226			}
227			return $strName;
228			}
229
230			/**
231			* Create image ressource from encoded string.
232			* Special processing for BMP cause there is no support in PHP before 7.2.
233			* @param string $strImage base64 encoded image
234			* @param string $strType image types supported by imagecreatefromstring
235			* @return \GdImage\|false image resource
236			*/
237			protected function imageFromString(string $strImage, string $strType)
238			{
239			$strImage = base64_decode($strImage);
240			if ($strType != 'BMP') {
241			$img = imagecreatefromstring($strImage);
242			} else {
243			// imagecreatefromstring don't supports BMP
244			// ...imagecreatefrombmp() is available from PHP version >= 7.2!
245			//
246			// thanks to Tomáš Grasl for following code from
247			// https://gist.github.com/freema/df8e7bae83c0e2a50ea4
248			$temp = unpack("H*", $strImage);
249			$hex = ($temp !== false ? $temp[1] : 0);
250			$header = substr($hex, 0, 108);
251			$width = 0;
252			$height = 0;
253			if (substr($header, 0, 4) == "424d") {
254			$parts = str_split($header, 2);
255			$width = (int)hexdec($parts[19] . $parts[18]);
256			$height = (int)hexdec($parts[23] . $parts[22]);
257			unset($parts);
258			}
259			$x = 0;
260			$y = 1;
261			$img = imagecreatetruecolor($width, $height);
262			if ($img !== false) {
263			$body = substr($hex, 108);
264			$body_size = (strlen($body) / 2);
265			$header_size = ($width * $height);
266			$usePadding = ($body_size > ($header_size * 3) + 4);
267			for ($i = 0; $i < $body_size; $i += 3) {
268			if ($x >= $width) {
269			if ($usePadding) {
270			$i += $width % 4;
271			}
272			$x = 0;
273			$y++;
274			if ($y > $height) {
275			break;
276			}
277			}
278			$i_pos = $i * 2;
279			$r = (int)hexdec($body[$i_pos + 4] . $body[$i_pos + 5]);
280			$g = (int)hexdec($body[$i_pos + 2] . $body[$i_pos + 3]);
281			$b = (int)hexdec($body[$i_pos] . $body[$i_pos + 1]);
282			$color = imagecolorallocate($img, $r, $g, $b);
283			if ($color !== false) {
284			imagesetpixel($img, $x, $height - $y, $color);
285			}
286			$x++;
287			}
288			}
289			}
290			return $img;
			0 ignored issues – show Bug Best Practice introduced 2025-09-05 22:26 UTC by Report Bug Copy Issue Report The expression `return $img` also could return the type `resource` which is incompatible with the documented return type `GdImage\|false`. Loading history...
291			}
292			}

Stefanius67 / VCard

VCardHelper A last analyzed 2025-09-05 22:26 UTC

Complexity

Size/Duplication

Importance

8 Methods

Duplication Side-by-Side

Filter issues like

VCardHelper A
last analyzed 2025-09-05 22:26 UTC