- md5
- 75294a6b8b819b31da801dde19741613
- sha1
- 5e0ca3a9ce08bd802438ae888d9fd085fd5a6801
- sha256
- 2182f80c86ea16708f2fba02c5c273ee1b85a0f4aa65074b2d19bea67642edd2
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147
<?php
/**
* Joomla! Content Management System
*
* @copyright (C) 2023 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\CMS\Event\Privacy;
use Joomla\CMS\Event\Result\ResultAware;
use Joomla\CMS\Event\Result\ResultAwareInterface;
use Joomla\CMS\User\User;
use Joomla\Component\Privacy\Administrator\Export\Domain;
use Joomla\Component\Privacy\Administrator\Table\RequestTable;
// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* Class for Privacy events.
* Example:
* new ExportRequestEvent('onEventName', ['subject' => $requestTable, 'user' => $user]);
*
* @since 5.0.0
*/
class ExportRequestEvent extends PrivacyEvent implements ResultAwareInterface
{
use ResultAware;
/**
* The argument names, in order expected by legacy plugins.
*
* @var array
*
* @since 5.0.0
* @deprecated 5.0 will be removed in 6.0
*/
protected $legacyArgumentsOrder = ['subject', 'user'];
/**
* Constructor.
*
* @param string $name The event name.
* @param array $arguments The event arguments.
*
* @throws \BadMethodCallException
*
* @since 5.0.0
*/
public function __construct($name, array $arguments = [])
{
parent::__construct($name, $arguments);
if (!\array_key_exists('subject', $this->arguments)) {
throw new \BadMethodCallException("Argument 'subject' of event {$name} is required but has not been provided");
}
if (!\array_key_exists('user', $this->arguments)) {
throw new \BadMethodCallException("Argument 'user' of event {$name} is required but has not been provided");
}
}
/**
* Setter for the subject argument.
*
* @param RequestTable $value The value to set
*
* @return RequestTable
*
* @since 5.0.0
*/
protected function onSetSubject(RequestTable $value): RequestTable
{
return $value;
}
/**
* Setter for the user argument.
*
* @param ?User $value The value to set
*
* @return ?User
*
* @since 5.0.0
*/
protected function onSetUser(?User $value): ?User
{
return $value;
}
/**
* Getter for the request.
*
* @return RequestTable
*
* @since 5.0.0
*/
public function getRequest(): RequestTable
{
return $this->arguments['subject'];
}
/**
* Getter for the user.
*
* @return ?User
*
* @since 5.0.0
*/
public function getUser(): ?User
{
return $this->arguments['user'];
}
/**
* Checks the type of the data being appended to the result argument.
*
* @param mixed $data The data to type check
*
* @return void
* @throws \InvalidArgumentException
*
* @internal
* @since 5.0.0
*/
public function typeCheckResult($data): void
{
if (!\is_array($data)) {
throw new \InvalidArgumentException(sprintf('Event %s only accepts Array results.', \get_class($this)));
}
// Validate items in array
foreach ($data as $item) {
if (!$item instanceof Domain) {
throw new \InvalidArgumentException(
sprintf(
'Event %s only accepts Joomla\Component\Privacy\Administrator\Export\Domain in result array.',
\get_class($this)
)
);
}
}
}
}
The same content is in 36 releases, Joomla 5.0.0-rc to 5.2.0-beta2. See them all, or every version of this file.