Settings_LayoutEditor_Module_Model
extends Settings_Vtiger_Module_Model
in package
Table of Contents
- EDIT_FIELDS_FORM = ['label', 'presence', 'quickcreate', 'summaryfield', 'generatedtype', 'masseditable', 'header_field', 'displaytype', 'maxlengthtext', 'maxwidthcolumn', 'tabindex', 'mandatory', 'icon']
- RELATED_VIEW_TYPE = ['RelatedTab' => 'LBL_RELATED_TAB_TYPE', 'DetailTop' => 'LBL_DETAIL_TOP_TYPE', 'DetailBottom' => 'LBL_DETAIL_BOTTOM_TYPE', 'SummaryTop' => 'LBL_SUMMARY_TOP_TYPE', 'SummaryBottom' => 'LBL_SUMMARY_BOTTOM_TYPE']
- TYPES = ['getRelatedList' => 'PLL_RELATED_LIST', 'getManyToMany' => 'PLL_SPLITED_RELATED_LIST', 'getAttachments' => 'PLL_ATTACHMENTS', 'getEmails' => 'PLL_EMAILS', 'getMultiReference' => 'PLL_MULTI_REFERENCE']
- $isentitytype : mixed
- {@inheritdoc}
- $name : mixed
- {@inheritdoc}
- $parent : string
- $relations : array<string|int, mixed>
- $sourceModule : Vtiger_Module_Model
- $supportedModules : array<string|int, string>
- addField() : Settings_LayoutEditor_Field_Model
- Add field.
- addSystemField() : void
- Create system field.
- checkFieldLabelExists() : bool
- Check if label exists.
- checkFieldNameCharacters() : bool
- Check field name characters.
- checkFieldNameExists() : bool
- Check if field exists.
- checkFieldNameIsAnException() : bool
- Check if the field name is reserved.
- checkIfPicklistFieldNameReserved() : bool
- Check if picklist field can have that name.
- getAddFieldTypeInfo() : array<string|int, mixed>
- Function which will give information about the field types that are supported for add.
- getAddSupportedFieldTypes() : array<string|int, string>
- List of supported field types.
- getBlocks() : array<string|int, Vtiger_Block_Model>
- Function returns all the blocks for the module.
- getEntityInstance() : mixed
- {@inheritdoc}
- getEntityModulesList() : array<string|int, string>
- Function to get Entity module names list.
- getFields() : array<string|int, Vtiger_Field_Model>
- Function that returns all the fields for the module.
- getFieldsForWebserviceApps() : array<string|int, mixed>
- Get fields for webservice apps.
- getId() : int
- Function to get the Module/Tab id.
- getMissingSystemFields() : array<string|int, Vtiger_Field_Model>
- Get missing system fields.
- getMultiReferenceFieldsRelatedWithModule() : array<string|int, Vtiger_Field_Model>
- Loading the list of multireference fields related with module.
- getParentName() : string
- Gets parent name.
- getRelations() : array<string|int, mixed>
- Get relations.
- getRelationsActions() : mixed
- getRelationsTypes() : array<string|int, mixed>
- Get relations types.
- getSourceModule() : Vtiger_Module_Model
- Get source module model.
- getSupportedModules() : mixed
- getTableName() : string
- Get table name.
- getTreeTemplates() : array<string|int, mixed>
- Function returns available templates for tree type field.
- getTypeDetailsForAddField() : array<string|int, \sting|int>
- Function defines details of the created field.
- isBlockSortableAllowed() : bool
- Function to check blocks are sortable for the module.
- isFieldsSortableAllowed() : bool
- Function to check fields are sortable for the block.
- isSortableAllowed() : bool
- Function to check field is editable or not.
- isTypeChangeAllowed() : mixed
- {@inheritdoc}
- setSourceModule() : $this
- Set source module.
- updateRelatedViewType() : mixed
- Update related view type.
- validate() : mixed
- Verification of data.
Constants
EDIT_FIELDS_FORM
public
array<string|int, string>
EDIT_FIELDS_FORM
= ['label', 'presence', 'quickcreate', 'summaryfield', 'generatedtype', 'masseditable', 'header_field', 'displaytype', 'maxlengthtext', 'maxwidthcolumn', 'tabindex', 'mandatory', 'icon']
List of fields in edit view modal
RELATED_VIEW_TYPE
public
array<string|int, string>
RELATED_VIEW_TYPE
= ['RelatedTab' => 'LBL_RELATED_TAB_TYPE', 'DetailTop' => 'LBL_DETAIL_TOP_TYPE', 'DetailBottom' => 'LBL_DETAIL_BOTTOM_TYPE', 'SummaryTop' => 'LBL_SUMMARY_TOP_TYPE', 'SummaryBottom' => 'LBL_SUMMARY_BOTTOM_TYPE']
Related view types.
TYPES
public
array<string|int, string>
TYPES
= ['getRelatedList' => 'PLL_RELATED_LIST', 'getManyToMany' => 'PLL_SPLITED_RELATED_LIST', 'getAttachments' => 'PLL_ATTACHMENTS', 'getEmails' => 'PLL_EMAILS', 'getMultiReference' => 'PLL_MULTI_REFERENCE']
List of supported relation types
Properties
$isentitytype
{@inheritdoc}
public
mixed
$isentitytype
= \false
$name
{@inheritdoc}
public
mixed
$name
= 'LayoutEditor'
$parent
public
string
$parent
= 'Settings'
Parent name
$relations
public
array<string|int, mixed>
$relations
Relations
$sourceModule
public
Vtiger_Module_Model
$sourceModule
Source module
$supportedModules
public
static array<string|int, string>
$supportedModules
= \false
List of supported modules
Methods
addField()
Add field.
public
addField(string $fieldType, int $blockId, array<string|int, mixed> $params) : Settings_LayoutEditor_Field_Model
Parameters
- $fieldType : string
- $blockId : int
- $params : array<string|int, mixed>
Tags
Return values
Settings_LayoutEditor_Field_Model —addSystemField()
Create system field.
public
addSystemField(string $sysName, int $blockId[, array<string|int, mixed> $params = [] ]) : void
Parameters
- $sysName : string
- $blockId : int
- $params : array<string|int, mixed> = []
Return values
void —checkFieldLabelExists()
Check if label exists.
public
checkFieldLabelExists(string $fieldLabel) : bool
Parameters
- $fieldLabel : string
Return values
bool —checkFieldNameCharacters()
Check field name characters.
public
checkFieldNameCharacters(string $name) : bool
Parameters
- $name : string
Return values
bool —checkFieldNameExists()
Check if field exists.
public
checkFieldNameExists(string $fieldName) : bool
Parameters
- $fieldName : string
Return values
bool —checkFieldNameIsAnException()
Check if the field name is reserved.
public
checkFieldNameIsAnException(string $fieldName) : bool
Parameters
- $fieldName : string
Return values
bool —checkIfPicklistFieldNameReserved()
Check if picklist field can have that name.
public
checkIfPicklistFieldNameReserved(string $fieldName) : bool
Parameters
- $fieldName : string
Return values
bool —getAddFieldTypeInfo()
Function which will give information about the field types that are supported for add.
public
getAddFieldTypeInfo() : array<string|int, mixed>
Return values
array<string|int, mixed> —getAddSupportedFieldTypes()
List of supported field types.
public
getAddSupportedFieldTypes() : array<string|int, string>
Return values
array<string|int, string> —getBlocks()
Function returns all the blocks for the module.
public
getBlocks() : array<string|int, Vtiger_Block_Model>
Return values
array<string|int, Vtiger_Block_Model> —- list of block models
getEntityInstance()
{@inheritdoc}
public
getEntityInstance() : mixed
Return values
mixed —getEntityModulesList()
Function to get Entity module names list.
public
static getEntityModulesList() : array<string|int, string>
Return values
array<string|int, string> —List of Entity modules
getFields()
Function that returns all the fields for the module.
public
getFields([mixed $blockInstance = false ]) : array<string|int, Vtiger_Field_Model>
Parameters
- $blockInstance : mixed = false
Return values
array<string|int, Vtiger_Field_Model> —- list of field models
getFieldsForWebserviceApps()
Get fields for webservice apps.
public
getFieldsForWebserviceApps(int $webserviceApp) : array<string|int, mixed>
Parameters
- $webserviceApp : int
Return values
array<string|int, mixed> —getId()
Function to get the Module/Tab id.
public
getId() : int
Return values
int —getMissingSystemFields()
Get missing system fields.
public
getMissingSystemFields() : array<string|int, Vtiger_Field_Model>
Return values
array<string|int, Vtiger_Field_Model> —getMultiReferenceFieldsRelatedWithModule()
Loading the list of multireference fields related with module.
public
static getMultiReferenceFieldsRelatedWithModule(string $moduleName) : array<string|int, Vtiger_Field_Model>
Parameters
- $moduleName : string
Return values
array<string|int, Vtiger_Field_Model> —getParentName()
Gets parent name.
public
getParentName() : string
Return values
string —getRelations()
Get relations.
public
getRelations() : array<string|int, mixed>
Return values
array<string|int, mixed> —getRelationsActions()
public
static getRelationsActions() : mixed
Return values
mixed —getRelationsTypes()
Get relations types.
public
static getRelationsTypes([string|null $moduleName = null ]) : array<string|int, mixed>
Parameters
- $moduleName : string|null = null
Return values
array<string|int, mixed> —getSourceModule()
Get source module model.
public
getSourceModule() : Vtiger_Module_Model
Return values
Vtiger_Module_Model —getSupportedModules()
public
static getSupportedModules() : mixed
Return values
mixed —getTableName()
Get table name.
public
getTableName(string $type) : string
Parameters
- $type : string
Return values
string —getTreeTemplates()
Function returns available templates for tree type field.
public
getTreeTemplates(string $sourceModule) : array<string|int, mixed>
Parameters
- $sourceModule : string
Return values
array<string|int, mixed> —getTypeDetailsForAddField()
Function defines details of the created field.
public
getTypeDetailsForAddField(string $fieldType, array<string|int, mixed> $params) : array<string|int, \sting|int>
Parameters
- $fieldType : string
- $params : array<string|int, mixed>
Return values
array<string|int, \sting|int> —isBlockSortableAllowed()
Function to check blocks are sortable for the module.
public
isBlockSortableAllowed() : bool
Return values
bool —isFieldsSortableAllowed()
Function to check fields are sortable for the block.
public
isFieldsSortableAllowed(mixed $blockName) : bool
Parameters
- $blockName : mixed
Return values
bool —isSortableAllowed()
Function to check field is editable or not.
public
isSortableAllowed() : bool
Return values
bool —isTypeChangeAllowed()
{@inheritdoc}
public
isTypeChangeAllowed() : mixed
Return values
mixed —setSourceModule()
Set source module.
public
setSourceModule(string $sourceModule) : $this
Parameters
- $sourceModule : string
Return values
$this —updateRelatedViewType()
Update related view type.
public
static updateRelatedViewType(int $relationId, array<string|int, string> $type) : mixed
Parameters
- $relationId : int
- $type : array<string|int, string>
Return values
mixed —validate()
Verification of data.
public
validate(array<string|int, mixed> $data[, bool $throw = true ]) : mixed
Parameters
- $data : array<string|int, mixed>
- $throw : bool = true