Documentation

Settings_Workflows_TaskType_Model extends Base
in package

Settings Workflows TaskType Model.

Table of Contents

$value  : mixed
__construct()  : mixed
Constructor.
get()  : mixed
Function to get the value for a given key.
getAllForModule()  : array<string|int, mixed>
Get all tasks for module.
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.
getEditViewUrl()  : string
Get edit view url.
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).
getId()  : int
Get record id.
getInstance()  : object
Get task type instance.
getInstanceFromClassName()  : $this
Create instance from class name.
getInstanceFromTaskTypeObject()  : self
Get instance from task type object.
getKeys()  : array<string|int, string>
Function to get keys.
getLabel()  : string
Get task label.
getName()  : string
Get task name.
getTaskBaseModule()  : object
Get task base module object.
getTemplatePath()  : string
Get template path.
has()  : bool
Function to check if the key exists.
isEmpty()  : bool
Function to check if the key is empty.
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.

Properties

$value

protected mixed $value

Methods

__construct()

Constructor.

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

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

getAllForModule()

Get all tasks for module.

public static getAllForModule(object $moduleModel) : array<string|int, mixed>
Parameters
$moduleModel : object
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>

getEditViewUrl()

Get edit view url.

public getEditViewUrl() : string
Return values
string

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

getId()

Get record id.

public getId() : int
Return values
int

getInstance()

Get task type instance.

public static getInstance(string $taskType) : object
Parameters
$taskType : string
Return values
object

getInstanceFromClassName()

Create instance from class name.

public static getInstanceFromClassName(VTTask $taskClass) : $this
Parameters
$taskClass : VTTask
Return values
$this

getInstanceFromTaskTypeObject()

Get instance from task type object.

public static getInstanceFromTaskTypeObject(object $taskTypeObject) : self
Parameters
$taskTypeObject : object
Return values
self

getKeys()

Function to get keys.

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

getLabel()

Get task label.

public getLabel() : string
Return values
string

getName()

Get task name.

public getName() : string
Return values
string

getTaskBaseModule()

Get task base module object.

public getTaskBaseModule() : object
Return values
object

getTemplatePath()

Get template path.

public getTemplatePath() : string
Return values
string

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

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

        

Search results