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

MINOR Documentation and @package phpDoc code additions to ReportAdmin and SSReport

Browse Source 
git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/cms/trunk@63958 467b73ca-7a2a-4603-9d3b-597d59a354a9
This commit is contained in:
Sean Harvey 2008-10-09 02:52:08 +00:00
parent 47ca384912
commit c784fdc875
2 changed files with 23 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
code/ReportAdmin.php
View File

@ -3,9 +3,7 @@
* Reports section of the CMS.
*
* All reports that should show in the ReportAdmin section
* of the CMS need to subclass Report.
*
* @see Report
* of the CMS need to subclass {@link SSReport}.
*
* @package cms
* @subpackage reports

22
code/SSReport.php
View File

@ -2,6 +2,28 @@
/**
* Base "abstract" class for all Report classes
* viewable in the Reports top menu section of CMS.
*
* To include your own report into the ReportAdmin
* of the CMS, your subclass of SSReport should
* overload these:
*
* @link SSReport::$title
* @link SSReport::$description
* @link SSReport->getReportField()
*
* getReportField() should return a FormField instance,
* such as a ComplexTableField, or TableListField. This
* is the "meat" of the report, as it's designed to
* show the actual data for the function of the report.
* For example, if this was an order that should show
* all orders that aren't printed, then it would show
* a TableListField with the filter "Unprinted = 1".
*
* @see ReportAdmin for where SSReport instances are
* used in the CMS.
*
* @package cms
* @subpackage reports
*/
class SSReport extends ViewableData {