CoreFiles by mySites.guru
ResultTypeFloatAware.php70 lines, 1,775 bytes, from Joomla_5.1.2-Stable-Full_Package.zip
Raw History Compare with 5.1.1
md5
aa149c80e1faf1f2b6ab35493e9bf86b
sha1
3ede38e071dd2c9e02c8b71cf5b0112dc1a70cc0
sha256
4d3fdc4b3e48941512fdc36efd41d5bf3c0c33be619b3c0db32b1fb4c6b7e083
<?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;

// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') 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 Float type.
 *
 * @since  4.2.0
 */
trait ResultTypeFloatAware
{
    /**
     * 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  4.3 will be removed in 6.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_float($data)) {
            throw new \InvalidArgumentException(sprintf('Event %s only accepts Float results.', $this->getName()));
        }
    }
}

The same content is in 36 releases, Joomla 5.0.0-rc to 5.2.0-beta2. See them all, or every version of this file.