PHP Class Swagger\Annotations\Xml

Inheritance: extends AbstractAnnotation

Show file Open project: zircote/swagger-php

Public Properties

Property	Type	Description
$_parents
$_types
$attribute	boolean	Declares whether the property definition translates to an attribute instead of an element. Default value is false.
$name	string	Replaces the name of the element/attribute used for the described schema property. When defined within the Items Object (items), it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will be ignored.
$namespace	string	The URL of the namespace definition. Value SHOULD be in the form of a URL.
$prefix	string	The prefix to be used for the name.
$wrapped	boolean	MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ) or unwrapped (). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).

Property Details

$_parents public static property

public static $_parents

$_types public static property

public static $_types

$attribute public property

Declares whether the property definition translates to an attribute instead of an element. Default value is false.

public bool $attribute
return	boolean

$name public property

Replaces the name of the element/attribute used for the described schema property. When defined within the Items Object (items), it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will be ignored.

public string $name
return	string

$namespace public property

The URL of the namespace definition. Value SHOULD be in the form of a URL.

public string $namespace
return	string

$prefix public property

The prefix to be used for the name.

public string $prefix
return	string

$wrapped public property

MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ) or unwrapped (). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).

public bool $wrapped
return	boolean