3.16.0-33.44~14.04.1
) is not available, but a newer one is (3.16.0-38.52~14.04.1
). We redirected you there.
/usr/share/php/propel/query/Join.php is in php-propel-runtime 1.6.9-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 | <?php
/**
* This file is part of the Propel package.
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @license MIT License
*/
/**
* Data object to describe a join between two tables, for example
* <pre>
* table_a LEFT JOIN table_b ON table_a.id = table_b.a_id
* </pre>
*
* @author Francois Zaninotto (Propel)
* @author Hans Lellelid <hans@xmpl.org> (Propel)
* @author Kaspars Jaudzems <kaspars.jaudzems@inbox.lv> (Propel)
* @author Frank Y. Kim <frank.kim@clearink.com> (Torque)
* @author John D. McNally <jmcnally@collab.net> (Torque)
* @author Brett McLaughlin <bmclaugh@algx.net> (Torque)
* @author Eric Dobbs <eric@dobbse.net> (Torque)
* @author Henning P. Schmiedehausen <hps@intermeta.de> (Torque)
* @author Sam Joseph <sam@neurogrid.com> (Torque)
* @package propel.runtime.query
*/
class Join
{
// default comparison type
const EQUAL = "=";
const INNER_JOIN = 'INNER JOIN';
// the left parts of the join condition
protected $left = array();
// the right parts of the join condition
protected $right = array();
// the comparison operators for each pair of columns in the join condition
protected $operator = array();
// the type of the join (LEFT JOIN, ...)
protected $joinType;
// the number of conditions in the join
protected $count = 0;
// the database adapter
protected $db;
protected $leftTableName;
protected $rightTableName;
protected $leftTableAlias;
protected $rightTableAlias;
protected $joinCondition;
/**
* Constructor
* Use it preferably with no arguments, and then use addCondition() and setJoinType()
* Syntax with arguments used mainly for backwards compatibility
*
* @param string $leftColumn The left column of the join condition
* (may contain an alias name)
* @param string $rightColumn The right column of the join condition
* (may contain an alias name)
* @param string $joinType The type of the join. Valid join types are null (implicit join),
* Criteria::LEFT_JOIN, Criteria::RIGHT_JOIN, and Criteria::INNER_JOIN
*/
public function __construct($leftColumn = null, $rightColumn = null, $joinType = null)
{
if (null !== $leftColumn) {
if (is_array($leftColumn)) {
// join with multiple conditions
$this->addConditions($leftColumn, $rightColumn);
} else {
// simple join
$this->addCondition($leftColumn, $rightColumn);
}
}
if (null !== $joinType) {
$this->setJoinType($joinType);
}
}
/**
* Join condition definition.
* Warning: doesn't support table aliases. Use the explicit methods to use aliases.
*
* @param string $left The left column of the join condition
* (may contain an alias name)
* @param string $right The right column of the join condition
* (may contain an alias name)
* @param string $operator The comparison operator of the join condition, default Join::EQUAL
*/
public function addCondition($left, $right, $operator = self::EQUAL)
{
if ($pos = strrpos($left, '.')) {
list($this->leftTableName, $this->left[]) = explode('.', $left);
} else {
$this->left[] = $left;
}
if ($pos = strrpos($right, '.')) {
list($this->rightTableName, $this->right[]) = explode('.', $right);
} else {
$this->right[] = $right;
}
$this->operator[] = $operator;
$this->count++;
}
/**
* Join condition definition, for several conditions
*
* @param array $lefts The left columns of the join condition
* @param array $rights The right columns of the join condition
* @param array $operators The comparison operators of the join condition, default Join::EQUAL
*
* @throws PropelException
*/
public function addConditions($lefts, $rights, $operators = array())
{
if (count($lefts) != count($rights) ) {
throw new PropelException("Unable to create join because the left column count isn't equal to the right column count");
}
foreach ($lefts as $key => $left) {
$this->addCondition($left, $rights[$key], isset($operators[$key]) ? $operators[$key] : self::EQUAL);
}
}
/**
* Join condition definition.
* @example
* <code>
* $join = new Join();
* $join->setJoinType(Criteria::LEFT_JOIN);
* $join->addExplicitCondition('book', 'AUTHOR_ID', null, 'author', 'ID', 'a', Join::EQUAL);
* echo $join->getClause();
* // LEFT JOIN author a ON (book.AUTHOR_ID=a.ID)
* </code>
*
* @param string $leftTableName
* @param string $leftColumnName
* @param string $leftTableAlias
* @param string $rightTableName
* @param string $rightColumnName
* @param string $rightTableAlias
* @param string $operator The comparison operator of the join condition, default Join::EQUAL
*/
public function addExplicitCondition($leftTableName, $leftColumnName, $leftTableAlias = null, $rightTableName, $rightColumnName, $rightTableAlias = null, $operator = self::EQUAL)
{
$this->leftTableName = $leftTableName;
$this->leftTableAlias = $leftTableAlias;
$this->rightTableName = $rightTableName;
$this->rightTableAlias = $rightTableAlias;
$this->left []= $leftColumnName;
$this->right []= $rightColumnName;
$this->operator []= $operator;
$this->count++;
}
/**
* Retrieve the number of conditions in the join
*
* @return integer The number of conditions in the join
*/
public function countConditions()
{
return $this->count;
}
/**
* Return an array of the join conditions
*
* @return array An array of arrays representing (left, comparison, right) for each condition
*/
public function getConditions()
{
$conditions = array();
for ($i=0; $i < $this->count; $i++) {
$conditions[] = array(
'left' => $this->getLeftColumn($i),
'operator' => $this->getOperator($i),
'right' => $this->getRightColumn($i)
);
}
return $conditions;
}
/**
* @param string $operator the comparison operator for the join condition
*/
public function addOperator($operator = null)
{
$this->operator []= $operator;
}
/**
* @param int $index
* @return string the comparison operator for the join condition
*/
public function getOperator($index = 0)
{
return $this->operator[$index];
}
public function getOperators()
{
return $this->operator;
}
/**
* Set the join type
*
* @param string $joinType The type of the join. Valid join types are
* null (adding the join condition to the where clause),
* Criteria::LEFT_JOIN(), Criteria::RIGHT_JOIN(), and Criteria::INNER_JOIN()
*/
public function setJoinType($joinType = null)
{
$this->joinType = $joinType;
}
/**
* Get the join type
*
* @return string The type of the join, i.e. Criteria::LEFT_JOIN(), ...,
* or null for adding the join condition to the where Clause
*/
public function getJoinType()
{
return null === $this->joinType ? self::INNER_JOIN : $this->joinType;
}
/**
* Add a left column name to the join condition
*
* @example
* <code>
* $join->setLeftTableName('book');
* $join->addLeftColumnName('AUTHOR_ID');
* </code>
* @param string $left The name of the left column to add
*/
public function addLeftColumnName($left)
{
$this->left []= $left;
}
/**
* Get the fully qualified name of the left column of the join condition
*
* @example
* <code>
* $join->addCondition('book.AUTHOR_ID', 'author.ID');
* echo $join->getLeftColumn(); // 'book.AUTHOR_ID'
* </code>
* @param integer $index The number of the condition to use
* @return string
*/
public function getLeftColumn($index = 0)
{
$tableName = $this->getLeftTableAliasOrName();
return $tableName ? $tableName . '.' . $this->left[$index] : $this->left[$index];
}
/**
* Get the left column name of the join condition
*
* @example
* <code>
* $join->addCondition('book.AUTHOR_ID', 'author.ID');
* echo $join->getLeftColumnName(); // 'AUTHOR_ID'
* </code>
* @param integer $index The number of the condition to use
* @return string
*/
public function getLeftColumnName($index = 0)
{
return $this->left[$index];
}
/**
* Get the list of all the names of left columns of the join condition
* @return array
*/
public function getLeftColumns()
{
$columns = array();
foreach ($this->left as $index => $column) {
$columns []= $this->getLeftColumn($index);
}
return $columns;
}
public function setLeftTableName($leftTableName)
{
$this->leftTableName = $leftTableName;
return $this;
}
public function getLeftTableName()
{
return $this->leftTableName;
}
public function setLeftTableAlias($leftTableAlias)
{
$this->leftTableAlias = $leftTableAlias;
return $this;
}
public function getLeftTableAlias()
{
return $this->leftTableAlias;
}
public function hasLeftTableAlias()
{
return null !== $this->leftTableAlias;
}
public function getLeftTableAliasOrName()
{
return $this->leftTableAlias ? $this->leftTableAlias : $this->leftTableName;
}
public function getLeftTableWithAlias()
{
return $this->leftTableAlias ? $this->leftTableName . ' ' . $this->leftTableAlias : $this->leftTableName;
}
/**
* Add a right column name to the join condition
*
* @example
* <code>
* $join->setRightTableName('author');
* $join->addRightColumnName('ID');
* </code>
* @param string $right The name of the right column to add
*/
public function addRightColumnName($right)
{
$this->right []= $right;
}
/**
* Get the fully qualified name of the right column of the join condition
*
* @example
* <code>
* $join->addCondition('book.AUTHOR_ID', 'author.ID');
* echo $join->getLeftColumn(); // 'author.ID'
* </code>
* @param integer $index The number of the condition to use
* @return string
*/
public function getRightColumn($index = 0)
{
$tableName = $this->getRightTableAliasOrName();
return $tableName ? $tableName . '.' . $this->right[$index] : $this->right[$index];
}
/**
* Get the right column name of the join condition
*
* @example
* <code>
* $join->addCondition('book.AUTHOR_ID', 'author.ID');
* echo $join->getLeftColumn(); // 'ID'
* </code>
* @param integer $index The number of the condition to use
* @return string
*/
public function getRightColumnName($index = 0)
{
return $this->right[$index];
}
/**
* @return all right columns of the join condition
*/
public function getRightColumns()
{
$columns = array();
foreach ($this->right as $index => $column) {
$columns []= $this->getRightColumn($index);
}
return $columns;
}
public function setRightTableName($rightTableName)
{
$this->rightTableName = $rightTableName;
return $this;
}
public function getRightTableName()
{
return $this->rightTableName;
}
public function setRightTableAlias($rightTableAlias)
{
$this->rightTableAlias = $rightTableAlias;
return $this;
}
public function getRightTableAlias()
{
return $this->rightTableAlias;
}
public function hasRightTableAlias()
{
return null !== $this->rightTableAlias;
}
public function getRightTableAliasOrName()
{
return $this->rightTableAlias ? $this->rightTableAlias : $this->rightTableName;
}
public function getRightTableWithAlias()
{
return $this->rightTableAlias ? $this->rightTableName . ' ' . $this->rightTableAlias : $this->rightTableName;
}
/**
* Get the value of db.
* The DBAdapter which might be used to get db specific
* variations of sql.
* @return DBAdapter value of db.
*/
public function getDB()
{
return $this->db;
}
/**
* Set the value of db.
* The DBAdapter might be used to get db specific variations of sql.
* @param DBAdapter $db Value to assign to db.
* @return void
*/
public function setDB(DBAdapter $db)
{
$this->db = $db;
}
/**
* Set a custom join condition
*
* @param Criterion $joinCondition a Join condition
*/
public function setJoinCondition(Criterion $joinCondition)
{
$this->joinCondition = $joinCondition;
}
/**
* Get the custom join condition, if previously set
*
* @return Criterion
*/
public function getJoinCondition()
{
return $this->joinCondition;
}
/**
* Set the custom join condition Criterion based on the conditions of this join
*
* @param Criteria $c A Criteria object to get Criterions from
*/
public function buildJoinCondition(Criteria $c)
{
$joinCondition = null;
for ($i=0; $i < $this->count; $i++) {
$criterion = $c->getNewCriterion($this->getLeftColumn($i), $this->getLeftColumn($i) . $this->getOperator($i) . $this->getRightColumn($i), Criteria::CUSTOM);
if (null === $joinCondition) {
$joinCondition = $criterion;
} else {
$joinCondition = $joinCondition->addAnd($criterion);
}
}
$this->joinCondition = $joinCondition;
}
/**
* Get the join clause for this Join.
* If the join condition needs binding, uses the passed params array.
* @example
* <code>
* $join = new Join();
* $join->addExplicitCondition('book', 'AUTHOR_ID', null, 'author', 'ID');
* $params = array();
* echo $j->getClause($params);
* // 'LEFT JOIN author ON (book.AUTHOR_ID=author.ID)'
* </code>
*
* @param array &$params
*
* @return string SQL join clause with join condition
*/
public function getClause(&$params)
{
if (null === $this->joinCondition) {
$conditions = array();
for ($i=0; $i < $this->count; $i++) {
$conditions []= $this->getLeftColumn($i) . $this->getOperator($i) . $this->getRightColumn($i);
}
$joinCondition = sprintf('(%s)', implode($conditions, ' AND '));
} else {
$joinCondition = '';
$this->getJoinCondition()->appendPsTo($joinCondition, $params);
}
$rightTableName = $this->getRightTableWithAlias();
if (null !== $this->db && $this->db->useQuoteIdentifier()) {
$rightTableName = $this->db->quoteIdentifierTable($rightTableName);
}
return sprintf('%s %s ON %s',
$this->getJoinType(),
$rightTableName,
$joinCondition
);
}
/**
* @param Join $join
* @return bool
*/
public function equals($join)
{
return $join !== null
&& $join instanceof Join
&& $this->joinType == $join->getJoinType()
&& $this->getConditions() == $join->getConditions();
}
/**
* Returns a String representation of the class,
*
* @return string A String representation of the class
*/
public function toString()
{
$params = array();
return $this->getClause($params);
}
public function __toString()
{
return $this->toString();
}
}
|