[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /**
   4   * Joomla! Content Management System
   5   *
   6   * @copyright  (C) 2020 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\Tag;
  11  
  12  use Joomla\CMS\Helper\TagsHelper;
  13  
  14  // phpcs:disable PSR1.Files.SideEffects
  15  \defined('JPATH_PLATFORM') or die;
  16  // phpcs:enable PSR1.Files.SideEffects
  17  
  18  /**
  19   * Defines the trait for a Taggable Table Class.
  20   *
  21   * @since  3.10.0
  22   */
  23  trait TaggableTableTrait
  24  {
  25      /**
  26       * The tags helper property
  27       *
  28       * @var    TagsHelper
  29       * @since  4.0.0
  30       * @note   The tags helper property is set to public for backwards compatibility for Joomla 4.0. It will be made a
  31       *         protected property in Joomla 5.0
  32       */
  33      public $tagsHelper;
  34  
  35      /**
  36       * Get the tags helper
  37       *
  38       * @return  TagsHelper  The tags helper object
  39       *
  40       * @since   4.0.0
  41       */
  42      public function getTagsHelper(): ?TagsHelper
  43      {
  44          return $this->tagsHelper;
  45      }
  46  
  47      /**
  48       * Set the tags helper
  49       *
  50       * @param   TagsHelper   $tagsHelper  The tags helper to be set
  51       *
  52       * @return  void
  53       *
  54       * @since   4.0.0
  55       */
  56      public function setTagsHelper(TagsHelper $tagsHelper): void
  57      {
  58          $this->tagsHelper = $tagsHelper;
  59      }
  60  
  61      /**
  62       * Clears the tags helper
  63       *
  64       * @return  void
  65       *
  66       * @since   4.0.0
  67       */
  68      public function clearTagsHelper(): void
  69      {
  70          $this->tagsHelper = null;
  71      }
  72  }