/usr/share/php/ApiGen/ReflectionElement.php is in php-apigen 2.8.0+dfsg-3.
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 | <?php
/**
* ApiGen 2.8.0 - API documentation generator for PHP 5.3+
*
* Copyright (c) 2010-2011 David Grudl (http://davidgrudl.com)
* Copyright (c) 2011-2012 Jaroslav Hanslík (https://github.com/kukulich)
* Copyright (c) 2011-2012 Ondřej Nešpor (https://github.com/Andrewsville)
*
* For the full copyright and license information, please view
* the file LICENSE.md that was distributed with this source code.
*/
namespace ApiGen;
/**
* Element reflection envelope.
*
* Alters TokenReflection\IReflection functionality for ApiGen.
*/
abstract class ReflectionElement extends ReflectionBase
{
/**
* Cache for information if the element should be documented.
*
* @var boolean
*/
protected $isDocumented;
/**
* Reflection elements annotations.
*
* @var array
*/
protected $annotations;
/**
* Returns the PHP extension reflection.
*
* @return \ApiGen\ReflectionExtension|null
*/
public function getExtension()
{
$extension = $this->reflection->getExtension();
return null === $extension ? null : new ReflectionExtension($extension, self::$generator);
}
/**
* Returns the PHP extension name.
*
* @return boolean
*/
public function getExtensionName()
{
return $this->reflection->getExtensionName();
}
/**
* Returns the start position in the file token stream.
*
* @return integer
*/
public function getStartPosition()
{
return $this->reflection->getStartPosition();
}
/**
* Returns the end position in the file token stream.
*
* @return integer
*/
public function getEndPosition()
{
return $this->reflection->getEndPosition();
}
/**
* Returns if the element belongs to main project.
*
* @return boolean
*/
public function isMain()
{
return empty(self::$config->main) || 0 === strpos($this->getName(), self::$config->main);
}
/**
* Returns if the element should be documented.
*
* @return boolean
*/
public function isDocumented()
{
if (null === $this->isDocumented) {
$this->isDocumented = $this->reflection->isTokenized() || $this->reflection->isInternal();
if ($this->isDocumented) {
if (!self::$config->php && $this->reflection->isInternal()) {
$this->isDocumented = false;
} elseif (!self::$config->deprecated && $this->reflection->isDeprecated()) {
$this->isDocumented = false;
} elseif (!self::$config->internal && ($internal = $this->reflection->getAnnotation('internal')) && empty($internal[0])) {
$this->isDocumented = false;
} elseif (count($this->reflection->getAnnotation('ignore')) > 0) {
$this->isDocumented = false;
}
}
}
return $this->isDocumented;
}
/**
* Returns if the element is deprecated.
*
* @return boolean
*/
public function isDeprecated()
{
if ($this->reflection->isDeprecated()) {
return true;
}
if (($this instanceof ReflectionMethod || $this instanceof ReflectionProperty || $this instanceof ReflectionConstant)
&& $class = $this->getDeclaringClass()
) {
return $class->isDeprecated();
}
return false;
}
/**
* Returns if the element is in package.
*
* @return boolean
*/
public function inPackage()
{
return '' !== $this->getPackageName();
}
/**
* Returns element package name (including subpackage name).
*
* @return string
*/
public function getPackageName()
{
static $packages = array();
if ($package = $this->getAnnotation('package')) {
$packageName = preg_replace('~\s+.*~s', '', $package[0]);
if (empty($packageName)) {
return '';
}
if ($subpackage = $this->getAnnotation('subpackage')) {
$subpackageName = preg_replace('~\s+.*~s', '', $subpackage[0]);
if (empty($subpackageName)) {
// Do nothing
} elseif (0 === strpos($subpackageName, $packageName)) {
$packageName = $subpackageName;
} else {
$packageName .= '\\' . $subpackageName;
}
}
$packageName = strtr($packageName, '._/', '\\\\\\');
$lowerPackageName = strtolower($packageName);
if (!isset($packages[$lowerPackageName])) {
$packages[$lowerPackageName] = $packageName;
}
return $packages[$lowerPackageName];
}
return '';
}
/**
* Returns element package name (including subpackage name).
*
* For internal elements returns "PHP", for elements in global space returns "None".
*
* @return string
*/
public function getPseudoPackageName()
{
if ($this->isInternal()) {
return 'PHP';
}
return $this->getPackageName() ?: 'None';
}
/**
* Returns if the element is defined within a namespace.
*
* @return boolean
*/
public function inNamespace()
{
return '' !== $this->getNamespaceName();
}
/**
* Returns element namespace name.
*
* @return string
*/
public function getNamespaceName()
{
static $namespaces = array();
$namespaceName = $this->reflection->getNamespaceName();
if (!$namespaceName) {
return $namespaceName;
}
$lowerNamespaceName = strtolower($namespaceName);
if (!isset($namespaces[$lowerNamespaceName])) {
$namespaces[$lowerNamespaceName] = $namespaceName;
}
return $namespaces[$lowerNamespaceName];
}
/**
* Returns element namespace name.
*
* For internal elements returns "PHP", for elements in global space returns "None".
*
* @return string
*/
public function getPseudoNamespaceName()
{
return $this->isInternal() ? 'PHP' : $this->getNamespaceName() ?: 'None';
}
/**
* Returns imported namespaces and aliases from the declaring namespace.
*
* @return array
*/
public function getNamespaceAliases()
{
return $this->reflection->getNamespaceAliases();
}
/**
* Returns the short description.
*
* @return string
*/
public function getShortDescription()
{
$short = $this->reflection->getAnnotation(\TokenReflection\ReflectionAnnotation::SHORT_DESCRIPTION);
if (!empty($short)) {
return $short;
}
if ($this instanceof ReflectionProperty || $this instanceof ReflectionConstant) {
$var = $this->getAnnotation('var');
list(, $short) = preg_split('~\s+|$~', $var[0], 2);
}
return $short;
}
/**
* Returns the long description.
*
* @return string
*/
public function getLongDescription()
{
$short = $this->getShortDescription();
$long = $this->reflection->getAnnotation(\TokenReflection\ReflectionAnnotation::LONG_DESCRIPTION);
if (!empty($long)) {
$short .= "\n\n" . $long;
}
return $short;
}
/**
* Returns the appropriate docblock definition.
*
* @return string|boolean
*/
public function getDocComment()
{
return $this->reflection->getDocComment();
}
/**
* Returns reflection element annotations.
*
* Removes the short and long description.
*
* In case of classes, functions and constants, @package, @subpackage, @author and @license annotations
* are added from declaring files if not already present.
*
* @return array
*/
public function getAnnotations()
{
if (null === $this->annotations) {
static $fileLevel = array('package' => true, 'subpackage' => true, 'author' => true, 'license' => true, 'copyright' => true);
$annotations = $this->reflection->getAnnotations();
unset($annotations[\TokenReflection\ReflectionAnnotation::SHORT_DESCRIPTION]);
unset($annotations[\TokenReflection\ReflectionAnnotation::LONG_DESCRIPTION]);
if ($this->reflection instanceof \TokenReflection\ReflectionClass || $this->reflection instanceof \TokenReflection\ReflectionFunction || ($this->reflection instanceof \TokenReflection\ReflectionConstant && null === $this->reflection->getDeclaringClassName())) {
foreach ($this->reflection->getFileReflection()->getAnnotations() as $name => $value) {
if (isset($fileLevel[$name]) && empty($annotations[$name])) {
$annotations[$name] = $value;
}
}
}
$this->annotations = $annotations;
}
return $this->annotations;
}
/**
* Returns reflection element annotation.
*
* @param string $annotation Annotation name
* @return array
*/
public function getAnnotation($annotation)
{
$annotations = $this->getAnnotations();
return isset($annotations[$annotation]) ? $annotations[$annotation] : null;
}
/**
* Checks if there is a particular annotation.
*
* @param string $annotation Annotation name
* @return boolean
*/
public function hasAnnotation($annotation)
{
$annotations = $this->getAnnotations();
return isset($annotations[$annotation]);
}
/**
* Adds element annotation.
*
* @param string $annotation Annotation name
* @param string $value Annotation value
* @return \ApiGen\ReflectionElement
*/
public function addAnnotation($annotation, $value)
{
if (null === $this->annotations) {
$this->getAnnotations();
}
$this->annotations[$annotation][] = $value;
return $this;
}
}
|