wcfsetup/install/files/lib/system/page/handler/ILookupPageHandler.class.php

   1 <?php
   2 namespace wcf\system\page\handler;
   3
   4 /**
   5  * Extends the menu page handler interface by providing additional methods to lookup
   6  * pages identified by a unique object id.
   7  *
   8  * @author      Alexander Ebert
   9  * @copyright   2001-2017 WoltLab GmbH
  10  * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  11  * @package     WoltLabSuite\Core\System\Page\Handler
  12  * @since       3.0
  13  */
  14 interface ILookupPageHandler extends IMenuPageHandler {
  15         /**
  16          * Returns the link for a page with an object id.
  17          *
  18          * @param       integer         $objectID       page object id
  19          * @return      string          page url
  20          */
  21         public function getLink($objectID);
  22
  23         /**
  24          * Returns true if provided object id exists and is valid.
  25          *
  26          * @param       integer         $objectID       page object id
  27          * @return      boolean         true if object id is valid
  28          */
  29         public function isValid($objectID);
  30
  31         /**
  32          * Performs a search for pages using a query string, returning an array containing
  33          * an `objectID => title` relation.
  34          *
  35          * @param       string          $searchString   search string
  36          * @return      string[]
  37          */
  38         public function lookup($searchString);
  39 }