Documentation

Block
in package

Provides API to work with vtiger CRM Module Blocks.

Table of Contents

$baseTable  : string
Basic table name.
$display_status  : mixed
$icon  : mixed
$id  : mixed
ID of this block instance
$increateview  : mixed
$indetailview  : mixed
$ineditview  : mixed
$iscustom  : mixed
$label  : mixed
Label for this block instance
$module  : mixed
$sequence  : mixed
$showtitle  : mixed
$tabid  : mixed
Tab id
$visible  : mixed
__create()  : mixed
Create vtiger CRM block.
__delete()  : mixed
Delete this instance.
__getNextSequence()  : int
Get next sequence value to use for this block instance.
__update()  : mixed
addField()  : Reference
Add field to this block.
delete()  : mixed
Delete block instance.
deleteForModule()  : mixed
Delete all blocks associated with module.
getAllForModule()  : self
Get all block instances associated with the module.
getInstance()  : self
Get instance of block.
initialize()  : mixed
Initialize this block instance.
save()  : mixed
Save this block instance.

Properties

$baseTable

Basic table name.

public static string $baseTable = 'vtiger_blocks'

$display_status

public mixed $display_status = 1

$id

ID of this block instance

public mixed $id

$increateview

public mixed $increateview = 0

$indetailview

public mixed $indetailview = 0

$ineditview

public mixed $ineditview = 0

$iscustom

public mixed $iscustom = 0

$label

Label for this block instance

public mixed $label

$module

public mixed $module

$sequence

public mixed $sequence

$showtitle

public mixed $showtitle = 0

$tabid

Tab id

public mixed $tabid

$visible

public mixed $visible = 0

Methods

__create()

Create vtiger CRM block.

public __create() : mixed
Return values
mixed —

__delete()

Delete this instance.

public __delete() : mixed
Return values
mixed —

__getNextSequence()

Get next sequence value to use for this block instance.

public __getNextSequence() : int
Return values
int —

__update()

public __update() : mixed
Return values
mixed —

addField()

Add field to this block.

public addField(FieldBasic $fieldInstance) : Reference
Parameters
$fieldInstance : FieldBasic
Return values
Reference —

to this block instance

delete()

Delete block instance.

public delete([mixed $recursive = true ]) : mixed
Parameters
$recursive : mixed = true
Return values
mixed —

deleteForModule()

Delete all blocks associated with module.

public static deleteForModule(ModuleBasic $moduleInstance[, mixed $recursive = true ]) : mixed
Parameters
$moduleInstance : ModuleBasic
$recursive : mixed = true
Return values
mixed —

getAllForModule()

Get all block instances associated with the module.

public static getAllForModule(ModuleBasic $moduleInstance) : self
Parameters
$moduleInstance : ModuleBasic
Return values
self —

getInstance()

Get instance of block.

public static getInstance(mixed $value[, mixed $module = false ]) : self
Parameters
$value : mixed
$module : mixed = false

Mixed id or name of the module

Return values
self —

initialize()

Initialize this block instance.

public initialize(mixed $valuemap) : mixed
Parameters
$valuemap : mixed
Return values
mixed —

save()

Save this block instance.

public save([mixed $moduleInstance = null ]) : mixed
Parameters
$moduleInstance : mixed = null
Return values
mixed — 

        

        
    




    

    

                

    

        

            
Search results