/usr/share/php/ApiGen/Templating/Filters/PhpManualFilters.php is in php-apigen 4.1.2-1ubuntu2.
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 | <?php
/**
* This file is part of the ApiGen (http://apigen.org)
*
* For the full copyright and license information, please view
* the file license.md that was distributed with this source code.
*/
namespace ApiGen\Templating\Filters;
use ApiGen\Reflection\ReflectionClass;
use ApiGen\Reflection\ReflectionConstant;
use ApiGen\Reflection\ReflectionElement;
use ApiGen\Reflection\ReflectionExtension;
use ApiGen\Reflection\ReflectionMethod;
use ApiGen\Reflection\ReflectionProperty;
/**
* Builds links to a element documentation at php.net
*/
class PhpManualFilters extends Filters
{
const PHP_MANUAL_URL = 'http://php.net/manual/en';
/**
* @var array [ className => callback ]
*/
private $assignments = [];
public function __construct()
{
$this->prepareAssignments();
}
/**
* @param ReflectionElement|ReflectionExtension|ReflectionMethod $element
* @return string
*/
public function manualUrl($element)
{
if ($element instanceof ReflectionExtension) {
return $this->createExtensionUrl($element);
}
$class = $this->detectClass($element);
if ($class && $this->isReservedClass($class)) {
return self::PHP_MANUAL_URL . '/reserved.classes.php';
}
$className = get_class($element);
if (isset($this->assignments[$className])) {
return $this->assignments[$className]($element, $class);
}
return '';
}
/**
* @return string
*/
private function createExtensionUrl(ReflectionExtension $reflectionExtension)
{
$extensionName = strtolower($reflectionExtension->getName());
if ($extensionName === 'core') {
return self::PHP_MANUAL_URL;
}
if ($extensionName === 'date') {
$extensionName = 'datetime';
}
return self::PHP_MANUAL_URL . '/book.' . $extensionName . '.php';
}
/**
* @return array
*/
private function prepareAssignments()
{
$this->assignments['ApiGen\Reflection\ReflectionClass'] = function ($element, $class) {
return $this->createClassUrl($class);
};
$this->assignments['ApiGen\Reflection\ReflectionMethod'] = function ($element, $class) {
return $this->createMethodUrl($element, $class);
};
$this->assignments['ApiGen\Reflection\ReflectionFunction'] = function ($element, $class) {
return $this->createFunctionUrl($element);
};
$this->assignments['ApiGen\Reflection\ReflectionProperty'] = function ($element, $class) {
return $this->createPropertyUrl($element, $class);
};
$this->assignments['ApiGen\Reflection\ReflectionConstant'] = function ($element, $class) {
return $this->createConstantUrl($element, $class);
};
}
/**
* @return string
*/
private function createClassUrl(ReflectionClass $classReflection)
{
return self::PHP_MANUAL_URL . '/class.' . strtolower($classReflection->getName()) . '.php';
}
/**
* @return string
*/
private function createConstantUrl(ReflectionConstant $reflectionConstant, ReflectionClass $classReflection)
{
return $this->createClassUrl($classReflection) . '#' . strtolower($classReflection->getName()) .
'.constants.' . $this->getElementName($reflectionConstant);
}
/**
* @return string
*/
private function createPropertyUrl(ReflectionProperty $reflectionProperty, ReflectionClass $classReflection)
{
return $this->createClassUrl($classReflection) . '#' . strtolower($classReflection->getName()) .
'.props.' . $this->getElementName($reflectionProperty);
}
/**
* @return string
*/
private function createMethodUrl(ReflectionMethod $reflectionMethod, ReflectionClass $reflectionClass)
{
return self::PHP_MANUAL_URL . '/' . strtolower($reflectionClass->getName()) . '.' .
$this->getElementName($reflectionMethod) . '.php';
}
/**
* @return string
*/
private function createFunctionUrl(ReflectionElement $reflectionElement)
{
return self::PHP_MANUAL_URL . '/function.' . strtolower($reflectionElement->getName()) . '.php';
}
/**
* @return bool
*/
private function isReservedClass(ReflectionClass $class)
{
$reservedClasses = ['stdClass', 'Closure', 'Directory'];
return (in_array($class->getName(), $reservedClasses));
}
/**
* @return string
*/
private function getElementName(ReflectionElement $element)
{
return strtolower(strtr(ltrim($element->getName(), '_'), '_', '-'));
}
/**
* @param ReflectionElement|string $element
* @return string
*/
private function detectClass($element)
{
if ($element instanceof ReflectionClass) {
return $element;
}
if ($element instanceof ReflectionMethod || $element instanceof ReflectionProperty
|| $element instanceof ReflectionConstant
) {
return $element->getDeclaringClass();
}
return '';
}
}
|