- md5
- ad4161b8fb200f9530dd4cf7c83c8efd
- sha1
- 02b9d54f68c82eee5b87b0cfd06bacc4b1843732
- sha256
- cc8e7c2a2de7d76001a753e17845e11a22b9a8c81772d165dc827953f62d19fc
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
<?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
*/
namespace Joomla\CMS\Event\Result;
use InvalidArgumentException;
/**
* 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 5.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 5 releases, Joomla 4.2.0-beta3 to 4.2.1-rc2. See them all, or every version of this file.