Documentation

Company extends Base
in package

Company basic class.

Table of Contents

$sizes  : array<string|int, int>
Classification of enterprises due to their size.
$value  : mixed
__construct()  : mixed
Constructor.
compareSize()  : bool
Compare company size.
get()  : mixed
Function to get the value for a given key.
getAll()  : array<string|int, mixed>
Function to get the instance of the Company model.
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).
getKeys()  : array<string|int, string>
Function to get keys.
getSize()  : string
Get company size.
has()  : bool
Function to check if the key exists.
isEmpty()  : bool
Function to check if the key is empty.
registerOnline()  : bool
Send registration data to YetiForce API server.
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.
statusUpdate()  : mixed
Update company status.

Properties

$sizes

Classification of enterprises due to their size.

public static array<string|int, int> $sizes = ['Micro' => 20, 'Small' => 50, 'Medium' => 250, 'Large' => 1000, 'Corporation' => 0]

$value

protected mixed $value

Methods

__construct()

Constructor.

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

compareSize()

Compare company size.

public static compareSize(string $package) : bool
Parameters
$package : string
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

getAll()

Function to get the instance of the Company model.

public static getAll() : 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>

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>

getSize()

Get company size.

public static getSize() : 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

registerOnline()

Send registration data to YetiForce API server.

public static registerOnline(array<string|int, mixed> $companiesNew) : bool
Parameters
$companiesNew : array<string|int, mixed>
Tags
throws
Security
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

statusUpdate()

Update company status.

public static statusUpdate(int $status[, string|null $name = null ]) : mixed
Parameters
$status : int
$name : string|null = null
Tags
throws
Exception
Return values
mixed

        

Search results