[TASK] Streamline phpdoc annotations in EXT:extbase
[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 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 /**
18 * Evaluates to the value of a bind variable.
19 * @internal only to be used within Extbase, not part of TYPO3 Core API.
20 */
21 class BindVariableValue implements \TYPO3\CMS\Extbase\Persistence\Generic\Qom\BindVariableValueInterface
22 {
23 /**
24 * @var string
25 */
26 protected $variableName;
27
28 /**
29 * Constructs this BindVariableValue instance
30 *
31 * @param string $variableName
32 */
33 public function __construct($variableName)
34 {
35 $this->variableName = $variableName;
36 }
37
38 /**
39 * Fills an array with the names of all bound variables in the operand
40 *
41 * @param array &$boundVariables
42 */
43 public function collectBoundVariableNames(&$boundVariables)
44 {
45 $boundVariables[$this->variableName] = null;
46 }
47
48 /**
49 * Gets the name of the bind variable.
50 *
51 * @return string the bind variable name; non-null
52 */
53 public function getBindVariableName()
54 {
55 return $this->variableName;
56 }
57 }