title; } /** * Allows access to title as a property * * @return string */ public function getTitle() { return $this->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 */ public function description() { return $this->description; } /** * Return the {@link DataQuery} that provides your report data. * * @param array $params * @return DataQuery */ public function sourceQuery($params) { if ($this->hasMethod('sourceRecords')) { return $this->sourceRecords($params, null, null)->dataQuery(); } 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. * * @param array $params * @return SS_List */ public function records($params) { if ($this->hasMethod('sourceRecords')) { return $this->sourceRecords($params, null, null); } else { $query = $this->sourceQuery(); $results = new ArrayList(); foreach ($query->execute() as $data) { $class = $this->dataClass(); $result = new $class($data); $results->push($result); } return $results; } } public function columns() { return []; } /** * Return the data class for this report */ public function dataClass() { return $this->dataClass; } public function getLink($action = null) { return Controller::join_links( ReportAdmin::singleton()->Link('show'), $this->sanitiseClassName(static::class), $action ); } /** * Sanitise a model class' name for inclusion in a link * * @param string $class * @return string */ protected function sanitiseClassName($class) { return str_replace('\\', '-', $class); } /** * counts the number of objects returned * @param array $params - any parameters for the sourceRecords * @return int */ public function getCount($params = array()) { $sourceRecords = $this->sourceRecords($params, null, null); if (!$sourceRecords instanceof SS_List) { user_error(static::class . "::sourceRecords does not return an SS_List", E_USER_NOTICE); return "-1"; } return $sourceRecords->count(); } /** * 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 */ public static function get_excluded_reports() { return (array) self::config()->get('excluded_reports'); } /** * Return the SS_Report objects making up the given list. * * @return Report[] Array of Report objects */ public static function get_reports() { $reports = ClassInfo::subclassesFor(get_called_class()); $reportsArray = []; if ($reports && count($reports) > 0) { $excludedReports = static::get_excluded_reports(); // Collect reports into array with an attribute for 'sort' foreach ($reports as $report) { // Don't use the Report superclass, or any excluded report classes if (in_array($report, $excludedReports)) { continue; } $reflectionClass = new ReflectionClass($report); // Don't use abstract classes if ($reflectionClass->isAbstract()) { continue; } /** @var Report $reportObj */ $reportObj = $report::create(); if ($reportObj->hasMethod('sort')) { // Use the sort method to specify the sort field $reportObj->sort = $reportObj->sort(); } $reportsArray[$report] = $reportObj; } } uasort($reportsArray, function ($a, $b) { if ($a->sort == $b->sort) { return 0; } else { return ($a->sort < $b->sort) ? -1 : 1; } }); return $reportsArray; } /////////////////////// 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 */ public function getCMSFields() { $fields = new FieldList(); if ($description = $this->description()) { $fields->push(new LiteralField('ReportDescription', "

" . $description . "

")); } // Add search fields is available if ($this->hasMethod('parameterFields') && $parameterFields = $this->parameterFields()) { /** @var FormField $field */ foreach ($parameterFields as $field) { // Namespace fields for easier handling in form submissions $field->setName(sprintf('filters[%s]', $field->getName())); $field->addExtraClass('no-change-track'); // ignore in changetracker $fields->push($field); } // Add a search button $formAction = FormAction::create('updatereport', _t('SilverStripe\\Forms\\GridField\\GridField.Filter', 'Filter')); $formAction->addExtraClass('btn-primary mb-4'); $fields->push($formAction); } $fields->push($this->getReportField()); $this->extend('updateCMSFields', $fields); return $fields; } public 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 GridField} 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 \SilverStripe\Forms\FormField subclass */ public function getReportField() { $params = []; if (Injector::inst()->has(HTTPRequest::class)) { /** @var HTTPRequest $request */ $request = Injector::inst()->get(HTTPRequest::class); $params = $request->param('filters') ?: $request->requestVar('filters') ?: []; } $items = $this->sourceRecords($params, null, null); $gridFieldConfig = GridFieldConfig::create()->addComponents( new GridFieldButtonRow('before'), new GridFieldPrintButton('buttons-before-left'), new GridFieldExportButton('buttons-before-left'), new GridFieldSortableHeader(), new GridFieldDataColumns(), new GridFieldPaginator() ); $gridField = new GridField('Report', null, $items, $gridFieldConfig); $columns = $gridField->getConfig()->getComponentByType(GridFieldDataColumns::class); $displayFields = []; $fieldCasting = []; $fieldFormatting = []; // Parse the column information foreach ($this->columns() as $source => $info) { if (is_string($info)) { $info = ['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']; } if (isset($info['link']) && $info['link']) { if (is_callable($info['link'])) { $fieldFormatting[$source] = $info['link']; } else { $fieldFormatting[$source] = function ($value, $item) { if ($item instanceof CMSPreviewable) { /** @var CMSPreviewable $item */ return sprintf( '%s', Convert::raw2att($item->CMSEditLink()), Convert::raw2att($value), Convert::raw2xml($value) ); } return $value; }; } } $displayFields[$source] = isset($info['title']) ? $info['title'] : $source; } $columns->setDisplayFields($displayFields); $columns->setFieldCasting($fieldCasting); $columns->setFieldFormatting($fieldFormatting); return $gridField; } /** * @param Member $member * @return boolean */ public function canView($member = null) { if (!$member && $member !== false) { $member = Security::getCurrentUser(); } $extended = $this->extendedCan('canView', $member); if ($extended !== null) { return $extended; } if ($member && Permission::checkMember($member, array('CMS_ACCESS_LeftAndMain', 'CMS_ACCESS_ReportAdmin'))) { return true; } return false; } /** * Helper to assist with permission extension * * {@see DataObject::extendedCan()} * * @param string $methodName Method on the same object, e.g. {@link canEdit()} * @param Member|int $member * @return boolean|null */ public function extendedCan($methodName, $member) { $results = $this->extend($methodName, $member); if ($results && is_array($results)) { // Remove NULLs $results = array_filter($results, function ($v) { return !is_null($v); }); // If there are any non-NULL responses, then return the lowest one of them. // If any explicitly deny the permission, then we don't get access if ($results) { return min($results); } } return null; } /** * 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 */ public function TreeTitle() { return $this->title(); } }