[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.txt
   8   */
   9  
  10  namespace Joomla\CMS\Helper;
  11  
  12  // phpcs:disable PSR1.Files.SideEffects
  13  \defined('_JEXEC') or die;
  14  // phpcs:enable PSR1.Files.SideEffects
  15  
  16  /**
  17   * Defines the trait for a HelperFactory Aware Class.
  18   *
  19   * @since  4.2.0
  20   */
  21  trait HelperFactoryAwareTrait
  22  {
  23      /**
  24       * HelperFactory
  25       *
  26       * @var    HelperFactory
  27       *
  28       * @since  4.2.0
  29       */
  30      private $helperFactory;
  31  
  32      /**
  33       * Get the HelperFactory.
  34       *
  35       * @return  HelperFactory
  36       *
  37       * @since   4.2.0
  38       *
  39       * @throws  \UnexpectedValueException May be thrown if the HelperFactory has not been set.
  40       */
  41      public function getHelperFactory(): HelperFactory
  42      {
  43          if ($this->helper) {
  44              return $this->helper;
  45          }
  46  
  47          throw new \UnexpectedValueException('HelperFactory not set in ' . __CLASS__);
  48      }
  49  
  50      /**
  51       * Sets the helper factory to use.
  52       *
  53       * @param   HelperFactory  $helperFactory  The helper factory to use.
  54       *
  55       * @return  void
  56       *
  57       * @since   4.2.0
  58       */
  59      public function setHelperFactory(HelperFactory $helperFactory)
  60      {
  61          $this->helper = $helperFactory;
  62      }
  63  }