Docs For Class acContentBlockBase

Class acContentBlockBase

Description

Class definition and methods for AdvancedContent contentblock types.
All block types needs to inherit and extend this class!

author: Georg Busch (NaN)
copyright: 2010-2012 Georg Busch (NaN)
abstract:
since: 0.9
access: public
license: GPL

Located in /class.acContentBlockBase.php (line 15)

Direct descendents

Class	Description
acBlockType_checkbox	Class definition and methods for AdvancedContent contentblock types. All block types needs to inherit and extend this class!
acBlockType_colorpicker	Class definition and methods for AdvancedContent contentblock types. All block types needs to inherit and extend this class!
acBlockType_date	Class definition and methods for AdvancedContent contentblock types. All block types needs to inherit and extend this class!
acBlockType_dropdown	Class definition and methods for AdvancedContent contentblock types. All block types needs to inherit and extend this class!
acBlockType_image	Class definition and methods for AdvancedContent contentblock types. All block types needs to inherit and extend this class!
acBlockType_module	Class definition and methods for AdvancedContent contentblock types. All block types needs to inherit and extend this class!
acBlockType_multi_input	Class definition and methods for AdvancedContent contentblock types. All block types needs to inherit and extend this class!
acBlockType_select_multiple	Class definition and methods for AdvancedContent contentblock types. All block types needs to inherit and extend this class!
acBlockType_slider	Class definition and methods for AdvancedContent contentblock types. All block types needs to inherit and extend this class!
acBlockType_text	Class definition and methods for AdvancedContent contentblock types. All block types needs to inherit and extend this class!
acBlockType_ui_slider	Class definition and methods for AdvancedContent contentblock types. All block types needs to inherit and extend this class!

Method Summary

acContentBlockBase __construct ( &$content_obj, [array $params = array()])

string FillParams (array &$params, [bool $editing = false])

string GetChangeLog ()

string GetContent ()

string GetHeaderHTML ()

string GetHelp ()

string GetInput ()

array GetProperties ()

mixed GetProperty (string $name, [string $default = ''])

array SetBlockTypeProperties ()

string SetContent ( $value)

void SetProperty (string $name, [string $value = ''])

string Show ()

bool Validate ()

Methods

Constructor __construct (line 43)

Constructor.
Required for all subclasses.
Should be called from each subclass as the very first.

acContentBlockBase __construct ( &$content_obj, [array $params = array()])

array $params: - the parameters of that contentblock
&$content_obj

Redefined in descendants as:

FillParams (line 196)

Function for the subclass to parse out data for it's parameters.
Needs to be overwritten if the blocktype provides a special kind of data that needs to be processed before storing it.

access: public

string FillParams (array &$params, [bool $editing = false])

array &$params: - the parameters that are passed when the form is submitted
bool $editing: - a flag to determine if the page is created or edited

Redefined in descendants as:

GetChangeLog (line 184)

Displays the changelog text for this blocktype.
Changelog will be displayed in modules changelog.

access: public

string GetChangeLog ()

GetContent (line 225)

Function to get the blocks raw content

since: 0.9.4
access: public

string GetContent ()

GetHeaderHTML (line 164)

Gets the html that needs to be inserted in the head section for all blocks of this type when editing a page.
Can be useful to add css or js.
Will be called only once for each block type.

access: public

string GetHeaderHTML ()

Redefined in descendants as:

GetHelp (line 174)

Displays the help text for this blocktype.
Helptext will be displayed in modulehelp.

access: public

string GetHelp ()

GetInput (line 156)

Gets the html output of the block in backend.
This method is required and needs to be overwritten.

access: public

string GetInput ()

Redefined in descendants as:

GetProperties (line 138)

Returns all valid properties of that block.

return: - array(propname => propvalue)
access: public

array GetProperties ()

GetProperty (line 125)

Returns the value of a property.

return: - usually this will be a string
access: public

mixed GetProperty (string $name, [string $default = ''])

string $name: - the name of the property
string $default: - the default value of the property if not exists

SetBlockTypeProperties (line 149)

Defines additional properties of the blocktype that affects all blocks of this type and needs to be stored "outside" the block.

return: - array(propname => propvalue)
abstract:
access: public

array SetBlockTypeProperties ()

Redefined in descendants as:

acBlockType_multi_input::SetBlockTypeProperties()

SetContent (line 235)

Function to set the content of a block temporary on runtime to a certain value

since: 0.9.4
access: protected

string SetContent ( $value)

$value

SetProperty (line 114)

Sets the value of a property. If not exists it will be created.

access: public

void SetProperty (string $name, [string $value = ''])

string $name: - the name of the property
string $value: - the value of the property

Show (line 206)

Function for the subclass to perform the blocks output
Needs to be overwritten if the blocktype provides a special kind of data that needs to be processed before displaying it in frontend.

access: public

string Show ()

Redefined in descendants as:

acBlockType_date::Show()

Validate (line 215)

Function for the subclass to validate its data

access: public

bool Validate ()

Documentation generated on Tue, 09 Oct 2012 16:57:05 +0200 by phpDocumentor 1.4.1