- md5
- 60823ed1771ac74c01baac32e37eb8be
- sha1
- 67e24064b108abf4dca71419d7caa33edf36598f
- sha256
- a6263c5c707f798d325254df7d1fe86ac40a456b1e29a55162f23ca78e3003f2
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
<?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;
\defined('JPATH_PLATFORM') or die;
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 3 releases, Joomla 4.2.0-alpha3 to 4.2.0-beta2. See them all, or every version of this file.