Docs For Class Display

Description

Common Display Class

This is the parent class class that each display class should be extending and executing parent::render()

abstract:

Located in /classes/Display/Common.php (line 24)

Object
   |
   --Display_Common

Variable Summary

string $child_template

string $css_class

string $extension

array $js_basename

array $meta_data

array $module_return

string $parent_template

Method Summary

Display_Common __construct ()

void render ()

void setMetaData (array $meta_data)

void setModuleReturn (array $module_return)

void setTemplateVariables (string $parent_template, string $child_template, string $css_class, string $js_basename)

boolean templateExists ()

Variables

string $child_template = null (line 48)

Child (sub) Template

access: protected

string $css_class = '' (line 56)

CSS Class Name

access: protected

string $extension = null (line 32)

Template Extension

var: file extension for the template files
access: protected

array $js_basename = '' (line 64)

Javascript [Path and] Basename

access: protected

array $meta_data = null (line 72)

Meta Data

access: protected

array $module_return = null (line 80)

Module Return Data

access: protected

string $parent_template = null (line 40)

Parent Template

access: protected

Methods

Constructor __construct (line 87)

Constructor

Gets those headers working

access: public

Display_Common __construct ()

render (line 194)

Rendering Method

abstract:
access: public

void render ()

setMetaData (line 159)

Set Meta Data

Sets the meta data from the module so the display class can use it

access: public

void setMetaData (array $meta_data)

array $meta_data: key/value array of data

setModuleReturn (line 171)

Set Module Return

Sets the return data from the module so the display class can display it

access: public

void setModuleReturn (array $module_return)

array $module_return: key / value pairs for the data

setTemplateVariables (line 143)

Set Template Variables

Sets the variables used by the templates

access: public

void setTemplateVariables (string $parent_template, string $child_template, string $css_class, string $js_basename)

string $parent_template: parent template
string $child_template: child (sub) template
string $css_class: name of the CSS class for the module
string $js_basename: basename for the javascript file for the module

templateExists (line 184)

Template Exists

Checks the templates for validity, not required by every display type so the return defaults to true.

return: whether or not the template exists
access: public

boolean templateExists ()

Class Display_Common