- md5
- 5df12e36b8e3cba15c3b57b2af59a62f
- sha1
- ae159ef5ac92acf73f8e474eb8d0627e8a0f5ad3
- sha256
- b3475aa3deec55abf6a75ff2a83bb271dcbc545eed92a75bd8dc6e5a8aaf80a5
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
<?php
/**
* Joomla! Content Management System
*
* @copyright (C) 2020 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\CMS\Serializer\Events;
use Joomla\CMS\Event\AbstractImmutableEvent;
use Tobscure\JsonApi\Relationship;
// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* Event for getting information on an API Relationship
*
* @since 4.0.0
*/
final class OnGetApiRelation extends AbstractImmutableEvent
{
/**
* The relationship
*
* @var Relationship
* @since 4.0.0
*/
private $relationship;
/**
* 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.
*
* @since 4.0.0
* @throws \BadMethodCallException
*/
public function __construct($name, array $arguments = [])
{
if (!\array_key_exists('model', $arguments)) {
throw new \BadMethodCallException("Argument 'model' is required for event $name");
}
if (!\array_key_exists('field', $arguments)) {
throw new \BadMethodCallException("Argument 'field' is required for event $name");
}
if (!\array_key_exists('context', $arguments)) {
throw new \BadMethodCallException("Argument 'context' is required for event $name");
}
parent::__construct($name, $arguments);
}
/**
* Get properties to render.
*
* @return Relationship
*
* @since 4.0.0
*/
public function getRelationship(): ?Relationship
{
return $this->relationship;
}
/**
* Set relationship object that should be rendered.
*
* @param Relationship $relationship The relationship object that should be rendered.
*
* @return void
* @since 4.0.0
*/
public function setRelationship(Relationship $relationship): void
{
$this->relationship = $relationship;
}
}
The same content is in 214 releases, Joomla 4.2.7-rc1 to 6.2.1-rc1. See them all, or every version of this file.