/usr/share/php/PHP/Depend/Metrics/Inheritance/Analyzer.php is in pdepend 1.1.4-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 | <?php
/**
* This file is part of PHP_Depend.
*
* PHP Version 5
*
* Copyright (c) 2008-2012, Manuel Pichler <mapi@pdepend.org>.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* * Neither the name of Manuel Pichler nor the names of his
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* @category QualityAssurance
* @package PHP_Depend
* @subpackage Metrics
* @author Manuel Pichler <mapi@pdepend.org>
* @copyright 2008-2012 Manuel Pichler. All rights reserved.
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @version SVN: $Id$
* @link http://pdepend.org/
*/
/**
* This analyzer provides two project related inheritance metrics.
*
* <b>ANDC - Average Number of Derived Classes</b>: The average number of direct
* subclasses of a class. This metric only covers classes in the analyzed system,
* no library or environment classes are covered.
*
* <b>AHH - Average Hierarchy Height</b>: The computed average of all inheritance
* trees within the analyzed system, external classes or interfaces are ignored.
*
* @category QualityAssurance
* @package PHP_Depend
* @subpackage Metrics
* @author Manuel Pichler <mapi@pdepend.org>
* @copyright 2008-2012 Manuel Pichler. All rights reserved.
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @version Release: 1.1.4
* @link http://pdepend.org/
*/
class PHP_Depend_Metrics_Inheritance_Analyzer
extends PHP_Depend_Metrics_AbstractAnalyzer
implements PHP_Depend_Metrics_NodeAwareI,
PHP_Depend_Metrics_FilterAwareI,
PHP_Depend_Metrics_ProjectAwareI
{
/**
* Type of this analyzer class.
*/
const CLAZZ = __CLASS__;
/**
* Metrics provided by the analyzer implementation.
*/
const M_AVERAGE_NUMBER_DERIVED_CLASSES = 'andc',
M_AVERAGE_HIERARCHY_HEIGHT = 'ahh',
M_DEPTH_OF_INHERITANCE_TREE = 'dit',
M_NUMBER_OF_ADDED_METHODS = 'noam',
M_NUMBER_OF_OVERWRITTEN_METHODS = 'noom',
M_NUMBER_OF_DERIVED_CLASSES = 'nocc',
M_MAXIMUM_INHERITANCE_DEPTH = 'maxDIT';
/**
* Contains the max inheritance depth for all root classes within the
* analyzed system. The array size is equal to the number of analyzed root
* classes.
*
* @var array(integer)
*/
private $rootClasses = null;
/**
* The maximum depth of inheritance tree value within the analyzed source code.
*
* @var integer
*/
private $maxDIT = 0;
/**
* The average number of derived classes.
*
* @var float
*/
private $andc = 0;
/**
* The average hierarchy height.
*
* @var float
*/
private $ahh = 0;
/**
* Total number of classes.
*
* @var integer
*/
private $numberOfClasses = 0;
/**
* Total number of derived classes.
*
* @var integer
*/
private $numberOfDerivedClasses = 0;
/**
* Metrics calculated for a single source node.
*
* @var array(string=>array)
*/
private $nodeMetrics = null;
/**
* This method will return an <b>array</b> with all generated metric values
* for the given <b>$node</b>. If there are no metrics for the requested
* node, this method will return an empty <b>array</b>.
*
* @param PHP_Depend_Code_NodeI $node The context node instance.
*
* @return array(string=>mixed)
*/
public function getNodeMetrics(PHP_Depend_Code_NodeI $node)
{
if (isset($this->nodeMetrics[$node->getUuid()])) {
return $this->nodeMetrics[$node->getUuid()];
}
return array();
}
/**
* Provides the project summary as an <b>array</b>.
*
* <code>
* array(
* 'andc' => 0.73,
* 'ahh' => 0.56
* )
* </code>
*
* @return array(string=>mixed)
*/
public function getProjectMetrics()
{
return array(
self::M_AVERAGE_NUMBER_DERIVED_CLASSES => $this->andc,
self::M_AVERAGE_HIERARCHY_HEIGHT => $this->ahh,
self::M_MAXIMUM_INHERITANCE_DEPTH => $this->maxDIT,
);
}
/**
* Processes all {@link PHP_Depend_Code_Package} code nodes.
*
* @param PHP_Depend_Code_NodeIterator $packages All code packages.
*
* @return void
*/
public function analyze(PHP_Depend_Code_NodeIterator $packages)
{
if ($this->nodeMetrics === null) {
$this->nodeMetrics = array();
$this->fireStartAnalyzer();
$this->doAnalyze($packages);
$this->fireEndAnalyzer();
}
}
/**
* Calculates several inheritance related metrics for the given source
* packages.
*
* @param PHP_Depend_Code_NodeIterator $packages The source packages.
*
* @return void
* @since 0.9.10
*/
private function doAnalyze(PHP_Depend_Code_NodeIterator $packages)
{
// Process all packages
foreach ($packages as $package) {
$package->accept($this);
}
if ($this->numberOfClasses > 0) {
$this->andc = $this->numberOfDerivedClasses / $this->numberOfClasses;
}
if (($count = count($this->rootClasses)) > 0) {
$this->ahh = array_sum($this->rootClasses) / $count;
}
}
/**
* Visits a class node.
*
* @param PHP_Depend_Code_Class $class The current class node.
*
* @return void
* @see PHP_Depend_Visitor_AbstractVisitor::visitClass()
*/
public function visitClass(PHP_Depend_Code_Class $class)
{
if (!$class->isUserDefined()) {
return;
}
$this->fireStartClass($class);
$this->initNodeMetricsForClass($class);
$this->calculateNumberOfDerivedClasses($class);
$this->calculateNumberOfAddedAndOverwrittenMethods($class);
$this->calculateDepthOfInheritanceTree($class);
$this->fireEndClass($class);
}
/**
* Calculates the number of derived classes.
*
* @param PHP_Depend_Code_Class $class The current class node.
*
* @return void
* @since 0.9.5
*/
private function calculateNumberOfDerivedClasses(PHP_Depend_Code_Class $class)
{
$uuid = $class->getUuid();
if (isset($this->derivedClasses[$uuid]) === false) {
$this->derivedClasses[$uuid] = 0;
}
$parentClass = $class->getParentClass();
if ($parentClass !== null && $parentClass->isUserDefined()) {
$uuid = $parentClass->getUuid();
++$this->numberOfDerivedClasses;
++$this->nodeMetrics[$uuid][self::M_NUMBER_OF_DERIVED_CLASSES];
}
}
/**
* Calculates the maximum HIT for the given class.
*
* @param PHP_Depend_Code_Class $class The context class instance.
*
* @return void
* @since 0.9.10
*/
private function calculateDepthOfInheritanceTree(PHP_Depend_Code_Class $class)
{
$dit = 0;
$uuid = $class->getUuid();
$root = $class->getUuid();
foreach ($class->getParentClasses() as $parent) {
if (!$parent->isUserDefined()) {
++$dit;
}
++$dit;
$root = $parent->getUuid();
}
// Collect max dit value
$this->maxDIT = max($this->maxDIT, $dit);
if (empty($this->rootClasses[$root]) || $this->rootClasses[$root] < $dit) {
$this->rootClasses[$root] = $dit;
}
$this->nodeMetrics[$uuid][self::M_DEPTH_OF_INHERITANCE_TREE] = $dit;
}
/**
* Calculates two metrics. The number of added methods and the number of
* overwritten methods.
*
* @param PHP_Depend_Code_Class $class The context class instance.
*
* @return void
* @since 0.9.10
*/
private function calculateNumberOfAddedAndOverwrittenMethods(
PHP_Depend_Code_Class $class
) {
$parentClass = $class->getParentClass();
if ($parentClass === null) {
return;
}
$parentMethodNames = array();
foreach ($parentClass->getAllMethods() as $method) {
$parentMethodNames[$method->getName()] = $method->isAbstract();
}
$numberOfAddedMethods = 0;
$numberOfOverwrittenMethods = 0;
foreach ($class->getAllMethods() as $method) {
if ($method->getParent() !== $class) {
continue;
}
if (isset($parentMethodNames[$method->getName()])) {
if (!$parentMethodNames[$method->getName()]) {
++$numberOfOverwrittenMethods;
}
} else {
++$numberOfAddedMethods;
}
}
$uuid = $class->getUuid();
$this->nodeMetrics[$uuid][self::M_NUMBER_OF_ADDED_METHODS]
= $numberOfAddedMethods;
$this->nodeMetrics[$uuid][self::M_NUMBER_OF_OVERWRITTEN_METHODS]
= $numberOfOverwrittenMethods;
}
/**
* Initializes a empty metric container for the given class node.
*
* @param PHP_Depend_Code_Class $class The context class instance.
*
* @return void
* @since 0.9.10
*/
private function initNodeMetricsForClass(PHP_Depend_Code_Class $class)
{
$uuid = $class->getUuid();
if (isset($this->nodeMetrics[$uuid])) {
return;
}
++$this->numberOfClasses;
$this->nodeMetrics[$uuid] = array(
self::M_DEPTH_OF_INHERITANCE_TREE => 0,
self::M_NUMBER_OF_ADDED_METHODS => 0,
self::M_NUMBER_OF_DERIVED_CLASSES => 0,
self::M_NUMBER_OF_OVERWRITTEN_METHODS => 0
);
foreach ($class->getParentClasses() as $parent) {
$this->initNodeMetricsForClass($parent);
}
}
}
|