mirror of
https://github.com/silverstripe/silverstripe-reports
synced 2024-10-22 11:05:53 +02:00
f71804e465
MINOR: Replaced usage of renamed classes with the new namespaced name. From: Sam Minnee <sam@silverstripe.com> git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/cms/trunk@90076 467b73ca-7a2a-4603-9d3b-597d59a354a9
233 lines
5.8 KiB
PHP
Executable File
233 lines
5.8 KiB
PHP
Executable File
<?php
|
|
/**
|
|
* Reports section of the CMS.
|
|
*
|
|
* All reports that should show in the ReportAdmin section
|
|
* of the CMS need to subclass {@link SS_Report}, and implement
|
|
* the appropriate methods and variables that are required.
|
|
*
|
|
* @see SS_Report
|
|
*
|
|
* @package cms
|
|
* @subpackage reports
|
|
*/
|
|
class ReportAdmin extends LeftAndMain {
|
|
|
|
static $url_segment = 'reports';
|
|
|
|
static $url_rule = '/$Action/$ID';
|
|
|
|
static $menu_title = 'Reports';
|
|
|
|
static $template_path = null; // defaults to (project)/templates/email
|
|
|
|
public function init() {
|
|
parent::init();
|
|
|
|
Requirements::javascript(CMS_DIR . '/javascript/ReportAdmin_left.js');
|
|
Requirements::javascript(CMS_DIR . '/javascript/ReportAdmin_right.js');
|
|
|
|
Requirements::css(CMS_DIR . '/css/ReportAdmin.css');
|
|
|
|
// Set custom options for TinyMCE specific to ReportAdmin
|
|
HtmlEditorConfig::get('cms')->setOption('ContentCSS', project() . '/css/editor.css');
|
|
HtmlEditorConfig::get('cms')->setOption('Lang', i18n::get_tinymce_lang());
|
|
|
|
// Always block the HtmlEditorField.js otherwise it will be sent with an ajax request
|
|
Requirements::block(SAPPHIRE_DIR . '/javascript/HtmlEditorField.js');
|
|
}
|
|
|
|
/**
|
|
* Returns an array of all the reports classnames that could be shown on this site
|
|
* to any user. Base class is not included in the response.
|
|
* It does not perform filtering based on canView().
|
|
*
|
|
* @return An array of report class-names, i.e.:
|
|
* array("AllOrdersReport","CurrentOrdersReport","UnprintedOrderReport")
|
|
*/
|
|
public function getReportClassNames() {
|
|
|
|
$baseClass = 'SS_Report';
|
|
$response = array();
|
|
|
|
// get all sub-classnames (incl. base classname).
|
|
$classNames = ClassInfo::subclassesFor( $baseClass );
|
|
|
|
// drop base className
|
|
$classNames = array_diff($classNames, array($baseClass));
|
|
|
|
// drop report classes, which are not initiatable.
|
|
foreach($classNames as $className) {
|
|
|
|
// Remove abstract classes
|
|
$classReflection = new ReflectionClass($className);
|
|
if($classReflection->isInstantiable() ) {
|
|
$response[] = $className;
|
|
}
|
|
}
|
|
return $response;
|
|
}
|
|
|
|
/**
|
|
* Does the parent permission checks, but also
|
|
* makes sure that instantiatable subclasses of
|
|
* {@link Report} exist. By default, the CMS doesn't
|
|
* include any Reports, so there's no point in showing
|
|
*
|
|
* @param Member $member
|
|
* @return boolean
|
|
*/
|
|
function canView($member = null) {
|
|
if(!$member && $member !== FALSE) {
|
|
$member = Member::currentUser();
|
|
}
|
|
|
|
if(!parent::canView($member)) return false;
|
|
|
|
$hasViewableSubclasses = false;
|
|
$subClasses = array_values( $this->getReportClassNames() );
|
|
|
|
foreach($subClasses as $subclass) {
|
|
|
|
if(singleton($subclass)->canView()) {
|
|
$hasViewableSubclasses = true;
|
|
}
|
|
|
|
}
|
|
return $hasViewableSubclasses;
|
|
}
|
|
|
|
/**
|
|
* Return a DataObjectSet of SS_Report subclasses
|
|
* that are available for use.
|
|
*
|
|
* @return DataObjectSet
|
|
*/
|
|
public function Reports() {
|
|
$processedReports = array();
|
|
$subClasses = $this->getReportClassNames();
|
|
|
|
if($subClasses) {
|
|
foreach($subClasses as $subClass) {
|
|
$processedReports[] = new $subClass();
|
|
}
|
|
}
|
|
|
|
$reports = new DataObjectSet($processedReports);
|
|
|
|
return $reports;
|
|
}
|
|
|
|
/**
|
|
* Show a report based on the URL query string.
|
|
*
|
|
* @param SS_HTTPRequest $request The HTTP request object
|
|
*/
|
|
public function show($request) {
|
|
$params = $request->allParams();
|
|
|
|
return $this->showWithEditForm($params, $this->reportEditFormFor($params['ID']));
|
|
}
|
|
|
|
/**
|
|
* @TODO What does this do?
|
|
*
|
|
* @param unknown_type $params
|
|
* @param unknown_type $editForm
|
|
* @return unknown
|
|
*/
|
|
protected function showWithEditForm($params, $editForm) {
|
|
if(isset($params['ID'])) Session::set('currentPage', $params['ID']);
|
|
if(isset($params['OtherID'])) Session::set('currentOtherID', $params['OtherID']);
|
|
|
|
if(Director::is_ajax()) {
|
|
SSViewer::setOption('rewriteHashlinks', false);
|
|
|
|
$result = $this->customise(array(
|
|
'EditForm' => $editForm
|
|
))->renderWith($this->getTemplatesWithSuffix('_right'));
|
|
|
|
return $this->getLastFormIn($result);
|
|
}
|
|
|
|
return array();
|
|
}
|
|
|
|
/**
|
|
* For the current report that the user is viewing,
|
|
* return a Form instance with the fields for that
|
|
* report.
|
|
*
|
|
* @return Form
|
|
*/
|
|
public function EditForm() {
|
|
$ids = array();
|
|
$id = isset($_REQUEST['ID']) ? $_REQUEST['ID'] : Session::get('currentPage');
|
|
$subClasses = $this->getReportClassNames();
|
|
|
|
if($subClasses) {
|
|
foreach($subClasses as $subClass) {
|
|
$obj = new $subClass();
|
|
$ids[] = $obj->ID();
|
|
}
|
|
}
|
|
|
|
if($id && in_array($id, $ids)) return $this->reportEditFormFor($id);
|
|
else return false;
|
|
}
|
|
|
|
/**
|
|
* Return a Form instance with fields for the
|
|
* particular report currently viewed.
|
|
*
|
|
* @TODO Dealing with multiple data types for the
|
|
* $id parameter is confusing. Ideally, it should
|
|
* deal with only one.
|
|
*
|
|
* @param id|string $id The ID of the report, or class name
|
|
* @return Form
|
|
*/
|
|
public function reportEditFormFor($id) {
|
|
$page = false;
|
|
$fields = new FieldSet();
|
|
$actions = new FieldSet();
|
|
|
|
if(is_numeric($id)) $page = DataObject::get_by_id('SiteTree', $id);
|
|
$reportClass = is_object($page) ? 'SS_Report_' . $page->ClassName : $id;
|
|
|
|
$obj = new $reportClass();
|
|
if($obj) $fields = $obj->getCMSFields();
|
|
|
|
$idField = new HiddenField('ID');
|
|
$idField->setValue($id);
|
|
$fields->push($idField);
|
|
|
|
$form = new Form($this, 'EditForm', $fields, $actions);
|
|
|
|
return $form;
|
|
}
|
|
|
|
/**
|
|
* Determine if we have reports and need
|
|
* to display the "Reports" main menu item
|
|
* in the CMS.
|
|
*
|
|
* The test for an existance of a report
|
|
* is done by checking for a subclass of
|
|
* "SS_Report" that exists.
|
|
*
|
|
* @return boolean
|
|
*/
|
|
public static function has_reports() {
|
|
$subClasses = $this->getReportClassNames();
|
|
if($subClasses) {
|
|
foreach($subClasses as $subClass) {
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
}
|
|
|
|
?>
|