- md5
- 4f913810a10b9d39e426553d20859947
- sha1
- f605f993533119c7af26d5edab4a0d17a16cbbb9
- sha256
- 2f3373a637cf09c2ad7c52ab6935c27cbbcc98750bf0413f212b0468a01365de
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
<?php
/**
* Joomla! Content Management System
*
* @copyright (C) 2022 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\CMS\Event\Result;
use InvalidArgumentException;
// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* This Trait partially implements the ResultAwareInterface for type checking.
*
* Events using this Trait (and the ResultAware trait) will expect event handlers to set results
* of an object type.
*
* If you do not set a list of acceptable result classes any PHP object will satisfy this type check.
*
* @since 4.2.0
*/
trait ResultTypeObjectAware
{
/**
* Can the result attribute values also be NULL?
*
* @var boolean
* @since 4.2.0
*/
protected $resultIsNullable = false;
/**
* Can the result attribute values also be boolean FALSE?
*
* @var boolean
* @since 4.2.0
*
* @deprecated 4.3 will be removed in 6.0
* You should use nullable values or exceptions instead of returning boolean false results.
*/
protected $resultIsFalseable = false;
/**
* Acceptable class names for result values.
*
* @var array
* @since 4.2.0
*/
protected $resultAcceptableClasses = [];
/**
* 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 4.2.0
*/
public function typeCheckResult($data): void
{
if ($this->resultIsNullable && $data === null) {
return;
}
if ($this->resultIsFalseable && $data === false) {
return;
}
if (!is_object($data)) {
throw new InvalidArgumentException(sprintf('Event %s only accepts object results.', $this->getName()));
}
if (empty($this->resultAcceptableClasses)) {
return;
}
foreach ($this->resultAcceptableClasses as $className) {
if (is_a($data, $className)) {
return;
}
}
$acceptableTypes = implode(', ', $this->resultAcceptableClasses);
$messageTemplate = 'Event %s only accepts object results which are instances of one of %s.';
throw new InvalidArgumentException(sprintf($messageTemplate, $this->getName(), $acceptableTypes));
}
}
The same content is in 2 releases, Joomla 5.0.0-alpha1 to 5.0.0-alpha2. See them all, or every version of this file.