include/DetailView/DetailView.php
\DetailView
Package: SugarCRM
DetailView - display single record
- Parent(s)
- \ListView
- Api
Properties
$_additionalDetails= 'false'
inheritedInherited from:
\ListView::$$_additionalDetails
Default value
false
Details- Type
- n/a
- Inherited_from
- \ListView::$$_additionalDetails
$additionalDetailsFunction= 'null'
inheritedInherited from:
\ListView::$$additionalDetailsFunction
Default value
null
Details- Type
- n/a
- Inherited_from
- \ListView::$$additionalDetailsFunction
$baseURL= ''''
inheritedInherited from:
\ListView::$$baseURL
Default value
''
Details- Type
- n/a
- Inherited_from
- \ListView::$$baseURL
$child_focus= ''''
inheritedInherited from:
\ListView::$$child_focus
Default value
''
Details- Type
- n/a
- Inherited_from
- \ListView::$$child_focus
$data_array= ''
inheritedInherited from:
\ListView::$$data_array
Details
- Type
- n/a
- Inherited_from
- \ListView::$$data_array
$display_header_and_footer= 'true'
inheritedInherited from:
\ListView::$$display_header_and_footer
Default value
true
Details- Type
- n/a
- Inherited_from
- \ListView::$$display_header_and_footer
$end_link_wrapper= ''''
inheritedInherited from:
\ListView::$$end_link_wrapper
Default value
''
Details- Type
- n/a
- Inherited_from
- \ListView::$$end_link_wrapper
$force_mass_update= 'false'
inheritedInherited from:
\ListView::$$force_mass_update
Default value
false
Details- Type
- n/a
- Inherited_from
- \ListView::$$force_mass_update
$header_text= ''''
inheritedInherited from:
\ListView::$$header_text
Default value
''
Details- Type
- n/a
- Inherited_from
- \ListView::$$header_text
$header_title= ''''
inheritedInherited from:
\ListView::$$header_title
Default value
''
Details- Type
- n/a
- Inherited_from
- \ListView::$$header_title
$ignorePopulateOnly= 'false'
inheritedInherited from:
\ListView::$$ignorePopulateOnly
Default value
false
Details- Type
- n/a
- Inherited_from
- \ListView::$$ignorePopulateOnly
$initialized= 'false'
inheritedInherited from:
\ListView::$$initialized
Default value
false
Details- Type
- n/a
- Inherited_from
- \ListView::$$initialized
$inline= 'false'
inheritedInherited from:
\ListView::$$inline
Default value
false
Details- Type
- n/a
- Inherited_from
- \ListView::$$inline
$is_dynamic= 'false'
inheritedInherited from:
\ListView::$$is_dynamic
Default value
false
Details- Type
- n/a
- Inherited_from
- \ListView::$$is_dynamic
$keep_mass_update_form_open= 'false'
inheritedInherited from:
\ListView::$$keep_mass_update_form_open
Default value
false
Details- Type
- n/a
- Inherited_from
- \ListView::$$keep_mass_update_form_open
$layout_manager= 'null'
inheritedInherited from:
\ListView::$$layout_manager
Default value
null
Details- Type
- n/a
- Inherited_from
- \ListView::$$layout_manager
$list_field_defs= 'array()'
inheritedInherited from:
\ListView::$$list_field_defs
Default value
array()
Details- Type
- n/a
- Inherited_from
- \ListView::$$list_field_defs
$local_app_strings= 'null'
inheritedInherited from:
\ListView::$$local_app_strings
Default value
null
Details- Type
- n/a
- Inherited_from
- \ListView::$$local_app_strings
$local_current_module= 'null'
inheritedInherited from:
\ListView::$$local_current_module
Default value
null
Details- Type
- n/a
- Inherited_from
- \ListView::$$local_current_module
$local_image_path= 'null'
inheritedInherited from:
\ListView::$$local_image_path
Default value
null
Details- Type
- n/a
- Inherited_from
- \ListView::$$local_image_path
$local_mod_strings= 'null'
inheritedInherited from:
\ListView::$$local_mod_strings
Default value
null
Details- Type
- n/a
- Inherited_from
- \ListView::$$local_mod_strings
$local_theme= 'null'
inheritedInherited from:
\ListView::$$local_theme
Default value
null
Details- Type
- n/a
- Inherited_from
- \ListView::$$local_theme
$multi_select_popup= 'false'
inheritedInherited from:
\ListView::$$multi_select_popup
Default value
false
Details- Type
- n/a
- Inherited_from
- \ListView::$$multi_select_popup
$process_for_popups= 'false'
inheritedInherited from:
\ListView::$$process_for_popups
Default value
false
Details- Type
- n/a
- Inherited_from
- \ListView::$$process_for_popups
$query_limit= '-1'
inheritedInherited from:
\ListView::$$query_limit
Default value
-1
Details- Type
- n/a
- Inherited_from
- \ListView::$$query_limit
$query_orderby= 'null'
inheritedInherited from:
\ListView::$$query_orderby
Default value
null
Details- Type
- n/a
- Inherited_from
- \ListView::$$query_orderby
$query_where= 'null'
inheritedInherited from:
\ListView::$$query_where
Default value
null
Details- Type
- n/a
- Inherited_from
- \ListView::$$query_where
$query_where_has_changed= 'false'
inheritedInherited from:
\ListView::$$query_where_has_changed
Default value
false
Details- Type
- n/a
- Inherited_from
- \ListView::$$query_where_has_changed
$records_per_page= '20'
inheritedInherited from:
\ListView::$$records_per_page
Default value
20
Details- Type
- n/a
- Inherited_from
- \ListView::$$records_per_page
$related_field_name= ''''
inheritedInherited from:
\ListView::$$related_field_name
Default value
''
Details- Type
- n/a
- Inherited_from
- \ListView::$$related_field_name
$seed_data= 'null'
inheritedInherited from:
\ListView::$$seed_data
Default value
null
Details- Type
- n/a
- Inherited_from
- \ListView::$$seed_data
$shouldProcess= 'false'
inheritedInherited from:
\ListView::$$shouldProcess
Default value
false
Details- Type
- n/a
- Inherited_from
- \ListView::$$shouldProcess
$show_delete_button= 'true'
inheritedInherited from:
\ListView::$$show_delete_button
Default value
true
Details- Type
- n/a
- Inherited_from
- \ListView::$$show_delete_button
$show_export_button= 'true'
inheritedInherited from:
\ListView::$$show_export_button
Default value
true
Details- Type
- n/a
- Inherited_from
- \ListView::$$show_export_button
$show_mass_update= 'true'
inheritedInherited from:
\ListView::$$show_mass_update
Default value
true
Details- Type
- n/a
- Inherited_from
- \ListView::$$show_mass_update
$show_mass_update_form= 'true'
inheritedInherited from:
\ListView::$$show_mass_update_form
Default value
true
Details- Type
- n/a
- Inherited_from
- \ListView::$$show_mass_update_form
$show_paging= 'true'
inheritedInherited from:
\ListView::$$show_paging
Default value
true
Details- Type
- n/a
- Inherited_from
- \ListView::$$show_paging
$show_select_menu= 'true'
inheritedInherited from:
\ListView::$$show_select_menu
Default value
true
Details- Type
- n/a
- Inherited_from
- \ListView::$$show_select_menu
$sort_order= ''''
inheritedInherited from:
\ListView::$$sort_order
Default value
''
Details- Type
- n/a
- Inherited_from
- \ListView::$$sort_order
$start_link_wrapper= ''''
inheritedInherited from:
\ListView::$$start_link_wrapper
Default value
''
Details- Type
- n/a
- Inherited_from
- \ListView::$$start_link_wrapper
$xTemplate= 'null'
inheritedInherited from:
\ListView::$$xTemplate
Default value
null
Details- Type
- n/a
- Inherited_from
- \ListView::$$xTemplate
$xTemplatePath= 'null'
inheritedInherited from:
\ListView::$$xTemplatePath
Default value
null
Details- Type
- n/a
- Inherited_from
- \ListView::$$xTemplatePath
Methods
calculateSortOrder(
array $sortOrderList
)
:
string
inherited
helper method to determine sort order by priority of source 1. explicit in request object 2. in session variable 3. subpaneldefs metadata 4. default 'asc'
Inherited from: \ListView::calculateSortOrder()
Parameters
Returns
Name | Type | Description |
---|---|---|
$sortOrderList | array |
|
Type | Description |
---|---|
string | 'asc' | 'desc' |
getArrowUpDownEnd(
$upDown
)
:
void
inherited
Inherited from:
\ListView::getArrowUpDownEnd()
Parameters
Name | Type | Description |
---|---|---|
$upDown |
getArrowUpDownImageSize(
$upDown
)
:
void
inherited
Inherited from:
\ListView::getArrowUpDownImageSize()
Parameters
Name | Type | Description |
---|---|---|
$upDown |
getArrowUpDownStart(
$upDown
)
:
void
inherited
Inherited from:
\ListView::getArrowUpDownStart()
Parameters
Name | Type | Description |
---|---|---|
$upDown |
getBaseURL(
$html_varName
)
:
void
inherited
Inherited from:
\ListView::getBaseURL()
Parameters
Name | Type | Description |
---|---|---|
$html_varName |
getLocalSessionVariable(
$localVarName, $varName
)
:
void
inherited
Inherited from:
\ListView::getLocalSessionVariable()
Parameters
Name | Type | Description |
---|---|---|
$localVarName | ||
$varName |
getOffset(
$localVarName
)
:
void
inherited
Inherited from:
\ListView::getOffset()
Parameters
Name | Type | Description |
---|---|---|
$localVarName |
getOrderBy(
$varName, $defaultOrderBy
=
'', $force_sortorder
=
''
)
:
void
inherited
Inherited from:
\ListView::getOrderBy()
Parameters
Name | Type | Description |
---|---|---|
$varName | ||
$defaultOrderBy | ||
$force_sortorder |
getOrderByInfo(
$html_varName
)
:
void
inherited
Inherited from:
\ListView::getOrderByInfo()
Parameters
Name | Type | Description |
---|---|---|
$html_varName |
getSessionVariable(
$localVarName, $varName
)
:
void
inherited
Inherited from:
\ListView::getSessionVariable()
Parameters
Name | Type | Description |
---|---|---|
$localVarName | ||
$varName |
getSessionVariableName(
\unknown $localVarName, \unknown $varName
)
:
void
inherited
Inherited from:
\ListView::getSessionVariableName()
Parameters
Details
Name | Type | Description |
---|---|---|
$localVarName | \unknown | |
$varName | \unknown |
- Desc
- INTERNAL FUNCTION returns the session/query variable name Portions created by SugarCRM are Copyright (C) SugarCRM, Inc. All Rights Reserved. Contributor(s): ______________________________________..
getUserVariable(
$localVarName, $varName
)
:
void
inherited
Inherited from:
\ListView::getUserVariable()
Parameters
Name | Type | Description |
---|---|---|
$localVarName | ||
$varName |
getVariableFromSession(
\unknown_type $name, \unknown_type $value
)
:
void
Return a variable from the session. uses the new ListView session data. Hence the '2'
Parameters
Name | Type | Description |
---|---|---|
$name | \unknown_type |
|
$value | \unknown_type |
|
initNewXTemplate(
$XTemplatePath, $modString, $imagePath
=
null
)
:
void
inherited
Inherited from:
\ListView::initNewXTemplate()
Parameters
Name | Type | Description |
---|---|---|
$XTemplatePath | ||
$modString | ||
$imagePath |
loadListFieldDefs(
$subpanel_fields, $child_focus
)
:
void
inherited
Inherited from:
\ListView::loadListFieldDefs()
Parameters
Name | Type | Description |
---|---|---|
$subpanel_fields | ||
$child_focus |
populateQueryWhere(
$isfirstview, $html_varName
)
:
void
Parameters
Name | Type | Description |
---|---|---|
$isfirstview | ||
$html_varName |
processListNavigation(
$xtpl, \unknown $html_varName, $current_offset, $display_audit_link
=
false
)
:
void
Parameters
Name | Type | Description |
---|---|---|
$xtpl | ||
$html_varName | \unknown | |
$current_offset | ||
$display_audit_link |
processListRows(
\unknown $data, $xtemplateSection, \unknown $html_varName
)
:
void
inherited
Inherited from:
\ListView::processListRows()
Parameters
Details
Name | Type | Description |
---|---|---|
$data | \unknown | |
$xtemplateSection | ||
$html_varName | \unknown |
- Desc
- INTERNAL FUNCTION handles the rows Portions created by SugarCRM are Copyright (C) SugarCRM, Inc. All Rights Reserved. Contributor(s): ______________________________________..
processListView(
$seed, $xTemplateSection, $html_varName
)
:
void
inherited
Inherited from:
\ListView::processListView()
Parameters
Name | Type | Description |
---|---|---|
$seed | ||
$xTemplateSection | ||
$html_varName |
processListViewMulti(
$seed, $xTemplateSection, $html_varName
)
:
void
inherited
Inherited from:
\ListView::processListViewMulti()
Parameters
Name | Type | Description |
---|---|---|
$seed | ||
$xTemplateSection | ||
$html_varName |
processListViewTwo(
\unknown $seed, \unknown $xTemplateSection, \unknown $html_varName
)
:
void
inherited
Inherited from:
\ListView::processListViewTwo()
Parameters
Details
Name | Type | Description |
---|---|---|
$seed | \unknown | |
$xTemplateSection | \unknown | |
$html_varName | \unknown |
- Desc
- PUBLIC FUNCTION Handles List Views using seeds that extend SugarBean $XTemplateSection is the section in the XTemplate file that should be parsed usually main $html_VarName is the variable name used in the XTemplateFile e.g. TASK $seed is a seed there are two types of seeds one is a subclass of SugarBean, the other is a list usually created from a sugar bean using get_list if no XTemplate is set it will create a new XTemplate Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.. All Rights Reserved.. Contributor(s): ______________________________________..
processOrderBy(
$html_varName
)
:
void
inherited
Inherited from:
\ListView::processOrderBy()
Parameters
Name | Type | Description |
---|---|---|
$html_varName |
processSortArrows(
$html_varName
)
:
void
inherited
Inherited from:
\ListView::processSortArrows()
Parameters
Name | Type | Description |
---|---|---|
$html_varName |
processSugarBean(
\unknown $html_varName, \unknown $seed, $offset, $isfirstview
=
0
)
:
void
Parameters
Name | Type | Description |
---|---|---|
$html_varName | \unknown | |
$seed | \unknown | |
$offset | ||
$isfirstview |
processUnionBeans(
$sugarbean, $subpanel_def, $html_var
=
'CELL'
)
:
void
inherited
Inherited from:
\ListView::processUnionBeans()
Parameters
Name | Type | Description |
---|---|---|
$sugarbean | ||
$subpanel_def | ||
$html_var |
process_dynamic_listview(
$source_module, $sugarbean, $subpanel_def
)
:
void
inherited
Inherited from:
\ListView::process_dynamic_listview()
Parameters
Name | Type | Description |
---|---|---|
$source_module | ||
$sugarbean | ||
$subpanel_def |
process_dynamic_listview_header(
$source_module, $subpanel_def, $html_var
=
'CELL'
)
:
void
inherited
Inherited from:
\ListView::process_dynamic_listview_header()
Parameters
Name | Type | Description |
---|---|---|
$source_module | ||
$subpanel_def | ||
$html_var |
process_dynamic_listview_rows(
\unknown $data, $parent_data, $xtemplateSection, \unknown $html_varName, $subpanel_def
)
:
void
inherited
Inherited from:
\ListView::process_dynamic_listview_rows()
Parameters
Details
Name | Type | Description |
---|---|---|
$data | \unknown | |
$parent_data | ||
$xtemplateSection | ||
$html_varName | \unknown | |
$subpanel_def |
- Desc
- INTERNAL FUNCTION handles the rows
setAdditionalDetails(
$value
=
true, $function
=
''
)
:
void
inherited
Inherited from:
\ListView::setAdditionalDetails()
Parameters
Name | Type | Description |
---|---|---|
$value | ||
$function |
setAppStrings(
$app_strings
)
:
void
inherited
Inherited from:
\ListView::setAppStrings()
Parameters
Name | Type | Description |
---|---|---|
$app_strings |
setCurrentModule(
$currentModule
)
:
void
inherited
Inherited from:
\ListView::setCurrentModule()
Parameters
Name | Type | Description |
---|---|---|
$currentModule |
setDataArray(
$value
)
:
void
inherited
Inherited from:
\ListView::setDataArray()
Parameters
Name | Type | Description |
---|---|---|
$value |
setDisplayHeaderAndFooter(
$bool
)
:
void
inherited
Inherited from:
\ListView::setDisplayHeaderAndFooter()
Parameters
Name | Type | Description |
---|---|---|
$bool |
setHeaderText(
$value
)
:
void
inherited
Inherited from:
\ListView::setHeaderText()
Parameters
Name | Type | Description |
---|---|---|
$value |
setHeaderTitle(
$value
)
:
void
inherited
Inherited from:
\ListView::setHeaderTitle()
Parameters
Name | Type | Description |
---|---|---|
$value |
setImagePath(
$image_path
)
:
void
inherited
Inherited from:
\ListView::setImagePath()
Parameters
Name | Type | Description |
---|---|---|
$image_path |
setLocalSessionVariable(
$localVarName, $varName, $value
)
:
void
inherited
Inherited from:
\ListView::setLocalSessionVariable()
Parameters
Name | Type | Description |
---|---|---|
$localVarName | ||
$varName | ||
$value |
setModStrings(
$mod_strings
)
:
void
inherited
Inherited from:
\ListView::setModStrings()
Parameters
Name | Type | Description |
---|---|---|
$mod_strings |
setOffset(
$localVarName, $value
)
:
void
inherited
Inherited from:
\ListView::setOffset()
Parameters
Name | Type | Description |
---|---|---|
$localVarName | ||
$value |
setQuery(
$where, $limit, $orderBy, $varName, $allowOrderByOveride
=
true
)
:
void
inherited
Inherited from:
\ListView::setQuery()
Parameters
Name | Type | Description |
---|---|---|
$where | ||
$limit | ||
$orderBy | ||
$varName | ||
$allowOrderByOveride |
setRecordsPerPage(
$count
)
:
void
inherited
Inherited from:
\ListView::setRecordsPerPage()
Parameters
Name | Type | Description |
---|---|---|
$count |
setSessionVariable(
$localVarName, $varName, $value
)
:
void
inherited
Inherited from:
\ListView::setSessionVariable()
Parameters
Name | Type | Description |
---|---|---|
$localVarName | ||
$varName | ||
$value |
setTheme(
$theme
)
:
void
inherited
Inherited from:
\ListView::setTheme()
Parameters
Name | Type | Description |
---|---|---|
$theme |
setUserVariable(
$localVarName, $varName, $value
)
:
void
inherited
Inherited from:
\ListView::setUserVariable()
Parameters
Name | Type | Description |
---|---|---|
$localVarName | ||
$varName | ||
$value |
setXTemplate(
$newXTemplate
)
:
void
inherited
Inherited from:
\ListView::setXTemplate()
Parameters
Name | Type | Description |
---|---|---|
$newXTemplate |
setXTemplatePath(
$value
)
:
void
inherited
Inherited from:
\ListView::setXTemplatePath()
Parameters
Name | Type | Description |
---|---|---|
$value |
xTemplateAssign(
$name, $value
)
:
void
inherited
Inherited from:
\ListView::xTemplateAssign()
Parameters
Name | Type | Description |
---|---|---|
$name | ||
$value |