Comments: on this page. Click to read or post your own.

Class ReportField

Description
Description | Vars (details) | Methods (details)

Displays complex reports based on the list of tables and fields provided to the object.

  • deprecated: 2.3 Use TableListField

Located in /sapphire/forms/ReportField.php (line 9) 

Object
   |
   --ViewableData
      |
      --RequestHandlingData
         |
         --FormField
            |
            --ReportField
Variable Summary
Description | Vars (details) | Methods (details)
mixed $export
mixed $fields
mixed $filter
mixed $primaryClass
mixed $primaryKeys
mixed $sort
mixed $tables
Method Summary
Description | Vars (details) | Methods (details)
ReportField __construct (name $name, title $title, tables $tables, fields $fields, [ $hideByDefault = null], [ $defaultSort = null], [ $form = null])
void columnheaders ([ $rowCallBack = 'htmlTableRow'], [ $cellCallBack = 'htmlHeaderCell'])
void csvCell ( $value,  $table,  $column)
void csvRow ( $value,  $table,  $column)
void datacells ([ $rowCallBack = 'htmlTableRow'], [ $cellCallBack = 'htmlTableCell'])
void expandWildcard ( $field)
void expandWildcards ( $fields)
void exportToCSV ( $fileName)
void FieldHolder ()
void getColumnsInTable ( $table)
void getRecords ()
void htmlHeaderCell ( $value,  $table,  $column)
void htmlTableCell ( $value,  $table,  $column)
void htmlTableRow ( $value,  $table,  $column)
void joinFields ( $object,  $fields)
void joinRecord ( $object)
void parseField ( $field)
void setExport ( $export)
void sortdata ()
Variables
Description | Vars (details) | Methods (details)
mixed $export = true (line 17)
  • access: protected
mixed $fields (line 13)
  • access: protected
mixed $filter (line 14)
  • access: protected
mixed $primaryClass (line 15)
  • access: protected
mixed $primaryKeys (line 12)
  • access: protected
mixed $sort (line 16)
  • access: protected
mixed $tables (line 11)
  • access: protected

Inherited Variables

Inherited from FormField

FormField::$containerFieldSet
 FormField::$description
 FormField::$disabled
 FormField::$dontEscape
 FormField::$extraClass
 FormField::$extraClasses
 FormField::$form
 FormField::$leftTitle
 FormField::$message
 FormField::$messageType
 FormField::$name
 FormField::$readonly
 FormField::$rightTitle
 FormField::$tabIndex
 FormField::$title
 FormField::$value

Inherited from RequestHandlingData

RequestHandlingData::$allowed_actions
 RequestHandlingData::$request
 RequestHandlingData::$url_handlers

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
Description | Vars (details) Methods (details)
Constructor __construct (line 27)

Construct a report field.

ReportField __construct (name $name, title $title, tables $tables, fields $fields, [ $hideByDefault = null], [ $defaultSort = null], [ $form = null])
  • name $name: Name of the report field
  • title $title: Title of the report field as displayed in the CMS.
  • tables $tables: Array of primary keys indexed by the names of the tables.
  • fields $fields: Array of fields indexed by the name of the table.
  • $hideByDefault
  • $defaultSort
  • $form
Redefinition of:
FormField::__construct()
Create a new field.
columnheaders (line 163)

Returns the HTML for the headers of the columns.

Can also be called via ajax to reload the headers.

  • access: public
void columnheaders ([ $rowCallBack = 'htmlTableRow'], [ $cellCallBack = 'htmlHeaderCell'])
  • $rowCallBack
  • $cellCallBack
csvCell (line 308)
void csvCell ( $value,  $table,  $column)
  • $value
  • $table
  • $column
csvRow (line 313)
void csvRow ( $value,  $table,  $column)
  • $value
  • $table
  • $column
datacells (line 124)

Returns the HTML for the data cells for the current report.

This can be used externally via ajax as the report might be filtered per column. It is also used internally to display the data cells.

  • access: public
void datacells ([ $rowCallBack = 'htmlTableRow'], [ $cellCallBack = 'htmlTableCell'])
  • $rowCallBack
  • $cellCallBack
expandWildcard (line 65)
  • access: protected
void expandWildcard ( $field)
  • $field
expandWildcards (line 51)
  • access: protected
void expandWildcards ( $fields)
  • $fields
exportToCSV (line 75)
void exportToCSV ( $fileName)
  • $fileName
FieldHolder (line 88)
void FieldHolder ()
Redefinition of:
FormField::FieldHolder()
Returns a "Field Holder" for this field - used by templates.
getColumnsInTable (line 182)
  • access: protected
void getColumnsInTable ( $table)
  • $table
getRecords (line 259)

Get the primary set of records for the cells. This returns a data object set.

  • access: protected
void getRecords ()
htmlHeaderCell (line 293)
void htmlHeaderCell ( $value,  $table,  $column)
  • $value
  • $table
  • $column
htmlTableCell (line 298)
void htmlTableCell ( $value,  $table,  $column)
  • $value
  • $table
  • $column
htmlTableRow (line 303)
void htmlTableRow ( $value,  $table,  $column)
  • $value
  • $table
  • $column
joinFields (line 239)
  • access: protected
void joinFields ( $object,  $fields)
  • $object
  • $fields
joinRecord (line 204)

Joins the given record together with the extra information in the other tables.

This is only used in a situation in which the database can't do the join and I'll correct it when I figure out how to use buildSQL

  • access: protected
void joinRecord ( $object)
  • $object
parseField (line 188)
  • access: protected
void parseField ( $field)
  • $field
setExport (line 46)
  • access: public
void setExport ( $export)
  • $export
sortdata (line 251)

Sort the data in the cells

  • access: public
void sortdata ()

Inherited Methods

Inherited From FormField

FormField::__construct()
FormField::addExtraClass()
FormField::attrName()
FormField::attrTitle()
FormField::attrValue()
FormField::createTag()
FormField::dataValue()
FormField::debug()
FormField::describe()
FormField::extraClass()
FormField::Field()
FormField::FieldHolder()
FormField::forTemplate()
FormField::getForm()
FormField::getTabIndex()
FormField::getTabIndexHTML()
FormField::hasClass()
FormField::hasData()
FormField::id()
FormField::isComposite()
FormField::isDisabled()
FormField::isReadonly()
FormField::jsValidation()
FormField::LeftTitle()
FormField::Link()
FormField::Message()
FormField::MessageType()
FormField::Name()
FormField::name_to_label()
FormField::performDisabledTransformation()
FormField::performReadonlyTransformation()
FormField::removeExtraClass()
FormField::Required()
FormField::RightTitle()
FormField::rootFieldSet()
FormField::saveInto()
FormField::setContainerFieldSet()
FormField::setDisabled()
FormField::setError()
FormField::setForm()
FormField::setLeftTitle()
FormField::setName()
FormField::setReadonly()
FormField::setRightTitle()
FormField::setTabIndex()
FormField::setTitle()
FormField::setValue()
FormField::SmallFieldHolder()
FormField::Title()
FormField::transform()
FormField::Type()
FormField::validate()
FormField::Value()

Inherited From RequestHandlingData

RequestHandlingData::checkAccessAction()
RequestHandlingData::getRequest()
RequestHandlingData::handleRequest()
RequestHandlingData::httpError()

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()
blog comments powered by Disqus

Documentation generated on Sun, 19 Oct 2008 06:44:52 +1300 by phpDocumentor 1.3.2