PHPXRef 0.7.1 : Joomla 4.2.2 documentation : Detail view of OnGetApiAttributes.php

Joomla! Content Management System

Copyright:	(C) 2020 Open Source Matters, Inc.
License:	GNU General Public License version 2 or later; see LICENSE.txt
File Size:	100 lines (3 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 4 functions

  __construct()
  getAttributes()
  addAttribute()
  addAttributes()

Functions

Functions that are not part of a class:

__construct($name, array $arguments = array() X-Ref

Constructor.

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

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

getAttributes() X-Ref

The properties to be rendered.

return: array

addAttribute($name, $value) X-Ref

Set a named attribute to be rendered in the API.

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

addAttributes(array $value) X-Ref

Set attributes to be rendered in the API.

param: array $value An array of key/value pairs for properties to be added to the api.
return: void

PHP Cross Reference of Joomla 4.2.2 documentation

/libraries/src/Serializer/Events/ -> OnGetApiAttributes.php (summary)

Defines 4 functions