title; } /** * Return the description of this report. * * You have two ways of specifying the description: * - overriding description(), which lets you support i18n * - defining the $description property */ function description() { return $this->description; } /** * Return the {@link SQLQuery} that provides your report data. */ function sourceQuery($params) { if($this->hasMethod('sourceRecords')) { $query = new SS_Report_FakeQuery($this, 'sourceRecords', $params); return $query; } else { user_error("Please override sourceQuery()/sourceRecords() and columns() or, if necessary, override getReportField()", E_USER_ERROR); } } /** * Return a SS_List records for this report. */ function records($params) { if($this->hasMethod('sourceRecords')) return $this->sourceRecords($params, null, null); else { $query = $this->sourceQuery(); return singleton($this->dataClass())->buildDataObjectSet($query->execute(), "DataObjectSet", $query); } } /** * Return the data class for this report */ function dataClass() { return $this->dataClass; } function getLink($action = null) { return Controller::join_links( 'admin/reports/', "$this->class", '/', // trailing slash needed if $action is null! "$action" ); } /** * @deprecated 3.0 * All subclasses of SS_Report now appear in the report admin, no need to register or unregister. * * Register a report. * @param $list The list to add the report to: "ReportAdmin" or "SideReports" * @param $reportClass The class of the report to add. * @param $priority The priority. Higher numbers will appear furhter up in the reports list. * The default value is zero. */ static function register($list, $reportClass, $priority = 0) { Deprecation::notice('3.0', 'All subclasses of SS_Report now appear in the report admin, no need to register'); } /** * @deprecated 3.0 * All subclasses of SS_Report now appear in the report admin, no need to register or unregister. */ static function unregister($list, $reportClass) { self::add_excluded_reports($reportClass); } /** * Exclude certain reports classes from the list of Reports in the CMS * @param $reportClass Can be either a string with the report classname or an array of reports classnames */ static function add_excluded_reports($reportClass) { if (is_array($reportClass)) { self::$excluded_reports = array_merge(self::$excluded_reports, $reportClass); } else { if (is_string($reportClass)) { //add to the excluded reports, so this report doesn't get used self::$excluded_reports[] = $reportClass; } } } /** * Return an array of excluded reports. That is, reports that will not be included in * the list of reports in report admin in the CMS. * @return array */ static function get_excluded_reports() { return self::$excluded_reports; } /** * Return the SS_Report objects making up the given list. * @return ArrayList an arraylist of SS_Report objects */ static function get_reports() { $reports = ClassInfo::subclassesFor(get_called_class()); $reportsArray = array(); if ($reports && count($reports) > 0) { //collect reports into array with an attribute for 'sort' foreach($reports as $report) { 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; if (method_exists($reportObj,'sort')) $reportObj->sort = $reportObj->sort(); //use the sort method to specify the sort field $reportsArray[$report] = $reportObj; } } //convert array into ArrayList $list = ArrayList::create($reportsArray); //sort $list = $list->sort('sort'); return $list; } /////////////////////// UI METHODS /////////////////////// /** * Returns a FieldList with which to create the CMS editing form. * You can use the extend() method of FieldList to create customised forms for your other * data objects. * * @uses getReportField() to render a table, or similar field for the report. This * method should be defined on the SS_Report subclasses. * * @return FieldList */ function getCMSFields() { $fields = new FieldList( new LiteralField( 'ReportTitle', "

{$this->title()}

" ) ); if($this->description()) $fields->push( new LiteralField('ReportDescription', "

" . $this->description() . "

")); // Add search fields is available if($params = $this->parameterFields()) { $filters = new FieldGroup('Filters'); foreach($params as $param) { if ($param instanceof HiddenField) $fields->push($param); else $filters->push($param); } $fields->push($filters); // Add a search button $fields->push(new FormAction('updatereport', 'Filter')); } $fields->push($this->getReportField()); $this->extend('updateCMSFields', $fields); return $fields; } function getCMSActions() { // getCMSActions() can be extended with updateCMSActions() on a extension $actions = new FieldList(); $this->extend('updateCMSActions', $actions); return $actions; } /** * Return a field, such as a {@link ComplexTableField} that is * used to show and manipulate data relating to this report. * * Generally, you should override {@link columns()} and {@link records()} to make your report, * but if they aren't sufficiently flexible, then you can override this method. * * @return FormField subclass */ function getReportField() { $columnTitles = array(); $fieldFormatting = array(); $csvFieldFormatting = array(); $fieldCasting = array(); // Parse the column information foreach($this->columns() as $source => $info) { if(is_string($info)) $info = array('title' => $info); if(isset($info['formatting'])) $fieldFormatting[$source] = $info['formatting']; if(isset($info['csvFormatting'])) $csvFieldFormatting[$source] = $info['csvFormatting']; if(isset($info['casting'])) $fieldCasting[$source] = $info['casting']; $columnTitles[$source] = isset($info['title']) ? $info['title'] : $source; } // To do: implement pagination $query = $this->sourceQuery($_REQUEST); $tlf = new TableListField('ReportContent', $this->dataClass(), $columnTitles); $tlf->setCustomQuery($query); $tlf->setShowPagination(true); $tlf->setPageSize(50); $tlf->setPermissions(array('export', 'print')); // Hack to figure out if we are printing if (isset($_REQUEST['url']) && array_pop(explode('/', $_REQUEST['url'])) == 'printall') { $tlf->setTemplate('SSReportTableField'); } if($fieldFormatting) $tlf->setFieldFormatting($fieldFormatting); if($csvFieldFormatting) $tlf->setCSVFieldFormatting($csvFieldFormatting); if($fieldCasting) $tlf->setFieldCasting($fieldCasting); return $tlf; } /** * @param Member $member * @return boolean */ function canView($member = null) { if(!$member && $member !== FALSE) { $member = Member::currentUser(); } return true; } /** * Return the name of this report, which * is used by the templates to render the * name of the report in the report tree, * the left hand pane inside ReportAdmin. * * @return string */ function TreeTitle() { return $this->title(); } } /** * This is an object that can be used to dress up a more complex querying mechanism in the clothing * of a SQLQuery object. This means that you can inject it into a TableListField. * * Use it like this: * * function sourceQuery($params) { * return new SS_Report_FakeQuery($this, 'sourceRecords', $params) * } * function sourceRecords($params, $sort, $limit) { * // Do some stuff * // Return a SS_List of actual objects. * } * * This object is used by the default implementation of sourceQuery() on SS_Report, to make use of * a sourceReords() method if one exists. */ class SS_Report_FakeQuery extends SQLQuery { public $orderby; public $limit; protected $obj, $method, $params; function __construct($obj, $method, $params) { $this->obj = $obj; $this->method = $method; $this->params = $params; } /** * Provide a method that will return a list of columns that can be used to sort. */ function setSortColumnMethod($sortColMethod) { $this->sortColMethod = $sortColMethod; } function limit($limit, $offset = 0) { $this->limit = $limit; } function unlimitedRowCount($column = null) { $source = $this->obj->{$this->method}($this->params, null, null); return $source ? $source->Count() : 0; } function execute() { $output = array(); $source = $this->obj->{$this->method}($this->params, $this->orderby, $this->limit); if($source) foreach($source as $item) { $mapItem = $item->toMap(); $mapItem['RecordClassName'] = get_class($item); $output[] = $mapItem; } return $output; } function canSortBy($fieldName) { $fieldName = preg_replace('/(\s+?)(A|DE)SC$/', '', $fieldName); if($this->sortColMethod) { $columns = $this->obj->{$this->sortColMethod}(); return in_array($fieldName, $columns); } else { return false; } } } /** * SS_ReportWrapper is a base class for creating report wappers. * * Wrappers encapsulate an existing report to alter their behaviour - they are implementations of * the standard GoF decorator pattern. * * This base class ensure that, by default, wrappers behave in the same way as the report that is * being wrapped. You should override any methods that need to behave differently in your subclass * of SS_ReportWrapper. * * It also makes calls to 2 empty methods that you can override {@link beforeQuery()} and * {@link afterQuery()} * * @package cms * @subpackage reports */ abstract class SS_ReportWrapper extends SS_Report { protected $baseReport; function __construct($baseReport) { $this->baseReport = is_string($baseReport) ? new $baseReport : $baseReport; $this->dataClass = $this->baseReport->dataClass(); parent::__construct(); } function ID() { return get_class($this->baseReport) . '_' . get_class($this); } /////////////////////////////////////////////////////////////////////////////////////////// // Filtering function parameterFields() { return $this->baseReport->parameterFields(); } /////////////////////////////////////////////////////////////////////////////////////////// // Columns function columns() { return $this->baseReport->columns(); } /////////////////////////////////////////////////////////////////////////////////////////// // Querying /** * Override this method to perform some actions prior to querying. */ function beforeQuery($params) { } /** * Override this method to perform some actions after querying. */ function afterQuery() { } function sourceQuery($params) { if($this->baseReport->hasMethod('sourceRecords')) { // The default implementation will create a fake query from our sourceRecords() method return parent::sourceQuery($params); } else if($this->baseReport->hasMethod('sourceQuery')) { $this->beforeQuery($params); $query = $this->baseReport->sourceQuery($params); $this->afterQuery(); return $query; } else { user_error("Please override sourceQuery()/sourceRecords() and columns() in your base report", E_USER_ERROR); } } function sourceRecords($params = array(), $sort = null, $limit = null) { $this->beforeQuery($params); $records = $this->baseReport->sourceRecords($params, $sort, $limit); $this->afterQuery(); return $records; } /////////////////////////////////////////////////////////////////////////////////////////// // Pass-through function title() { return $this->baseReport->title(); } function group() { return $this->baseReport->hasMethod('group') ? $this->baseReport->group() : 'Group'; } function sort() { return $this->baseReport->hasMethod('sort') ? $this->baseReport->sort() : 0; } function description() { return $this->baseReport->description(); } function canView($member = null) { return $this->baseReport->canView($member); } }