diff --git a/code/ReportAdmin.php b/code/ReportAdmin.php index 1fdc6bc5..4d6bf00f 100755 --- a/code/ReportAdmin.php +++ b/code/ReportAdmin.php @@ -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 diff --git a/code/SSReport.php b/code/SSReport.php index f8831d6a..205c20db 100644 --- a/code/SSReport.php +++ b/code/SSReport.php @@ -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 {