mod_system_Blocks

Notice: Wiki was automatic generated from project sources as project API documentation. Do not edit manually!

mod_system_Blocks

System Block Configuration Object Class

• Class name: mod_system_Blocks
• Namespace:
• Parent class: icms_view_block_Object

Constants

BLOCK_TYPE_SYSTEM

const BLOCK_TYPE_SYSTEM = S

BLOCK_TYPE_MODULE

const BLOCK_TYPE_MODULE = M

BLOCK_TYPE_CUSTOM

const BLOCK_TYPE_CUSTOM = C

BLOCK_TYPE_DUPLICATED

const BLOCK_TYPE_DUPLICATED = K

BLOCK_TYPE_LEGACY_DUPLICATED

const BLOCK_TYPE_LEGACY_DUPLICATED = D

BLOCK_TYPE_LEGACY_CUSTOM

const BLOCK_TYPE_LEGACY_CUSTOM = E

CONTENT_TYPE_HTML

const CONTENT_TYPE_HTML = H

CONTENT_TYPE_PHP

const CONTENT_TYPE_PHP = P

CONTENT_TYPE_AUTO_FORMAT

const CONTENT_TYPE_AUTO_FORMAT = S

CONTENT_TYPE_NO_AUTO_FORMAT

const CONTENT_TYPE_NO_AUTO_FORMAT = T

Properties

$visiblein

public array $visiblein = []

Visible areas for block

• Visibility: public

name

public string name

Name

• Visibility: public
• This property is defined by icms_view_block_Object

bid

public int bid

Block ID

• Visibility: public
• This property is defined by icms_view_block_Object

mid

public int mid

Module ID

• Visibility: public
• This property is defined by icms_view_block_Object

func_num

public int func_num

• Visibility: public
• This property is defined by icms_view_block_Object

title

public string title

Title

• Visibility: public
• This property is defined by icms_view_block_Object

content

public string content

Content

• Visibility: public
• This property is defined by icms_view_block_Object

side

public int side

Side

• Visibility: public
• This property is defined by icms_view_block_Object

weight

public int weight

Weight used for sorting positions

• Visibility: public
• This property is defined by icms_view_block_Object

visible

public int visible

Is visible?

• Visibility: public
• This property is defined by icms_view_block_Object

block_type

public string block_type

Type

• Visibility: public
• This property is defined by icms_view_block_Object

c_type

public string c_type

• Visibility: public
• This property is defined by icms_view_block_Object

isactive

public int isactive

Is active?

• Visibility: public
• This property is defined by icms_view_block_Object

dirname

public string dirname

Directory name

• Visibility: public
• This property is defined by icms_view_block_Object

func_file

public string func_file

Function file

• Visibility: public
• This property is defined by icms_view_block_Object

show_func

public string show_func

Show function

• Visibility: public
• This property is defined by icms_view_block_Object

edit_func

public string edit_func

Edit function

• Visibility: public
• This property is defined by icms_view_block_Object

template

public string template

Template

• Visibility: public
• This property is defined by icms_view_block_Object

bcachetime

public int bcachetime

Cache time

• Visibility: public
• This property is defined by icms_view_block_Object

last_modified

public int last_modified

When it was last modified?

• Visibility: public
• This property is defined by icms_view_block_Object

options

public string options

Options

• Visibility: public
• This property is defined by icms_view_block_Object

Methods

__construct

mixed icms_view_block_Object::__construct(handler, mixed data)

Constructor for the block object

• Visibility: public
• This method is defined by icms_view_block_Object

Arguments

• handler mixed
• data mixed

getVar

mixed icms_view_block_Object::getVar(mixed name, mixed format)

• Visibility: public
• This method is defined by icms_view_block_Object

Arguments

• name mixed
• format mixed

weight

mixed mod_system_Blocks::weight()

Custom accesser for weight property

• Visibility: private

visible

mixed mod_system_Blocks::visible()

Custom accessor for visible property

• Visibility: private

mid

mixed mod_system_Blocks::mid()

Custom accessor for mid property

• Visibility: private

side

mixed mod_system_Blocks::side()

Custom accessor for side property

• Visibility: private

getBlankLink

mixed mod_system_Blocks::getBlankLink()

Renders a space in the actions column

• Visibility: public

getUpActionLink

mixed mod_system_Blocks::getUpActionLink()

Renders a graphic and link to move the block up (lower weight)

• Visibility: public

getDownActionLink

mixed mod_system_Blocks::getDownActionLink()

Renders a graphic and link to move the block down (increase weight)

• Visibility: public

getCloneActionLink

mixed mod_system_Blocks::getCloneActionLink()

Renders a graphic and link to clone the block

• Visibility: public

getEditActionLink

mixed mod_system_Blocks::getEditActionLink()

Renders a graphic and link to edit a block

• Visibility: public

getAdminViewItemLink

mixed mod_system_Blocks::getAdminViewItemLink(mixed onlyUrl)

Overrides parent method

• Visibility: public

Arguments

• onlyUrl mixed

getDeleteItemLink

string mod_system_Blocks::getDeleteItemLink(string onlyUrl, bool withimage, bool userSide)

getDeleteItemLink

Overwrited Method

• Visibility: public

Arguments

• onlyUrl string
• withimage bool
• userSide bool

getForm

\icms_form_Base mod_system_Blocks::getForm(string form_caption, string form_name, bool|string form_action, string submit_button_caption, bool cancel_js_action, bool captcha)

Create the form for this object

• Visibility: public

Arguments

• form_caption string - <p>Form caption</p>
• form_name string - <p>Form name</p>
• form_action bool|string - <p>Form action</p>
• submit_button_caption string - <p>Submit button caption</p>
• cancel_js_action bool - <p>Cancel JS action?</p>
• captcha bool - <p>Use captcha?</p>

getSideControl

mixed mod_system_Blocks::getSideControl()

• Visibility: public

getWeightControl

mixed mod_system_Blocks::getWeightControl()

• Visibility: public

setVar

mixed icms_view_block_Object::setVar(mixed name, mixed value, mixed options)

• Visibility: public
• This method is defined by icms_view_block_Object

Arguments

• name mixed
• value mixed
• options mixed

getOptions

string|bool icms_view_block_Object::getOptions()

(HTML-) form for setting the options of the block

• Visibility: public
• This method is defined by icms_view_block_Object

buildBlock

array icms_view_block_Object::buildBlock()

Builds the block

• Visibility: public
• This method is defined by icms_view_block_Object

isCustom

bool icms_view_block_Object::isCustom()

Gets if block is of type custom

For backward compatibility

• Visibility: public
• This method is defined by icms_view_block_Object

getContent

array|bool|mixed|string|string[] icms_view_block_Object::getContent(string format, string c_type)

Gets content for block

• Visibility: public
• This method is defined by icms_view_block_Object

Arguments

• format string - <p>Block type</p>
• c_type string - <p>Content type</p>