/usr/share/php/PHP/Depend/Code/Parameter.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 | <?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/
*/
/**
* An instance of this class represents a function or method parameter within
* the analyzed source code.
*
* <code>
* <?php
* class PHP_Depend_BuilderI
* {
* public function buildNode($name, $line, PHP_Depend_Code_File $file) {
* }
* }
*
* function parse(PHP_Depend_BuilderI $builder, $file) {
* }
* </code>
*
* @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/
*/
class PHP_Depend_Code_Parameter
extends ReflectionParameter
implements PHP_Depend_Code_NodeI
{
/**
* The type of this class.
*
* @since 0.10.0
*/
const CLAZZ = __CLASS__;
/**
* The unique identifier for this function.
*
* @var string
*/
private $uuid = null;
/**
* The parent function or method instance.
*
* @var PHP_Depend_Code_AbstractCallable
*/
private $declaringFunction = null;
/**
* The parameter position.
*
* @var integer
*/
private $position = 0;
/**
* Is this parameter optional or mandatory?
*
* @var boolean
*/
private $optional = false;
/**
* The wrapped formal parameter instance.
*
* @var PHP_Depend_Code_ASTFormalParameter
*/
private $formalParameter = null;
/**
* The wrapped variable declarator instance.
*
* @var PHP_Depend_Code_ASTVariableDeclarator
*/
private $variableDeclarator = null;
/**
* Constructs a new parameter instance for the given AST node.
*
* @param PHP_Depend_Code_ASTFormalParameter $formalParameter The wrapped AST
* parameter node.
*/
public function __construct(PHP_Depend_Code_ASTFormalParameter $formalParameter)
{
$this->formalParameter = $formalParameter;
$this->variableDeclarator = $formalParameter->getFirstChildOfType(
PHP_Depend_Code_ASTVariableDeclarator::CLAZZ
);
$this->uuid = spl_object_hash($this);
}
/**
* Returns the item name.
*
* @return string
*/
public function getName()
{
return $this->variableDeclarator->getImage();
}
/**
* Returns a uuid for this code node.
*
* @return string
*/
public function getUuid()
{
return $this->uuid;
}
/**
* Returns the line number where the item declaration can be found.
*
* @return integer
*/
public function getStartLine()
{
return $this->formalParameter->getStartLine();
}
/**
* Returns the line number where the item declaration ends.
*
* @return integer The last source line for this item.
*/
public function getEndLine()
{
return $this->formalParameter->getEndLine();
}
/**
* Returns the parent function or method instance or <b>null</b>
*
* @return PHP_Depend_Code_AbstractCallable
* @since 0.9.5
*/
public function getDeclaringFunction()
{
return $this->declaringFunction;
}
/**
* Sets the parent function or method object.
*
* @param PHP_Depend_Code_AbstractCallable $function The parent callable.
*
* @return void
* @since 0.9.5
*/
public function setDeclaringFunction(PHP_Depend_Code_AbstractCallable $function)
{
$this->declaringFunction = $function;
}
/**
* This method will return the class where the parent method was declared.
* The returned value will be <b>null</b> if the parent is a function.
*
* @return PHP_Depend_Code_AbstractClassOrInterface
* @since 0.9.5
*/
public function getDeclaringClass()
{
// TODO: Review this for refactoring, maybe create a empty getParent()?
if ($this->declaringFunction instanceof PHP_Depend_Code_Method) {
return $this->declaringFunction->getParent();
}
return null;
}
/**
* Returns the parameter position in the method/function signature.
*
* @return integer
*/
public function getPosition()
{
return $this->position;
}
/**
* Sets the parameter position in the method/function signature.
*
* @param integer $position The parameter position.
*
* @return void
*/
public function setPosition($position)
{
$this->position = $position;
}
/**
* Returns the class type of this parameter. This method will return
* <b>null</b> for all scalar type, only classes or interfaces are used.
*
* @return PHP_Depend_Code_AbstractClassOrInterface
* @since 0.9.5
*/
public function getClass()
{
$classReference = $this->formalParameter->getFirstChildOfType(
PHP_Depend_Code_ASTClassOrInterfaceReference::CLAZZ
);
if ($classReference === null) {
return null;
}
return $classReference->getType();
}
/**
* This method will return <b>true</b> when the parameter is passed by
* reference.
*
* @return boolean
* @since 0.9.5
*/
public function isPassedByReference()
{
return $this->formalParameter->isPassedByReference();
}
/**
* This method will return <b>true</b> when the parameter was declared with
* the array type hint, otherwise the it will return <b>false</b>.
*
* @return boolean
* @since 0.9.5
*/
public function isArray()
{
$node = $this->formalParameter->getChild(0);
return ($node instanceof PHP_Depend_Code_ASTTypeArray);
}
/**
* This method will return <b>true</b> when current parameter is a simple
* scalar or it is an <b>array</b> or type explicit declared with a default
* value <b>null</b>.
*
* @return boolean
* @since 0.9.5
*/
public function allowsNull()
{
return (
(
$this->isArray() === false
&& $this->getClass() === null
) || (
$this->isDefaultValueAvailable() === true
&& $this->getDefaultValue() === null
)
);
}
/**
* This method will return <b>true</b> when this parameter is optional and
* can be left blank on invocation.
*
* @return boolean
* @since 0.9.5
*/
public function isOptional()
{
return $this->optional;
}
/**
* This method can be used to mark a parameter optional. Note that a
* parameter is only optional when it has a default value an no following
* parameter has no default value.
*
* @param boolean $optional Boolean flag that marks this parameter a
* optional or not.
*
* @return void
* @since 0.9.5
*/
public function setOptional($optional)
{
$this->optional = (boolean) $optional;
}
/**
* This method will return <b>true</b> when the parameter declaration
* contains a default value.
*
* @return boolean
* @since 0.9.5
*/
public function isDefaultValueAvailable()
{
$value = $this->variableDeclarator->getValue();
if ($value === null) {
return false;
}
return $value->isValueAvailable();
}
/**
* This method will return the declared default value for this parameter.
* Please note that this method will return <b>null</b> when no default
* value was declared, therefore you should combine calls to this method and
* {@link PHP_Depend_Code_Parameter::isDefaultValueAvailable()} to detect a
* NULL-value.
*
* @return mixed
* @since 0.9.5
*/
public function getDefaultValue()
{
$value = $this->variableDeclarator->getValue();
if ($value === null) {
return null;
}
return $value->getValue();
}
/**
* Visitor method for node tree traversal.
*
* @param PHP_Depend_VisitorI $visitor The context visitor implementation.
*
* @return void
*/
public function accept(PHP_Depend_VisitorI $visitor)
{
$visitor->visitParameter($this);
}
/**
* This method returns a string representation of this parameter.
*
* @return string
*/
public function __toString()
{
$required = $this->isOptional() ? 'optional' : 'required';
$reference = $this->isPassedByReference() ? '&' : '';
$typeHint = '';
if ($this->isArray() === true) {
$typeHint = ' array';
} else if ($this->getClass() !== null) {
$typeHint = ' ' . $this->getClass()->getName();
}
$default = '';
if ($this->isDefaultValueAvailable()) {
$default = ' = ';
$value = $this->getDefaultValue();
if ($value === null) {
$default .= 'NULL';
$typeHint .= ($typeHint !== '' ? ' or NULL' : '');
} else if ($value === false) {
$default .= 'false';
} else if ($value === true) {
$default .= 'true';
} else if (is_array($value) === true) {
$default .= 'Array';
} else if (is_string($value) === true) {
$default .= "'" . $value . "'";
} else {
$default .= $value;
}
}
return sprintf(
'Parameter #%d [ <%s>%s %s%s%s ]',
$this->position,
$required,
$typeHint,
$reference,
$this->getName(),
$default
);
}
/**
* This method can be used to export a single function or method parameter.
*
* @param string|array $function Name of the parent function.
* @param string|integer $parameter Name or offset of the export parameter.
* @param boolean $return Should this method return the export.
*
* @return string|null
*/
public static function export($function, $parameter, $return = false)
{
if (is_callable($function) === false) {
throw new ReflectionException(__METHOD__ . '() is not supported.');
}
return parent::export($function, $parameter, $return);
}
// @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
* @deprecated Since 0.10.0
*/
public function free()
{
}
// @codeCoverageIgnoreEnd
}
|