mirror of
https://github.com/retailcrm/NelmioApiDocBundle.git
synced 2025-02-09 02:59:27 +03:00
78664ef9ec
* Initial pass for OA3 upgrade * Fix Util Tests * Fix first batch of Unit Tests. Up to Model * Another batch of fixed tests * Update annotations * Convert Model & Property Describers * Update tests, Fix RouteDescribers, FIx additional bugs * Another batch of updates * Another batch of fixed Functional Tests * Fix FunctionalTest tests * Fix Bazinga Tests * FIx FOS Rest * Fix JMS TEsts & describers * Fix all Tests * Fix few stuff from own CR * CS Fixes * CS Fixes 2 * CS Fixes 3 * CS Fixes 4 * Remove collection bug * Updates after first CRs * CS * Drop support for SF3 * Update the docs * Add an upgrade guide * misc doc fixes * Configurable media types * Code Style Fixes * Don't use ::$ref for @Response and @RequestBody * Fix upgrading guide * Fix OA case Co-authored-by: Filip Benčo <filip.benco@websupport.sk> Co-authored-by: Guilhem Niot <guilhem.niot@gmail.com> Co-authored-by: Mantis Development <mantis@users.noreply.github.com>
59 lines
1.9 KiB
PHP
59 lines
1.9 KiB
PHP
<?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\PropertyDescriber;
|
|
|
|
use Nelmio\ApiDocBundle\Describer\ModelRegistryAwareInterface;
|
|
use Nelmio\ApiDocBundle\Describer\ModelRegistryAwareTrait;
|
|
use Nelmio\ApiDocBundle\OpenApiPhp\Util;
|
|
use OpenApi\Annotations as OA;
|
|
use Symfony\Component\PropertyInfo\Type;
|
|
|
|
class ArrayPropertyDescriber implements PropertyDescriberInterface, ModelRegistryAwareInterface
|
|
{
|
|
use ModelRegistryAwareTrait;
|
|
|
|
/** @var PropertyDescriberInterface[] */
|
|
private $propertyDescribers;
|
|
|
|
public function __construct(iterable $propertyDescribers = [])
|
|
{
|
|
$this->propertyDescribers = $propertyDescribers;
|
|
}
|
|
|
|
public function describe(Type $type, OA\Schema $property, array $groups = null)
|
|
{
|
|
$type = $type->getCollectionValueType();
|
|
if (null === $type) {
|
|
throw new \LogicException(sprintf('Property "%s" is an array, but its items type isn\'t specified. You can specify that by using the type `string[]` for instance or `@SWG\Property(type="array", @SWG\Items(type="string"))`.', $property->getTitle()));
|
|
}
|
|
|
|
$property->type = 'array';
|
|
$property = Util::getChild($property, OA\Items::class);
|
|
|
|
foreach ($this->propertyDescribers as $propertyDescriber) {
|
|
if ($propertyDescriber instanceof ModelRegistryAwareInterface) {
|
|
$propertyDescriber->setModelRegistry($this->modelRegistry);
|
|
}
|
|
if ($propertyDescriber->supports($type)) {
|
|
$propertyDescriber->describe($type, $property, $groups);
|
|
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
public function supports(Type $type): bool
|
|
{
|
|
return $type->isCollection();
|
|
}
|
|
}
|