Référence de la classe OnGetApiFields

Graphe d'héritage de OnGetApiFields:

Fonctions membres publiques
	__construct ($name, array $arguments=array())
	addFields (array $fields)
	addRelations (array $fields)
	getAllPropertiesToRender ()
	getAllRelationsToRender ()
Fonctions membres publiques hérités de AbstractImmutableEvent
	__construct (string $name, array $arguments=[])
	offsetSet ($name, $value)
	offsetUnset ($name)
Fonctions membres publiques hérités de AbstractEvent
	__construct (string $name, array $arguments=[])
	getArgument ($name, $default=null)
	setArgument ($name, $value)
Fonctions membres publiques hérités de Event
	addArgument ($name, $value)
	setArgument ($name, $value)
	removeArgument ($name)
	clearArguments ()
	stop ()
	offsetSet ($name, $value)
	offsetUnset ($name)
Fonctions membres publiques hérités de AbstractEvent
	__construct ($name, array $arguments=[])
	getName ()
	getArgument ($name, $default=null)
	hasArgument ($name)
	getArguments ()
	isStopped ()
	stopPropagation ()
	count ()
	serialize ()
	__serialize ()
	unserialize ($serialized)
	__unserialize (array $data)
	offsetExists ($name)
	offsetGet ($name)

Champs de données
const	LIST = 'list'
const	ITEM = 'item'

Fonctions membres protégées
	setType ($value)
	setFields ($value)
	setRelations ($value)

Attributs privés
	$extraRelations = []
	$extraAttributes = []

Membres hérités additionnels
Fonctions membres publiques statiques hérités de AbstractEvent
static	create (string $eventName, array $arguments=[])
Attributs protégés hérités de AbstractEvent
	$name
	$arguments
	$stopped = false

Description détaillée

Event for getting extra API Fields and Relations to render with an entity

Depuis

4.0.0

Documentation des constructeurs et destructeur

__construct()

__construct	(		$name,
		array	$arguments = array()
	)

Constructor.

Mandatory arguments: type string The type of the field. Should be a constant from static::VIEW_TYPE fields fields The list of fields that will be rendered in the API.

Paramètres

string	$name	The event name.
array	$arguments	The event arguments.

Exceptions

BadMethodCallException

Références $name, et Symfony\Contracts\Service\__construct().

Documentation des fonctions membres

addFields()

addFields

(

array

$fields

)

Allows the user to add names of properties that will be interpreted as relations Note that if there is an existing data property it will also be displayed as well as the relation due to the internal implementation (this behaviour is not part of this API however and should not be guaranteed)

Paramètres

string[]

$fields The array of additional fields to add to the data of the attribute

Renvoie

void

Références $fields.

addRelations()

addRelations

(

array

$fields

)

Allows the user to add names of properties that will be interpreted as relations Note that if there is an existing data property it will also be displayed as well as the relation due to the internal implementation (this behaviour is not part of this API however and should not be guaranteed)

Paramètres

string[]

$fields The array of additional fields to add as relations

Renvoie

void

Références $fields.

getAllPropertiesToRender()

getAllPropertiesToRender

(

)

Get properties to render.

Renvoie

array

getAllRelationsToRender()

getAllRelationsToRender

(

)

Get properties to render.

Renvoie

array

setFields()

setFields (   $value )

protected

Setter for the fields argument

Paramètres

mixed

$value

The value to set

Renvoie

array

Exceptions

BadMethodCallException

if the argument is not a non-empty array

Références $value.

setRelations()

setRelations (   $value )

protected

Setter for the relations argument

Paramètres

mixed

$value

The value to set

Renvoie

array

Exceptions

BadMethodCallException

if the argument is not a non-empty array

Références $value.

setType()

setType (   $value )

protected

Setter for the type argument

Paramètres

integer

$value

The constant from VIEW_TYPE

Renvoie

mixed

Exceptions

BadMethodCallException

if the argument is not of the expected type

Références $value.

Documentation des champs

$extraAttributes

$extraAttributes = []

private

$extraRelations

$extraRelations = []

private

ITEM

const ITEM = 'item'

List of types of view supported

Depuis

4.0.0

LIST

const LIST = 'list'

List of types of view supported

Depuis

4.0.0

---

La documentation de cette classe a été générée à partir du fichier suivant :

• OnGetApiFields.php