Documentation

Settings_SharingAccess_Action_Model extends Base
in package

Sharing Access Action Model Class.

Table of Contents

$nonConfigurableActions  : mixed
$value  : mixed
__construct()  : mixed
Constructor.
get()  : mixed
Function to get the value for a given key.
getAll()  : array<string|int, self>
Function to get all action.
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.
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()  : mixed
getInstance()  : self
Function to get instance of class.
getKeys()  : array<string|int, string>
Function to get keys.
getName()  : mixed
has()  : bool
Function to check if the key exists.
isEmpty()  : bool
Function to check if the key is empty.
isModuleEnabled()  : mixed
isUtilityTool()  : mixed
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

$nonConfigurableActions

public static mixed $nonConfigurableActions = ['Hide Details', 'Hide Details and Add Events', 'Show Details', 'Show Details and Add Events']

$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

getAll()

Function to get all action.

public static getAll([bool $configurable = true ]) : array<string|int, self>
Parameters
$configurable : bool = true
Return values
array<string|int, self>

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>

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()

public getId() : mixed
Return values
mixed

getInstance()

Function to get instance of class.

public static getInstance(int|string $value) : self
Parameters
$value : int|string
Return values
self

getKeys()

Function to get keys.

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

getName()

public getName() : mixed
Return values
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

isModuleEnabled()

public isModuleEnabled(mixed $module) : mixed
Parameters
$module : mixed
Return values
mixed

isUtilityTool()

public isUtilityTool() : mixed
Return values
mixed

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