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

Merge pull request #105 from silverstripe-big-o/ss-reports-documentation

Browse Source 
BUGFIX: check for abstract classes when automatically registering SS_Report
This commit is contained in:
Sam Minnée 2012-04-19 21:55:44 -07:00
commit 99e9c48647
2 changed files with 35 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
code/reports/Report.php
View File

@ -14,17 +14,6 @@
* {@link parameterFields()}: Return a FieldList of the fields that can be used to filter this * {@link parameterFields()}: Return a FieldList of the fields that can be used to filter this
* report. * report.
* *
* If you can't express your report as a query, you can implement the this method instead:
*
* // Return an array of fields that can be used to sort the data
* public function sourceRecords($params, $sort, $limit) { ... }
*
* The $sort value will be set to the corresponding key of the columns() array. If you wish to
* make only a subset of the columns sortable, then you can override `sortColumns()` to return a
* subset of the array keys.
*
* Note that this implementation is less efficient and should only be used when necessary.
*
* If you wish to modify the report in more extreme ways, you could overload these methods instead. * If you wish to modify the report in more extreme ways, you could overload these methods instead.
* *
* {@link getReportField()}: Return a FormField in the place where your report's TableListField * {@link getReportField()}: Return a FormField in the place where your report's TableListField
@ -204,6 +193,9 @@ class SS_Report extends ViewableData {
//collect reports into array with an attribute for 'sort' //collect reports into array with an attribute for 'sort'
foreach($reports as $report) { foreach($reports as $report) {
if (in_array($report, self::$excluded_reports)) continue; //don't use the SS_Report superclass if (in_array($report, self::$excluded_reports)) continue; //don't use the SS_Report superclass
$reflectionClass = new ReflectionClass($report);
if ($reflectionClass->isAbstract()) continue; //don't use abstract classes
$reportObj = new $report; $reportObj = new $report;
if (method_exists($reportObj,'sort')) $reportObj->sort = $reportObj->sort(); //use the sort method to specify the sort field if (method_exists($reportObj,'sort')) $reportObj->sort = $reportObj->sort(); //use the sort method to specify the sort field
$reportsArray[$report] = $reportObj; $reportsArray[$report] = $reportObj;

32
tests/reports/ReportTest.php
View File

@ -41,6 +41,17 @@ class ReportTest extends SapphireTest {
$this->assertNotContains('ReportTest_FakeTest',$reportNames,'ReportTest_FakeTest is NOT in reports list'); $this->assertNotContains('ReportTest_FakeTest',$reportNames,'ReportTest_FakeTest is NOT in reports list');
$this->assertNotContains('ReportTest_FakeTest2',$reportNames,'ReportTest_FakeTest2 is NOT in reports list'); $this->assertNotContains('ReportTest_FakeTest2',$reportNames,'ReportTest_FakeTest2 is NOT in reports list');
} }
function testAbstractClassesAreExcluded() {
$reports = SS_Report::get_reports();
$reportNames = array();
foreach($reports as $report) {
$reportNames[] = $report->class;
}
$this->assertNotContains('ReportTest_FakeTest_Abstract',
$reportNames,
'ReportTest_FakeTest_Abstract is NOT in reports list as it is abstract');
}
} }
class ReportTest_FakeTest extends SS_Report implements TestOnly { class ReportTest_FakeTest extends SS_Report implements TestOnly {
@ -83,3 +94,24 @@ class ReportTest_FakeTest2 extends SS_Report implements TestOnly {
return 98; return 98;
} }
} }
abstract class ReportTest_FakeTest_Abstract extends SS_Report implements TestOnly {
function title() {
return 'Report title Abstract';
}
function columns() {
return array(
"Title" => array(
"title" => "Page Title Abstract"
)
);
}
function sourceRecords($params, $sort, $limit) {
return new ArrayList();
}
function sort() {
return 5;
}
}