Documentation

Vtiger_ProcessWizard_Model extends Base
in package

Process wizard base model class.

Table of Contents

$recordModel  : Vtiger_Record_Model
Vtiger_Record_Model.
$step  : array<string|int, mixed>
Current process step.
$value  : mixed
$wizardMap  : array<string|int, mixed>
The current process wizard map.
__construct()  : mixed
Constructor.
checkPermissionsToStep()  : bool
Check permissions to step.
get()  : mixed
Function to get the value for a given key.
getActions()  : array<string|int, mixed>
Get the actions of the current step.
getArray()  : array<string|int, mixed>
Function to get the array values for a given key.
getData()  : array<string|int, mixed>
Function to get all the values of the Object.
getFieldsStructure()  : array<string|int, mixed>
Get fields structure for fields block type.
getForHtml()  : mixed
Function to get the html encoded value for a given key.
getForSql()  : mixed
Function to get the value if its safe to use for SQL Query (column).
getInstance()  : self
Get instance model.
getKeys()  : array<string|int, string>
Function to get keys.
getRelatedListReferenceStructure()  : array<string|int, mixed>
Get structure for related lists block type for reference record.
getRelatedListStructure()  : array<string|int, mixed>
Get structure for related lists block type.
getStep()  : array<string|int, mixed>|null
Get active process wizard step.
getStepBlocks()  : array<string|int, mixed>
Get the blocks of the current step.
getSteps()  : array<string|int, mixed>
Get process wizard steps.
has()  : bool
Function to check if the key exists.
isEmpty()  : bool
Function to check if the key is empty.
loadConditions()  : void
Load and check the process wizard conditions.
loadGroup()  : void
Load current map group.
remove()  : mixed
Function to remove the value.
set()  : $this
Function to set the value for a given key.
setData()  : $this
Function to set all the values.
setStep()  : void
Set the active step of the process wizard.

Properties

$step

Current process step.

protected array<string|int, mixed> $step

$value

protected mixed $value

$wizardMap

The current process wizard map.

protected array<string|int, mixed> $wizardMap

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $values = [] ]) : mixed
Parameters
$values : array<string|int, mixed> = []
Return values
mixed

checkPermissionsToStep()

Check permissions to step.

public checkPermissionsToStep() : bool
Return values
bool

get()

Function to get the value for a given key.

public get(string $key) : mixed
Parameters
$key : string
Return values
mixed

Value for the given key

getActions()

Get the actions of the current step.

public getActions() : array<string|int, mixed>

.

Return values
array<string|int, mixed>

getArray()

Function to get the array values for a given key.

public getArray(string $key[, array<string|int, mixed> $value = [] ]) : array<string|int, mixed>
Parameters
$key : string
$value : array<string|int, mixed> = []
Return values
array<string|int, mixed>

getData()

Function to get all the values of the Object.

public getData() : array<string|int, mixed>
Return values
array<string|int, mixed>

getFieldsStructure()

Get fields structure for fields block type.

public getFieldsStructure(array<string|int, mixed> $block) : array<string|int, mixed>
Parameters
$block : array<string|int, mixed>
Return values
array<string|int, mixed>

getForHtml()

Function to get the html encoded value for a given key.

public getForHtml(string $key) : mixed
Parameters
$key : string
Return values
mixed

getForSql()

Function to get the value if its safe to use for SQL Query (column).

public getForSql(string $key[, bool $skipEmtpy = true ]) : mixed
Parameters
$key : string
$skipEmtpy : bool = true

Skip the check if string is empty

Return values
mixed

Value for the given key

getKeys()

Function to get keys.

public getKeys() : array<string|int, string>
Return values
array<string|int, string>

getRelatedListReferenceStructure()

Get structure for related lists block type for reference record.

public getRelatedListReferenceStructure(array<string|int, mixed> $block) : array<string|int, mixed>
Parameters
$block : array<string|int, mixed>
Return values
array<string|int, mixed>

getRelatedListStructure()

Get structure for related lists block type.

public getRelatedListStructure(array<string|int, mixed> $block) : array<string|int, mixed>
Parameters
$block : array<string|int, mixed>
Return values
array<string|int, mixed>

getStep()

Get active process wizard step.

public getStep() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getStepBlocks()

Get the blocks of the current step.

public getStepBlocks() : array<string|int, mixed>
Return values
array<string|int, mixed>

getSteps()

Get process wizard steps.

public getSteps() : array<string|int, mixed>
Return values
array<string|int, mixed>

has()

Function to check if the key exists.

public has(string $key) : bool
Parameters
$key : string
Return values
bool

isEmpty()

Function to check if the key is empty.

public isEmpty(string $key) : bool
Parameters
$key : string
Return values
bool

loadConditions()

Load and check the process wizard conditions.

public loadConditions() : void
Return values
void

loadGroup()

Load current map group.

public loadGroup() : void
Return values
void

remove()

Function to remove the value.

public remove(string $key) : mixed
Parameters
$key : string
Return values
mixed

set()

Function to set the value for a given key.

public set(string $key, mixed $value) : $this
Parameters
$key : string
$value : mixed
Return values
$this

setData()

Function to set all the values.

public setData(mixed $values) : $this
Parameters
$values : mixed
Return values
$this

setStep()

Set the active step of the process wizard.

public setStep(int $id) : void
Parameters
$id : int
Return values
void

Search results