/usr/share/php/PHP/Depend/Code/Package.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 | <?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/
*/
/**
* Represents a php package node.
*
* @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_Package implements PHP_Depend_Code_NodeI
{
/**
* The type of this class.
*
* @since 0.10.0
*/
const CLAZZ = __CLASS__;
/**
* The package name.
*
* @var string
*/
protected $name = '';
/**
* The unique identifier for this function.
*
* @var string
*/
protected $uuid = null;
/**
* List of all {@link PHP_Depend_Code_AbstractClassOrInterface} objects for
* this package.
*
* @var PHP_Depend_Code_AbstractClassOrInterface[]
*/
protected $types = array();
/**
* List of all standalone {@link PHP_Depend_Code_Function} objects in this
* package.
*
* @var PHP_Depend_Code_Function[]
*/
protected $functions = array();
/**
* Does this package contain user defined functions, classes or interfaces?
*
* @var boolean
*/
private $userDefined = null;
/**
* Constructs a new package for the given <b>$name</b>
*
* @param string $name The package name.
*/
public function __construct($name)
{
$this->name = $name;
$this->uuid = spl_object_hash($this);
}
/**
* Returns the package name.
*
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Returns a uuid for this code node.
*
* @return string
*/
public function getUuid()
{
return $this->uuid;
}
/**
* Returns <b>true</b> when at least one artifact <b>function</b> or a
* <b>class/method</b> is user defined. Otherwise this method will return
* <b>false</b>.
*
* @return boolean
* @since 0.9.10
*/
public function isUserDefined()
{
if ($this->userDefined === null) {
$this->userDefined = $this->checkUserDefined();
}
return $this->userDefined;
}
/**
* Returns <b>true</b> when at least one artifact <b>function</b> or a
* <b>class/method</b> is user defined. Otherwise this method will return
* <b>false</b>.
*
* @return boolean
* @since 0.9.10
*/
private function checkUserDefined()
{
foreach ($this->types as $type) {
if ($type->isUserDefined()) {
return true;
}
}
return (count($this->functions) > 0);
}
/**
* Returns an array with all {@link PHP_Depend_Code_Trait} instances
* declared in this package.
*
* @return array
* @since 1.0.0
*/
public function getTraits()
{
return $this->getTypesOfType(PHP_Depend_Code_Trait::CLAZZ);
}
/**
* Returns an iterator with all {@link PHP_Depend_Code_Class} instances
* within this package.
*
* @return PHP_Depend_Code_NodeIterator
*/
public function getClasses()
{
return $this->getTypesOfType(PHP_Depend_Code_Class::CLAZZ);
}
/**
* Returns an iterator with all {@link PHP_Depend_Code_Interface} instances
* within this package.
*
* @return PHP_Depend_Code_NodeIterator
*/
public function getInterfaces()
{
return $this->getTypesOfType(PHP_Depend_Code_Interface::CLAZZ);
}
/**
* Returns an iterator with all types of the given <b>$className</b> in this
* package.
*
* @param string $className The class/type we are looking for.
*
* @return PHP_Depend_Code_NodeIterator
* @since 1.0.0
*/
private function getTypesOfType($className)
{
$types = array();
foreach ($this->types as $type) {
if (get_class($type) === $className) {
$types[] = $type;
}
}
return new PHP_Depend_Code_NodeIterator($types);
}
/**
* Returns all {@link PHP_Depend_Code_AbstractType} objects in
* this package.
*
* @return PHP_Depend_Code_NodeIterator
*/
public function getTypes()
{
return new PHP_Depend_Code_NodeIterator($this->types);
}
/**
* Adds the given type to this package and returns the input type instance.
*
* @param PHP_Depend_Code_AbstractType $type The new package type.
*
* @return PHP_Depend_Code_AbstractType
*/
public function addType(PHP_Depend_Code_AbstractType $type)
{
// Skip if this package already contains this type
if (in_array($type, $this->types, true)) {
return $type;
}
if ($type->getPackage() !== null) {
$type->getPackage()->removeType($type);
}
// Set this as class package
$type->setPackage($this);
// Append class to internal list
$this->types[$type->getUuid()] = $type;
return $type;
}
/**
* Removes the given type instance from this package.
*
* @param PHP_Depend_Code_AbstractType $type The type instance to remove.
*
* @return void
*/
public function removeType(PHP_Depend_Code_AbstractType $type)
{
if (($index = array_search($type, $this->types, true)) !== false) {
// Remove class from internal list
unset($this->types[$index]);
// Remove this as parent
$type->unsetPackage();
}
}
/**
* Returns all {@link PHP_Depend_Code_Function} objects in this package.
*
* @return PHP_Depend_Code_NodeIterator
*/
public function getFunctions()
{
return new PHP_Depend_Code_NodeIterator($this->functions);
}
/**
* Adds the given function to this package and returns the input instance.
*
* @param PHP_Depend_Code_Function $function The new package function.
*
* @return PHP_Depend_Code_Function
*/
public function addFunction(PHP_Depend_Code_Function $function)
{
if ($function->getPackage() !== null) {
$function->getPackage()->removeFunction($function);
}
// Set this as function package
$function->setPackage($this);
// Append function to internal list
$this->functions[$function->getUuid()] = $function;
return $function;
}
/**
* Removes the given function from this package.
*
* @param PHP_Depend_Code_Function $function The function to remove
*
* @return void
*/
public function removeFunction(PHP_Depend_Code_Function $function)
{
if (($index = array_search($function, $this->functions, true)) !== false) {
// Remove function from internal list
unset($this->functions[$index]);
// Remove this as parent
$function->unsetPackage();
}
}
/**
* 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->visitPackage($this);
}
// @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 1.0.0
*/
public function free()
{
trigger_error(__METHOD__ . '() is deprecated.', E_USER_DEPRECATED);
}
// @codeCoverageIgnoreEnd
}
|