FieldParserBarcode::convertToFontCode() - Code Metrics - Inspection of "Remove whitespace from text around CDATA nodes. Fi..." - graze/ciff-renderer - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — refactor-03-simple-xml-replace ( b520e3...e5037f )

by John

created 2018-09-04 15:33 UTC

FieldParserBarcode::convertToFontCode() A

↳ Parent: FieldParserBarcode

Complexity

Conditions	2
Paths	2

Size

Total Lines	62
Code Lines	21

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	21
nc	2
nop	1
dl	0
loc	62
rs	9.584
c	0
b	0
f	0

How to fix Long Method

<?php

namespace Graze\CiffRenderer\Parser\FieldParser;

use Graze\CiffRenderer\Parser\FieldParser\FieldParserFixedText;
use Graze\CiffRenderer\Parser\FieldParser\FieldParserInterface;

class FieldParserBarcode extends FieldParserFixedText implements FieldParserInterface
{
    /**
     * @return float
     */
    public function getFontSize()
    {
        return (float) $this->xmlField->Barcode->HR->HRFont->Pitch;

    }

    /**
     * @return bool
     */
    public function getIsInverse()
    {
        return (bool) (string) $this->xmlField->Inverse;

    }

    /**
    * Only EAN13 currently supported.
    *
    * @return string
    */
    public function getText()
    {
        $barcode = parent::getText();

        // add up each digit in the barcode - odd digits counting
        // from the right are tripled before being added
        $sum = 0;
        $triple = true;
        for ($i = strlen($barcode)-1; $i >= 0; $i--) {
            $sum += ($triple ? 3 : 1) * $barcode[$i];
            $triple = !$triple;

        }

        //check digit is the inverse remainder after / by 10
        //e.g. 4 becomes 6, 8 becomes 2 etc...
        $remainder = $sum % 10;

        if ($remainder > 0) {
            $remainder = 10 - $remainder;
        }

        return $this->convertToFontCode($barcode . $remainder);
    }
    /**
    * @param string $barcode
    * @return string
    */
    private function convertToFontCode($barcode)
    {
        /**
        * The barcode is split into the following sections:
        *  First digit
        *  First group of 6 digits (2nd-7th)
        *  Last group of 6 digits (8th-13th)
        *      e.g.        1234567890128
        *      becomes     1   234567  890128
        *
        * The font converts the first digit to a char between q-z
        *
        * The first group of digits are converted to chars starting at either A or Q,
        * the first digit affects the format of the first group as follows:
        *  1st digit     First group format
        *      0           AAAAAA
        *      1           AAQAQQ
        *      2           AAQQAQ
        *      3           AAQQQA
        *      4           AQAAQQ
        *      5           AQQAAQ
        *      6           AQQQAA
        *      7           AQAQAQ
        *      8           AQAQQA
        *      9           AQQAQA
        *
        * The last group of digits remain unchanged
        *
        * The actual format used by the font is:
        *       firstDigit  {{{{{|  firstGroup  {|{  secondGroup  |
        */

        // convert first digit
        $firstDigit = (int)substr($barcode, 0, 1);
        $firstDigitChar = chr(113 + $firstDigit);

        // convert first group
        $firstGroup = '';
        $firstGroupFormats = [
            'AAAAAA',
            'AAQAQQ',
            'AAQQAQ',
            'AAQQQA',
            'AQAAQQ',
            'AQQAAQ',
            'AQQQAA',
            'AQAQAQ',
            'AQAQQA',
            'AQQAQA'
        ];
        $firstGroupFormat = $firstGroupFormats[$firstDigit];
        for ($i = 1; $i <= 6; $i++) {
            $digit = (int)substr($barcode, $i, 1);
            $startingChar = substr($firstGroupFormat, $i - 1, 1);
            $firstGroup .= chr(ord($startingChar) + $digit);
        }

        // extract second group
        $secondGroup = substr($barcode, 7);

        // combine the barcode with the special chars used by the font
        return $firstDigitChar.'{{{{{|'.$firstGroup.'{|{'.$secondGroup.'|';
    }
}


1			<?php
2
3			namespace Graze\CiffRenderer\Parser\FieldParser;
4
5			use Graze\CiffRenderer\Parser\FieldParser\FieldParserFixedText;
6			use Graze\CiffRenderer\Parser\FieldParser\FieldParserInterface;
7
8			class FieldParserBarcode extends FieldParserFixedText implements FieldParserInterface
9			{
10			/**
11			* @return float
12			*/
13			public function getFontSize()
14			{
15			return (float) $this->xmlField->Barcode->HR->HRFont->Pitch;
			0 ignored issues – show Bug introduced 2018-09-04 15:41 UTC by Report Bug Copy Issue Report Accessing `Barcode` on the interface `Graze\CiffRenderer\Parse...mpleXmlElementInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? Loading history...
16			}
17
18			/**
19			* @return bool
20			*/
21			public function getIsInverse()
22			{
23			return (bool) (string) $this->xmlField->Inverse;
			0 ignored issues – show Bug introduced 2018-09-04 15:41 UTC by Report Bug Copy Issue Report Accessing `Inverse` on the interface `Graze\CiffRenderer\Parse...mpleXmlElementInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? Loading history...
24			}
25
26			/**
27			* Only EAN13 currently supported.
28			*
29			* @return string
30			*/
31			public function getText()
32			{
33			$barcode = parent::getText();
34
35			// add up each digit in the barcode - odd digits counting
36			// from the right are tripled before being added
37			$sum = 0;
38			$triple = true;
39			for ($i = strlen($barcode)-1; $i >= 0; $i--) {
40			$sum += ($triple ? 3 : 1) * $barcode[$i];
41			$triple = !$triple;
			0 ignored issues – show introduced 2018-08-20 13:25 UTC by Report Bug Copy Issue Report The condition `$triple` is always `true`. Loading history...
42			}
43
44			//check digit is the inverse remainder after / by 10
45			//e.g. 4 becomes 6, 8 becomes 2 etc...
46			$remainder = $sum % 10;
47
48			if ($remainder > 0) {
49			$remainder = 10 - $remainder;
50			}
51
52			return $this->convertToFontCode($barcode . $remainder);
53			}
54			/**
55			* @param string $barcode
56			* @return string
57			*/
58			private function convertToFontCode($barcode)
59			{
60			/**
61			* The barcode is split into the following sections:
62			* First digit
63			* First group of 6 digits (2nd-7th)
64			* Last group of 6 digits (8th-13th)
65			* e.g. 1234567890128
66			* becomes 1 234567 890128
67			*
68			* The font converts the first digit to a char between q-z
69			*
70			* The first group of digits are converted to chars starting at either A or Q,
71			* the first digit affects the format of the first group as follows:
72			* 1st digit First group format
73			* 0 AAAAAA
74			* 1 AAQAQQ
75			* 2 AAQQAQ
76			* 3 AAQQQA
77			* 4 AQAAQQ
78			* 5 AQQAAQ
79			* 6 AQQQAA
80			* 7 AQAQAQ
81			* 8 AQAQQA
82			* 9 AQQAQA
83			*
84			* The last group of digits remain unchanged
85			*
86			* The actual format used by the font is:
87			* firstDigit {{{{{\| firstGroup {\|{ secondGroup \|
88			*/
89
90			// convert first digit
91			$firstDigit = (int)substr($barcode, 0, 1);
92			$firstDigitChar = chr(113 + $firstDigit);
93
94			// convert first group
95			$firstGroup = '';
96			$firstGroupFormats = [
97			'AAAAAA',
98			'AAQAQQ',
99			'AAQQAQ',
100			'AAQQQA',
101			'AQAAQQ',
102			'AQQAAQ',
103			'AQQQAA',
104			'AQAQAQ',
105			'AQAQQA',
106			'AQQAQA'
107			];
108			$firstGroupFormat = $firstGroupFormats[$firstDigit];
109			for ($i = 1; $i <= 6; $i++) {
110			$digit = (int)substr($barcode, $i, 1);
111			$startingChar = substr($firstGroupFormat, $i - 1, 1);
112			$firstGroup .= chr(ord($startingChar) + $digit);
113			}
114
115			// extract second group
116			$secondGroup = substr($barcode, 7);
117
118			// combine the barcode with the special chars used by the font
119			return $firstDigitChar.'{{{{{\|'.$firstGroup.'{\|{'.$secondGroup.'\|';
120			}
121			}
122

graze / ciff-renderer

Push — refactor-03-simple-xml-replace ( b520e3...e5037f )

FieldParserBarcode::convertToFontCode() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like