- md5
- bd0357a97760b99cd53ba9c6e534c3f8
- sha1
- 554a4e4b2af916b1cb8f114b5ca83521a1208904
- sha256
- 49bf175a97dc1c1582af0a1fdae36a121d88b91ff537d3ee4f3150e4d87b23d6
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
<?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;
// 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 String type.
*
* @since 4.2.0
*/
trait ResultTypeStringAware
{
/**
* 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;
/**
* 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_string($data)) {
throw new InvalidArgumentException(sprintf('Event %s only accepts String results.', $this->getName()));
}
}
}
The same content is in 23 releases, Joomla 4.2.1 to 4.3.0-rc2. See them all, or every version of this file.