123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141 |
- <?php
- declare(strict_types=1);
- /**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Bernhard Posselt <dev@bernhard-posselt.com>
- * @author Bjoern Schiessle <bjoern@schiessle.org>
- * @author Christoph Wurst <christoph@winzerhof-wurst.at>
- * @author Daniel Kesselberg <mail@danielkesselberg.de>
- * @author Joas Schilling <coding@schilljs.com>
- * @author Lukas Reschke <lukas@statuscode.ch>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Olivier Paroz <github@oparoz.com>
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- * @author Thomas Müller <thomas.mueller@tmit.eu>
- *
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License, version 3,
- * as published by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License, version 3,
- * along with this program. If not, see <http://www.gnu.org/licenses/>
- *
- */
- namespace OC\AppFramework\Utility;
- use OCP\AppFramework\Utility\IControllerMethodReflector;
- /**
- * Reads and parses annotations from doc comments
- */
- class ControllerMethodReflector implements IControllerMethodReflector {
- public $annotations = [];
- private $types = [];
- private $parameters = [];
- /**
- * @param object $object an object or classname
- * @param string $method the method which we want to inspect
- */
- public function reflect($object, string $method) {
- $reflection = new \ReflectionMethod($object, $method);
- $docs = $reflection->getDocComment();
- if ($docs !== false) {
- // extract everything prefixed by @ and first letter uppercase
- preg_match_all('/^\h+\*\h+@(?P<annotation>[A-Z]\w+)((?P<parameter>.*))?$/m', $docs, $matches);
- foreach ($matches['annotation'] as $key => $annontation) {
- $annontation = strtolower($annontation);
- $annotationValue = $matches['parameter'][$key];
- if (isset($annotationValue[0]) && $annotationValue[0] === '(' && $annotationValue[\strlen($annotationValue) - 1] === ')') {
- $cutString = substr($annotationValue, 1, -1);
- $cutString = str_replace(' ', '', $cutString);
- $splittedArray = explode(',', $cutString);
- foreach ($splittedArray as $annotationValues) {
- [$key, $value] = explode('=', $annotationValues);
- $this->annotations[$annontation][$key] = $value;
- }
- continue;
- }
- $this->annotations[$annontation] = [$annotationValue];
- }
- // extract type parameter information
- preg_match_all('/@param\h+(?P<type>\w+)\h+\$(?P<var>\w+)/', $docs, $matches);
- $this->types = array_combine($matches['var'], $matches['type']);
- }
- foreach ($reflection->getParameters() as $param) {
- // extract type information from PHP 7 scalar types and prefer them over phpdoc annotations
- $type = $param->getType();
- if ($type instanceof \ReflectionNamedType) {
- $this->types[$param->getName()] = $type->getName();
- }
- $default = null;
- if ($param->isOptional()) {
- $default = $param->getDefaultValue();
- }
- $this->parameters[$param->name] = $default;
- }
- }
- /**
- * Inspects the PHPDoc parameters for types
- * @param string $parameter the parameter whose type comments should be
- * parsed
- * @return string|null type in the type parameters (@param int $something)
- * would return int or null if not existing
- */
- public function getType(string $parameter) {
- if (array_key_exists($parameter, $this->types)) {
- return $this->types[$parameter];
- }
- return null;
- }
- /**
- * @return array the arguments of the method with key => default value
- */
- public function getParameters(): array {
- return $this->parameters;
- }
- /**
- * Check if a method contains an annotation
- * @param string $name the name of the annotation
- * @return bool true if the annotation is found
- */
- public function hasAnnotation(string $name): bool {
- $name = strtolower($name);
- return array_key_exists($name, $this->annotations);
- }
- /**
- * Get optional annotation parameter by key
- *
- * @param string $name the name of the annotation
- * @param string $key the string of the annotation
- * @return string
- */
- public function getAnnotationParameter(string $name, string $key): string {
- $name = strtolower($name);
- if (isset($this->annotations[$name][$key])) {
- return $this->annotations[$name][$key];
- }
- return '';
- }
- }
|