PHPXRef 0.7.1 : Joomla 4.2.2 documentation : Detail view of OnGetApiRelation.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:	89 lines (2 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 3 functions

  __construct()
  getRelationship()
  setRelationship()

Functions

Functions that are not part of a class:

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

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: string  $name       The event name.
param: array   $arguments  The event arguments.

getRelationship() X-Ref

Get properties to render.

return: Relationship

setRelationship(Relationship $relationship) X-Ref

Set relationship object that should be rendered.

param: Relationship $relationship The relationship object that should be rendered.
return: void

PHP Cross Reference of Joomla 4.2.2 documentation

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

Defines 3 functions