[CLEANUP] Replace wrong/old file copyright comments
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Persistence / Generic / Typo3QuerySettings.php
index 130cf86..cd54754 100644 (file)
 <?php
-/***************************************************************
-*  Copyright notice
-*
-*  (c) 2009 Jochen Rau <jochen.rau@typoplanet.de>
-*  All rights reserved
-*
-*  This class is a backport of the corresponding class of FLOW3.
-*  All credits go to the v5 team.
-*
-*  This script is part of the TYPO3 project. The TYPO3 project is
-*  free software; you can redistribute it and/or modify
-*  it under the terms of the GNU General Public License as published by
-*  the Free Software Foundation; either version 2 of the License, or
-*  (at your option) any later version.
-*
-*  The GNU General Public License can be found at
-*  http://www.gnu.org/copyleft/gpl.html.
-*
-*  This script is distributed in the hope that it will be useful,
-*  but WITHOUT ANY WARRANTY; without even the implied warranty of
-*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-*  GNU General Public License for more details.
-*
-*  This copyright notice MUST APPEAR in all copies of the script!
-***************************************************************/
+namespace TYPO3\CMS\Extbase\Persistence\Generic;
 
+/***************************************************************
+ *  Copyright notice
+ *
+ *  (c) 2010-2012 Extbase Team (http://forge.typo3.org/projects/typo3v4-mvc)
+ *  Extbase is a backport of TYPO3 Flow. All credits go to the TYPO3 Flow team.
+ *  All rights reserved
+ *
+ *  This script is part of the TYPO3 project. The TYPO3 project is
+ *  free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; either version 2 of the License, or
+ *  (at your option) any later version.
+ *
+ *  The GNU General Public License can be found at
+ *  http://www.gnu.org/copyleft/gpl.html.
+ *  A copy is found in the textfile GPL.txt and important notices to the license
+ *  from the author is found in LICENSE.txt distributed with these scripts.
+ *
+ *
+ *  This script is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  This copyright notice MUST APPEAR in all copies of the script!
+ ***************************************************************/
 /**
  * Query settings. This class is NOT part of the FLOW3 API.
  * It reflects the settings unique to TYPO3 4.x.
  *
- * @package Extbase
- * @subpackage Persistence
- * @version $Id$
  * @api
  */
-class Tx_Extbase_Persistence_Typo3QuerySettings implements Tx_Extbase_Persistence_QuerySettingsInterface {
+class Typo3QuerySettings implements \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface {
 
        /**
         * Flag if the storage page should be respected for the query.
+        *
         * @var boolean
         */
        protected $respectStoragePage = TRUE;
 
        /**
         * the pid(s) of the storage page(s) that should be respected for the query.
+        *
         * @var array
         */
        protected $storagePageIds = array();
 
        /**
-        * Flag if the visibility settings for the frontend should be respected.
+        * A flag indicating whether all or some enable fields should be ignored. If TRUE, all enable fields are ignored.
+        * If--in addition to this--enableFieldsToBeIgnored is set, only fields specified there are ignored. If FALSE, all
+        * enable fields are taken into account, regardless of the enableFieldsToBeIgnored setting.
+        *
+        * @var boolean
+        */
+       protected $ignoreEnableFields = FALSE;
+
+       /**
+        * An array of column names in the enable columns array (array keys in $GLOBALS['TCA'][$table]['ctrl']['enablecolumns']),
+        * to be ignored while building the query statement
+        *
+        * @var array
+        */
+       protected $enableFieldsToBeIgnored = array();
+
+       /**
+        * Flag whether deleted records should be included in the result set.
+        *
         * @var boolean
         */
-       protected $respectEnableFields = TRUE;
+       protected $includeDeleted = FALSE;
 
        /**
         * Flag if the sys_language_uid should be respected (default is TRUE).
+        *
         * @var boolean
         */
        protected $respectSysLanguage = TRUE;
 
        /**
+        * The language uid for the language overlay.
+        *
+        * @var integer
+        */
+       protected $sysLanguageUid = 0;
+
+       /**
         * Flag if the the query result should be returned as raw QueryResult.
+        *
         * @var boolean
         */
        protected $returnRawQueryResult = FALSE;
 
        /**
+        * As long as we use a feature flag ignoreAllEnableFieldsInBe to determine the default behavior, the
+        * initializeObject is responsible for handling that.
+        */
+       public function initializeObject() {
+               /** @var $objectManager \TYPO3\CMS\Extbase\Object\ObjectManager */
+               $objectManager = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Extbase\\Object\\ObjectManager');
+               /** @var $configurationManager \TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface */
+               $configurationManager = $objectManager->get('TYPO3\\CMS\\Extbase\\Configuration\\ConfigurationManagerInterface');
+               if (TYPO3_MODE === 'BE' && $configurationManager->isFeatureEnabled('ignoreAllEnableFieldsInBe')) {
+                       $this->setIgnoreEnableFields(TRUE);
+               }
+
+               // Set correct language uid for frontend handling
+               if (isset($GLOBALS['TSFE']) && is_object($GLOBALS['TSFE'])) {
+                       $this->setSysLanguageUid($GLOBALS['TSFE']->sys_language_content);
+               } elseif (intval(\TYPO3\CMS\Core\Utility\GeneralUtility::_GP('L'))) {
+                       // Set language from 'L' parameter
+                       $this->setSysLanguageUid(intval(\TYPO3\CMS\Core\Utility\GeneralUtility::_GP('L')));
+               }
+       }
+
+       /**
         * Sets the flag if the storage page should be respected for the query.
         *
-        * @param $respectStoragePage If TRUE the storage page ID will be determined and the statement will be extended accordingly.
-        * @return $this (fluent interface)
+        * @param boolean $respectStoragePage If TRUE the storage page ID will be determined and the statement will be extended accordingly.
+        * @return \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface (fluent interface)
         * @api
         */
        public function setRespectStoragePage($respectStoragePage) {
@@ -90,8 +140,8 @@ class Tx_Extbase_Persistence_Typo3QuerySettings implements Tx_Extbase_Persistenc
        /**
         * Sets the pid(s) of the storage page(s) that should be respected for the query.
         *
-        * @param array $respectStoragePage If TRUE the storage page ID will be determined and the statement will be extended accordingly.
-        * @return Tx_Extbase_Persistence_QuerySettingsInterface instance of $this to allow method chaining
+        * @param array $storagePageIds If TRUE the storage page ID will be determined and the statement will be extended accordingly.
+        * @return \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface instance of $this to allow method chaining
         * @api
         */
        public function setStoragePageIds(array $storagePageIds) {
@@ -110,8 +160,8 @@ class Tx_Extbase_Persistence_Typo3QuerySettings implements Tx_Extbase_Persistenc
        /**
         * Sets the flag if a  and language overlay should be performed.
         *
-        * @param $respectEnableFields TRUE if a  and language overlay should be performed.
-        * @return $this (fluent interface)
+        * @param boolean $respectSysLanguage TRUE if a  and language overlay should be performed.
+        * @return \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface (fluent interface)
         * @api
         */
        public function setRespectSysLanguage($respectSysLanguage) {
@@ -129,14 +179,39 @@ class Tx_Extbase_Persistence_Typo3QuerySettings implements Tx_Extbase_Persistenc
        }
 
        /**
+        * Sets the language uid for the language overlay.
+        *
+        * @param integer $sysLanguageUid language uid for the language overlay
+        * @return \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface instance of $this to allow method chaining
+        * @api
+        */
+       public function setSysLanguageUid($sysLanguageUid) {
+               $this->sysLanguageUid = $sysLanguageUid;
+       }
+
+       /**
+        * Returns the language uid for the language overlay
+        *
+        * @return integer language uid for the language overlay
+        */
+       public function getSysLanguageUid() {
+               return $this->sysLanguageUid;
+       }
+
+       /**
         * Sets the flag if the visibility in the frontend should be respected.
         *
-        * @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.
-        * @return $this (fluent interface)
+        * @param boolean $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.
+        * @return \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface (fluent interface)
+        * @deprecated since Extbase 6.0, will be removed in Extbase 6.2. Use setIgnoreEnableFields() and setEnableFieldsToBeIgnored() instead.
+        * @see setIgnoreEnableFields()
+        * @see setEnableFieldsToBeIgnored()
         * @api
         */
        public function setRespectEnableFields($respectEnableFields) {
-               $this->respectEnableFields = $respectEnableFields;
+               \TYPO3\CMS\Core\Utility\GeneralUtility::logDeprecatedFunction();
+               $this->setIgnoreEnableFields(!$respectEnableFields);
+               $this->setIncludeDeleted(!$respectEnableFields);
                return $this;
        }
 
@@ -144,15 +219,90 @@ class Tx_Extbase_Persistence_Typo3QuerySettings implements Tx_Extbase_Persistenc
         * Returns the state, if the visibility settings for the frontend should be respected for the query.
         *
         * @return boolean TRUE, if the visibility settings for the frontend should should be respected; otherwise FALSE.
+        * @deprecated since Extbase 6.0, will be removed in Extbase 6.2. Use getIgnoreEnableFields() and getEnableFieldsToBeIgnored() instead.
+        * @see getIgnoreEnableFields()
+        * @see getEnableFieldsToBeIgnored()
         */
        public function getRespectEnableFields() {
-               return $this->respectEnableFields;
+               \TYPO3\CMS\Core\Utility\GeneralUtility::logDeprecatedFunction();
+               return !($this->getIgnoreEnableFields() && $this->getIncludeDeleted());
+       }
+
+       /**
+        * Sets a flag indicating whether all or some enable fields should be ignored. If TRUE, all enable fields are ignored.
+        * If--in addition to this--enableFieldsToBeIgnored is set, only fields specified there are ignored. If FALSE, all
+        * enable fields are taken into account, regardless of the enableFieldsToBeIgnored setting.
+        *
+        * @param boolean $ignoreEnableFields
+        * @see setEnableFieldsToBeIgnored()
+        * @api
+        */
+       public function setIgnoreEnableFields($ignoreEnableFields) {
+               $this->ignoreEnableFields = $ignoreEnableFields;
+       }
+
+       /**
+        * The returned value indicates whether all or some enable fields should be ignored.
+        *
+        * If TRUE, all enable fields are ignored. If--in addition to this--enableFieldsToBeIgnored is set, only fields specified there are ignored.
+        * If FALSE, all enable fields are taken into account, regardless of the enableFieldsToBeIgnored setting.
+        *
+        * @return boolean
+        * @see getEnableFieldsToBeIgnored()
+        */
+       public function getIgnoreEnableFields() {
+               return $this->ignoreEnableFields;
+       }
+
+       /**
+        * An array of column names in the enable columns array (array keys in $GLOBALS['TCA'][$table]['ctrl']['enablecolumns']),
+        * to be ignored while building the query statement. Adding a column name here effectively switches off filtering
+        * by this column. This setting is only taken into account if $this->ignoreEnableFields = TRUE.
+        *
+        * @param array $enableFieldsToBeIgnored
+        * @return void
+        * @see setIgnoreEnableFields()
+        * @api
+        */
+       public function setEnableFieldsToBeIgnored($enableFieldsToBeIgnored) {
+               $this->enableFieldsToBeIgnored = $enableFieldsToBeIgnored;
+       }
+
+       /**
+        * An array of column names in the enable columns array (array keys in $GLOBALS['TCA'][$table]['ctrl']['enablecolumns']),
+        * to be ignored while building the query statement.
+        *
+        * @return array
+        * @see getIgnoreEnableFields()
+        */
+       public function getEnableFieldsToBeIgnored() {
+               return $this->enableFieldsToBeIgnored;
+       }
+
+       /**
+        * Sets the flag if the query should return objects that are deleted.
+        *
+        * @param boolean $includeDeleted
+        * @return void
+        * @api
+        */
+       public function setIncludeDeleted($includeDeleted) {
+               $this->includeDeleted = $includeDeleted;
+       }
+
+       /**
+        * Returns if the query should return objects that are deleted.
+        *
+        * @return boolean
+        */
+       public function getIncludeDeleted() {
+               return $this->includeDeleted;
        }
 
        /**
         * Sets the state, if the QueryResult should be returned unmapped.
         *
-        * @var boolean $returnRawQueryResult TRUE, if the QueryResult should be returned unmapped; otherwise FALSE.
+        * @param boolean $returnRawQueryResult TRUE, if the QueryResult should be returned unmapped; otherwise FALSE.
         * @return void
         */
        public function setReturnRawQueryResult($returnRawQueryResult) {
@@ -167,6 +317,6 @@ class Tx_Extbase_Persistence_Typo3QuerySettings implements Tx_Extbase_Persistenc
        public function getReturnRawQueryResult() {
                return $this->returnRawQueryResult;
        }
-
 }
+
 ?>
\ No newline at end of file