/usr/share/php/PHP/Depend/Code/AbstractCallable.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 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 | <?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 Code
* @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/
*/
/**
* Abstract base class for callable objects.
*
* Callable objects is a generic parent for methods and functions.
*
* @category QualityAssurance
* @package PHP_Depend
* @subpackage Code
* @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/
*/
abstract class PHP_Depend_Code_AbstractCallable
extends PHP_Depend_Code_AbstractItem
{
/**
* The type of this class.
*
* @since 0.10.0
*/
const CLAZZ = __CLASS__;
/**
* The internal used cache instance.
*
* @var PHP_Depend_Util_Cache_Driver
* @since 0.10.0
*/
protected $cache = null;
/**
* A reference instance for the return value of this callable. By
* default and for any scalar type this property is <b>null</b>.
*
* @var PHP_Depend_Code_ASTClassOrInterfaceReference
* @since 0.9.5
*/
protected $returnClassReference = null;
/**
* List of all exceptions classes referenced by this callable.
*
* @var PHP_Depend_Code_ASTClassOrInterfaceReference[]
* @since 0.9.5
*/
protected $exceptionClassReferences = array();
/**
* Does this callable return a value by reference?
*
* @var boolean
*/
protected $returnsReference = false;
/**
* List of all parsed child nodes.
*
* @var PHP_Depend_Code_ASTNode[]
* @since 0.9.6
*/
protected $nodes = array();
/**
* The start line number of the method or function declaration.
*
* @var integer
* @since 0.9.12
*/
protected $startLine = 0;
/**
* The end line number of the method or function declaration.
*
* @var integer
* @since 0.9.12
*/
protected $endLine = 0;
/**
* List of method/function parameters.
*
* @var PHP_Depend_Code_Parameter[]
*/
private $parameters = null;
/**
* Setter method for the currently used token cache, where this callable
* instance can store the associated tokens.
*
* @param PHP_Depend_Util_Cache_Driver $cache The currently used cache instance.
*
* @return PHP_Depend_Code_AbstractCallable
* @since 0.10.0
*/
public function setCache(PHP_Depend_Util_Cache_Driver $cache)
{
$this->cache = $cache;
return $this;
}
/**
* Adds a parsed child node to this node.
*
* @param PHP_Depend_Code_ASTNode $node A parsed child node instance.
*
* @return void
* @access private
* @since 0.9.6
*/
public function addChild(PHP_Depend_Code_ASTNode $node)
{
$this->nodes[] = $node;
}
/**
* Returns all child nodes of this method.
*
* @return PHP_Depend_Code_ASTNode[]
* @since 0.9.8
*/
public function getChildren()
{
return $this->nodes;
}
/**
* This method will search recursive for the first child node that is an
* instance of the given <b>$targetType</b>. The returned value will be
* <b>null</b> if no child exists for that.
*
* @param string $targetType Searched class or interface type.
*
* @return PHP_Depend_Code_ASTNode
* @access private
* @since 0.9.6
*/
public function getFirstChildOfType($targetType)
{
foreach ($this->nodes as $node) {
if ($node instanceof $targetType) {
return $node;
}
if (($child = $node->getFirstChildOfType($targetType)) !== null) {
return $child;
}
}
return null;
}
/**
* Will find all children for the given type.
*
* @param string $targetType The target class or interface type.
* @param array &$results The found children.
*
* @return PHP_Depend_Code_ASTNode[]
* @access private
* @since 0.9.6
*/
public function findChildrenOfType($targetType, array &$results = array())
{
foreach ($this->nodes as $node) {
if ($node instanceof $targetType) {
$results[] = $node;
}
$node->findChildrenOfType($targetType, $results);
}
return $results;
}
/**
* Returns the tokens found in the function body.
*
* @return array(mixed)
*/
public function getTokens()
{
return (array) $this->cache
->type('tokens')
->restore($this->uuid);
}
/**
* Sets the tokens found in the function body.
*
* @param PHP_Depend_Token[] $tokens The body tokens.
*
* @return void
*/
public function setTokens(array $tokens)
{
$this->startLine = reset($tokens)->startLine;
$this->endLine = end($tokens)->endLine;
$this->cache
->type('tokens')
->store($this->uuid, $tokens);
}
/**
* Returns the line number where the callable declaration starts.
*
* @return integer
* @since 0.9.6
*/
public function getStartLine()
{
return $this->startLine;
}
/**
* Returns the line number where the callable declaration ends.
*
* @return integer
* @since 0.9.6
*/
public function getEndLine()
{
return $this->endLine;
}
/**
* Returns all {@link PHP_Depend_Code_AbstractClassOrInterface} objects this
* function depends on.
*
* @return PHP_Depend_Code_NodeIterator
*/
public function getDependencies()
{
return new PHP_Depend_Code_ClassOrInterfaceReferenceIterator(
$this->findChildrenOfType(
PHP_Depend_Code_ASTClassOrInterfaceReference::CLAZZ
)
);
}
/**
* This method will return a class or interface instance that represents
* the return value of this callable. The returned value will be <b>null</b>
* if there is no return value or the return value is scalat.
*
* @return PHP_Depend_Code_ASTClassOrInterfaceReference
* @since 0.9.5
*/
public function getReturnClass()
{
if ($this->returnClassReference === null) {
return null;
}
return $this->returnClassReference->getType();
}
/**
* This method can be used to set a reference instance for the declared
* function return type.
*
* @param PHP_Depend_Code_ASTClassOrInterfaceReference $classReference Holder
* instance for the declared function return type.
*
* @return void
* @since 0.9.5
*/
public function setReturnClassReference(
PHP_Depend_Code_ASTClassOrInterfaceReference $classReference
) {
$this->returnClassReference = $classReference;
}
/**
* Adds a reference holder for a thrown exception class or interface to
* this callable.
*
* @param PHP_Depend_Code_ASTClassOrInterfaceReference $classReference A
* reference instance for a thrown exception.
*
* @return void
* @since 0.9.5
*/
public function addExceptionClassReference(
PHP_Depend_Code_ASTClassOrInterfaceReference $classReference
) {
$this->exceptionClassReferences[] = $classReference;
}
/**
* Returns an iterator with thrown exception
* {@link PHP_Depend_Code_AbstractClassOrInterface} instances.
*
* @return PHP_Depend_Code_NodeIterator
*/
public function getExceptionClasses()
{
return new PHP_Depend_Code_ClassOrInterfaceReferenceIterator(
$this->exceptionClassReferences
);
}
/**
* Returns an array with all method/function parameters.
*
* @return PHP_Depend_Code_Parameter[]
*/
public function getParameters()
{
if ($this->parameters === null) {
$this->initParameters();
}
return $this->parameters;
}
/**
* This method will return <b>true</b> when this method returns a value by
* reference, otherwise the return value will be <b>false</b>.
*
* @return boolean
* @since 0.9.5
*/
public function returnsReference()
{
return $this->returnsReference;
}
/**
* A call to this method will flag the callable instance with the returns
* reference flag, which means that the context function or method returns
* a value by reference.
*
* @return void
* @since 0.9.5
*/
public function setReturnsReference()
{
$this->returnsReference = true;
}
/**
* Returns an array with all declared static variables.
*
* @return array
* @since 0.9.6
*/
public function getStaticVariables()
{
$staticVariables = array();
$declarations = $this->findChildrenOfType(
PHP_Depend_Code_ASTStaticVariableDeclaration::CLAZZ
);
foreach ($declarations as $declaration) {
$variables = $declaration->findChildrenOfType(
PHP_Depend_Code_ASTVariableDeclarator::CLAZZ
);
foreach ($variables as $variable) {
$image = $variable->getImage();
$value = $variable->getValue();
if ($value !== null) {
$value = $value->getValue();
}
$staticVariables[substr($image, 1)] = $value;
}
}
return $staticVariables;
}
/**
* This method will return <b>true</b> when this callable instance was
* restored from the cache and not currently parsed. Otherwise this method
* will return <b>false</b>.
*
* @return boolean
* @since 0.10.0
*/
public function isCached()
{
return $this->sourceFile->isCached();
}
/**
* This method will initialize the <b>$_parameters</b> property.
*
* @return void
* @since 0.9.6
*/
private function initParameters()
{
$parameters = array();
$formalParameters = $this->getFirstChildOfType(
PHP_Depend_Code_ASTFormalParameters::CLAZZ
);
$formalParameters = $formalParameters->findChildrenOfType(
PHP_Depend_Code_ASTFormalParameter::CLAZZ
);
foreach ($formalParameters as $formalParameter) {
$parameter = new PHP_Depend_Code_Parameter(
$formalParameter
);
$parameter->setDeclaringFunction($this);
$parameter->setPosition(count($parameters));
$parameters[] = $parameter;
}
$optional = true;
foreach (array_reverse($parameters) as $parameter) {
if ($parameter->isDefaultValueAvailable() === false) {
$optional = false;
}
$parameter->setOptional($optional);
}
$this->parameters = $parameters;
}
/**
* The magic sleep method will be called by the PHP engine when this class
* gets serialized. It returns an array with those properties that should be
* cached for all callable instances.
*
* @return array
* @since 0.10.0
*/
public function __sleep()
{
return array(
'cache',
'uuid',
'name',
'nodes',
'startLine',
'endLine',
'docComment',
'returnsReference',
'returnClassReference',
'exceptionClassReferences'
);
}
// @codeCoverageIgnoreStart
/**
* This method can be called by the PHP_Depend runtime environment or a
* utilizing component to free up memory. This methods are required for
* PHP version < 5.3 where cyclic references can not be resolved
* automatically by PHP's garbage collector.
*
* @return void
* @since 0.9.12
*/
public function free()
{
trigger_error(__METHOD__ . '() is deprecated.', E_USER_DEPRECATED);
}
// @codeCoverageIgnoreEnd
}
|