wcfsetup/install/files/lib/data/search/ISearchResultObject.class.php

   1 <?php
   2
   3 namespace wcf\data\search;
   4
   5 /**
   6  * All search result objects should implement this interface.
   7  *
   8  * @author  Marcel Werk
   9  * @copyright   2001-2019 WoltLab GmbH
  10  * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  11  * @package WoltLabSuite\Core\Data\Search
  12  */
  13 interface ISearchResultObject
  14 {
  15     /**
  16      * Returns author's user profile.
  17      *
  18      * @return  \wcf\data\user\UserProfile
  19      */
  20     public function getUserProfile();
  21
  22     /**
  23      * Returns the subject of this object.
  24      *
  25      * @return  string
  26      */
  27     public function getSubject();
  28
  29     /**
  30      * Returns the creation time.
  31      *
  32      * @return  int
  33      */
  34     public function getTime();
  35
  36     /**
  37      * Returns the link to this object.
  38      *
  39      * @param string $query search query
  40      * @return  string
  41      */
  42     public function getLink($query = '');
  43
  44     /**
  45      * Returns the object type name.
  46      *
  47      * @return  string
  48      */
  49     public function getObjectTypeName();
  50
  51     /**
  52      * Returns the message text.
  53      *
  54      * @return  string
  55      */
  56     public function getFormattedMessage();
  57
  58     /**
  59      * Returns the title of object's container. Returns empty string if there
  60      * is no container.
  61      *
  62      * @return  string
  63      */
  64     public function getContainerTitle();
  65
  66     /**
  67      * Returns the link to object's container. Returns empty string if there
  68      * is no container.
  69      *
  70      * @return  string
  71      */
  72     public function getContainerLink();
  73 }