Class: I2CE CustomReport Display PieChart (4.0.19)

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

This article describes the class I2CE_CustomReport_Display_PieChart .

• Extends the class: I2CE_CustomReport_Display.
• Location: Part of the module CustomReports_PieChart in the package I2CE 4.0.19-release
• Source: Defined in the file modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php on line 29
• Author: Carl Leitner <litlfred@ibiblio.org>

I2CE_CustomReport_Display_PDF

Variables

$chart

• Defined in i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php on line 35
• Type: protected $chart

$displayedChartFields

An array with values the name of the columns used for this display

• Defined in i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php on line 309
• Type: protected array $displayedChartFields

$displayedChartFieldsIndices

An array (or an array or arrays) with keys the values of the charted fields and values the index row (row and col) they are in the $chart['chart_data'] array @var protected array $displayedChartFields

• Defined in i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php on line 315
• Type: protected $displayedChartFieldsIndices

Methods

SendChartData()

Calls the Chart, SendChartData() function and exits

• Defined in i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php on line 162
• Signature: protected function SendChartData()

canView()

Abstract method that each display is resposbile for implementing. Checks to see if it can display the given view.

• Defined in i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php on line 455
• Signature: protected function canView()
• Returns: boolean

display()

Display the report

• Defined in i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php on line 45
• Signature: public function display($contentNode,$processResults,$controls)
• Parameters:
  • DOMNode $contentNode
    The DOM node we wish to display into
  • boolean $processResults
    Defaults to true meaning we run through the 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

displayReportControl()

Adds any controls for this display to the content node.

• Defined in i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php on line 571
• Signature: protected function displayReportControl($contentNode)
• Parameters:
  • DOMNode $contentNode
• Returns: boolean;

ensureValidStyleAndType()

Ensures check we have a valid style and type set or we can fall back onto one.

• Defined in i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php on line 468
• Signature: protected function ensureValidStyleAndType($defaultOptions)
• Parameters:
  • array &$defaultOptions
    The default options we are scanning
• Returns: boolean.
  True on success

getDefaultOptions()

returns an array of the default display options. Default options are read and overriddenb in the following order: /modules/CustomReports/displays/$display/display_options /modules/CustomReports/relationships/display_options/$display /modules/CustomReports/reports/display_options/$display /modules/CustomReports/reportViews/$view/display_options/$display Finally any options that have a key in $get are replaced by that value

• Defined in i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php on line 406
• Signature: protected function getDefaultOptions($get,$options)
• Parameters:
  • array $get
  • array $options
    Default to the empty array. The options that we want to be already set before we start goinng through
    • Default Value: array()
• Returns: array

makeChartStylesSane()

• Defined in i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php on line 522
• Signature: protected function makeChartStylesSane($defaultOptions)
• Parameters:
  • &$defaultOptions

postProcessResultsMultiRow()

• Defined in i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php on line 291
• Signature: protected function postProcessResultsMultiRow()

postProcessResultsOneRow()

• Defined in i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php on line 204
• Signature: protected function postProcessResultsOneRow()

preProcessResultsMultiRow()

• Defined in i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php on line 285
• Signature: protected function preProcessResultsMultiRow()

preProcessResultsOneRow()

• Defined in i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php on line 281
• Signature: protected function preProcessResultsOneRow()

processResultRow()

Process a result row.

• Defined in i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php on line 324
• 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

processResults()

Process results

• Defined in i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php on line 86
• Signature: protected function processResults($results_data,$contentNode)
• Parameters:
  • array $results_data
    an array of results. indices are 'results' and MDB2 Buffered result and 'num_results' the number of results. (these values may be false on failure)
  • DOMNode $contentNode
    Default to null a node to append the results onto
    • Default Value: null

setupFlashChart()

Sets up the flash chart options in $this->chart

• Defined in i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php on line 712
• Signature: protected function setupFlashChart($defaultOptions)
• Parameters:
  • &$defaultOptions
• Returns: boolean.
  True on success

setupHeightWidth()

Set up the height or width of the chart rectangle based no the size of the legend for pie and the relevant axis for column/bar/line.

• Defined in i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php on line 180
• Signature: protected function setupHeightWidth()

Inherited Methods

__construct()

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

saveDefaultView()

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

saveDisplayOptions()

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

_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()

displayReportControls()

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

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()

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()

getPivots()

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

getReportLimitsDescription()

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

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()

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()

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

$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

$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

Inherited Fuzzy Methods

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()