<?php /* * This file is part of the NelmioApiDocBundle package. * * (c) Nelmio * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Nelmio\ApiDocBundle\ModelDescriber\Annotations; use EXSyst\Component\Swagger\Schema; use phpDocumentor\Reflection\DocBlock\Tags\Var_; use phpDocumentor\Reflection\DocBlockFactory; /** * Extract information about properties of a model from the DocBlock comment. * * @internal */ class PropertyPhpDocReader { private $docBlockFactory; public function __construct() { $this->docBlockFactory = DocBlockFactory::createInstance(); } /** * Update the Swagger information with information from the DocBlock comment. */ public function updateProperty(\ReflectionProperty $reflectionProperty, Schema $property) { try { $docBlock = $this->docBlockFactory->create($reflectionProperty); } catch (\Exception $e) { // ignore return; } if (!$title = $docBlock->getSummary()) { /** @var Var_ $var */ foreach ($docBlock->getTagsByName('var') as $var) { if (!$description = $var->getDescription()) { continue; } $title = $description->render(); if ($title) { break; } } } if (null === $property->getTitle() && $title) { $property->setTitle($title); } if (null === $property->getDescription() && $docBlock->getDescription() && $docBlock->getDescription()->render()) { $property->setDescription($docBlock->getDescription()->render()); } } }