<?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\Helper;

// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects

/**
 * Defines the trait for a HelperFactory Aware Class.
 *
 * @since  4.2.0
 */
trait HelperFactoryAwareTrait
{
    /**
     * HelperFactory
     *
     * @var    HelperFactory
     *
     * @since  4.2.0
     */
    private $helper;

    /**
     * Get the HelperFactory.
     *
     * @return  HelperFactory
     *
     * @since   4.2.0
     *
     * @throws  \UnexpectedValueException May be thrown if the HelperFactory has not been set.
     */
    public function getHelperFactory(): HelperFactory
    {
        if ($this->helper) {
            return $this->helper;
        }

        throw new \UnexpectedValueException('HelperFactory not set in ' . __CLASS__);
    }

    /**
     * Sets the helper factory to use.
     *
     * @param   HelperFactory  $helperFactory  The helper factory to use.
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function setHelperFactory(HelperFactory $helperFactory)
    {
        $this->helper = $helperFactory;
    }
}