/** * @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; }
/** * Converts the given parameter reflection into an information array * * @param ParameterReflection $parameter The parameter to reflect * @param MethodReflection $method The parameter's method * @return array Parameter information array */ protected function convertParameterReflectionToArray(ParameterReflection $parameter, MethodReflection $method = null) { $parameterInformation = [self::DATA_PARAMETER_POSITION => $parameter->getPosition()]; if ($parameter->isPassedByReference()) { $parameterInformation[self::DATA_PARAMETER_BY_REFERENCE] = true; } if ($parameter->isArray()) { $parameterInformation[self::DATA_PARAMETER_ARRAY] = true; } if ($parameter->isOptional()) { $parameterInformation[self::DATA_PARAMETER_OPTIONAL] = true; } if ($parameter->allowsNull()) { $parameterInformation[self::DATA_PARAMETER_ALLOWS_NULL] = true; } $parameterClass = $parameter->getClass(); if ($parameterClass !== null) { $parameterInformation[self::DATA_PARAMETER_CLASS] = $parameterClass->getName(); } if ($parameter->isOptional() && $parameter->isDefaultValueAvailable()) { $parameterInformation[self::DATA_PARAMETER_DEFAULT_VALUE] = $parameter->getDefaultValue(); } if ($method !== null) { $paramAnnotations = $method->isTaggedWith('param') ? $method->getTagValues('param') : []; if (isset($paramAnnotations[$parameter->getPosition()])) { $explodedParameters = explode(' ', $paramAnnotations[$parameter->getPosition()]); if (count($explodedParameters) >= 2) { $parameterType = $this->expandType($method->getDeclaringClass(), $explodedParameters[0]); $parameterInformation[self::DATA_PARAMETER_TYPE] = $this->cleanClassName($parameterType); } } if (!$parameter->isArray()) { $builtinType = $parameter->getBuiltinType(); if ($builtinType !== null) { $parameterInformation[self::DATA_PARAMETER_TYPE] = $builtinType; $parameterInformation[self::DATA_PARAMETER_SCALAR_DECLARATION] = true; } } } if (!isset($parameterInformation[self::DATA_PARAMETER_TYPE]) && $parameterClass !== null) { $parameterInformation[self::DATA_PARAMETER_TYPE] = $this->cleanClassName($parameterClass->getName()); } elseif (!isset($parameterInformation[self::DATA_PARAMETER_TYPE])) { $parameterInformation[self::DATA_PARAMETER_TYPE] = 'mixed'; } return $parameterInformation; }