Class: I2CE CustomReport Display Selector (4.1.12)

For other versions, see Class: I2CE_CustomReport_Display_Selector (versions) .

This article describes the class I2CE_CustomReport_Display_Selector .

• Extends the class: I2CE_CustomReport_Display_Default.
• Location: Part of the module CustomReports-Selector in the package I2CE 4.1.12-release
• Source: Defined in the file modules/CustomReports/modules/CustomReportSelector/lib/I2CE_CustomReport_Display_Selector.php on line 33
• Author: Carl Leitner <litlfred@ibiblio.org>
• Since: v4.0.11

@filesource Class I2CE_CustomReport_Display_Selector

Variables

$ff

• Defined in i2ce/modules/CustomReports/modules/CustomReportSelector/lib/I2CE_CustomReport_Display_Selector.php on line 37
• Type: protected I2CE_FormFactory $ff

$printf

• Defined in i2ce/modules/CustomReports/modules/CustomReportSelector/lib/I2CE_CustomReport_Display_Selector.php on line 41
• Type: protected $printf

$selctorid

• Defined in i2ce/modules/CustomReports/modules/CustomReportSelector/lib/I2CE_CustomReport_Display_Selector.php on line 45
• Type: protected $selctorid

$reportFrom

• Defined in i2ce/modules/CustomReports/modules/CustomReportSelector/lib/I2CE_CustomReport_Display_Selector.php on line 50
• Type: protected $reportFrom

$printf_args

printf_args. The array field names which are arguments to the printf

• Defined in i2ce/modules/CustomReports/modules/CustomReportSelector/lib/I2CE_CustomReport_Display_Selector.php on line 55
• Type: protected array $printf_args

$style

style. The style to use for the display values.

• Defined in i2ce/modules/CustomReports/modules/CustomReportSelector/lib/I2CE_CustomReport_Display_Selector.php on line 60
• Type: protected string $style

$multi_select

set if the page is allows multiple selection.

• Defined in i2ce/modules/CustomReports/modules/CustomReportSelector/lib/I2CE_CustomReport_Display_Selector.php on line 67
• Type: protected boolean $multi_select

Methods

__construct()

The constuctor

• Defined in i2ce/modules/CustomReports/modules/CustomReportSelector/lib/I2CE_CustomReport_Display_Selector.php on line 82
• Signature: public function __construct($page,$view)
• Parameters:
  • I2CE_Page $page
  • string $view @throws Excecption on error

display()

Display the report

• Defined in i2ce/modules/CustomReports/modules/CustomReportSelector/lib/I2CE_CustomReport_Display_Selector.php on line 185
• Signature: public function display($contentNode,$processResults,$controls)
• Parameters:
  • DOMNode $contentNode
    The DOM node we wish to display into. If null, we do not do any of the DOM processing stuff, do not call the report display controls, limits etc. It will however still call processResults with a DOMNode of null
  • boolean $processResults
    Defaults to true meaning we run through the results. If false, we do not process results.
    • Default Value: true
  • mixed $controls
    If null (default), we display all the report controsl. If string or an array of string, we only display the indicated controls
    • Default Value: null
• Returns: boolean.
  true on sucess

displayReportControls()

Adds any report display controls that can be added for this view. @param DOMNode $conentNode

• Defined in i2ce/modules/CustomReports/modules/CustomReportSelector/lib/I2CE_CustomReport_Display_Selector.php on line 127
• Signature: protected function displayReportControls($contentNode,$controls)
• Parameters:
  • $contentNode
  • mixed $controls
    If null (default), we display all the report controsl. If string or an array of string, we only display the indicated controls
    • Default Value: null
• Returns: boolean
  $true on success

getJumperQryFields()

Get the query fields for the jumper

• Defined in i2ce/modules/CustomReports/modules/CustomReportSelector/lib/I2CE_CustomReport_Display_Selector.php on line 110
• Signature: protected function getJumperQryFields()
• Returns: array

getPivots()

• Defined in i2ce/modules/CustomReports/modules/CustomReportSelector/lib/I2CE_CustomReport_Display_Selector.php on line 172
• Signature: protected function getPivots()

getReportPrefix()

Get the report results prefix for the DOM

• Defined in i2ce/modules/CustomReports/modules/CustomReportSelector/lib/I2CE_CustomReport_Display_Selector.php on line 72
• Signature: protected function getReportPrefix()
• Returns: string

processResultRow()

Process a result row.

• Defined in i2ce/modules/CustomReports/modules/CustomReportSelector/lib/I2CE_CustomReport_Display_Selector.php on line 199
• Signature: protected function processResultRow($row,$row_num,$contentNode)
• Parameters:
  • array $row
  • int $row_num
    The current row number when processing results. If there was a result limit, it starts the count from the beginning of the result offset. Othwerwise, it starts counting form zero.
  • DOMNode $contentNode
    Default to null. A node to append the result onto
    • Default Value: null

Inherited Methods

canView()

This protected method is inherited from I2CE_CustomReport_Display_Default->canView()

doHeaderRow()

This protected method is inherited from I2CE_CustomReport_Display_Default->doHeaderRow()

doJumper()

This protected method is inherited from I2CE_CustomReport_Display_Default->doJumper()

getPageRoot()

This protected method is inherited from I2CE_CustomReport_Display_Default->getPageRoot()

noData()

This protected method is inherited from I2CE_CustomReport_Display_Default->noData()

processResults()

This protected method is inherited from I2CE_CustomReport_Display_Default->processResults()

getReportLimitsDescription()

This public method is inherited from I2CE_CustomReport_Display->getReportLimitsDescription()

saveDefaultView()

This public method is inherited from I2CE_CustomReport_Display->saveDefaultView()

saveDisplayOptions()

This public method is inherited from I2CE_CustomReport_Display->saveDisplayOptions()

unsetPaging()

This public method is inherited from I2CE_CustomReport_Display->unsetPaging()

_displayReportFormLimit()

This protected method is inherited from I2CE_CustomReport_Display->_displayReportFormLimit()

_displayReportFunctionLimit()

This protected method is inherited from I2CE_CustomReport_Display->_displayReportFunctionLimit()

_displayReportInternalLimit()

This protected method is inherited from I2CE_CustomReport_Display->_displayReportInternalLimit()

_displayReportLimits()

This protected method is inherited from I2CE_CustomReport_Display->_displayReportLimits()

_getMergedReportData()

This protected method is inherited from I2CE_CustomReport_Display->_getMergedReportData()

_getPivots()

This protected method is inherited from I2CE_CustomReport_Display->_getPivots()

_getReportViewDisplayedFieldsWalker()

This protected method is inherited from I2CE_CustomReport_Display->_getReportViewDisplayedFieldsWalker()

displayMetaInfo()

This protected method is inherited from I2CE_CustomReport_Display->displayMetaInfo()

displayReportControl()

This protected method is inherited from I2CE_CustomReport_Display->displayReportControl()

displayReportLimit()

This protected method is inherited from I2CE_CustomReport_Display->displayReportLimit()

displayReportLimits()

This protected method is inherited from I2CE_CustomReport_Display->displayReportLimits()

findNumericFields()

This protected method is inherited from I2CE_CustomReport_Display->findNumericFields()

getBasePage()

This protected method is inherited from I2CE_CustomReport_Display->getBasePage()

getDefaultOptions()

This protected method is inherited from I2CE_CustomReport_Display->getDefaultOptions()

getDisplayFieldsData()

This protected method is inherited from I2CE_CustomReport_Display->getDisplayFieldsData()

getFormFieldObjects()

This protected method is inherited from I2CE_CustomReport_Display->getFormFieldObjects()

getMappedValue()

This protected method is inherited from I2CE_CustomReport_Display->getMappedValue()

getMergedReportJoins()

This protected method is inherited from I2CE_CustomReport_Display->getMergedReportJoins()

getModuleLimits()

This protected method is inherited from I2CE_CustomReport_Display->getModuleLimits()

getReportViewDisplayedFields()

This protected method is inherited from I2CE_CustomReport_Display->getReportViewDisplayedFields()

getReportViewsFactory()

This protected method is inherited from I2CE_CustomReport_Display->getReportViewsFactory()

getResults()

This protected method is inherited from I2CE_CustomReport_Display->getResults()

getSwissReport()

This protected method is inherited from I2CE_CustomReport_Display->getSwissReport()

getSwissReportFunction()

This protected method is inherited from I2CE_CustomReport_Display->getSwissReportFunction()

getSwissReportInternal()

This protected method is inherited from I2CE_CustomReport_Display->getSwissReportInternal()

getSwissReportView()

This protected method is inherited from I2CE_CustomReport_Display->getSwissReportView()

isMapped()

This protected method is inherited from I2CE_CustomReport_Display->isMapped()

mapReportFormField()

This protected method is inherited from I2CE_CustomReport_Display->mapReportFormField()

mapResults()

This protected method is inherited from I2CE_CustomReport_Display->mapResults()

mergeOn_child()

This protected method is inherited from I2CE_CustomReport_Display->mergeOn_child()

mergeOn_child_field()

This protected method is inherited from I2CE_CustomReport_Display->mergeOn_child_field()

mergeOn_parent()

This protected method is inherited from I2CE_CustomReport_Display->mergeOn_parent()

mergeOn_parent_field()

This protected method is inherited from I2CE_CustomReport_Display->mergeOn_parent_field()

processWhere()

This protected method is inherited from I2CE_CustomReport_Display->processWhere()

processWhereByField()

This protected method is inherited from I2CE_CustomReport_Display->processWhereByField()

processWhereByFunction()

This protected method is inherited from I2CE_CustomReport_Display->processWhereByFunction()

processWhereByInternal()

This protected method is inherited from I2CE_CustomReport_Display->processWhereByInternal()

setupMappedValues()

This protected method is inherited from I2CE_CustomReport_Display->setupMappedValues()

validateSortFields()

This protected method is inherited from I2CE_CustomReport_Display->validateSortFields()

_hasMethod()

This public method is inherited from I2CE_Fuzzy->_hasMethod()

Inherited Variables

$formfields

Theis protected variable is inherited from I2CE_CustomReport_Display_Default->$formfields

$formObjs

Theis protected variable is inherited from I2CE_CustomReport_Display->$formObjs

$mappedFields

Theis protected variable is inherited from I2CE_CustomReport_Display->$mappedFields

$formMaps

Theis protected variable is inherited from I2CE_CustomReport_Display->$formMaps

$fieldMaps

Theis protected variable is inherited from I2CE_CustomReport_Display->$fieldMaps

$mappedValues

Theis protected variable is inherited from I2CE_CustomReport_Display->$mappedValues

$display

Theis protected variable is inherited from I2CE_CustomReport_Display->$display

$reportObj

Theis protected variable is inherited from I2CE_CustomReport_Display->$reportObj

$limitDescText

Theis protected variable is inherited from I2CE_CustomReport_Display->$limitDescText

$limitModules

Theis protected variable is inherited from I2CE_CustomReport_Display->$limitModules

$defaultOptions

Theis protected variable is inherited from I2CE_CustomReport_Display->$defaultOptions

$view

Theis protected variable is inherited from I2CE_CustomReport_Display->$view

$page

Theis protected variable is inherited from I2CE_CustomReport_Display->$page

$template

Theis protected variable is inherited from I2CE_CustomReport_Display->$template

$displayConfig

Theis protected variable is inherited from I2CE_CustomReport_Display->$displayConfig

$config

Theis protected variable is inherited from I2CE_CustomReport_Display->$config

$reportConfig

Theis protected variable is inherited from I2CE_CustomReport_Display->$reportConfig

$relationshipConfig

Theis protected variable is inherited from I2CE_CustomReport_Display->$relationshipConfig

$numeric

Theis protected variable is inherited from I2CE_CustomReport_Display->$numeric

$seen_merges

Theis protected variable is inherited from I2CE_CustomReport_Display->$seen_merges

$row_start

Theis protected variable is inherited from I2CE_CustomReport_Display->$row_start

$row_amount

Theis protected variable is inherited from I2CE_CustomReport_Display->$row_amount

$relationships

Theis protected variable is inherited from I2CE_CustomReport_Display->$relationships

$reportViewsFactory

Theis protected variable is inherited from I2CE_CustomReport_Display->$reportViewsFactory

$displayed_limits

Theis protected variable is inherited from I2CE_CustomReport_Display->$displayed_limits

$displayedFields

Theis protected variable is inherited from I2CE_CustomReport_Display->$displayedFields

Inherited Fuzzy Methods

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()