OnGetApiAttributes

Extends AbstractImmutableEvent

Event for getting extra data attributes for an API Entity

final
since

4.0.0

package

Application

Methods

__construct

Constructor. Overridden to go through the argument setters.

__construct(string name, array arguments = []) : mixed
inherited
since

4.0.0

Arguments

name

stringThe event name.

arguments

arrayThe event arguments.

Response

mixed

addAttribute

Set a named attribute to be rendered in the API.

addAttribute(string name, mixed value) : void
since

4.0.0

Arguments

name

stringThe name of the property to be rendered in the api

value

mixedThe value of the named property to be rendered in the api.

addAttributes

Set attributes to be rendered in the API.

addAttributes(array value) : void
since

4.0.0

Arguments

value

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

create

Creates a new CMS event object for a given event name and subject. The following arguments must be given: subject object The subject of the event. This is the core object you are going to manipulate.

create(string eventName, array arguments = []) : static
inherited static

eventClass string The Event class name. If you do not provide it Joomla\CMS\Events<eventNameWithoutOnPrefix> will be used.

since

4.0.0

throws

\BadMethodCallExceptionIf you do not provide a subject argument

Arguments

eventName

stringThe name of the event, e.g. onTableBeforeLoad

arguments

arrayAdditional arguments to pass to the event

Response

static

getArgument

Get an event argument value. It will use a getter method if one exists. The getters have the signature:

getArgument(string name, mixed default = null) : mixed
inherited

get<ArgumentName>($value): mixed

where:

$value is the value currently stored in the $arguments array of the event It returns the value to return to the caller.

since

4.0.0

Arguments

name

stringThe argument name.

default

mixedThe default value if not found.

Response

mixedThe argument value or the default value.

getAttributes

The properties to be rendered.

getAttributes() : array
since

4.0.0

Response

array

offsetSet

Set the value of an event argument.

offsetSet(string name, mixed value) : void
inherited
since

4.0.0

throws

\BadMethodCallException

Arguments

name

stringThe argument name.

value

mixedThe argument value.

offsetUnset

Remove an event argument.

offsetUnset(string name) : void
inherited
since

4.0.0

throws

\BadMethodCallException

Arguments

name

stringThe argument name.

setArgument

Add argument to event. It will use a setter method if one exists. The setters have the signature:

setArgument(string name, mixed value) : $this
inherited

set<ArgumentName>($value): mixed

where:

$value is the value being set by the user It returns the value to return to set in the $arguments array of the event.

since

4.0.0

Arguments

name

stringArgument name.

value

mixedValue.

Response

$this

Properties

attributes

The attributes

since

4.0.0

Type(s)

array

constructed

A flag to see if the constructor has been already called.

inherited
since

4.0.0

Type(s)

bool