/usr/share/php/PHP/Depend/Metrics/ClassLevel/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 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 | <?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/
*/
/**
* Generates some class level based metrics. This analyzer is based on the
* metrics specified in the following document.
*
* http://www.aivosto.com/project/help/pm-oo-misc.html
*
* @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_ClassLevel_Analyzer
extends PHP_Depend_Metrics_AbstractAnalyzer
implements PHP_Depend_Metrics_AggregateAnalyzerI,
PHP_Depend_Metrics_FilterAwareI,
PHP_Depend_Metrics_NodeAwareI
{
/**
* Type of this analyzer class.
*/
const CLAZZ = __CLASS__;
/**
* Metrics provided by the analyzer implementation.
*/
const M_IMPLEMENTED_INTERFACES = 'impl',
M_CLASS_INTERFACE_SIZE = 'cis',
M_CLASS_SIZE = 'csz',
M_NUMBER_OF_PUBLIC_METHODS = 'npm',
M_PROPERTIES = 'vars',
M_PROPERTIES_INHERIT = 'varsi',
M_PROPERTIES_NON_PRIVATE = 'varsnp',
M_WEIGHTED_METHODS = 'wmc',
M_WEIGHTED_METHODS_INHERIT = 'wmci',
M_WEIGHTED_METHODS_NON_PRIVATE = 'wmcnp';
/**
* Hash with all calculated node metrics.
*
* <code>
* array(
* '0375e305-885a-4e91-8b5c-e25bda005438' => array(
* 'loc' => 42,
* 'ncloc' => 17,
* 'cc' => 12
* ),
* 'e60c22f0-1a63-4c40-893e-ed3b35b84d0b' => array(
* 'loc' => 42,
* 'ncloc' => 17,
* 'cc' => 12
* )
* )
* </code>
*
* @var array(string=>array)
*/
private $nodeMetrics = null;
/**
* The internal used cyclomatic complexity analyzer.
*
* @var PHP_Depend_Metrics_CyclomaticComplexity_Analyzer
*/
private $cyclomaticAnalyzer = null;
/**
* 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) {
// First check for the require cc analyzer
if ($this->cyclomaticAnalyzer === null) {
throw new RuntimeException('Missing required CC analyzer.');
}
$this->fireStartAnalyzer();
$this->cyclomaticAnalyzer->analyze($packages);
// Init node metrics
$this->nodeMetrics = array();
// Visit all nodes
foreach ($packages as $package) {
$package->accept($this);
}
$this->fireEndAnalyzer();
}
}
/**
* This method must return an <b>array</b> of class names for required
* analyzers.
*
* @return array(string)
*/
public function getRequiredAnalyzers()
{
return array(
PHP_Depend_Metrics_CyclomaticComplexity_Analyzer::CLAZZ
);
}
/**
* Adds a required sub analyzer.
*
* @param PHP_Depend_Metrics_AnalyzerI $analyzer The sub analyzer instance.
*
* @return void
*/
public function addAnalyzer(PHP_Depend_Metrics_AnalyzerI $analyzer)
{
if ($analyzer instanceof PHP_Depend_Metrics_CyclomaticComplexity_Analyzer) {
$this->cyclomaticAnalyzer = $analyzer;
} else {
throw new InvalidArgumentException('CC Analyzer required.');
}
}
/**
* 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)
{
$metrics = array();
if (isset($this->nodeMetrics[$node->getUuid()])) {
$metrics = $this->nodeMetrics[$node->getUuid()];
}
return $metrics;
}
/**
* 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)
{
$this->fireStartClass($class);
$impl = $class->getInterfaces()->count();
$varsi = $this->calculateVarsi($class);
$wmci = $this->calculateWmciForClass($class);
$this->nodeMetrics[$class->getUuid()] = array(
self::M_IMPLEMENTED_INTERFACES => $impl,
self::M_CLASS_INTERFACE_SIZE => 0,
self::M_CLASS_SIZE => 0,
self::M_NUMBER_OF_PUBLIC_METHODS => 0,
self::M_PROPERTIES => 0,
self::M_PROPERTIES_INHERIT => $varsi,
self::M_PROPERTIES_NON_PRIVATE => 0,
self::M_WEIGHTED_METHODS => 0,
self::M_WEIGHTED_METHODS_INHERIT => $wmci,
self::M_WEIGHTED_METHODS_NON_PRIVATE => 0
);
foreach ($class->getProperties() as $property) {
$property->accept($this);
}
foreach ($class->getMethods() as $method) {
$method->accept($this);
}
$this->fireEndClass($class);
}
/**
* Visits a code interface object.
*
* @param PHP_Depend_Code_Interface $interface The context code interface.
*
* @return void
* @see PHP_Depend_VisitorI::visitInterface()
*/
public function visitInterface(PHP_Depend_Code_Interface $interface)
{
// Empty visit method, we don't want interface metrics
}
/**
* Visits a trait node.
*
* @param PHP_Depend_Code_Trait $trait The current trait node.
*
* @return void
* @since 1.0.0
*/
public function visitTrait(PHP_Depend_Code_Trait $trait)
{
$this->fireStartTrait($trait);
$wmci = $this->calculateWmciForTrait($trait);
$this->nodeMetrics[$trait->getUuid()] = array(
self::M_IMPLEMENTED_INTERFACES => 0,
self::M_CLASS_INTERFACE_SIZE => 0,
self::M_CLASS_SIZE => 0,
self::M_NUMBER_OF_PUBLIC_METHODS => 0,
self::M_PROPERTIES => 0,
self::M_PROPERTIES_INHERIT => 0,
self::M_PROPERTIES_NON_PRIVATE => 0,
self::M_WEIGHTED_METHODS => 0,
self::M_WEIGHTED_METHODS_INHERIT => $wmci,
self::M_WEIGHTED_METHODS_NON_PRIVATE => 0
);
foreach ($trait->getProperties() as $property) {
$property->accept($this);
}
foreach ($trait->getMethods() as $method) {
$method->accept($this);
}
$this->fireEndTrait($trait);
}
/**
* Visits a method node.
*
* @param PHP_Depend_Code_Class $method The method class node.
*
* @return void
* @see PHP_Depend_VisitorI::visitMethod()
*/
public function visitMethod(PHP_Depend_Code_Method $method)
{
$this->fireStartMethod($method);
// Get parent class uuid
$uuid = $method->getParent()->getUuid();
$ccn = $this->cyclomaticAnalyzer->getCcn2($method);
// Increment Weighted Methods Per Class(WMC) value
$this->nodeMetrics[$uuid][self::M_WEIGHTED_METHODS] += $ccn;
// Increment Class Size(CSZ) value
++$this->nodeMetrics[$uuid][self::M_CLASS_SIZE];
// Increment Non Private values
if ($method->isPublic()) {
++$this->nodeMetrics[$uuid][self::M_NUMBER_OF_PUBLIC_METHODS];
// Increment Non Private WMC value
$this->nodeMetrics[$uuid][self::M_WEIGHTED_METHODS_NON_PRIVATE] += $ccn;
// Increment Class Interface Size(CIS) value
++$this->nodeMetrics[$uuid][self::M_CLASS_INTERFACE_SIZE];
}
$this->fireEndMethod($method);
}
/**
* Visits a property node.
*
* @param PHP_Depend_Code_Property $property The property class node.
*
* @return void
* @see PHP_Depend_VisitorI::visitProperty()
*/
public function visitProperty(PHP_Depend_Code_Property $property)
{
$this->fireStartProperty($property);
// Get parent class uuid
$uuid = $property->getDeclaringClass()->getUuid();
// Increment VARS value
++$this->nodeMetrics[$uuid][self::M_PROPERTIES];
// Increment Class Size(CSZ) value
++$this->nodeMetrics[$uuid][self::M_CLASS_SIZE];
// Increment Non Private values
if ($property->isPublic()) {
// Increment Non Private VARS value
++$this->nodeMetrics[$uuid][self::M_PROPERTIES_NON_PRIVATE];
// Increment Class Interface Size(CIS) value
++$this->nodeMetrics[$uuid][self::M_CLASS_INTERFACE_SIZE];
}
$this->fireEndProperty($property);
}
/**
* Calculates the Variables Inheritance of a class metric, this method only
* counts protected and public properties of parent classes.
*
* @param PHP_Depend_Code_Class $class The context class instance.
*
* @return integer
*/
private function calculateVarsi(PHP_Depend_Code_Class $class)
{
// List of properties, this method only counts not overwritten properties
$properties = array();
// Collect all properties of the context class
foreach ($class->getProperties() as $prop) {
$properties[$prop->getName()] = true;
}
foreach ($class->getParentClasses() as $parent) {
foreach ($parent->getProperties() as $prop) {
if (!$prop->isPrivate() && !isset($properties[$prop->getName()])) {
$properties[$prop->getName()] = true;
}
}
}
return count($properties);
}
/**
* Calculates the Weight Method Per Class metric, this method only counts
* protected and public methods of parent classes.
*
* @param PHP_Depend_Code_Class $class The context class instance.
*
* @return integer
*/
private function calculateWmciForClass(PHP_Depend_Code_Class $class)
{
$ccn = $this->calculateWmci($class);
foreach ($class->getParentClasses() as $parent) {
foreach ($parent->getMethods() as $method) {
if ($method->isPrivate()) {
continue;
}
if (isset($ccn[($name = $method->getName())])) {
continue;
}
$ccn[$name] = $this->cyclomaticAnalyzer->getCcn2($method);
}
}
return array_sum($ccn);
}
/**
* Calculates the Weight Method Per Class metric for a trait.
*
* @param PHP_Depend_Code_Trait $trait The context trait instance.
*
* @return integer
* @since 1.0.6
*/
private function calculateWmciForTrait(PHP_Depend_Code_Trait $trait)
{
return array_sum($this->calculateWmci($trait));
}
/**
* Calculates the Weight Method Per Class metric.
*
* @param PHP_Depend_Code_AbstractType $type The context type instance.
*
* @return integer[]
* @since 1.0.6
*/
private function calculateWmci(PHP_Depend_Code_AbstractType $type)
{
$ccn = array();
foreach ($type->getMethods() as $method) {
$ccn[$method->getName()] = $this->cyclomaticAnalyzer->getCcn2($method);
}
return $ccn;
}
}
|