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: QueryInterface.php 658 2009-05-16 13:54:16Z jocrau $
  35  */
  36 interface Tx_Extbase_Persistence_Typo3QuerySettingsInterface extends Tx_Extbase_Persistence_QuerySettingsInterface {
  37
  38         /**
  39          * Sets the flag if the storage page should be respected for the query.
  40          *
  41          * @param $respectStoragePage If TRUE the storage page ID will be determined and the statement will be extended accordingly.
  42          * @return $this (fluent interface)
  43          */
  44         public function setRespectStoragePageState($respectStoragePage);
  45
  46         /**
  47          * Returns the state, if the storage page should be respected for the query.
  48          *
  49          * @return boolean TRUE, if the storage page should be respected; otherwise FALSE.
  50          */
  51         public function respectStoragePage();
  52
  53         /**
  54          * Sets the flag if the visibility in the frontend should be respected.
  55          *
  56          * @param $checkVisibility TRUE if the visibility in the frontend should be respected. If TRUE, the "enable fields" of TYPO3 will be added to the query statement.
  57          * @return $this (fluent interface)
  58          */
  59         public function setCheckVisibilityState($checkVisibility);
  60
  61         /**
  62          * Returns the state, if the visibility settings for the frontend should be respected for the query.
  63          *
  64          * @return boolean TRUE, if the visibility settings for the frontend should should be respected; otherwise FALSE.
  65          */
  66         public function doVisibilityCheck();
  67
  68 }
  69 ?>