Application API Documentation

Directional Consulting

Search Documentation

Classes

BooleanPropertyDescriber in package implements PropertyDescriberInterface Uses NullablePropertyTrait

Interfaces, Classes and Traits

PropertyDescriberInterface

Table of Contents

describe()  : mixed
supports()  : bool
setNullableProperty()  : void

Methods

describe()

public describe(array<string|int, mixed> $types, Schema $property[, array<string|int, mixed> $groups = null ]) : mixed
Parameters
$types : array<string|int, mixed>
$property : Schema
$groups : array<string|int, mixed> = null
Return values
mixed —

supports()

public supports(array<string|int, mixed> $types) : bool
Parameters
$types : array<string|int, mixed>
Return values
bool —

setNullableProperty()

protected setNullableProperty(Type $type, Schema $property) : void
Parameters
$type : Type
$property : Schema
Return values
void — 
<?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 OpenApi\Annotations as OA;
use Symfony\Component\PropertyInfo\Type;

class BooleanPropertyDescriber implements PropertyDescriberInterface
{
    use NullablePropertyTrait;

    public function describe(array $types, OA\Schema $property, array $groups = null)
    {
        $property->type = 'boolean';
        $this->setNullableProperty($types[0], $property);
    }

    public function supports(array $types): bool
    {
        return 1 === count($types) && Type::BUILTIN_TYPE_BOOL === $types[0]->getBuiltinType();
    }
}

Search Results

Search results

Found Results