ITSP::getRootIndexChunkNumber() - Code Metrics - Inspection of "Allow section data greater than needed" - mlocati/chm-lib - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 7c9391...32ff51 )

by Michele

created 2016-05-04 16:57 UTC

ITSP::getRootIndexChunkNumber() A

↳ Parent: ITSP

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	4
ccs	0
cts	0
cp	0
rs	10
cc	1
eloc	2
nc	1
nop	0
crap	2

<?php

namespace CHMLib\Header;

use Exception;
use CHMLib\Reader\Reader;
use CHMLib\Windows\Language;
use CHMLib\Exception\UnexpectedHeaderException;

/**
 * The directory header of a CHM file.
 */
class ITSP extends VersionedHeader
{
    /**
     * The directory chunk size.
     *
     * @var int
     */
    protected $directoryChunkSize;

    /**
     * The "density" of the QuickRef section (usually 2).
     *
     * @var int
     *
     * @example quickRef = 1 + 2 * quickRefDensity;
     */
    protected $quickRefDensity;

    /**
     * The depth of the index tree (1: no index; 2 one level of PMGI chunks).
     *
     * @var int
     */
    protected $indexDepth;

    /**
     * The chunk number of the root index chunk  (-1: none, though at least sometimes this is 0 even if there is no index chunk - probably a bug).
     *
     * @var int
     */
    protected $rootIndexChunkNumber;

    /**
     * The chunk number of the first PMGL (listing) chunk.
     *
     * @var int
     */
    protected $firstPMGLChunkNumber;

    /**
     * The chunk number of the last PMGL (listing) chunk.
     *
     * @var int
     */
    protected $lastPMGLChunkNumber;

    /**
     * The total number of directory chunks.
     *
     * @var int
     */
    protected $numberOfDirectoryChunks;

    /**
     * The language of the program that generated the CHM file.
     *
     * @var Language
     */
    protected $generatorLanguage;

    /**
     * The system GUID (it should be '{5D02926A-212E-11D0-9DF9-00A0C922E6EC}').
     *
     * @var string
     */
    protected $systemGUID;

    /**
     * Initialize the instance.
     *
     * @param Reader $reader The reader that provides the data.
     *
     * @throws UnexpectedHeaderException Throws an UnexpectedHeaderException if the header signature is not valid.
     * @throws Exception Throws an Exception in case of errors.
     */
    public function __construct(Reader $reader)
    {
        parent::__construct($reader);
        if ($this->headerSignature !== 'ITSP') {
            throw UnexpectedHeaderException::create('ITSP', $this->headerSignature);
        }
        if ($this->headerVersion !== 1) {
            throw new Exception('Unsupported ITSP version number: '.$this->headerVersion);
        }
        /* Unknown (10) */ $reader->readUInt32();

        $this->directoryChunkSize = $reader->readUInt32();
        $this->quickRefDensity = $reader->readUInt32();
        $this->indexDepth = $reader->readUInt32();
        $this->rootIndexChunkNumber = $reader->readInt32();
        $this->firstPMGLChunkNumber = $reader->readUInt32();
        $this->lastPMGLChunkNumber = $reader->readUInt32();
        /* Unknown (-1) */ $reader->readInt32();

        $this->numberOfDirectoryChunks = $reader->readUInt32();
        $this->generatorLanguage = new Language($reader->readUInt32());
        $this->systemGUID = $reader->readGUID();
        /* Again the size of this header (84) */ $reader->readUInt32();
        /* Unknown (-1) */ $reader->readInt32();

        /* Unknown (-1) */ $reader->readInt32();

        /* Unknown (-1) */ $reader->readInt32();

    }

    /**
     * Get the directory chunk size.
     *
     * @return int
     */
    public function getDirectoryChunkSize()
    {
        return $this->directoryChunkSize;
    }

    /**
     * Get the "density" of the QuickRef section (usually 2).
     *
     * @return int
     *
     * @example quickRef = 1 + 2 * quickRefDensity
     */
    public function getQuickRefDensity()
    {
        return $this->quickRefDensity;
    }

    /**
     * Get the depth of the index tree (1: no index; 2 one level of PMGI chunks).
     *
     * @return int
     */
    public function getIndexDepth()
    {
        return $this->indexDepth;
    }

    /**
     * Get the chunk number of the root index chunk (-1: none, though at least sometimes this is 0 even if there is no index chunk - probably a bug).
     *
     * @return int
     */
    public function getRootIndexChunkNumber()
    {
        return $this->rootIndexChunkNumber;
    }

    /**
     * Get the chunk number of the first PMGL (listing) chunk.
     *
     * @return int
     */
    public function getFirstPMGLChunkNumber()
    {
        return $this->firstPMGLChunkNumber;
    }

    /**
     * Get the chunk number of the last PMGL (listing) chunk.
     *
     * @return int
     */
    public function getLastPMGLChunkNumber()
    {
        return $this->lastPMGLChunkNumber;
    }

    /**
     * Get the total number of directory chunks.
     *
     * @return int
     */
    public function getNumberOfDirectoryChunks()
    {
        return $this->numberOfDirectoryChunks;
    }

    /**
     * Get the language of the program that generated the CHM file.
     *
     * @return Language
     */
    public function getGeneratorLanguage()
    {
        return $this->generatorLanguage;
    }

    /**
     * Get the system GUID (it should be '{5D02926A-212E-11D0-9DF9-00A0C922E6EC}').
     *
     * @return string
     */
    public function getSystemGUID()
    {
        return $this->systemGUID;
    }
}


1		<?php
2
3		namespace CHMLib\Header;
4
5		use Exception;
6		use CHMLib\Reader\Reader;
7		use CHMLib\Windows\Language;
8		use CHMLib\Exception\UnexpectedHeaderException;
9
10		/**
11		* The directory header of a CHM file.
12		*/
13		class ITSP extends VersionedHeader
14		{
15		/**
16		* The directory chunk size.
17		*
18		* @var int
19		*/
20		protected $directoryChunkSize;
21
22		/**
23		* The "density" of the QuickRef section (usually 2).
24		*
25		* @var int
26		*
27		* @example quickRef = 1 + 2 * quickRefDensity;
28		*/
29		protected $quickRefDensity;
30
31		/**
32		* The depth of the index tree (1: no index; 2 one level of PMGI chunks).
33		*
34		* @var int
35		*/
36		protected $indexDepth;
37
38		/**
39		* The chunk number of the root index chunk (-1: none, though at least sometimes this is 0 even if there is no index chunk - probably a bug).
40		*
41		* @var int
42		*/
43		protected $rootIndexChunkNumber;
44
45		/**
46		* The chunk number of the first PMGL (listing) chunk.
47		*
48		* @var int
49		*/
50		protected $firstPMGLChunkNumber;
51
52		/**
53		* The chunk number of the last PMGL (listing) chunk.
54		*
55		* @var int
56		*/
57		protected $lastPMGLChunkNumber;
58
59		/**
60		* The total number of directory chunks.
61		*
62		* @var int
63		*/
64		protected $numberOfDirectoryChunks;
65
66		/**
67		* The language of the program that generated the CHM file.
68		*
69		* @var Language
70		*/
71		protected $generatorLanguage;
72
73		/**
74		* The system GUID (it should be '{5D02926A-212E-11D0-9DF9-00A0C922E6EC}').
75		*
76		* @var string
77		*/
78		protected $systemGUID;
79
80		/**
81		* Initialize the instance.
82		*
83		* @param Reader $reader The reader that provides the data.
84		*
85		* @throws UnexpectedHeaderException Throws an UnexpectedHeaderException if the header signature is not valid.
86		* @throws Exception Throws an Exception in case of errors.
87		*/
88	1	public function __construct(Reader $reader)
89		{
90	1	parent::__construct($reader);
91	1	if ($this->headerSignature !== 'ITSP') {
92		throw UnexpectedHeaderException::create('ITSP', $this->headerSignature);
93		}
94	1	if ($this->headerVersion !== 1) {
95		throw new Exception('Unsupported ITSP version number: '.$this->headerVersion);
96		}
97	1	/* Unknown (10) */ $reader->readUInt32();
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-05-04 14:16 UTC by Report Bug Copy Issue Report `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
98	1	$this->directoryChunkSize = $reader->readUInt32();
99	1	$this->quickRefDensity = $reader->readUInt32();
100	1	$this->indexDepth = $reader->readUInt32();
101	1	$this->rootIndexChunkNumber = $reader->readInt32();
102	1	$this->firstPMGLChunkNumber = $reader->readUInt32();
103	1	$this->lastPMGLChunkNumber = $reader->readUInt32();
104	1	/* Unknown (-1) */ $reader->readInt32();
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-05-04 14:16 UTC by Report Bug Copy Issue Report `43%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
105	1	$this->numberOfDirectoryChunks = $reader->readUInt32();
106	1	$this->generatorLanguage = new Language($reader->readUInt32());
107	1	$this->systemGUID = $reader->readGUID();
108	1	/* Again the size of this header (84) */ $reader->readUInt32();
109	1	/* Unknown (-1) */ $reader->readInt32();
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-05-04 14:16 UTC by Report Bug Copy Issue Report `43%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
110	1	/* Unknown (-1) */ $reader->readInt32();
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-05-04 14:16 UTC by Report Bug Copy Issue Report `43%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
111	1	/* Unknown (-1) */ $reader->readInt32();
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-05-04 14:16 UTC by Report Bug Copy Issue Report `43%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
112	1	}
113
114		/**
115		* Get the directory chunk size.
116		*
117		* @return int
118		*/
119	1	public function getDirectoryChunkSize()
120		{
121	1	return $this->directoryChunkSize;
122		}
123
124		/**
125		* Get the "density" of the QuickRef section (usually 2).
126		*
127		* @return int
128		*
129		* @example quickRef = 1 + 2 * quickRefDensity
130		*/
131		public function getQuickRefDensity()
132		{
133		return $this->quickRefDensity;
134		}
135
136		/**
137		* Get the depth of the index tree (1: no index; 2 one level of PMGI chunks).
138		*
139		* @return int
140		*/
141		public function getIndexDepth()
142		{
143		return $this->indexDepth;
144		}
145
146		/**
147		* Get the chunk number of the root index chunk (-1: none, though at least sometimes this is 0 even if there is no index chunk - probably a bug).
148		*
149		* @return int
150		*/
151		public function getRootIndexChunkNumber()
152		{
153		return $this->rootIndexChunkNumber;
154		}
155
156		/**
157		* Get the chunk number of the first PMGL (listing) chunk.
158		*
159		* @return int
160		*/
161	1	public function getFirstPMGLChunkNumber()
162		{
163	1	return $this->firstPMGLChunkNumber;
164		}
165
166		/**
167		* Get the chunk number of the last PMGL (listing) chunk.
168		*
169		* @return int
170		*/
171	1	public function getLastPMGLChunkNumber()
172		{
173	1	return $this->lastPMGLChunkNumber;
174		}
175
176		/**
177		* Get the total number of directory chunks.
178		*
179		* @return int
180		*/
181	1	public function getNumberOfDirectoryChunks()
182		{
183	1	return $this->numberOfDirectoryChunks;
184		}
185
186		/**
187		* Get the language of the program that generated the CHM file.
188		*
189		* @return Language
190		*/
191		public function getGeneratorLanguage()
192		{
193		return $this->generatorLanguage;
194		}
195
196		/**
197		* Get the system GUID (it should be '{5D02926A-212E-11D0-9DF9-00A0C922E6EC}').
198		*
199		* @return string
200		*/
201		public function getSystemGUID()
202		{
203		return $this->systemGUID;
204		}
205		}
206

mlocati / chm-lib

Push — master ( 7c9391...32ff51 )

ITSP::getRootIndexChunkNumber() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like