CoreFiles by mySites.guru
ResultTypeStringAware.php71 lines, 1,540 bytes, from Joomla_4.2.0-alpha3-dev-Development-Full_Package.zip
Raw History Compare with 4.2.0-alpha2
md5
415f8617f78852b3d43865422ded613c
sha1
f10708d1bbedac7c419982988757c1dff0c8dc30
sha256
71eaa7717949c4b7dc208a701bf61e0af7b9b0e8ee8158bc00e8d0f76f22acce
<?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 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 3 releases, Joomla 4.2.0-alpha3 to 4.2.0-beta2. See them all, or every version of this file.