/usr/share/php/ApiGen/Templating/Filters/AnnotationFilters.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 | <?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;
use ApiGen\Configuration\Configuration;
use ApiGen\Configuration\ConfigurationOptions as CO;
use Nette;
class AnnotationFilters extends Filters
{
/**
* @var array
*/
private $rename = [
'usedby' => 'used by'
];
/**
* @var string[]
*/
private $remove = [
'package', 'subpackage', 'property', 'property-read', 'property-write', 'method', 'abstract', 'access',
'final', 'filesource', 'global', 'name', 'static', 'staticvar'
];
/**
* @var array
*/
private $order = [
'deprecated' => 0,
'category' => 1,
'copyright' => 2,
'license' => 3,
'author' => 4,
'version' => 5,
'since' => 6,
'see' => 7,
'uses' => 8,
'usedby' => 9,
'link' => 10,
'internal' => 11,
'example' => 12,
'tutorial' => 13,
'todo' => 14
];
/**
* @var Configuration
*/
private $configuration;
public function __construct(Configuration $configuration)
{
$this->configuration = $configuration;
}
/**
* @param string $name
* @return string
*/
public function annotationBeautify($name)
{
if (isset($this->rename[$name])) {
$name = $this->rename[$name];
}
return Nette\Utils\Strings::firstUpper($name);
}
/**
* @return array
*/
public function annotationFilter(array $annotations, array $customToRemove = [])
{
$annotations = $this->filterOut($annotations, $this->remove);
$annotations = $this->filterOut($annotations, $customToRemove);
if ( ! $this->configuration->getOption(CO::INTERNAL)) {
unset($annotations['internal']);
}
if ( ! $this->configuration->getOption(CO::TODO)) {
unset($annotations['todo']);
}
return $annotations;
}
/**
* @return array
*/
public function annotationSort(array $annotations)
{
uksort($annotations, function ($one, $two) {
if (isset($this->order[$one], $this->order[$two])) {
return $this->order[$one] - $this->order[$two];
} elseif (isset($this->order[$one])) {
return -1;
} elseif (isset($this->order[$two])) {
return 1;
} else {
return strcasecmp($one, $two);
}
});
return $annotations;
}
/**
* @return array
*/
private function filterOut(array $annotations, array $toRemove)
{
foreach ($toRemove as $annotation) {
unset($annotations[$annotation]);
}
return $annotations;
}
}
|