Skip to content

Commit a88e6a8

Browse files
dereuromarkdereuromark
authored
Merge pull request #1782 from mringler/reintroduce_late_select_for_backward_compatibility
Reintroduce late select for backward compatibility
2 parents faf29e2 + 3caa4bf commit a88e6a8

File tree

7 files changed

+104
-61
lines changed

7 files changed

+104
-61
lines changed

‎src/Propel/Generator/Behavior/QueryCache/QueryCacheBehavior.php

+3
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,7 @@ public function doSelect(ConnectionInterface \$con = null)
230230
if (!\$this->hasSelectClause() && !\$this->getPrimaryCriteria()) {
231231
\$this->addSelfSelectColumns();
232232
}
233+
\$this->configureSelectColumns();
233234
234235
\$dbMap = Propel::getServiceContainer()->getDatabaseMap(" . $this->tableClassName . "::DATABASE_NAME);
235236
\$db = Propel::getServiceContainer()->getAdapter(" . $this->tableClassName . "::DATABASE_NAME);
@@ -284,6 +285,8 @@ public function doCount(ConnectionInterface \$con = null)
284285
\$this->addSelfSelectColumns();
285286
}
286287
288+
\$this->configureSelectColumns();
289+
287290
\$needsComplexCount = \$this->getGroupByColumns()
288291
|| \$this->getOffset()
289292
|| \$this->getLimit() >= 0

‎src/Propel/Generator/Builder/Om/QueryBuilder.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -654,7 +654,7 @@ public function findPk(\$key, ConnectionInterface \$con = null)
654654
\$this->basePreSelect(\$con);
655655
656656
if (
657-
\$this->formatter || \$this->modelAlias || \$this->with
657+
\$this->formatter || \$this->modelAlias || \$this->with || \$this->select
658658
|| \$this->selectColumns || \$this->asColumns || \$this->selectModifiers
659659
|| \$this->map || \$this->having || \$this->joins
660660
) {

‎src/Propel/Runtime/ActiveQuery/ModelCriteria.php

+63-25
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,12 @@ class ModelCriteria extends BaseModelCriteria
8282
*/
8383
protected $isKeepQuery = true;
8484

85+
// this is for the select method
86+
/**
87+
* @var string|array|null
88+
*/
89+
protected $select;
90+
8591
/**
8692
* Used to memorize whether we added self-select columns before.
8793
*
@@ -466,50 +472,42 @@ public function select($columnArray)
466472
if (empty($columnArray)) {
467473
throw new PropelException('You must ask for at least one column');
468474
}
469-
$this->isSelfSelected = true;
470-
if ($this->formatter === null) {
471-
$this->setFormatter(SimpleArrayFormatter::class);
472-
}
473475

474476
if ($columnArray === '*') {
475-
$columnArray = [];
476-
foreach ($this->getTableMap()->getColumns() as $columnMap) {
477-
$columnArray[] = $this->modelName . '.' . $columnMap->getPhpName();
478-
}
477+
$columnArray = $this->resolveSelectAll();
479478
}
480479
if (!is_array($columnArray)) {
481480
$columnArray = [$columnArray];
482481
}
482+
$this->select = $columnArray;
483+
$this->isSelfSelected = true;
483484

484-
$this->selectColumns = [];
485+
return $this;
486+
}
485487

486-
foreach ($columnArray as $columnName) {
487-
if (array_key_exists($columnName, $this->asColumns)) {
488-
continue;
489-
}
490-
[$columnMap, $realColumnName] = $this->getColumnFromName($columnName);
491-
if ($realColumnName === null) {
492-
throw new PropelException("Cannot find selected column '$columnName'");
493-
}
494-
// always put quotes around the columnName to be safe, we strip them in the formatter
495-
$this->addAsColumn('"' . $columnName . '"', $realColumnName);
488+
/**
489+
* @return string[]
490+
*/
491+
protected function resolveSelectAll(): array
492+
{
493+
$columnArray = [];
494+
foreach ($this->getTableMap()->getColumns() as $columnMap) {
495+
$columnArray[] = $this->modelName . '.' . $columnMap->getPhpName();
496496
}
497497

498-
return $this;
498+
return $columnArray;
499499
}
500500

501501
/**
502502
* Retrieves the columns defined by a previous call to select().
503503
*
504-
* @deprecated Not needed anymore, selected columns are part of {@link Criteria::$asColumns}
505-
*
506504
* @see select()
507505
*
508506
* @return array|string A list of column names (e.g. array('Title', 'Category.Name', 'c.Content')) or a single column name (e.g. 'Name')
509507
*/
510508
public function getSelect()
511509
{
512-
return array_values($this->asColumns);
510+
return $this->select;
513511
}
514512

515513
/**
@@ -976,6 +974,7 @@ public function clear()
976974
$this->with = [];
977975
$this->primaryCriteria = null;
978976
$this->formatter = null;
977+
$this->select = null;
979978

980979
return $this;
981980
}
@@ -1637,6 +1636,8 @@ public function count(?ConnectionInterface $con = null)
16371636
*/
16381637
public function doCount(?ConnectionInterface $con = null)
16391638
{
1639+
$this->configureSelectColumns();
1640+
16401641
// check that the columns of the main class are already added (if this is the primary ModelCriteria)
16411642
if (!$this->hasSelectClause() && !$this->getPrimaryCriteria()) {
16421643
$this->addSelfSelectColumns();
@@ -2203,19 +2204,56 @@ public function getModelJoinByTableName($tableName)
22032204
*/
22042205
public function doSelect(?ConnectionInterface $con = null)
22052206
{
2207+
$this->configureSelectColumns();
2208+
22062209
$this->addSelfSelectColumns();
22072210

22082211
return parent::doSelect($con);
22092212
}
22102213

22112214
/**
2212-
* @deprecated This method was used to add columns from {@link select()} during query generation, but that is handled
2213-
* right away now.
2215+
* {@inheritDoc}
2216+
*
2217+
* @see \Propel\Runtime\ActiveQuery\Criteria::createSelectSql()
2218+
*
2219+
* @param array $params Parameters that are to be replaced in prepared statement.
2220+
*
2221+
* @return string
2222+
*/
2223+
public function createSelectSql(&$params)
2224+
{
2225+
$this->configureSelectColumns();
2226+
2227+
return parent::createSelectSql($params);
2228+
}
2229+
2230+
/**
2231+
* @throws \Propel\Runtime\Exception\PropelException
22142232
*
22152233
* @return void
22162234
*/
22172235
public function configureSelectColumns()
22182236
{
2237+
if (!$this->select) {
2238+
return;
2239+
}
2240+
2241+
if ($this->formatter === null) {
2242+
$this->setFormatter(SimpleArrayFormatter::class);
2243+
}
2244+
$this->selectColumns = [];
2245+
2246+
foreach ($this->select as $columnName) {
2247+
if (array_key_exists($columnName, $this->asColumns)) {
2248+
continue;
2249+
}
2250+
[$columnMap, $realColumnName] = $this->getColumnFromName($columnName);
2251+
if ($realColumnName === null) {
2252+
throw new PropelException("Cannot find selected column '$columnName'");
2253+
}
2254+
// always put quotes around the columnName to be safe, we strip them in the formatter
2255+
$this->addAsColumn('"' . $columnName . '"', $realColumnName);
2256+
}
22192257
}
22202258

22212259
/**

‎tests/Propel/Tests/Runtime/ActiveQuery/ModelCriteriaGroupByArrayTest.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ public function testGroupByArray()
8686
->orderByLastName()
8787
->find();
8888

89-
$expectedSql = 'SELECT author.first_name AS "FirstName", author.last_name AS "LastName", COUNT(book.id) AS nbBooks FROM author LEFT JOIN book ON (author.id=book.author_id) GROUP BY author.first_name,author.last_name ORDER BY author.last_name ASC';
89+
$expectedSql = 'SELECT COUNT(book.id) AS nbBooks, author.first_name AS "FirstName", author.last_name AS "LastName" FROM author LEFT JOIN book ON (author.id=book.author_id) GROUP BY author.first_name,author.last_name ORDER BY author.last_name ASC';
9090

9191
$this->assertEquals($expectedSql, $this->con->getLastExecutedQuery());
9292

‎tests/Propel/Tests/Runtime/ActiveQuery/ModelCriteriaSelectTest.php

+33-30
Original file line numberDiff line numberDiff line change
@@ -452,35 +452,40 @@ public function testSelectArrayPaginate()
452452
/**
453453
* @return void
454454
*/
455-
public function testGetSelectAddsToAsColumns()
455+
public function testGetSelectReturnsNullByDefault()
456456
{
457457
$c = new ModelCriteria('bookstore', 'Propel\Tests\Bookstore\Book');
458-
$c->select('Title');
458+
$this->assertNull($c->getSelect());
459+
}
459460

460-
$this->assertIsArray($c->getAsColumns());
461-
$this->assertCount(1, $c->getAsColumns());
462-
$this->assertArrayHasKey('"Title"', $c->getAsColumns());
463-
$clause = $c->getAsColumns()['"Title"'];
464-
$this->assertEquals('book.title', $clause);
461+
/**
462+
* @return void
463+
*/
464+
public function testGetSelectReturnsArrayWhenSelectingASingleColumn()
465+
{
466+
$c = new ModelCriteria('bookstore', 'Propel\Tests\Bookstore\Book');
467+
$c->select('Title');
468+
$this->assertEquals(['Title'], $c->getSelect());
469+
}
470+
471+
/**
472+
* @return void
473+
*/
474+
public function testGetSelectReturnsArrayWhenSelectingSeveralColumns()
475+
{
476+
$c = new ModelCriteria('bookstore', 'Propel\Tests\Bookstore\Book');
477+
$c->select(['Id', 'Title']);
478+
$this->assertEquals(['Id', 'Title'], $c->getSelect());
465479
}
466480

467481
/**
468482
* @return void
469483
*/
470-
public function testGetSelectAddsArrayToAsColumns()
484+
public function testGetSelectReturnsArrayWhenSelectingASingleColumnAsArray()
471485
{
472486
$c = new ModelCriteria('bookstore', 'Propel\Tests\Bookstore\Book');
473-
$columns = ['Id', 'Title'];
474-
$c->select($columns);
475-
476-
$this->assertIsArray($c->getAsColumns());
477-
$this->assertCount(2, $c->getAsColumns());
478-
foreach ($columns as $columnName) {
479-
$quotedName = "\"$columnName\"";
480-
$this->assertArrayHasKey($quotedName, $c->getAsColumns());
481-
$clause = $c->getAsColumns()[$quotedName];
482-
$this->assertEquals('book.' . strtolower($columnName), $clause);
483-
}
487+
$c->select(['Title']);
488+
$this->assertEquals(['Title'], $c->getSelect());
484489
}
485490

486491
/**
@@ -490,17 +495,14 @@ public function testGetSelectReturnsArrayWhenSelectingAllColumns()
490495
{
491496
$c = new ModelCriteria('bookstore', 'Propel\Tests\Bookstore\Book');
492497
$c->select('*');
493-
$tableColumns = BookTableMap::getTableMap()->getColumns();
494-
495-
$this->assertIsArray($c->getAsColumns());
496-
$this->assertCount(count($tableColumns), $c->getAsColumns());
497-
foreach ($tableColumns as $columnMap) {
498-
$columnName = $c->getModelName() . '.' . $columnMap->getPhpName();
499-
$quotedName = "\"$columnName\"";
500-
$this->assertArrayHasKey($quotedName, $c->getAsColumns());
501-
$clause = $c->getAsColumns()[$quotedName];
502-
$this->assertEquals($columnMap->getFullyQualifiedName(), $clause);
503-
}
498+
$this->assertEquals([
499+
'Propel\Tests\Bookstore\Book.Id',
500+
'Propel\Tests\Bookstore\Book.Title',
501+
'Propel\Tests\Bookstore\Book.ISBN',
502+
'Propel\Tests\Bookstore\Book.Price',
503+
'Propel\Tests\Bookstore\Book.PublisherId',
504+
'Propel\Tests\Bookstore\Book.AuthorId',
505+
], $c->getSelect());
504506
}
505507

506508
/**
@@ -525,5 +527,6 @@ public function testSelectNonexistentColumnThrowsException()
525527
$this->expectException(PropelException::class);
526528
$c = new ModelCriteria('bookstore', 'Propel\Tests\Bookstore\Book');
527529
$c->select(['Id', 'LeUnknonwColumn']);
530+
$c->configureSelectColumns();
528531
}
529532
}

‎tests/Propel/Tests/Runtime/ActiveQuery/ModelCriteriaTest.php

+2-4
Original file line numberDiff line numberDiff line change
@@ -3110,15 +3110,13 @@ public function testCloneCopiesFormatter()
31103110
/**
31113111
* @return void
31123112
*/
3113-
public function testCloneCopiesAsColumns()
3113+
public function testCloneCopiesSelect()
31143114
{
31153115
$bookQuery1 = BookQuery::create();
31163116
$bookQuery1->select(['Id', 'Title']);
31173117
$bookQuery2 = clone $bookQuery1;
31183118
$bookQuery2->select(['ISBN', 'Price']);
3119-
$this->assertCount(2, $bookQuery1->getAsColumns());
3120-
$this->assertArrayHasKey('"Id"', $bookQuery1->getAsColumns());
3121-
$this->assertArrayHasKey('"Title"', $bookQuery1->getAsColumns());
3119+
$this->assertEquals(['Id', 'Title'], $bookQuery1->getSelect());
31223120
}
31233121

31243122
/**

‎tests/Propel/Tests/Runtime/ActiveQuery/SubQueryTest.php

+1
Original file line numberDiff line numberDiff line change
@@ -283,6 +283,7 @@ public function testSubQueryWithSelectColumns()
283283
$c = new BookQuery();
284284
$c->addSelectQuery($subCriteria, 'alias1', false);
285285
$c->select(['alias1.Id']);
286+
$c->configureSelectColumns();
286287

287288
$sql = $this->getSql('SELECT alias1.id AS "alias1.Id" FROM (SELECT book.id, book.title, book.isbn, book.price, book.publisher_id, book.author_id FROM book) AS alias1');
288289

0 commit comments

Comments
 (0)