[TASK] Streamline phpdoc annotations in EXT:extbase
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Persistence / Generic / Qom / BindVariableValue.php
index 5346c91..230bb28 100644 (file)
@@ -1,71 +1,57 @@
 <?php
 namespace TYPO3\CMS\Extbase\Persistence\Generic\Qom;
 
-/***************************************************************
- *  Copyright notice
+/*
+ * This file is part of the TYPO3 CMS project.
  *
- *  (c) 2009 Jochen Rau <jochen.rau@typoplanet.de>
- *  All rights reserved
+ * 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 class is a backport of the corresponding class of FLOW3.
- *  All credits go to the v5 team.
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
  *
- *  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!
- ***************************************************************/
+ * The TYPO3 project - inspiring people to share!
+ */
+
 /**
  * Evaluates to the value of a bind variable.
- * @scope prototype
+ * @internal only to be used within Extbase, not part of TYPO3 Core API.
  */
-class BindVariableValue extends \TYPO3\CMS\Extbase\Persistence\Generic\Qom\StaticOperand implements \TYPO3\CMS\Extbase\Persistence\Generic\Qom\BindVariableValueInterface {
-
-       /**
-        * @var string
-        */
-       protected $variableName;
-
-       /**
-        * Constructs this BindVariableValue instance
-        *
-        * @param string $variableName
-        */
-       public function __construct($variableName) {
-               $this->variableName = $variableName;
-       }
-
-       /**
-        * Fills an array with the names of all bound variables in the operand
-        *
-        * @param array &$boundVariables
-        * @return void
-        */
-       public function collectBoundVariableNames(&$boundVariables) {
-               $boundVariables[$this->variableName] = NULL;
-       }
-
-       /**
-        * Gets the name of the bind variable.
-        *
-        * @return string the bind variable name; non-null
-        */
-       public function getBindVariableName() {
-               return $this->variableName;
-       }
-
+class BindVariableValue implements \TYPO3\CMS\Extbase\Persistence\Generic\Qom\BindVariableValueInterface
+{
+    /**
+     * @var string
+     */
+    protected $variableName;
+
+    /**
+     * Constructs this BindVariableValue instance
+     *
+     * @param string $variableName
+     */
+    public function __construct($variableName)
+    {
+        $this->variableName = $variableName;
+    }
+
+    /**
+     * Fills an array with the names of all bound variables in the operand
+     *
+     * @param array &$boundVariables
+     */
+    public function collectBoundVariableNames(&$boundVariables)
+    {
+        $boundVariables[$this->variableName] = null;
+    }
+
+    /**
+     * Gets the name of the bind variable.
+     *
+     * @return string the bind variable name; non-null
+     */
+    public function getBindVariableName()
+    {
+        return $this->variableName;
+    }
 }
-
-
-?>
\ No newline at end of file