Settings_WebserviceUsers_WebserviceStandard_Service
extends Settings_WebserviceUsers_Record_Model
in package
WebserviceStandard Record Model class.
Table of Contents
- $baseIndex : string
- Table name.
- $baseTable : string
- Table name.
- $changes : array<string|int, mixed>
- Changes.
- $columnsToShow : array<string|int, mixed>
- $customParamsLabels : array<string|int, mixed>
- $editFields : array<string|int, string>
- Edit fields.
- $listFields : array<string|int, string>
- List of fields displayed in list view.
- $name : string
- Module Name.
- $paramsFields : array<string|int, mixed>
- $value : array<string|int, mixed>
- __construct() : mixed
- Constructor.
- checkData() : bool|string
- Check if the data is correct.
- delete() : bool
- Function removes record.
- get() : mixed
- Function to get the value for a given key.
- getArray() : array<string|int, mixed>
- Function to get the array values for a given key.
- getCleanInstance() : $this
- Function to get the clean instance.
- getData() : array<string|int, mixed>
- Function to get all the values of the Object.
- getDataForSave() : array<string|int, mixed>
- Function gives data for save.
- getDisplayValue() : string
- Function to get the Display Value, for the current field type with given DB Insert Value.
- getEditFields() : array<string|int, string>
- Function determines fields available in edition view.
- getFieldInstanceByName() : array<string|int, string>
- Function determines fields available in edition view.
- getFieldsForSave() : array<string|int, mixed>
- Function gives list fields for save.
- getForHtml() : mixed
- Function to get the html encoded value for a given key.
- getFormatDataSession() : array<string|int, mixed>
- Get format data session.
- getFormatLoginHistory() : array<string|int, mixed>
- Get format data session.
- getForSql() : mixed
- Function to get the value if its safe to use for SQL Query (column).
- getId() : int
- Record ID.
- getInstanceById() : self
- Function to get the instance, given id.
- getKeys() : array<string|int, string>
- Function to get keys.
- getListFields() : array<string|int, mixed>
- {@inheritdoc}
- getModule() : Settings_WebserviceUsers_Module_Model
- Function to get Module instance.
- getName() : string
- Record name.
- getRecordLinks() : array<string|int, mixed>
- {@inheritdoc}
- getTypeValues() : string|array<string|int, string>
- Type field values.
- getUserHistoryAccessActivity() : array<string|int, mixed>
- Get user session.
- getUserName() : string
- Get user name.
- getUserSession() : array<string|int, mixed>
- Get user session.
- getValueToSave() : int|string
- Function formats data for saving.
- has() : bool
- Function to check if the key exists.
- init() : mixed
- {@inheritdoc}
- isEmpty() : bool
- Function to check if the key is empty.
- isNew() : int
- Check if record is new.
- remove() : mixed
- Function to remove the value.
- save() : bool
- Function to save.
- sendEmail() : void
- Send mails with access.
- set() : $this
- Function to set the value for a given key.
- setData() : $this
- Function to set all the values.
- setDataFromRequest() : mixed
- Sets data from request.
- setModule() : $this
- Function to set Module instance.
Properties
$baseIndex
Table name.
public
string
$baseIndex
= 'id'
Table name.
$baseTable
Table name.
public
string
$baseTable
= 'w_#__api_user'
Table name.
$changes
Changes.
public
array<string|int, mixed>
$changes
= []
$columnsToShow
public
array<string|int, mixed>
$columnsToShow
= ['time' => 'FL_LOGIN_TIME', 'status' => 'FL_STATUS', 'agent' => 'LBL_USER_AGENT', 'ip' => 'LBL_IP_ADDRESS']
Columns to show on the list session.
$customParamsLabels
public
static array<string|int, mixed>
$customParamsLabels
= ['language' => 'FL_LANGUAGE', 'ip' => 'FL_LAST_IP', 'invalid_login_time' => 'FL_DATETIME_LAST_INVALID_LOGIN', 'invalid_login' => 'FL_LAST_INVALID_LOGIN', 'logout_time' => 'FL_LOGOUT_TIME', 'last_error' => 'FL_LAST_ERROR', 'error_time' => 'FL_LAST_ERROR_DATE', 'error_method' => 'FL_LAST_ERROR_METHOD', 'version' => 'FL_VERSION', 'fromUrl' => 'FL_FROM_URL', 'agent' => 'LBL_USER_AGENT', 'deviceId' => 'LBL_DEVICE_ID']
List of custom params labels.
$editFields
Edit fields.
public
array<string|int, string>
$editFields
= ['server_id' => 'FL_SERVER', 'status' => 'FL_STATUS', 'password' => 'FL_PASSWORD', 'type' => 'FL_TYPE', 'crmid' => 'FL_RECORD_NAME', 'user_id' => 'FL_USER', 'login_method' => 'FL_LOGIN_METHOD', 'authy_methods' => 'FL_AUTHY_METHODS', 'language' => 'FL_LANGUAGE']
$listFields
List of fields displayed in list view.
public
array<string|int, string>
$listFields
= ['server_id' => 'FL_SERVER', 'user_name' => 'FL_LOGIN', 'type' => 'FL_TYPE', 'user_id' => 'FL_USER', 'status' => 'FL_STATUS', 'login_method' => 'FL_LOGIN_METHOD', 'login_time' => 'FL_LOGIN_TIME', 'custom_params' => 'FL_CUSTOM_PARAMS']
$name
Module Name.
public
string
$name
= 'WebserviceUsers'
$paramsFields
public
array<string|int, mixed>
$paramsFields
= ['language', 'logout_time']
List of fields in param column.
$value
protected
array<string|int, mixed>
$value
Values
Methods
__construct()
Constructor.
public
__construct([array<string|int, mixed> $values = [] ]) : mixed
Parameters
- $values : array<string|int, mixed> = []
Return values
mixed —checkData()
Check if the data is correct.
public
checkData() : bool|string
Return values
bool|string —delete()
Function removes record.
public
delete() : 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
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> —getCleanInstance()
Function to get the clean instance.
public
static getCleanInstance(string $type) : $this
Parameters
- $type : string
Return values
$this —getData()
Function to get all the values of the Object.
public
getData() : array<string|int, mixed>
Return values
array<string|int, mixed> —getDataForSave()
Function gives data for save.
public
getDataForSave() : array<string|int, mixed>
Return values
array<string|int, mixed> —getDisplayValue()
Function to get the Display Value, for the current field type with given DB Insert Value.
public
getDisplayValue(string $name) : string
Parameters
- $name : string
Return values
string —getEditFields()
Function determines fields available in edition view.
public
getEditFields() : array<string|int, string>
Return values
array<string|int, string> —getFieldInstanceByName()
Function determines fields available in edition view.
public
getFieldInstanceByName(mixed $name) : array<string|int, string>
Parameters
- $name : mixed
Return values
array<string|int, string> —getFieldsForSave()
Function gives list fields for save.
public
getFieldsForSave() : 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 —getFormatDataSession()
Get format data session.
public
getFormatDataSession(array<string|int, mixed> $row) : array<string|int, mixed>
Parameters
- $row : array<string|int, mixed>
Return values
array<string|int, mixed> —getFormatLoginHistory()
Get format data session.
public
getFormatLoginHistory(array<string|int, mixed> $row) : array<string|int, mixed>
Parameters
- $row : array<string|int, mixed>
Return values
array<string|int, 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()
Record ID.
public
abstract getId() : int
Return values
int —getInstanceById()
Function to get the instance, given id.
public
static getInstanceById(int $id, string $type) : self
Parameters
- $id : int
- $type : string
Return values
self —getKeys()
Function to get keys.
public
getKeys() : array<string|int, string>
Return values
array<string|int, string> —getListFields()
{@inheritdoc}
public
getListFields() : array<string|int, mixed>
Return values
array<string|int, mixed> —getModule()
Function to get Module instance.
public
getModule() : Settings_WebserviceUsers_Module_Model
Return values
Settings_WebserviceUsers_Module_Model —getName()
Record name.
public
abstract getName() : string
Return values
string —getRecordLinks()
{@inheritdoc}
public
getRecordLinks() : array<string|int, mixed>
Return values
array<string|int, mixed> —getTypeValues()
Type field values.
public
getTypeValues([mixed|null $value = null ]) : string|array<string|int, string>
Parameters
- $value : mixed|null = null
Return values
string|array<string|int, string> —getUserHistoryAccessActivity()
Get user session.
public
getUserHistoryAccessActivity(string $container) : array<string|int, mixed>
Parameters
- $container : string
Return values
array<string|int, mixed> —getUserName()
Get user name.
public
getUserName() : string
Return values
string —getUserSession()
Get user session.
public
getUserSession(string $container) : array<string|int, mixed>
Parameters
- $container : string
Return values
array<string|int, mixed> —getValueToSave()
Function formats data for saving.
public
getValueToSave(string $key, mixed $value) : int|string
Parameters
- $key : string
- $value : mixed
Return values
int|string —has()
Function to check if the key exists.
public
has(string $key) : bool
Parameters
- $key : string
Return values
bool —init()
{@inheritdoc}
public
init(array<string|int, mixed> $data) : mixed
Parameters
- $data : array<string|int, mixed>
Return values
mixed —isEmpty()
Function to check if the key is empty.
public
isEmpty(string $key) : bool
Parameters
- $key : string
Return values
bool —isNew()
Check if record is new.
public
isNew() : int
Return values
int —remove()
Function to remove the value.
public
remove(string $key) : mixed
Parameters
- $key : string
Return values
mixed —save()
Function to save.
public
save() : bool
Return values
bool —sendEmail()
Send mails with access.
public
sendEmail() : void
Return values
void —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 —setDataFromRequest()
Sets data from request.
public
setDataFromRequest(Request $request) : mixed
Parameters
- $request : Request
Return values
mixed —setModule()
Function to set Module instance.
public
setModule(Settings_WebserviceUsers_Module_Model $moduleModel) : $this
Parameters
- $moduleModel : Settings_WebserviceUsers_Module_Model