Settings_Password_Record_Model
extends Vtiger_Record_Model
in package
Settings Password save model class.
Tags
Table of Contents
- $ext : mixed
- $isNew : mixed
- $label : string
- $summaryRowCount : mixed
- $changes : array<string|int, mixed>
- $changesInventory : array<string|int, mixed>
- $dataForSave : array<string|int, mixed>
- $handler : mixed
- $handlerExceptions : array<string|int, mixed>
- $inventoryData : array<string|int, mixed>
- $module : Vtiger_Module_Model
- $privileges : mixed
- $value : array<string|int, mixed>
- __construct() : mixed
- Constructor.
- addRelations() : void
- Add relations on save.
- changeState() : mixed
- Change record state.
- checkPassword() : mixed
- clearPrivilegesCache() : mixed
- Clear privileges.
- delete() : mixed
- Function to delete the current Record Model.
- 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.
- getChanges() : array<string|int, mixed>
- Gets previous values.
- getCleanInstance() : $this
- Static Function to get the instance of a clean Vtiger Record Model for the given module name.
- getData() : array<string|int, mixed>
- Function to get all the values of the Object.
- getDataForSave() : mixed
- Gets custom data for save.
- getDeleteUrl() : string
- Function to get the Delete Action url for the record.
- getDetailViewUrl() : string
- Function to get the Detail View url for the record.
- getDisplayableValues() : array<string|int, mixed>
- Function returns all the field values in user format.
- getDisplayName() : string
- Function to get the Display Name for the record.
- getDisplayValue() : bool|string
- Function to retieve display value for a field.
- getDuplicateRecordUrl() : string
- Funtion to get Duplicate Record Url.
- getEditViewUrl() : string
- Function to get the Edit View url for the record.
- getEncryptionModules() : array<string|int, mixed>
- Gets encryption modules.
- getEntity() : CRMEntity
- Function to get the entity instance of the recrod.
- getEntityDataForSave() : array<string|int, mixed>
- Get entity data for save.
- getEventHandler() : EventHandler
- Gets Event Handler.
- getField() : Vtiger_Field_Model|false
- Function returns the Vtiger_Field_Model.
- 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).
- getFullDetailViewUrl() : string
- Function to get the complete Detail View url for the record.
- getHandlerExceptions() : array<string|int, mixed>
- get handler exceptions.
- getId() : int
- Function to get the id of the record.
- getImage() : array<string|int, mixed>
- Function to get record image.
- getInstanceByEntity() : mixed
- getInstanceById() : $this
- Static Function to get the instance of the Vtiger Record Model given the recordid and the module name.
- getInventoryData() : array<string|int, mixed>
- Loading the inventory data.
- getInventoryDefaultDataFields() : int|string|null
- Function to gets inventory default data fields.
- getInventoryItem() : mixed
- Gets inventory item.
- getKeys() : array<string|int, string>
- Function to get keys.
- getListFieldsToGenerate() : mixed
- getListViewColor() : array<string|int, string>
- Get list view color for record.
- getListViewDisplayValue() : mixed
- Function to get the display value in ListView.
- getModule() : Vtiger_Module_Model
- Function to get the Module to which the record belongs.
- getModuleName() : string
- Function to get the name of the module to which the record belongs.
- getName() : string
- Function to get the Name of the record.
- getPasswordChangeDateCondition() : array<string|int, mixed>
- Get conditions for password modification.
- getPreviousInventoryItems() : array<string|int, mixed>|bool
- Gets previous values by inventory.
- getPreviousValue() : mixed
- Get pervious value by field.
- getRawValue() : mixed
- Function to get raw data value by field.
- getRecordListViewLinksLeftSide() : array<string|int, Vtiger_Link_Model>
- Function to get the list view actions for the record.
- getRecordListViewLinksRightSide() : array<string|int, Vtiger_Link_Model>
- Function to get the list view actions for the record.
- getRecordNumber() : string
- Get record number.
- getRecordRelatedListViewLinksLeftSide() : array<string|int, Vtiger_Link_Model>
- Get the related list view actions for the record.
- getRelatedListDisplayValue() : string
- Function to get Display value for RelatedList.
- getRelatedListViewDisplayValue() : string
- Function to get the display value in RelatedListView.
- getSearchName() : mixed
- getSummaryInfo() : mixed
- getTilesDisplayValue() : string
- Function to get the display value in Tiles.
- getTimeLineUrl() : string
- Timeline view URL.
- getUnlockFields() : array<string|int, mixed>
- Gets unlock fields.
- getUpdatesUrl() : string
- Function to get the Update View url for the record.
- getUserPassConfig() : array<string|int, mixed>|string
- Get user password configuration.
- getValueByField() : mixed
- Function gets the value from this record.
- getValueByFieldModel() : mixed
- Function gets the value from this record.
- getValuesForSave() : array<string|int, mixed>
- Prepare value to save.
- has() : bool
- Function to check if the key exists.
- initInventoryData() : mixed
- Initialization of inventory data.
- initInventoryDataFromRequest() : void
- Initialization of inventory data from request.
- isBlocked() : bool
- Function check if record is blocked.
- isCanAssignToHimself() : bool
- Function checks if user can assign record to himself.
- isCreateable() : bool
- Function check if record is createable.
- isEditable() : bool
- Function check if record is editable.
- isEmpty() : bool
- Function to check if the key is empty.
- isLockByFields() : mixed
- isMandatorySave() : bool
- The function decide about mandatory save record.
- isNew() : bool
- Is new record.
- isPermitted() : bool
- Function to check permission.
- isReadOnly() : bool
- Function to check read only record.
- isUnlockByFields() : bool
- Function check if record is to unlock.
- isViewable() : bool
- Function check if record is viewable.
- isWatchingRecord() : mixed
- privilegeToActivate() : bool
- Checking for permission to activate.
- privilegeToArchive() : bool
- Checking for permission to archive.
- privilegeToDelete() : bool
- Checking for permission to delete.
- privilegeToMoveToTrash() : bool
- Checking for permission to move to trash.
- remove() : mixed
- Function to remove the value.
- revertPreviousValue() : void
- Revert previous value.
- save() : mixed
- Function to save the current Record Model.
- saveInventoryData() : mixed
- Save the inventory data.
- saveToDb() : mixed
- Save data to the database.
- set() : $this
- Function to set the value for a given key.
- setData() : $this
- Function to set all the values.
- setDataForSave() : $this
- Set custom data for save.
- setEntity() : Vtiger_Record_Model
- Function to set the entity instance of the record.
- setFromUserValue() : $this
- Function to set the value for a given key and user farmat.
- setHandlerExceptions() : void
- Set handler exceptions.
- setId() : mixed
- Function to set the id of the record.
- setInventoryItemPart() : mixed
- Sets inventory item part.
- setModule() : Vtiger_Record_Model
- Function to set the Module to which the record belongs.
- setModuleFromInstance() : Vtiger_Record_Model
- Function to set the Module to which the record belongs from the Module model instance.
- setPassDetail() : mixed
- setRecordFieldValues() : mixed
- Function to set record module field values.
- validation() : bool
- Validation.
Properties
$ext
public
mixed
$ext
= []
$isNew
public
mixed
$isNew
= \true
$label
public
string
$label
Record label
$summaryRowCount
public
mixed
$summaryRowCount
= 4
$changes
protected
array<string|int, mixed>
$changes
= []
Record changes
$changesInventory
protected
array<string|int, mixed>
$changesInventory
= []
Record inventory changes
$dataForSave
protected
array<string|int, mixed>
$dataForSave
= []
Data for save
$handler
protected
mixed
$handler
$handlerExceptions
protected
array<string|int, mixed>
$handlerExceptions
= []
Event handler exceptions
$inventoryData
protected
array<string|int, mixed>
$inventoryData
Inventory data
$module
protected
Vtiger_Module_Model
$module
Module model
$privileges
protected
mixed
$privileges
= []
$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 —addRelations()
Add relations on save.
public
addRelations() : void
The main purpose of the function to share relational data in workflow.
Return values
void —changeState()
Change record state.
public
changeState(type $state) : mixed
Parameters
- $state : type
Return values
mixed —checkPassword()
public
static checkPassword(mixed $pass) : mixed
Parameters
- $pass : mixed
Return values
mixed —clearPrivilegesCache()
Clear privileges.
public
clearPrivilegesCache() : mixed
Return values
mixed —delete()
Function to delete the current Record Model.
public
delete() : 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
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> —getChanges()
Gets previous values.
public
getChanges() : array<string|int, mixed>
Return values
array<string|int, mixed> —getCleanInstance()
Static Function to get the instance of a clean Vtiger Record Model for the given module name.
public
static getCleanInstance(string $moduleName) : $this
Parameters
- $moduleName : string
Tags
Return values
$this —or Module Specific Record Model instance
getData()
Function to get all the values of the Object.
public
getData() : array<string|int, mixed>
Return values
array<string|int, mixed> —getDataForSave()
Gets custom data for save.
public
getDataForSave() : mixed
Return values
mixed —getDeleteUrl()
Function to get the Delete Action url for the record.
public
getDeleteUrl() : string
Return values
string —- Record Delete Action Url
getDetailViewUrl()
Function to get the Detail View url for the record.
public
getDetailViewUrl() : string
Return values
string —- Record Detail View Url
getDisplayableValues()
Function returns all the field values in user format.
public
getDisplayableValues() : array<string|int, mixed>
Return values
array<string|int, mixed> —getDisplayName()
Function to get the Display Name for the record.
public
getDisplayName() : string
Return values
string —- Entity Display Name for the record
getDisplayValue()
Function to retieve display value for a field.
public
getDisplayValue(string $fieldName[, bool|int $record = false ][, bool $rawText = false ][, bool|int $length = false ]) : bool|string
Parameters
- $fieldName : string
-
Field name for which values need to get
- $record : bool|int = false
-
Record Id
- $rawText : bool = false
- $length : bool|int = false
-
Length of the text
Return values
bool|string —getDuplicateRecordUrl()
Funtion to get Duplicate Record Url.
public
getDuplicateRecordUrl() : string
Return values
string —getEditViewUrl()
Function to get the Edit View url for the record.
public
getEditViewUrl() : string
Return values
string —- Record Edit View Url
getEncryptionModules()
Gets encryption modules.
public
static getEncryptionModules() : array<string|int, mixed>
Return values
array<string|int, mixed> —getEntity()
Function to get the entity instance of the recrod.
public
getEntity() : CRMEntity
Return values
CRMEntity —object
getEntityDataForSave()
Get entity data for save.
public
getEntityDataForSave() : array<string|int, mixed>
Return values
array<string|int, mixed> —getEventHandler()
Gets Event Handler.
public
getEventHandler() : EventHandler
Return values
EventHandler —getField()
Function returns the Vtiger_Field_Model.
public
getField(string $fieldName) : Vtiger_Field_Model|false
Parameters
- $fieldName : string
-
- field name
Return values
Vtiger_Field_Model|false —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
getFullDetailViewUrl()
Function to get the complete Detail View url for the record.
public
getFullDetailViewUrl() : string
Return values
string —- Record Detail View Url
getHandlerExceptions()
get handler exceptions.
public
getHandlerExceptions() : array<string|int, mixed>
Return values
array<string|int, mixed> —getId()
Function to get the id of the record.
public
getId() : int
Return values
int —- Record Id
getImage()
Function to get record image.
public
getImage() : array<string|int, mixed>
Return values
array<string|int, mixed> —getInstanceByEntity()
public
static getInstanceByEntity(mixed $focus, mixed $recordId) : mixed
Parameters
- $focus : mixed
- $recordId : mixed
Return values
mixed —getInstanceById()
Static Function to get the instance of the Vtiger Record Model given the recordid and the module name.
public
static getInstanceById(int $recordId[, string $module = null ]) : $this
Parameters
- $recordId : int
- $module : string = null
Tags
Return values
$this —Module Specific Record Model instance
getInventoryData()
Loading the inventory data.
public
getInventoryData() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —Inventory data
getInventoryDefaultDataFields()
Function to gets inventory default data fields.
public
getInventoryDefaultDataFields() : int|string|null
Return values
int|string|null —getInventoryItem()
Gets inventory item.
public
getInventoryItem(int|string $key) : mixed
Parameters
- $key : int|string
Tags
Return values
mixed —getKeys()
Function to get keys.
public
getKeys() : array<string|int, string>
Return values
array<string|int, string> —getListFieldsToGenerate()
public
getListFieldsToGenerate(mixed $parentModuleName, mixed $moduleName) : mixed
Parameters
- $parentModuleName : mixed
- $moduleName : mixed
Return values
mixed —getListViewColor()
Get list view color for record.
public
getListViewColor() : array<string|int, string>
Return values
array<string|int, string> —getListViewDisplayValue()
Function to get the display value in ListView.
public
getListViewDisplayValue(string|Vtiger_Field_Model $field[, bool $rawText = false ]) : mixed
Parameters
- $field : string|Vtiger_Field_Model
- $rawText : bool = false
Tags
Return values
mixed —getModule()
Function to get the Module to which the record belongs.
public
getModule() : Vtiger_Module_Model
Return values
Vtiger_Module_Model —getModuleName()
Function to get the name of the module to which the record belongs.
public
getModuleName() : string
Return values
string —- Record Module Name
getName()
Function to get the Name of the record.
public
getName() : string
Return values
string —- Entity Name of the record
getPasswordChangeDateCondition()
Get conditions for password modification.
public
static getPasswordChangeDateCondition() : array<string|int, mixed>
Return values
array<string|int, mixed> —getPreviousInventoryItems()
Gets previous values by inventory.
public
getPreviousInventoryItems([int|string|null $key = null ]) : array<string|int, mixed>|bool
Parameters
- $key : int|string|null = null
Return values
array<string|int, mixed>|bool —getPreviousValue()
Get pervious value by field.
public
getPreviousValue([string $fieldName = '' ]) : mixed
Parameters
- $fieldName : string = ''
Return values
mixed —getRawValue()
Function to get raw data value by field.
public
getRawValue(string $fieldName) : mixed
Parameters
- $fieldName : string
Return values
mixed —getRecordListViewLinksLeftSide()
Function to get the list view actions for the record.
public
getRecordListViewLinksLeftSide() : array<string|int, Vtiger_Link_Model>
Return values
array<string|int, Vtiger_Link_Model> —- Associate array of Vtiger_Link_Model instances
getRecordListViewLinksRightSide()
Function to get the list view actions for the record.
public
getRecordListViewLinksRightSide() : array<string|int, Vtiger_Link_Model>
Return values
array<string|int, Vtiger_Link_Model> —- Associate array of Vtiger_Link_Model instances
getRecordNumber()
Get record number.
public
getRecordNumber() : string
Return values
string —getRecordRelatedListViewLinksLeftSide()
Get the related list view actions for the record.
public
getRecordRelatedListViewLinksLeftSide(Vtiger_RelationListView_Model $viewModel) : array<string|int, Vtiger_Link_Model>
Parameters
- $viewModel : Vtiger_RelationListView_Model
Return values
array<string|int, Vtiger_Link_Model> —- Associate array of Vtiger_Link_Model instances
getRelatedListDisplayValue()
Function to get Display value for RelatedList.
public
getRelatedListDisplayValue(string $fieldName) : string
Parameters
- $fieldName : string
Return values
string —getRelatedListViewDisplayValue()
Function to get the display value in RelatedListView.
public
getRelatedListViewDisplayValue(string $fieldName) : string
Parameters
- $fieldName : string
Return values
string —getSearchName()
public
getSearchName() : mixed
Return values
mixed —getSummaryInfo()
public
getSummaryInfo() : mixed
Return values
mixed —getTilesDisplayValue()
Function to get the display value in Tiles.
public
getTilesDisplayValue(string|Vtiger_Field_Model $field[, bool $rawText = false ]) : string
Parameters
- $field : string|Vtiger_Field_Model
- $rawText : bool = false
Tags
Return values
string —getTimeLineUrl()
Timeline view URL.
public
getTimeLineUrl() : string
Return values
string —getUnlockFields()
Gets unlock fields.
public
getUnlockFields([bool $isAjaxEditable = false ]) : array<string|int, mixed>
Parameters
- $isAjaxEditable : bool = false
Return values
array<string|int, mixed> —getUpdatesUrl()
Function to get the Update View url for the record.
public
getUpdatesUrl() : string
Return values
string —- Record Upadte view Url
getUserPassConfig()
Get user password configuration.
public
static getUserPassConfig([string|bool $type = false ]) : array<string|int, mixed>|string
Parameters
- $type : string|bool = false
Return values
array<string|int, mixed>|string —getValueByField()
Function gets the value from this record.
public
getValueByField(string $fieldName) : mixed
Parameters
- $fieldName : string
Return values
mixed —getValueByFieldModel()
Function gets the value from this record.
public
getValueByFieldModel(Vtiger_Field_Model $fieldModel) : mixed
Parameters
- $fieldModel : Vtiger_Field_Model
Return values
mixed —getValuesForSave()
Prepare value to save.
public
getValuesForSave() : array<string|int, mixed>
Return values
array<string|int, mixed> —has()
Function to check if the key exists.
public
has(string $key) : bool
Parameters
- $key : string
Return values
bool —initInventoryData()
Initialization of inventory data.
public
initInventoryData(array<string|int, mixed> $items[, bool $userFormat = true ]) : mixed
Parameters
- $items : array<string|int, mixed>
- $userFormat : bool = true
Tags
Return values
mixed —initInventoryDataFromRequest()
Initialization of inventory data from request.
public
initInventoryDataFromRequest(Request $request) : void
Parameters
- $request : Request
Tags
Return values
void —isBlocked()
Function check if record is blocked.
public
isBlocked() : bool
Return values
bool —isCanAssignToHimself()
Function checks if user can assign record to himself.
public
isCanAssignToHimself() : bool
Return values
bool —isCreateable()
Function check if record is createable.
public
isCreateable() : bool
Return values
bool —isEditable()
Function check if record is editable.
public
isEditable() : bool
Tags
Return values
bool —isEmpty()
Function to check if the key is empty.
public
isEmpty(string $key) : bool
Parameters
- $key : string
Return values
bool —isLockByFields()
public
isLockByFields() : mixed
Tags
Return values
mixed —isMandatorySave()
The function decide about mandatory save record.
public
isMandatorySave() : bool
Return values
bool —isNew()
Is new record.
public
isNew() : bool
Return values
bool —isPermitted()
Function to check permission.
public
isPermitted(string $action) : bool
Parameters
- $action : string
Return values
bool —isReadOnly()
Function to check read only record.
public
isReadOnly() : bool
Return values
bool —isUnlockByFields()
Function check if record is to unlock.
public
isUnlockByFields() : bool
Return values
bool —isViewable()
Function check if record is viewable.
public
isViewable() : bool
Return values
bool —isWatchingRecord()
public
isWatchingRecord() : mixed
Return values
mixed —privilegeToActivate()
Checking for permission to activate.
public
privilegeToActivate() : bool
Return values
bool —privilegeToArchive()
Checking for permission to archive.
public
privilegeToArchive() : bool
Return values
bool —privilegeToDelete()
Checking for permission to delete.
public
privilegeToDelete() : bool
Return values
bool —privilegeToMoveToTrash()
Checking for permission to move to trash.
public
privilegeToMoveToTrash() : bool
Return values
bool —remove()
Function to remove the value.
public
remove(string $key) : mixed
Parameters
- $key : string
Return values
mixed —revertPreviousValue()
Revert previous value.
public
revertPreviousValue(string $fieldName) : void
Parameters
- $fieldName : string
Return values
void —save()
Function to save the current Record Model.
public
save() : mixed
Return values
mixed —saveInventoryData()
Save the inventory data.
public
saveInventoryData() : mixed
Tags
Return values
mixed —saveToDb()
Save data to the database.
public
saveToDb() : mixed
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 —setDataForSave()
Set custom data for save.
public
setDataForSave(array<string|int, mixed> $data) : $this
Parameters
- $data : array<string|int, mixed>
Return values
$this —setEntity()
Function to set the entity instance of the record.
public
setEntity(CRMEntity $entity) : Vtiger_Record_Model
Parameters
- $entity : CRMEntity
Return values
Vtiger_Record_Model —instance
setFromUserValue()
Function to set the value for a given key and user farmat.
public
setFromUserValue(string $fieldName, mixed $value) : $this
Parameters
- $fieldName : string
- $value : mixed
Return values
$this —setHandlerExceptions()
Set handler exceptions.
public
setHandlerExceptions(array<string|int, mixed> $exceptions) : void
Parameters
- $exceptions : array<string|int, mixed>
Return values
void —setId()
Function to set the id of the record.
public
setId(int $value) : mixed
Parameters
- $value : int
-
- id value
Return values
mixed —setInventoryItemPart()
Sets inventory item part.
public
setInventoryItemPart(mixed $itemId, string $name, mixed $value) : mixed
Parameters
- $itemId : mixed
- $name : string
- $value : mixed
Tags
Return values
mixed —setModule()
Function to set the Module to which the record belongs.
public
setModule(string $moduleName) : Vtiger_Record_Model
Parameters
- $moduleName : string
Return values
Vtiger_Record_Model —Record Model instance
setModuleFromInstance()
Function to set the Module to which the record belongs from the Module model instance.
public
setModuleFromInstance(Vtiger_Module_Model $module) : Vtiger_Record_Model
Parameters
- $module : Vtiger_Module_Model
Return values
Vtiger_Record_Model —Record Model instance
setPassDetail()
public
static setPassDetail(mixed $type, mixed $vale) : mixed
Parameters
- $type : mixed
- $vale : mixed
Return values
mixed —setRecordFieldValues()
Function to set record module field values.
public
setRecordFieldValues(self $parentRecordModel) : mixed
Parameters
- $parentRecordModel : self
Return values
mixed —validation()
Validation.
public
static validation(string $type, string $vale) : bool
Parameters
- $type : string
- $vale : string