Skip to content

Zend instead of regex in getGetterReturnType #6344

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
magento-team merged 3 commits into from
May 24, 2017
Merged

Zend instead of regex in getGetterReturnType #6344

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2906e42
Refactoring of getGetterReturnType method
flancer64 Aug 25, 2016
27a6e8d
Use Zend reflection instead of regex'es.
flancer64 Aug 25, 2016
ab0ff78
Add missed entry to docs for @return
flancer64 Aug 26, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 6 additions & 15 deletions lib/internal/Magento/Framework/Reflection/TypeProcessor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,7 @@ protected function dataObjectGetterDescriptionToFieldDescription($shortDescripti
* 'type' => <string>$type,
* 'isRequired' => $isRequired,
* 'description' => $description
* 'parameterCount' => $numberOfRequiredParameters
* )</pre>
* @throws \InvalidArgumentException
*/
Expand All @@ -309,23 +310,13 @@ public function getGetterReturnType($methodReflection)
}
/** @var \Zend\Code\Reflection\DocBlock\Tag\ReturnTag $returnAnnotation */
$returnAnnotation = current($returnAnnotations);
$returnType = $returnAnnotation->getType();
/*
* Adding this code as a workaround since \Zend\Code\Reflection\DocBlock\Tag\ReturnTag::initialize does not
* detect and return correct type for array of objects in annotation.
* eg @return \Magento\Webapi\Service\Entity\SimpleData[] is returned with type
* \Magento\Webapi\Service\Entity\SimpleData instead of \Magento\Webapi\Service\Entity\SimpleData[]
*/
$escapedReturnType = str_replace('[]', '\[\]', $returnType);
$escapedReturnType = str_replace('\\', '\\\\', $escapedReturnType);

if (preg_match("/.*\\@return\\s+({$escapedReturnType}).*/i", $methodDocBlock->getContents(), $matches)) {
$returnType = $matches[1];
}
$isNotRequired = (bool)preg_match("/.*\@return\s+\S+\|null.*/i", $methodDocBlock->getContents(), $matches);
$types = $returnAnnotation->getTypes();
$returnType = current($types);
$nullable = in_array('null', $types);

return [
'type' => $returnType,
'isRequired' => !$isNotRequired,
'isRequired' => !$nullable,
'description' => $returnAnnotation->getDescription(),
'parameterCount' => $methodReflection->getNumberOfRequiredParameters()
];
Expand Down