[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  use Joomla\CMS\Table\TableInterface;
  14  
  15  // phpcs:disable PSR1.Files.SideEffects
  16  \defined('JPATH_PLATFORM') or die;
  17  // phpcs:enable PSR1.Files.SideEffects
  18  
  19  /**
  20   * Interface for a taggable Table class
  21   *
  22   * @since  3.10.0
  23   */
  24  interface TaggableTableInterface extends TableInterface
  25  {
  26      /**
  27       * Get the type alias for the tags mapping table
  28       *
  29       * The type alias generally is the internal component name with the
  30       * content type. Ex.: com_content.article
  31       *
  32       * @return  string  The alias as described above
  33       *
  34       * @since   4.0.0
  35       */
  36      public function getTypeAlias();
  37  
  38      /**
  39       * Get the tags helper
  40       *
  41       * @return  ?TagsHelper  The tags helper object
  42       *
  43       * @since   4.0.0
  44       */
  45      public function getTagsHelper(): ?TagsHelper;
  46  
  47      /**
  48       * Set the tags helper
  49       *
  50       * @param   TagsHelper  $tagsHelper  The tags helper object
  51       *
  52       * @return  void
  53       *
  54       * @since   4.0.0
  55       */
  56      public function setTagsHelper(TagsHelper $tagsHelper): void;
  57  
  58      /**
  59       * Clears a set tags helper
  60       *
  61       * @return  void
  62       *
  63       * @since   4.0.0
  64       */
  65      public function clearTagsHelper(): void;
  66  }