<?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 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  4.3 will be removed in 7.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));
    }
}
