[TASK] Adjust phpdoc for classes (files) of backports
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Persistence / Generic / Qom / BindVariableValue.php
1 <?php
2 namespace TYPO3\CMS\Extbase\Persistence\Generic\Qom;
3
4 /***************************************************************
5 * Copyright notice
6 *
7 * This class is a backport of the corresponding class of TYPO3 Flow.
8 * All credits go to the TYPO3 Flow team.
9 * All rights reserved
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 * A copy is found in the textfile GPL.txt and important notices to the license
20 * from the author is found in LICENSE.txt distributed with these scripts.
21 *
22 *
23 * This script is distributed in the hope that it will be useful,
24 * but WITHOUT ANY WARRANTY; without even the implied warranty of
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 * GNU General Public License for more details.
27 *
28 * This copyright notice MUST APPEAR in all copies of the script!
29 ***************************************************************/
30 /**
31 * Evaluates to the value of a bind variable.
32 * @scope prototype
33 */
34 class BindVariableValue extends \TYPO3\CMS\Extbase\Persistence\Generic\Qom\StaticOperand implements \TYPO3\CMS\Extbase\Persistence\Generic\Qom\BindVariableValueInterface {
35
36 /**
37 * @var string
38 */
39 protected $variableName;
40
41 /**
42 * Constructs this BindVariableValue instance
43 *
44 * @param string $variableName
45 */
46 public function __construct($variableName) {
47 $this->variableName = $variableName;
48 }
49
50 /**
51 * Fills an array with the names of all bound variables in the operand
52 *
53 * @param array &$boundVariables
54 * @return void
55 */
56 public function collectBoundVariableNames(&$boundVariables) {
57 $boundVariables[$this->variableName] = NULL;
58 }
59
60 /**
61 * Gets the name of the bind variable.
62 *
63 * @return string the bind variable name; non-null
64 */
65 public function getBindVariableName() {
66 return $this->variableName;
67 }
68
69 }
70
71
72 ?>