Référence de la classe OnGetApiAttributes

Graphe d'héritage de OnGetApiAttributes:

Fonctions membres publiques
	__construct ($name, array $arguments=array())
	getAttributes ()
	addAttribute ($name, $value)
	addAttributes (array $value)
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)

Attributs privés
	$attributes = []

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 data attributes for an API Entity

Depuis

4.0.0

Documentation des constructeurs et destructeur

__construct()

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

Constructor.

Mandatory arguments: attributes array The main data for the object. context string The content type of the api resource.

Paramètres

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

Depuis

4.0.0

Exceptions

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

Documentation des fonctions membres

addAttribute()

addAttribute	(		$name,
			$value
	)

Set a named attribute to be rendered in the API.

Paramètres

string	$name	The name of the property to be rendered in the api
mixed	$value	The value of the named property to be rendered in the api.

Renvoie

void

Depuis

4.0.0

Références $name, et $value.

addAttributes()

addAttributes

(

array

$value

)

Set attributes to be rendered in the API.

Paramètres

array

$value

An array of key/value pairs for properties to be added to the api.

Renvoie

void

Depuis

4.0.0

Références $value.

getAttributes()

getAttributes

(

)

The properties to be rendered.

Renvoie

array

Depuis

4.0.0

Références $attributes.

Documentation des champs

$attributes

$attributes = []

private

---

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

• OnGetApiAttributes.php