[TASK] Re-work/simplify copyright header in PHP files - Part 8
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Persistence / Generic / Typo3QuerySettings.php
index 5443119..48c95e1 100644 (file)
@@ -1,32 +1,18 @@
 <?php
 namespace TYPO3\CMS\Extbase\Persistence\Generic;
 
-/***************************************************************
- *  Copyright notice
- *
- *  (c) 2010-2013 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 text file GPL.txt and important notices to the license
- *  from the author is found in LICENSE.txt distributed with these scripts.
+/**
+ * This file is part of the TYPO3 CMS project.
  *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
  *
- *  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.
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
  *
- *  This copyright notice MUST APPEAR in all copies of the script!
- ***************************************************************/
+ * The TYPO3 project - inspiring people to share!
+ */
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
@@ -35,7 +21,7 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
  *
  * @api
  */
-class Typo3QuerySettings implements \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface {
+class Typo3QuerySettings implements QuerySettingsInterface {
 
        /**
         * Flag if the storage page should be respected for the query.
@@ -119,6 +105,13 @@ class Typo3QuerySettings implements \TYPO3\CMS\Extbase\Persistence\Generic\Query
        protected $usePreparedStatement = FALSE;
 
        /**
+        * Flag whether the query should be cached using the caching framework
+        *
+        * @var bool
+        */
+       protected $useQueryCache = TRUE;
+
+       /**
         * As long as we use a feature flag ignoreAllEnableFieldsInBe to determine the default behavior, the
         * initializeObject is responsible for handling that.
         */
@@ -151,7 +144,7 @@ class Typo3QuerySettings implements \TYPO3\CMS\Extbase\Persistence\Generic\Query
         * Sets the flag if the storage page should be respected for the query.
         *
         * @param bool $respectStoragePage If TRUE the storage page ID will be determined and the statement will be extended accordingly.
-        * @return \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface
+        * @return QuerySettingsInterface
         * @api
         */
        public function setRespectStoragePage($respectStoragePage) {
@@ -172,7 +165,7 @@ class Typo3QuerySettings implements \TYPO3\CMS\Extbase\Persistence\Generic\Query
         * Sets the pid(s) of the storage page(s) that should be respected for the query.
         *
         * @param array $storagePageIds If given the storage page IDs will be determined and the statement will be extended accordingly.
-        * @return \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface
+        * @return QuerySettingsInterface
         * @api
         */
        public function setStoragePageIds(array $storagePageIds) {
@@ -191,7 +184,7 @@ class Typo3QuerySettings implements \TYPO3\CMS\Extbase\Persistence\Generic\Query
 
        /**
         * @param bool $respectSysLanguage TRUE if TYPO3 language settings are to be applied
-        * @return \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface (fluent interface)
+        * @return QuerySettingsInterface
         * @api
         */
        public function setRespectSysLanguage($respectSysLanguage) {
@@ -208,7 +201,7 @@ class Typo3QuerySettings implements \TYPO3\CMS\Extbase\Persistence\Generic\Query
 
        /**
         * @param mixed $languageOverlayMode TRUE, FALSE or "hideNonTranslated"
-        * @return \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface instance of $this to allow method chaining
+        * @return QuerySettingsInterface instance of $this to allow method chaining
         * @api
         */
        public function setLanguageOverlayMode($languageOverlayMode = FALSE) {
@@ -225,7 +218,7 @@ class Typo3QuerySettings implements \TYPO3\CMS\Extbase\Persistence\Generic\Query
 
        /**
         * @param string $languageMode NULL, "content_fallback", "strict" or "ignore"
-        * @return \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface instance of $this to allow method chaining
+        * @return QuerySettingsInterface instance of $this to allow method chaining
         * @api
         */
        public function setLanguageMode($languageMode = '') {
@@ -242,7 +235,7 @@ class Typo3QuerySettings implements \TYPO3\CMS\Extbase\Persistence\Generic\Query
 
        /**
         * @param int $languageUid
-        * @return \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface instance of $this to allow method chaining
+        * @return QuerySettingsInterface instance of $this to allow method chaining
         * @api
         */
        public function setLanguageUid($languageUid) {
@@ -261,7 +254,7 @@ class Typo3QuerySettings implements \TYPO3\CMS\Extbase\Persistence\Generic\Query
         * Sets the language uid for the language overlay.
         *
         * @param int $sysLanguageUid language uid for the language overlay
-        * @return \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface instance of $this to allow method chaining
+        * @return QuerySettingsInterface instance of $this to allow method chaining
         * @deprecated since Extbase 6.2, will be removed two versions later. Use setLanguageUid() instead.
         */
        public function setSysLanguageUid($sysLanguageUid) {
@@ -281,42 +274,12 @@ class Typo3QuerySettings implements \TYPO3\CMS\Extbase\Persistence\Generic\Query
        }
 
        /**
-        * Sets the flag if the visibility in the frontend should be respected.
-        *
-        * @param bool $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
-        * @deprecated since Extbase 6.0, will be removed two versions later. Use setIgnoreEnableFields() and setEnableFieldsToBeIgnored() instead.
-        * @see setIgnoreEnableFields()
-        * @see setEnableFieldsToBeIgnored()
-        * @api
-        */
-       public function setRespectEnableFields($respectEnableFields) {
-               GeneralUtility::logDeprecatedFunction();
-               $this->setIgnoreEnableFields(!$respectEnableFields);
-               $this->setIncludeDeleted(!$respectEnableFields);
-               return $this;
-       }
-
-       /**
-        * Returns the state, if the visibility settings for the frontend should be respected for the query.
-        *
-        * @return bool TRUE, if the visibility settings for the frontend should should be respected; otherwise FALSE.
-        * @deprecated since Extbase 6.0, will be removed two versions later. Use getIgnoreEnableFields() and getEnableFieldsToBeIgnored() instead.
-        * @see getIgnoreEnableFields()
-        * @see getEnableFieldsToBeIgnored()
-        */
-       public function getRespectEnableFields() {
-               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 bool $ignoreEnableFields
-        * @return \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface
+        * @return QuerySettingsInterface
         * @see setEnableFieldsToBeIgnored()
         * @api
         */
@@ -344,7 +307,7 @@ class Typo3QuerySettings implements \TYPO3\CMS\Extbase\Persistence\Generic\Query
         * by this column. This setting is only taken into account if $this->ignoreEnableFields = TRUE.
         *
         * @param array $enableFieldsToBeIgnored
-        * @return \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface
+        * @return QuerySettingsInterface
         * @see setIgnoreEnableFields()
         * @api
         */
@@ -368,7 +331,7 @@ class Typo3QuerySettings implements \TYPO3\CMS\Extbase\Persistence\Generic\Query
         * Sets the flag if the query should return objects that are deleted.
         *
         * @param bool $includeDeleted
-        * @return \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface
+        * @return QuerySettingsInterface
         * @api
         */
        public function setIncludeDeleted($includeDeleted) {
@@ -389,7 +352,7 @@ class Typo3QuerySettings implements \TYPO3\CMS\Extbase\Persistence\Generic\Query
         * Sets the state, if the QueryResult should be returned unmapped.
         *
         * @param bool $returnRawQueryResult TRUE, if the QueryResult should be returned unmapped; otherwise FALSE.
-        * @return \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface
+        * @return QuerySettingsInterface
         * @deprecated since Extbase 6.2, will be removed two versions later. Please use argument in query->execute() instead.
         */
        public function setReturnRawQueryResult($returnRawQueryResult) {
@@ -411,7 +374,7 @@ class Typo3QuerySettings implements \TYPO3\CMS\Extbase\Persistence\Generic\Query
 
        /**
         * @param bool $usePreparedStatement
-        * @return \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface
+        * @return QuerySettingsInterface
         */
        public function usePreparedStatement($usePreparedStatement) {
                $this->usePreparedStatement = $usePreparedStatement;
@@ -424,4 +387,20 @@ class Typo3QuerySettings implements \TYPO3\CMS\Extbase\Persistence\Generic\Query
        public function getUsePreparedStatement() {
                return (bool)$this->usePreparedStatement;
        }
+
+       /**
+        * @param bool $useQueryCache
+        * @return QuerySettingsInterface
+        */
+       public function useQueryCache($useQueryCache) {
+               $this->useQueryCache = (bool)$useQueryCache;
+               return $this;
+       }
+
+       /**
+        * @return bool
+        */
+       public function getUseQueryCache() {
+               return $this->useQueryCache;
+       }
 }