$ A B C D E F G H I L M P R S T U V

$

$b_order - Variable in class Template
This array is a index of blocks by ID within each zone.
$blockAppend - Variable in class Template
A flag which indicates if the Dynamic block add should append the current parsed data or create a new entry for the block ID.
$blockID - Variable in class Template
For dynamic blocks, we wish to only add a copy of the block which is calling itself into the zone.
$blocks - Variable in class Template
An array of the block content for the Template.
$command - Variable in class Interface
 
$config - Variable in class Config
Holds an array containing the global configuration options for the entire portal.
$content - Variable in class Template
The raw content of the template.
$data - Variable in class Template
The physical dynamic data used placed into the <[data]> tags of the web page.
$debug - Variable in class Template
A debugging flag.
$elements - Variable in class Template
An array of all elements used in the Template.
$id - Variable in class Theme
The theme id generated during interface initialization.
$id - Variable in class Template
The theme passes its own ID as the ID for the template.
$interface - Variable in class Interface
 
$language - Variable in class MethodFactory
Contains the language translation object.
$name - Variable in class Template
The internal name of the theme as generated during template initialzation.
$parsed_text - Variable in class Template
The fully parsed text of the template.
$session - Variable in class Interface
 
$tconfig - Variable in class Theme
The theme config defines several options in the theme.
$template - Variable in class Theme
The template object should only be accessed through its owning Theme.
$theme - Variable in class Interface
 
$tmeta - Variable in class Theme
The theme meta data contains information about the page composition, author, etc.
$zoneID - Variable in class Template
This holding variable allows the dynamically added block to know what zone it apply itself to.
$zones - Variable in class Template
An array of the zones in the Template as indexed by their name and ID.

A

add() - Method in class Interface
Add Stub Method
addParsedBlock() - Method in class Template
Add Parsed Block This method can be used by an interface method on its own theme object to add an additional entry for the same block within a zone.
assign(var, var) - Method in class Template
Assign Template Data Assigns data to the template using either single items or arrays.

B

buildForm(var) - Method in class Template
Build Dynamic Form Dynamic form generation is handled by reading parameters from the dynamic form and form element tables to compose data into the form as needed.
buildTable(var) - Method in class Template
Build Dynamic Table When a <[table]> tag is inserted in an element or block, this method is called to parse the table into the content.

C

censorContent(var) - Method in class MethodFactory
Deprecated.  
Config - class Config.
Configuration While not completely object oriented, this config class opens the door for using config as an object in later development.
Config() - Constructor for class Config
Config Constructor Creates a configuration object from the global configuration.
CoreErrorHandler(var, var, var, var, var) - Method in class Interface
Custom Error Handler Rather than rely on defauly PHP error handling, we will override the error handler with our own method.

D

dateArray(var) - Method in class MethodFactory
Date Array Using an internal portal date format, the system will return an array variable containing the values for the date.
db_quote(var, var) - Method in class MethodFactory
Database Quote Parser Parses text for entry into a database field.
delete() - Method in class Interface
Delete Stub Method
display() - Method in class Interface
Display Interface The display method calls upon the theme object to perform parsing of the various areas of the template and return the completely parsed text from the template display method.
displayTheme() - Method in class Theme
Display Theme Displays the theme by causing the template to self-parse its contents.

E

edit() - Method in class Interface
Edit Stub Method

F

footer(var) - Method in class Interface
Footer Stub Method
formatDBTimestamp(var) - Method in class MethodFactory
Format Database Timestamp Dark Portal forces all timestamps to be set in the database as VARCHAR fields rather than database date or time formats.
formatUNIXTimestamp(var) - Method in class MethodFactory
Format UNIX/System Timestamp Extracts a UNIX level timestamp (seconds since 1970) and converts the value to an internal timestamp format (YYYYMMDDHHMISS).

G

getBlocks(var) - Method in class Template
Get Blocks Loads the blocks based on a list of zones provided by the getZones method.
getElements() - Method in class Template
Get Elements We load the elements before any other portions of the template are loaded.
getInterfaceData(var, var) - Method in class MethodFactory
Get Interface Data Loads the data from the searched database table into an array which is used in many global interface operations.
getparse() - Method in class Template
Get Parsed Text Pulls the parsed text of the template and returns it as a string.
getTemplate() - Method in class Template
Get Template Pulls the name and content from the database theme table and returns an array containing the theme name and raw content information.
getThemeConfig() - Method in class Theme
Get Theme Configuration Loads the theme configuration from the database.
getThemeMeta() - Method in class Theme
Get Theme MetaData Theme meta data is inserted into META HTML headers in the portal interface code.
getUserEmail(var) - Method in class MethodFactory
Get User Email Based on the user id number, this method will return the displayable email of the user.
getUserName(var) - Method in class MethodFactory
Get User Name Based on a userid number, this method will return the displayable name of the user to the calling method.
getZones() - Method in class Template
Get Zones Loads the zones for the theme based on how the zones are defined in the database.

H

header(var) - Method in class Interface
Header Stub Method

I

Initialize() - Method in class Interface
Class Initializer The initializer performs a number of key tasks that are crucial to the setup of the interface.
initializeLocal() - Method in class LocalInterface
Initialize Local Interface If special initialzation is required by the local interface, it should be performed here.
initTemplate() - Method in class Template
Initialize Template Initialization of the template first removes any data from the current zone, block and element arrays.
Interface - class Interface.
Interface Parent Class The interface class contains all the methods required to handle user input from the web interface and handles any specialized handling of the display for these requests.
Interface() - Constructor for class Interface
Interface Constructor The class constructor requires the input of an interface, operation and plugin name.

L

leftblock(var) - Method in class Interface
LeftBlock Stub Method
loadFormData() - Method in class MethodFactory
Load Form Data Dark Portal uses a standard method for determining names of variables used in an HTML form.
loadSearch() - Method in class MethodFactory
Load Search Using the global search parameters, the method will create a private array of search parameters for generating an interface data query.
loadUserPrefs() - Method in class MethodFactory
Load User Preferences Based on the global userinfo variable, we will load the user preferences for the user from the database.
LocalInterface - class LocalInterface.
API Interface The following template provides the basic level of functionality for all Dark Portal plugin interfaces.
LocalInterface() - Constructor for class LocalInterface
API Interface Constructor The local interface contructor should usually only call the super class constructor.

M

main(var) - Method in class LocalInterface
Main Zone Callback Method Almost all interfaces should contain a main() method.
main(var) - Method in class Interface
Main Stub Method
MethodFactory - class MethodFactory.
Method Factory The base method factory parent contains basic method commands which can be executed within an interface.
MethodFactory() - Constructor for class MethodFactory
MethodFactory Constructor Only called by the plugin method constructor.
monthArray() - Method in class MethodFactory
Month Array Returns an array which contains a list of month names.

P

parse() - Method in class Template
Parse Template Content The template parsing procedure starts with the element parsing and then moves outward through the blocks, zones and finally core template to render the fully parsed HTML.
parseBlocks(var) - Method in class Template
Parse Blocks Unlike elements, blocks are not parsed recursively.
parseContent(var, var) - Method in class MethodFactory
Parse Content Some named fields may require special parsing for display in the interfaces.
parseElements(var, var) - Method in class Template
Parse Elements Element parsing is done one element at a time.
parseZones(var) - Method in class Template
Parse Zones Zones differ in how they are parsed from the blocks and elements.

R

resetTheme() - Method in class Interface
Reset Theme
rightblock(var) - Method in class Interface
RightBlock Stub Method

S

search() - Method in class Interface
Search Stub Method The following is a sample base operations method.
sendEmail(var, var) - Method in class MethodFactory
Send Email Message

T

Template - class Template.
Template The template itself contains all the zones, blocks and elements needed to compose a HTML template of the interface to display.
Template(var) - Constructor for class Template
Template Constructor Using the ID from the theme, the template will construct a new object.
Theme - class Theme.
Theme The current templating system is broken into two container classes.
Theme(var) - Constructor for class Theme
Theme Constructor Creates the theme object and performs the initialization to load the config and meta data loading.
translate(var) - Method in class MethodFactory
Deprecated.  
transposeData(var) - Method in class MethodFactory
Transpose Data Data in the form of ID NAME VALUE 1 name1 val1 2 name2 val2 3 name3 val3 Will be transposed into name1 name2 name3 val1 val2 val3

U

ultramode() - Method in class MethodFactory
RSS UltraMode - Not Implemented
unknownError() - Method in class Interface
Unknown Error A fallback method for displaying an error when a particular operation fails because of odd reasons.

V

validateForm() - Method in class Interface
Validate HTML Form

$ A B C D E F G H I L M P R S T U V