Class: I2CE CustomReport Display PieChart

From IHRIS Wiki
Revision as of 16:01, 16 October 2009 by Litlfred (talk | contribs) (Created page with 'This article desrcibes the class '''I2CE_CustomReport_Display_PieChart'''which extends the class I2CE_CustomReport_Display It is contained …')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This article desrcibes the class I2CE_CustomReport_Display_PieChartwhich extends the class I2CE_CustomReport_Display It is contained in the module CustomReports_PieChart in the package I2CE The class is defined in the file: modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php I2CE_CustomReport_Display_PDF @package I2CE @subpackage Core @author Carl Leitner <litlfred@ibiblio.org> @version 2.1 @access public

Variables

$chart

  • Type: protected $chart

$displayedChartFields

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

  • Type: protected y $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

  • Type: protected $displayedChartFieldsIndices

Methods

canView()

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

  • Signature: protected function canView()
  • Returns: boolean

display()

Display the report

  • Signature: public function display($contentNode,$processResults,$controls)
  • Returns: boolean. true on sucess

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

displayReportControl()

Adds any controls for this display to the content node.

  • Signature: protected function displayReportControl($contentNode)
  • Returns: boolean;

Parameters:

ensureValidStyleAndType()

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

  • Signature: protected function ensureValidStyleAndType($defaultOptions)
  • Returns: boolean. True on success

Parameters:

  • array &$defaultOptions
    The default options we are scanning

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

  • Signature: protected function getDefaultOptions($get,$options)
  • Returns: array

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

makeChartStylesSane()

  • Signature: protected function makeChartStylesSane($defaultOptions)

Parameters:

  • &$defaultOptions

postProcessResultsMultiRow()

  • Signature: protected function postProcessResultsMultiRow()

postProcessResultsOneRow()

  • Signature: protected function postProcessResultsOneRow()

preProcessResultsMultiRow()

  • Signature: protected function preProcessResultsMultiRow()

preProcessResultsOneRow()

  • Signature: protected function preProcessResultsOneRow()

processResultRow()

Process a result row. result offset. Othwerwise, it starts counting form zero.

  • 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
  • domnode $contentNode
    Default to null. A node to append the result onto
    • Default Value: null

processResults()

Process results number of results. (these values may be false on failure)

  • Signature: protected function processResults($results_data,$contentNode)

Parameters:

  • array $results_data
    an array of results. indices are 'restults' and MDB2 Buffered result and 'num_results' the
  • 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

  • Signature: protected function setupFlashChart($defaultOptions)
  • Returns: boolean. True on success

Parameters:

  • &$defaultOptions

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

$$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

$$reportViewsFactory

Theis protected variable is inherited from I2CE_CustomReport_Display->$$reportViewsFactory

Inherited Fuzzy Methods

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_I2CE_CustomReport_Display_PieChart&oldid=4859"