[TASK] Streamline phpdoc annotations in EXT:extbase
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Persistence / Generic / Qom / LogicalNot.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 * Performs a logical negation of another constraint.
19 *
20 * To satisfy the Not constraint, the node-tuple must not satisfy constraint.
21 * @internal only to be used within Extbase, not part of TYPO3 Core API.
22 */
23 class LogicalNot implements NotInterface
24 {
25 /**
26 * @var ConstraintInterface
27 */
28 protected $constraint;
29
30 /**
31 * @param ConstraintInterface $constraint
32 */
33 public function __construct(ConstraintInterface $constraint)
34 {
35 $this->constraint = $constraint;
36 }
37
38 /**
39 * Fills an array with the names of all bound variables in the constraint
40 *
41 * @param array &$boundVariables
42 */
43 public function collectBoundVariableNames(&$boundVariables)
44 {
45 $this->constraint->collectBoundVariableNames($boundVariables);
46 }
47
48 /**
49 * Gets the constraint negated by this Not constraint.
50 *
51 * @return ConstraintInterface the constraint; non-null
52 */
53 public function getConstraint()
54 {
55 return $this->constraint;
56 }
57 }