[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /**
   4   * Joomla! Content Management System
   5   *
   6   * @copyright  (C) 2022 Open Source Matters, Inc. <https://www.joomla.org>
   7   * @license        GNU General Public License version 2 or later; see LICENSE
   8   */
   9  
  10  namespace Joomla\CMS\Event\Result;
  11  
  12  use InvalidArgumentException;
  13  
  14  // phpcs:disable PSR1.Files.SideEffects
  15  \defined('JPATH_PLATFORM') or die;
  16  // phpcs:enable PSR1.Files.SideEffects
  17  
  18  /**
  19   * This Trait partially implements the ResultAwareInterface for type checking.
  20   *
  21   * Events using this Trait (and the ResultAware trait) will expect event handlers to set results
  22   * of a any type. THIS IS A COP OUT! If you expect a nullable or union type it's best to implement
  23   * the typeCheckResult method yourself to check for the exact types you expect.
  24   *
  25   * @since  4.2.0
  26   */
  27  trait ResultTypeMixedAware
  28  {
  29      /**
  30       * Checks the type of the data being appended to the result argument.
  31       *
  32       * @param   mixed  $data  The data to type check
  33       *
  34       * @return  void
  35       * @throws  InvalidArgumentException
  36       *
  37       * @internal
  38       * @since   4.2.0
  39       */
  40      public function typeCheckResult($data): void
  41      {
  42          // Intentionally left blank; no type check is performed.
  43      }
  44  }