Skip to content

icms_view_block_Object

Jump to bottom
Raimondas Rimkevičius edited this page Mar 9, 2020 · 1 revision
Notice: Wiki was automatic generated from project sources as project API documentation. Do not edit manually!

icms_view_block_Object

ImpressCMS Core Block Object Class

  • Class name: icms_view_block_Object
  • Namespace:
  • Parent class: icms_ipf_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

bid

public int bid

Block ID

  • Visibility: public

mid

public int mid

Module ID

  • Visibility: public

func_num

public int func_num
  • Visibility: public

title

public string title

Title

  • Visibility: public

content

public string content

Content

  • Visibility: public

side

public int side

Side

  • Visibility: public

weight

public int weight

Weight used for sorting positions

  • Visibility: public

visible

public int visible

Is visible?

  • Visibility: public

block_type

public string block_type

Type

  • Visibility: public

c_type

public string c_type
  • Visibility: public

isactive

public int isactive

Is active?

  • Visibility: public

dirname

public string dirname

Directory name

  • Visibility: public

func_file

public string func_file

Function file

  • Visibility: public

show_func

public string show_func

Show function

  • Visibility: public

edit_func

public string edit_func

Edit function

  • Visibility: public

template

public string template

Template

  • Visibility: public

bcachetime

public int bcachetime

Cache time

  • Visibility: public

last_modified

public int last_modified

When it was last modified?

  • Visibility: public

options

public string options

Options

  • Visibility: public

Methods

__construct

mixed icms_view_block_Object::__construct(handler, mixed data)

Constructor for the block object

  • Visibility: public

Arguments

  • handler mixed
  • data mixed

setVar

mixed icms_view_block_Object::setVar(mixed name, mixed value, mixed options)
  • Visibility: public

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

getVar

mixed icms_view_block_Object::getVar(mixed name, mixed format)
  • Visibility: public

Arguments

  • name mixed
  • format mixed

buildBlock

array icms_view_block_Object::buildBlock()

Builds the block

  • Visibility: public

isCustom

bool icms_view_block_Object::isCustom()

Gets if block is of type custom

For backward compatibility

  • Visibility: public

getContent

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

Gets content for block

  • Visibility: public

Arguments

  • format string - <p>Block type</p>
  • c_type string - <p>Content type</p>
Clone this wiki locally