Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class OnGetApiRelation - list of methods

Event for getting information on an API Relationship

Extends

AbstractImmutableEvent
Package: Joomla\CMS\Serializer\Events
Copyright: (C) 2020 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Serializer/Events/OnGetApiRelation.php
Project: Joomla

Method Summary

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

Constructor.
Parameters
  • string $name The event name.
  • array $arguments The event arguments.
Since
  • 4.0.0
-
  • \BadMethodCallException
Show source code of this method: __construct Source Code

public \Tobscure\JsonApi\Relationship
()

Get properties to render.
Returns
  • \Tobscure\JsonApi\Relationship
Since
  • 4.0.0
Show source code of this method: getRelationship Source Code

public void
(\Tobscure\JsonApi\Relationship $relationship)

Set relationship object that should be rendered.
Parameters
  • \Tobscure\JsonApi\Relationship $relationship The relationship object that should be rendered.
Returns
  • void
Since
  • 4.0.0
Show source code of this method: setRelationship Source Code

Properties Summary

private \Tobscure\JsonApi\Relationship
$relationship
The relationship
Since
  • 4.0.0

Tags Summary

Since
4.0.0