FontMeta::unpack() - Code Metrics - Inspection of "Initial commit for rendered cell autosizing in 0.7..." - nimmneun/onesheet - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — rendered-cell-sizes ( 8ba9d2...8dc155 )

by Stefan

created 2017-03-17 09:26 UTC

FontMeta::unpack() A

↳ Parent: FontMeta

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	1	Features	1

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

<?php

namespace OneSheet\Size;

/**
 * Class FontMeta to determine available ttf fonts for cell autosizing.
 *
 * @method string getCopyright()
 * @method string getFontFamily()
 * @method string getFontSubFamily()
 * @method string getFontIdentifier()
 * @method string getFontName()
 * @method string getFontVersion()
 * @method string getPostscriptName()
 * @method string getTrademark()
 * @method string getManufacturerName()
 * @method string getDesigner()
 * @method string getDescription()
 * @method string getVendorUrl()
 * @method string getDesignerUrl()
 * @method string getLicenseDescription()
 * @method string getLicenseUrl()
 * @method string getReservedField()
 * @method string getPreferredFamily()
 * @method string getPreferredSubFamily()
 * @method string getCompatibleFullName()
 * @method string getPostscriptCid()
 */
class FontMeta
{
    /**
     * @var string
     */
    private $fileName;

    /**
     * @var array
     */
    private $data = array(
        'copyright' => null,
        'fontFamily' => null,
        'fontSubFamily' => null,
        'fontIdentifier' => null,
        'fontName' => null,
        'fontVersion' => null,
        'postscriptName' => null,
        'trademark' => null,
        'manufacturerName' => null,
        'designer' => null,
        'description' => null,
        'vendorUrl' => null,
        'designerUrl' => null,
        'licenseDescription' => null,
        'licenseUrl' => null,
        'reservedField' => null,
        'preferredFamily' => null,
        'preferredSubFamily' => null,
        'compatibleFullName' => null,
        'postscriptCid' => null,
    );

    /**
     * FontMeta constructor.
     *
     * @param string $fileName
     * @throws \Exception
     */
    function __construct($fileName)

    {
        if (!$fileName || !is_readable($fileName)) {
            throw new \Exception('File ' . $fileName . ' is not readable');
        }

        $this->fileName = $fileName;
        $this->readFontMetadata();
    }

    /**
     * @param string $name
     * @param array  $args
     * @return mixed
     */
    public function __call($name, $args)
    {
        $property = lcfirst(substr($name, 3));
        return isset($this->data[$property]) ? $this->data[$property] : null;
    }

    /**
     * Read the font Metadata
     *
     * @throws \Exception
     */
    public function readFontMetadata()
    {
        $fontHandle = fopen($this->fileName, "r");
        $offset = $this->getNameTableOffset($fontHandle);

        fseek($fontHandle, $offset, SEEK_SET);

        $nameTableHeader = fread($fontHandle, 6);

        $numberOfRecords = $this->unpack(substr($nameTableHeader, 2, 2));
        $storageOffset = $this->unpack(substr($nameTableHeader, 4, 2));

        for ($a = 0; $a < $numberOfRecords; $a++) {
            $this->findAndExtractCandidate($fontHandle, $offset, $storageOffset);
        }

        fclose($fontHandle);
    }

    /**
     * @param resource $fontHandle
     *
     * @return int
     * @throws \Exception
     */
    private function getNameTableOffset($fontHandle)
    {
        $numberOfTables = $this->unpack(substr(fread($fontHandle, 12), 4, 2));

        for ($t = 0; $t < $numberOfTables; $t++) {
            $tableDirectory = fread($fontHandle, 16);
            $szTag = substr($tableDirectory, 0, 4);
            if (strtolower($szTag) == 'name') {
                return $this->unpack(substr($tableDirectory, 8, 4), 'N');
            }
        }

        fclose($fontHandle);
        throw new \Exception('Can\'t find name table in ' . $this->fileName);
    }

    /**
     * @param resource $fontHandle
     * @param int      $offset
     * @param int      $storageOffset
     */
    private function findAndExtractCandidate($fontHandle, $offset, $storageOffset)
    {
        $nameRecord = fread($fontHandle, 12);

        $nameId = $this->unpack(substr($nameRecord, 6, 2));

        $stringLength = $this->unpack(substr($nameRecord, 8, 2));
        $stringOffset = $this->unpack(substr($nameRecord, 10, 2));

        if ($stringLength > 0) {
            $position = ftell($fontHandle);
            fseek($fontHandle, $offset + $stringOffset + $storageOffset, SEEK_SET);

            $testValue = fread($fontHandle, $stringLength);
            $this->extractCandidate($nameId, $testValue);

            fseek($fontHandle, $position, SEEK_SET);
        }
    }

    /**
     * Extract possible property/attribute. $data keys are
     * intentionally sorted in order of the font file table.
     *
     * @param int    $nameId
     * @param string $testValue
     */
    private function extractCandidate($nameId, $testValue)
    {
        $map = array_keys($this->data);
        if (strlen(trim($testValue)) && array_key_exists($nameId, $map)) {
            $this->data[$map[$nameId]] = $this->cleanupValue(trim($testValue));
        }
    }

    /**
     * Remove ASCII ctrl characters
     *
     * @param string $value
     * @return string
     */
    private function cleanupValue($value)
    {
        return preg_replace('/[[:cntrl:]]/', '', trim($value));
    }

    /**
     *  Convert big endian unsigned short[n] or long[N] value to an integer.
     *
     * @param string $value
     * @param string $format
     * @return int
     */
    private function unpack($value, $format = 'n')
    {
        $unpacked = unpack($format, $value);
        return (int)array_pop($unpacked);
    }
}


1			<?php
2
3			namespace OneSheet\Size;
4
5			/**
6			* Class FontMeta to determine available ttf fonts for cell autosizing.
7			*
8			* @method string getCopyright()
9			* @method string getFontFamily()
10			* @method string getFontSubFamily()
11			* @method string getFontIdentifier()
12			* @method string getFontName()
13			* @method string getFontVersion()
14			* @method string getPostscriptName()
15			* @method string getTrademark()
16			* @method string getManufacturerName()
17			* @method string getDesigner()
18			* @method string getDescription()
19			* @method string getVendorUrl()
20			* @method string getDesignerUrl()
21			* @method string getLicenseDescription()
22			* @method string getLicenseUrl()
23			* @method string getReservedField()
24			* @method string getPreferredFamily()
25			* @method string getPreferredSubFamily()
26			* @method string getCompatibleFullName()
27			* @method string getPostscriptCid()
28			*/
29			class FontMeta
30			{
31			/**
32			* @var string
33			*/
34			private $fileName;
35
36			/**
37			* @var array
38			*/
39			private $data = array(
40			'copyright' => null,
41			'fontFamily' => null,
42			'fontSubFamily' => null,
43			'fontIdentifier' => null,
44			'fontName' => null,
45			'fontVersion' => null,
46			'postscriptName' => null,
47			'trademark' => null,
48			'manufacturerName' => null,
49			'designer' => null,
50			'description' => null,
51			'vendorUrl' => null,
52			'designerUrl' => null,
53			'licenseDescription' => null,
54			'licenseUrl' => null,
55			'reservedField' => null,
56			'preferredFamily' => null,
57			'preferredSubFamily' => null,
58			'compatibleFullName' => null,
59			'postscriptCid' => null,
60			);
61
62			/**
63			* FontMeta constructor.
64			*
65			* @param string $fileName
66			* @throws \Exception
67			*/
68			function __construct($fileName)
			0 ignored issues – show Best Practice introduced 2017-03-17 09:32 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...
69			{
70			if (!$fileName \|\| !is_readable($fileName)) {
71			throw new \Exception('File ' . $fileName . ' is not readable');
72			}
73
74			$this->fileName = $fileName;
75			$this->readFontMetadata();
76			}
77
78			/**
79			* @param string $name
80			* @param array $args
81			* @return mixed
82			*/
83			public function __call($name, $args)
84			{
85			$property = lcfirst(substr($name, 3));
86			return isset($this->data[$property]) ? $this->data[$property] : null;
87			}
88
89			/**
90			* Read the font Metadata
91			*
92			* @throws \Exception
93			*/
94			public function readFontMetadata()
95			{
96			$fontHandle = fopen($this->fileName, "r");
97			$offset = $this->getNameTableOffset($fontHandle);
98
99			fseek($fontHandle, $offset, SEEK_SET);
100
101			$nameTableHeader = fread($fontHandle, 6);
102
103			$numberOfRecords = $this->unpack(substr($nameTableHeader, 2, 2));
104			$storageOffset = $this->unpack(substr($nameTableHeader, 4, 2));
105
106			for ($a = 0; $a < $numberOfRecords; $a++) {
107			$this->findAndExtractCandidate($fontHandle, $offset, $storageOffset);
108			}
109
110			fclose($fontHandle);
111			}
112
113			/**
114			* @param resource $fontHandle
115			*
116			* @return int
117			* @throws \Exception
118			*/
119			private function getNameTableOffset($fontHandle)
120			{
121			$numberOfTables = $this->unpack(substr(fread($fontHandle, 12), 4, 2));
122
123			for ($t = 0; $t < $numberOfTables; $t++) {
124			$tableDirectory = fread($fontHandle, 16);
125			$szTag = substr($tableDirectory, 0, 4);
126			if (strtolower($szTag) == 'name') {
127			return $this->unpack(substr($tableDirectory, 8, 4), 'N');
128			}
129			}
130
131			fclose($fontHandle);
132			throw new \Exception('Can\'t find name table in ' . $this->fileName);
133			}
134
135			/**
136			* @param resource $fontHandle
137			* @param int $offset
138			* @param int $storageOffset
139			*/
140			private function findAndExtractCandidate($fontHandle, $offset, $storageOffset)
141			{
142			$nameRecord = fread($fontHandle, 12);
143
144			$nameId = $this->unpack(substr($nameRecord, 6, 2));
145
146			$stringLength = $this->unpack(substr($nameRecord, 8, 2));
147			$stringOffset = $this->unpack(substr($nameRecord, 10, 2));
148
149			if ($stringLength > 0) {
150			$position = ftell($fontHandle);
151			fseek($fontHandle, $offset + $stringOffset + $storageOffset, SEEK_SET);
152
153			$testValue = fread($fontHandle, $stringLength);
154			$this->extractCandidate($nameId, $testValue);
155
156			fseek($fontHandle, $position, SEEK_SET);
157			}
158			}
159
160			/**
161			* Extract possible property/attribute. $data keys are
162			* intentionally sorted in order of the font file table.
163			*
164			* @param int $nameId
165			* @param string $testValue
166			*/
167			private function extractCandidate($nameId, $testValue)
168			{
169			$map = array_keys($this->data);
170			if (strlen(trim($testValue)) && array_key_exists($nameId, $map)) {
171			$this->data[$map[$nameId]] = $this->cleanupValue(trim($testValue));
172			}
173			}
174
175			/**
176			* Remove ASCII ctrl characters
177			*
178			* @param string $value
179			* @return string
180			*/
181			private function cleanupValue($value)
182			{
183			return preg_replace('/[[:cntrl:]]/', '', trim($value));
184			}
185
186			/**
187			* Convert big endian unsigned short[n] or long[N] value to an integer.
188			*
189			* @param string $value
190			* @param string $format
191			* @return int
192			*/
193			private function unpack($value, $format = 'n')
194			{
195			$unpacked = unpack($format, $value);
196			return (int)array_pop($unpacked);
197			}
198			}
199

nimmneun / onesheet

Push — rendered-cell-sizes ( 8ba9d2...8dc155 )

FontMeta::unpack() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like