typo3/sysext/extbase/Classes/Persistence/Typo3QuerySettingsInterface.php

   1 <?php
   2 /***************************************************************
   3 *  Copyright notice
   4 *
   5 *  (c) 2009 Jochen Rau <jochen.rau@typoplanet.de>
   6 *  All rights reserved
   7 *
   8 *  This class is a backport of the corresponding class of FLOW3.
   9 *  All credits go to the v5 team.
  10 *
  11 *  This script is part of the TYPO3 project. The TYPO3 project is
  12 *  free software; you can redistribute it and/or modify
  13 *  it under the terms of the GNU General Public License as published by
  14 *  the Free Software Foundation; either version 2 of the License, or
  15 *  (at your option) any later version.
  16 *
  17 *  The GNU General Public License can be found at
  18 *  http://www.gnu.org/copyleft/gpl.html.
  19 *
  20 *  This script is distributed in the hope that it will be useful,
  21 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  22 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23 *  GNU General Public License for more details.
  24 *
  25 *  This copyright notice MUST APPEAR in all copies of the script!
  26 ***************************************************************/
  27
  28 /**
  29  * TYPO3 Query settings interface. This interfaceis NOT part of the FLOW3 API.
  30  * It reflects the settings unique to TYPO3 4.x.
  31  *
  32  * @package Extbase
  33  * @subpackage Persistence
  34  * @version $Id$
  35  * @api
  36  */
  37 interface Tx_Extbase_Persistence_Typo3QuerySettingsInterface extends Tx_Extbase_Persistence_QuerySettingsInterface {
  38
  39         /**
  40          * Sets the flag if the storage page should be respected for the query.
  41          *
  42          * @param $respectStoragePage If TRUE the storage page ID will be determined and the statement will be extended accordingly.
  43          * @return $this (fluent interface)
  44          * @api
  45          */
  46         public function setRespectStoragePage($respectStoragePage);
  47
  48         /**
  49          * Sets the flag if the visibility in the frontend should be respected.
  50          *
  51          * @param $respectEnableFields TRUE if the visibility in the frontend should be respected. If TRUE, the "enable fields" of TYPO3 will be added to the query statement.
  52          * @return $this (fluent interface)
  53          * @api
  54          */
  55         public function setRespectEnableFields($respectEnableFields);
  56
  57         /**
  58          * Sets the flag if if the sys language should be respected.
  59          *
  60          * @param $respectSysLanguage TRUE if the sys language should be respected.
  61          * @return $this (fluent interface)
  62          * @api
  63          */
  64         public function setRespectSysLanguage($respectSysLanguage);
  65
  66         /**
  67          * Returns the state, if the sys language should be respected.
  68          *
  69          * @return boolean TRUE, if the sys language should be respected; otherwise FALSE.
  70          */
  71         public function getRespectSysLanguage();
  72
  73
  74         /**
  75          * Sets the state, if the QueryResult should be returned unmapped.
  76          *
  77          * @return boolean TRUE, if the QueryResult should be returned unmapped; otherwise FALSE.
  78          * @api
  79          */
  80         public function setReturnRawQueryResult($returnRawQueryResult);
  81
  82         /**
  83          * Returns the state, if the QueryResult should be returned unmapped.
  84          *
  85          * @return boolean TRUE, if the QueryResult should be returned unmapped; otherwise FALSE.
  86          * @api
  87          */
  88         public function getReturnRawQueryResult();
  89
  90 }
  91 ?>