IP.Board  3.3.0
adminBlockHelperInterface Interface Reference
Inheritance diagram for adminBlockHelperInterface:
adminBlockHelper_custom adminBlockHelper_feed adminBlockHelper_plugin

Public Member Functions

 createWizardSession ($block)
 getBlockConfig ()
 getBlockContent ($block)
 recacheBlock ($block, $return=false)
 returnNextStep ($session)

Member Function Documentation

createWizardSession ( block)

Store data to initiate a wizard session based on given block table data

public

Parameters:
arrayBlock data
Returns:
array Data to store for wizard session

Implemented in adminBlockHelper_feed, adminBlockHelper_plugin, and adminBlockHelper_custom.

Get configuration data. Allows for automatic block types.

public

Returns:
array Array( key, text )

Implemented in adminBlockHelper_feed, adminBlockHelper_plugin, and adminBlockHelper_custom.

getBlockContent ( block)

Return the block content to display. Checks cache and updates cache if needed.

public

Parameters:
arrayBlock data
Returns:
string Content to output
recacheBlock ( block,
return = false 
)

Recache this block to the database based on content type and cache settings.

public

Parameters:
arrayBlock data
boolReturn data instead of saving to database
Returns:
bool Cache done successfully

Implemented in adminBlockHelper_plugin, and adminBlockHelper_custom.

returnNextStep ( session)

Wizard launcher. Should determine the next step necessary and act appropriately.

public

Parameters:
arraySession data
Returns:
string HTML to output to screen

Implemented in adminBlockHelper_custom, adminBlockHelper_feed, and adminBlockHelper_plugin.


The documentation for this interface was generated from the following file:
 All Data Structures Functions Variables