Documentation

Settings_ConfigEditor_Module_Model extends Settings_Vtiger_Module_Model
in package

Config editor basic module class.

Table of Contents

$brandingFields  : array<string|int, mixed>
$listFields  : mixed
{@inheritdoc}
$name  : mixed
{@inheritdoc}
$performanceFields  : array<string|int, mixed>
$relationFields  : array<string|int, mixed>
$type  : string
getDetailViewUrl()  : string
Function to get Detail view Url.
getDisplayValue()  : mixed
Function to getDisplay value of every field.
getEditFields()  : array<string|int, mixed>
Gets fields for edit.
getEditViewUrl()  : string
Function to get Edit view Url.
getFieldInstanceByName()  : Settings_Vtiger_Field_Model
Function determines fields available in edition view.
getInstance()  : self
Function to get the instance of Config module model.
getMenuItem()  : menu
Function to get CompanyDetails Menu item.
init()  : mixed
Function to initiation.

Properties

$brandingFields

public array<string|int, mixed> $brandingFields = ['footerName' => 'LBL_BRAND_DATA_NAME', 'urlFacebook' => 'LBL_FACEBOOK', 'urlLinkedIn' => 'LBL_LINKEDIN', 'urlTwitter' => 'LBL_TWITTER']

Fields for branding

$listFields

{@inheritdoc}

public mixed $listFields = ['upload_maxsize' => 'LBL_MAX_UPLOAD_SIZE', 'default_module' => 'LBL_DEFAULT_MODULE', 'listview_max_textlength' => 'LBL_MAX_TEXT_LENGTH_IN_LISTVIEW', 'list_max_entries_per_page' => 'LBL_MAX_ENTRIES_PER_PAGE_IN_LISTVIEW', 'defaultLayout' => 'LBL_DEFAULT_LAYOUT', 'breadcrumbs' => 'LBL_SHOWING_BREADCRUMBS', 'title_max_length' => 'LBL_TITLE_MAX_LENGTH', 'MINIMUM_CRON_FREQUENCY' => 'LBL_MINIMUM_CRON_FREQUENCY', 'listMaxEntriesMassEdit' => 'LBL_LIST_MAX_ENTRIES_MASSEDIT', 'backgroundClosingModal' => 'LBL_BG_CLOSING_MODAL', 'href_max_length' => 'LBL_HREF_MAX_LEGTH', 'langInLoginView' => 'LBL_SHOW_LANG_IN_LOGIN_PAGE', 'layoutInLoginView' => 'LBL_SHOW_LAYOUT_IN_LOGIN_PAGE']

$name

{@inheritdoc}

public mixed $name = 'ConfigEditor'

$performanceFields

public array<string|int, mixed> $performanceFields = ['MAX_NUMBER_EXPORT_RECORDS' => 'LBL_MAX_NUMBER_EXPORT_RECORDS']

Fields for performance

$relationFields

public array<string|int, mixed> $relationFields = ['SHOW_RELATED_MODULE_NAME' => 'LBL_RELATION_SHOW_RELATED_MODULE_NAME', 'SHOW_RELATED_ICON' => 'LBL_RELATION_SHOW_RELATED_ICON', 'SHOW_RECORDS_COUNT' => 'LBL_RELATION_SHOW_RECORDS_COUNT', 'COMMENT_MAX_LENGTH' => 'LBL_RELATION_COMMENT_MAX_LENGTH', 'separateChangeRelationButton' => 'LBL_RELATION_SEPARATE_CHANGE_RELATION_BUTTON']

Fields for relation

$type

public string $type

Configuration type

Methods

getDetailViewUrl()

Function to get Detail view Url.

public getDetailViewUrl() : string
Return values
string

Url

getDisplayValue()

Function to getDisplay value of every field.

public getDisplayValue(string $name) : mixed
Parameters
$name : string

field name

Return values
mixed

getEditFields()

Gets fields for edit.

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

getEditViewUrl()

Function to get Edit view Url.

public getEditViewUrl() : string
Return values
string

Url

getInstance()

Function to get the instance of Config module model.

public static getInstance([mixed $name = 'Settings:Vtiger' ]) : self
Parameters
$name : mixed = 'Settings:Vtiger'
Tags
throws
ReflectionException
Return values
self

getMenuItem()

Function to get CompanyDetails Menu item.

public getMenuItem() : menu
Return values
menu

item Model

init()

Function to initiation.

public init([string $type = 'Main' ]) : mixed
Parameters
$type : string = 'Main'
Tags
throws
ReflectionException
Return values
mixed

        

Search results