[CLEANUP] Replace wrong/old file copyright comments
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Persistence / Generic / Qom / Join.php
1 <?php
2 namespace TYPO3\CMS\Extbase\Persistence\Generic\Qom;
3
4 /***************************************************************
5 * Copyright notice
6 *
7 * (c) 2010-2012 Extbase Team (http://forge.typo3.org/projects/typo3v4-mvc)
8 * Extbase is a backport of TYPO3 Flow. 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 * Performs a join between two node-tuple sources.
32 */
33 class Join implements \TYPO3\CMS\Extbase\Persistence\Generic\Qom\JoinInterface {
34
35 /**
36 * @var \TYPO3\CMS\Extbase\Persistence\Generic\Qom\SourceInterface
37 */
38 protected $left;
39
40 /**
41 * @var \TYPO3\CMS\Extbase\Persistence\Generic\Qom\SourceInterface
42 */
43 protected $right;
44
45 /**
46 * @var integer
47 */
48 protected $joinType;
49
50 /**
51 * @var \TYPO3\CMS\Extbase\Persistence\Generic\Qom\JoinConditionInterface
52 */
53 protected $joinCondition;
54
55 /**
56 * Constructs the Join instance
57 *
58 * @param \TYPO3\CMS\Extbase\Persistence\Generic\Qom\SourceInterface $left the left node-tuple source; non-null
59 * @param \TYPO3\CMS\Extbase\Persistence\Generic\Qom\SourceInterface $right the right node-tuple source; non-null
60 * @param string $joinType one of QueryObjectModelConstants.JCR_JOIN_TYPE_*
61 * @param JoinConditionInterface $joinCondition
62 */
63 public function __construct(\TYPO3\CMS\Extbase\Persistence\Generic\Qom\SourceInterface $left, \TYPO3\CMS\Extbase\Persistence\Generic\Qom\SourceInterface $right, $joinType, \TYPO3\CMS\Extbase\Persistence\Generic\Qom\JoinConditionInterface $joinCondition) {
64 $this->left = $left;
65 $this->right = $right;
66 $this->joinType = $joinType;
67 $this->joinCondition = $joinCondition;
68 }
69
70 /**
71 * Gets the left node-tuple source.
72 *
73 * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\SourceInterface the left source; non-null
74 */
75 public function getLeft() {
76 return $this->left;
77 }
78
79 /**
80 * Gets the right node-tuple source.
81 *
82 * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\SourceInterface the right source; non-null
83 */
84 public function getRight() {
85 return $this->right;
86 }
87
88 /**
89 * Gets the join type.
90 *
91 * @return string one of QueryObjectModelConstants.JCR_JOIN_TYPE_*
92 */
93 public function getJoinType() {
94 return $this->joinType;
95 }
96
97 /**
98 * Gets the join condition.
99 *
100 * @return JoinConditionInterface the join condition; non-null
101 */
102 public function getJoinCondition() {
103 return $this->joinCondition;
104 }
105 }
106
107 ?>