Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe OnGetApiRelation
+ Graphe d'héritage de OnGetApiRelation:

Fonctions membres publiques

 __construct ($name, array $arguments=array())
 
 getRelationship ()
 
 setRelationship (Relationship $relationship)
 
- 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

 $relationship
 

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 information on an API Relationship

Depuis
4.0.0

Documentation des constructeurs et destructeur

◆ __construct()

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

Constructor.

Mandatory arguments: model mixed The model being used to render the resource. field string The field name we wish to obtain a relationship for. context string The content type of the api resource.

Paramètres
string$nameThe event name.
array$argumentsThe event arguments.
Depuis
4.0.0
Exceptions

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

Documentation des fonctions membres

◆ getRelationship()

getRelationship ( )

Get properties to render.

Renvoie
Relationship
Depuis
4.0.0

◆ setRelationship()

setRelationship ( Relationship  $relationship)

Set relationship object that should be rendered.

Paramètres
Relationship$relationshipThe relationship object that should be rendered.
Renvoie
void
Depuis
4.0.0

Documentation des champs

◆ $relationship

$relationship
private

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