/** * @param string $helperName * @param MethodReflection $methodReflection * @return string */ protected function getMethodDescription($helperName, $methodReflection) { $methodDescription = ''; $methodName = $methodReflection->getName(); $methodParameters = array(); foreach ($methodReflection->getParameters() as $parameterReflection) { $methodParameters[$parameterReflection->getName()] = $parameterReflection; } $parameterNames = array_keys($methodParameters); $methodSignature = str_replace('_', '\\_', $helperName . '.' . $methodName . '(' . implode(', ', $parameterNames) . ')'); $methodDescription .= $methodSignature . chr(10) . str_repeat('^', strlen($methodSignature)) . chr(10) . chr(10); if ($methodReflection->getDescription() !== '') { $methodDescription .= $methodReflection->getDescription() . chr(10) . chr(10); } if ($methodReflection->isTaggedWith('param')) { $paramTagValues = $methodReflection->getTagValues('param'); foreach ($paramTagValues as $paramTagValue) { $values = explode(' ', $paramTagValue, 3); list($parameterType, $parameterName) = $values; $parameterName = ltrim($parameterName, '$'); $parameterDescription = isset($values[2]) ? $values[2] : ''; $parameterOptionalSuffix = $methodParameters[$parameterName]->isOptional() ? ', *optional*' : ''; $methodDescription .= trim('* ``' . $parameterName . '`` (' . $parameterType . $parameterOptionalSuffix . ') ' . $parameterDescription) . chr(10); } $methodDescription .= chr(10); } if ($methodReflection->isTaggedWith('return')) { list($returnTagValue) = $methodReflection->getTagValues('return'); $values = explode(' ', $returnTagValue, 2); list($returnType) = $values; $returnDescription = isset($values[1]) ? $values[1] : ''; $methodDescription .= '**Return** (' . $returnType . ') ' . $returnDescription . chr(10); } return $methodDescription; }
/** * @param string $className * @param \TYPO3\Flow\Reflection\MethodReflection $method * @param \TYPO3\Flow\Reflection\ParameterReflection $parameter * @return void */ protected function reflectClassMethodParameter($className, MethodReflection $method, ParameterReflection $parameter) { $methodName = $method->getName(); $paramAnnotations = $method->isTaggedWith('param') ? $method->getTagValues('param') : []; $this->classReflectionData[$className][self::DATA_CLASS_METHODS][$methodName][self::DATA_METHOD_PARAMETERS][$parameter->getName()] = $this->convertParameterReflectionToArray($parameter, $method); if ($this->settings['reflection']['logIncorrectDocCommentHints'] !== true) { return; } if (!isset($paramAnnotations[$parameter->getPosition()])) { $this->log(' Missing @param for "' . $method->getName() . '::$' . $parameter->getName(), LOG_DEBUG); return; } $parameterAnnotation = explode(' ', $paramAnnotations[$parameter->getPosition()], 3); if (count($parameterAnnotation) < 2) { $this->log(' Wrong @param use for "' . $method->getName() . '::' . $parameter->getName() . '": "' . implode(' ', $parameterAnnotation) . '"', LOG_DEBUG); } if (isset($this->classReflectionData[$className][self::DATA_CLASS_METHODS][$methodName][self::DATA_METHOD_PARAMETERS][$parameter->getName()][self::DATA_PARAMETER_TYPE]) && $this->classReflectionData[$className][self::DATA_CLASS_METHODS][$methodName][self::DATA_METHOD_PARAMETERS][$parameter->getName()][self::DATA_PARAMETER_TYPE] !== $this->cleanClassName($parameterAnnotation[0])) { $this->log(' Wrong type in @param for "' . $method->getName() . '::' . $parameter->getName() . '": "' . $parameterAnnotation[0] . '"', LOG_DEBUG); } if ($parameter->getName() !== ltrim($parameterAnnotation[1], '$&')) { $this->log(' Wrong name in @param for "' . $method->getName() . '::$' . $parameter->getName() . '": "' . $parameterAnnotation[1] . '"', LOG_DEBUG); } }