Documentation

Contact
in package
implements OpenApiAttributeInterface

The attribute may be used in {@see Info::$contact} to define a contact for the OpenAPI spec.

Interfaces, Classes, Traits and Enums

OpenApiAttributeInterface

Table of Contents

$email  : string
$extensions  : array<string|int, mixed>
$name  : string
$url  : string
__construct()  : mixed

Properties

$extensions

public array<string|int, mixed> $extensions = []

Methods

__construct()

public __construct([string $name = "" ][, string $url = "" ][, string $email = "" ][, array<string|int, Extension$extensions = [] ]) : mixed
Parameters
$name : string = ""

The identifying name of the contact person/organization.

$url : string = ""

The URL pointing to the contact information. Must be in the format of a URL.

$email : string = ""

The email address of the contact person/organization. Must be in the format of an email address.

$extensions : array<string|int, Extension> = []

The list of optional extensions.

Return values
mixed

Search results