tonyair/silverstripe-contentreview
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-contentreview synced 2024-10-22 17:05:47 +02:00
Code Issues Projects Releases Wiki Activity

ENH: Respect sort and limit arguments (#158)

Browse Source 
These parameters are defined in the PHPDocs for `Report` and are technically part of the method signature. They should be respected and in the case of the new default limit in silverstripe/silverstripe-reports#139 this could have performance ramifications for large datasets.
This commit is contained in:
Guy Sartorelli 2022-03-11 09:14:06 +13:00 committed by GitHub
parent 46a637a6a8
commit 141e8d0bf3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 30 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/Reports/PagesDueForReviewReport.php
View File

@ -148,16 +148,26 @@ class PagesDueForReviewReport extends Report
/**
* @param array $params
* @param array|string|null $sort
* @param int|null $limit
*
* @return SS_List
*/
public function sourceRecords($params = [])
public function sourceRecords($params = [], $sort = null, $limit = null)
{
Versioned::set_stage(Versioned::DRAFT);
$records = SiteTree::get();
$compatibility = ContentReviewCompatability::start();
// Apply sort and limit if appropriate.
if ($sort !== null) {
$records = $records->sort($sort);
}
if ($limit !== null) {
$records = $records->limit($limit);
}
if (empty($params['ReviewDateBefore']) && empty($params['ReviewDateAfter'])) {
// If there's no review dates set, default to all pages due for review now
$records = $records->where(

22
src/Reports/PagesWithoutReviewScheduleReport.php
View File

@ -104,10 +104,12 @@ class PagesWithoutReviewScheduleReport extends Report
/**
* @param array $params
* @param array|string|null $sort
* @param int|null $limit
*
* @return SS_List
*/
public function sourceRecords($params = [])
public function sourceRecords($params = [], $sort = null, $limit = null)
{
Versioned::set_stage(Versioned::DRAFT);
@ -125,16 +127,18 @@ class PagesWithoutReviewScheduleReport extends Report
));
}
$records->sort("ParentID");
$records = $records->toArray();
// Apply sort and limit if appropriate.
if ($sort !== null) {
$records = $records->sort($sort);
}
if ($limit !== null) {
$records = $records->limit($limit);
}
// Trim out calculated values
$list = ArrayList::create();
foreach ($records as $record) {
if (!$this->hasReviewSchedule($record)) {
$list->push($record);
}
}
$list = $records->filterByCallback(function ($record) {
return !$this->hasReviewSchedule($record);
});
ContentReviewCompatability::done($compatibility);

12
tests/php/ContentReviewReportTest.php
View File

@ -87,11 +87,11 @@ class ContentReviewReportTest extends FunctionalTest
$results = $report->sourceRecords();
$this->assertEquals([
"Home",
"About Us",
"Page without review date",
"Page owned by group",
], $results->column("Title"));
$this->assertListEquals([
['Title' => 'Home'],
['Title' => 'About Us'],
['Title' => 'Page without review date'],
['Title' => 'Page owned by group'],
], $results);
}
}