- md5
- 3ec4aa025c6ac88687d7a6e7330f8786
- sha1
- 21d6c376c723f9c7b5063e4473d0e750bc6063fc
- sha256
- 8d7b4e8158652d6154da660ee374f9f32dec6dabb96a808be9df2107fe6fdeef
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
<?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('JPATH_PLATFORM') 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 a Boolean type.
*
* @since 4.2.0
*/
trait ResultTypeBooleanAware
{
/**
* Can the result attribute values also be NULL?
*
* @var boolean
* @since 4.2.0
*/
protected $resultIsNullable = false;
/**
* 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 (!is_bool($data)) {
throw new InvalidArgumentException(sprintf('Event %s only accepts Boolean results.', $this->getName()));
}
}
}
The same content is in 8 releases, Joomla 4.3.2-rc1 to 4.4.0-alpha2. See them all, or every version of this file.