Documentation

Vtiger_SocialMedia_Model extends Base
in package

SocialMedia Model.

Tags
copyright

YetiForce Sp. z o.o

license

YetiForce Public License 3.0 (licenses/LicenseEN.txt or yetiforce.com)

author

Arkadiusz Adach a.adach@yetiforce.com

Table of Contents

$value  : mixed
$recordModel  : Vtiger_Record_Model
Temporary record object.
__construct()  : mixed
Vtiger_SocialMedia_Model constructor.
get()  : mixed
Function to get the value for a given key.
getAllColumnName()  : array<string|int, string>
Get all available social media columns name.
getAllRecords()  : Generator
Get all social media records.
getAllSocialMediaAccount()  : array<string|int, string>
Get all social media account names by socialType.
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).
getInstanceByRecordModel()  : self
Function to get instance of this object.
getKeys()  : array<string|int, string>
Function to get keys.
has()  : bool
Function to check if the key exists.
isEmpty()  : bool
Function to check if the key is empty.
isEnableForRecord()  : bool
Checking whether social media are available for the record.
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

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

getAllColumnName()

Get all available social media columns name.

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

getAllRecords()

Get all social media records.

public getAllRecords(int $start[, int $limit = 50 ]) : Generator
Parameters
$start : int
$limit : int = 50
Return values
Generator

getAllSocialMediaAccount()

Get all social media account names by socialType.

public getAllSocialMediaAccount(string $socialType) : array<string|int, string>
Parameters
$socialType : string
Tags
throws
AppException
Return values
array<string|int, string>

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

getKeys()

Function to get keys.

public getKeys() : array<string|int, string>
Return values
array<string|int, 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

isEnableForRecord()

Checking whether social media are available for the record.

public isEnableForRecord() : bool
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