Docs For Class SSReport

Description

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:

see: ReportAdmin for where SSReport instances are used in the CMS.
link: SSReport->getReportField()
link: SSReport::$description
link: SSReport::$title

Located in /cms/code/SSReport.php (line 29)

Object
   |
   --ViewableData
      |
      --SSReport

Direct descendents

Class	Description
UnprintedOrderReport	An extension to SSReport that allows a user to view all Order instances in the system that are not printed. UnprintedOrderReport->getReportField() outlines the logic for what orders are considered to be "unprinted".
AllOrdersReport	An extension to SSReport that allows a user to view all Order instances in the system.
CurrentOrdersReport	An extension to SSReport that allows a user to view all Order instances that are "current", CurrentOrdersReport->getReportField() has the detail on the logic for what "Current" means.

Variable Summary

string $description

string $title

Method Summary

FieldSet getCMSFields ()

FormField getReportField ()

string ID ()

string TreeTitle ()

Variables

string $description = '' (line 46)

This is a description about what this report does. Used by the ReportAdmin templates.

access: protected

Redefined in descendants as:

string $title = '' (line 37)

This is the title of the report, used by the ReportAdmin templates.

access: protected

Redefined in descendants as:

Inherited Variables

Inherited from ViewableData

ViewableData::$casting
ViewableData::$castingHelperPair_cache
ViewableData::$customisedObj
ViewableData::$failover
ViewableData::$iteratorPos
ViewableData::$iteratorTotalItems
ViewableData::$namedAs
ViewableData::$parent
ViewableData::$_natural_cache
ViewableData::$_object_cache
ViewableData::$_xml_cache

Inherited from Object

Object::$builtInMethods
Object::$class
Object::$classConstructed
Object::$extensions
Object::$extension_instances
Object::$extraMethods
Object::$extraStatics
Object::$statics
Object::$static_cached

Methods

getCMSFields (line 58)

Returns a FieldSet with which to create the CMS editing form.

You can use the extend() method of FieldSet to create customised forms for your other data objects.

uses: SSReport::getReportField() - to render a table, or similar field for the report. This method should be defined on the SSReport subclasses.

FieldSet getCMSFields ()

getReportField (line 81)

Return a field, such as a ComplexTableField that is used to show and manipulate data relating to this report.

For example, if this were an "Unprinted Orders" report, this field would return a table that shows all Orders with "Unprinted = 1".

return: subclass
usedby: SSReport::getCMSFields() - to render a table, or similar field for the report. This method should be defined on the SSReport subclasses.

FormField getReportField ()

Redefined in descendants as:

UnprintedOrderReport::getReportField() : Return a ComplexTableField that shows all Order instances that are not printed. That is, Order instances with the property "Printed" value set to "0".
AllOrdersReport::getReportField() : Return a ComplexTableField that shows all Order instances that are not printed. That is, Order instances with the property "Printed" value set to "0".
CurrentOrdersReport::getReportField() : Return a ComplexTableField that shows all Order instances that are current.

ID (line 104)

Return the ID of this Report class.

Because it doesn't have a number, we use the class name as the ID.

string ID ()

TreeTitle (line 93)

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.

string TreeTitle ()

Inherited Methods

Inherited From ViewableData

ViewableData::ATT_val()
ViewableData::BaseHref()
ViewableData::buildCastingHelperCache()
ViewableData::cachedCall()
ViewableData::castingHelper()
ViewableData::castingHelperPair()
ViewableData::castingObjectCreator()
ViewableData::castingObjectCreatorPair()
ViewableData::CSSClasses()
ViewableData::CurrentMember()
ViewableData::CurrentPage()
ViewableData::customise()
ViewableData::Debug()
ViewableData::defineMethods()
ViewableData::escapeTypeForField()
ViewableData::Even()
ViewableData::EvenOdd()
ViewableData::First()
ViewableData::FirstLast()
ViewableData::getField()
ViewableData::getIterator()
ViewableData::getXMLValues()
ViewableData::hasField()
ViewableData::HasPerm()
ViewableData::hasValue()
ViewableData::i18nLocale()
ViewableData::IsAjax()
ViewableData::iteratorProperties()
ViewableData::JS_val()
ViewableData::Last()
ViewableData::Me()
ViewableData::Middle()
ViewableData::MiddleString()
ViewableData::obj()
ViewableData::Odd()
ViewableData::Pos()
ViewableData::RAW_val()
ViewableData::renderWith()
ViewableData::SecurityID()
ViewableData::setCustomisedObj()
ViewableData::setField()
ViewableData::SQL_val()
ViewableData::ThemeDir()
ViewableData::Top()
ViewableData::TotalItems()
ViewableData::val()
ViewableData::XML_val()
ViewableData::__get()
ViewableData::__isset()
ViewableData::__set()

Inherited From Object

Object::__construct()
Object::addMethodsFrom()
Object::addStaticVars()
Object::addWrapperMethod()
Object::add_extension()
Object::allMethodNames()
Object::buildMethodList()
Object::cacheToFile()
Object::cacheToFileWithArgs()
Object::create()
Object::createMethod()
Object::defineMethods()
Object::exists()
Object::extend()
Object::extInstance()
Object::getCustomClass()
Object::hasExtension()
Object::hasMethod()
Object::invokeWithExtensions()
Object::is_a()
Object::loadCache()
Object::parentClass()
Object::sanitiseCachename()
Object::saveCache()
Object::set_stat()
Object::set_uninherited()
Object::stat()
Object::strong_create()
Object::uninherited()
Object::useCustomClass()
Object::__call()
Object::__toString()