include/DetailView/DetailView.php

Show: inherited
Table of Contents

\DetailView

Package: SugarCRM

DetailView - display single record

Parent(s)
\ListView
Api
 

Properties

Propertypublic  $_additionalDetails= 'false'
inheritedInherited from: \ListView::$$_additionalDetails
Default valuefalseDetails
Type
n/a
Inherited_from
\ListView::$$_additionalDetails  
Propertypublic  $additionalDetailsFunction= 'null'
inheritedInherited from: \ListView::$$additionalDetailsFunction
Default valuenullDetails
Type
n/a
Inherited_from
\ListView::$$additionalDetailsFunction  
Propertypublic  $baseURL= ''''
inheritedInherited from: \ListView::$$baseURL
Default value''Details
Type
n/a
Inherited_from
\ListView::$$baseURL  
Propertypublic  $child_focus= ''''
inheritedInherited from: \ListView::$$child_focus
Default value''Details
Type
n/a
Inherited_from
\ListView::$$child_focus  
Propertypublic  $data_array= ''
inheritedInherited from: \ListView::$$data_array
Details
Type
n/a
Inherited_from
\ListView::$$data_array  
Propertypublic  $display_header_and_footer= 'true'
inheritedInherited from: \ListView::$$display_header_and_footer
Default valuetrueDetails
Type
n/a
Inherited_from
\ListView::$$display_header_and_footer  
Propertypublic  $end_link_wrapper= ''''
inheritedInherited from: \ListView::$$end_link_wrapper
Default value''Details
Type
n/a
Inherited_from
\ListView::$$end_link_wrapper  
Propertypublic  $force_mass_update= 'false'
inheritedInherited from: \ListView::$$force_mass_update
Default valuefalseDetails
Type
n/a
Inherited_from
\ListView::$$force_mass_update  
Propertypublic  $header_text= ''''
inheritedInherited from: \ListView::$$header_text
Default value''Details
Type
n/a
Inherited_from
\ListView::$$header_text  
Propertypublic  $header_title= ''''
inheritedInherited from: \ListView::$$header_title
Default value''Details
Type
n/a
Inherited_from
\ListView::$$header_title  
Propertypublic  $ignorePopulateOnly= 'false'
inheritedInherited from: \ListView::$$ignorePopulateOnly
Default valuefalseDetails
Type
n/a
Inherited_from
\ListView::$$ignorePopulateOnly  
Propertypublic  $initialized= 'false'
inheritedInherited from: \ListView::$$initialized
Default valuefalseDetails
Type
n/a
Inherited_from
\ListView::$$initialized  
Propertypublic  $inline= 'false'
inheritedInherited from: \ListView::$$inline
Default valuefalseDetails
Type
n/a
Inherited_from
\ListView::$$inline  
Propertypublic  $is_dynamic= 'false'
inheritedInherited from: \ListView::$$is_dynamic
Default valuefalseDetails
Type
n/a
Inherited_from
\ListView::$$is_dynamic  
Propertypublic  $keep_mass_update_form_open= 'false'
inheritedInherited from: \ListView::$$keep_mass_update_form_open
Default valuefalseDetails
Type
n/a
Inherited_from
\ListView::$$keep_mass_update_form_open  
Propertypublic  $layout_manager= 'null'
inheritedInherited from: \ListView::$$layout_manager
Default valuenullDetails
Type
n/a
Inherited_from
\ListView::$$layout_manager  
Propertypublic  $list_field_defs= 'array()'
inheritedInherited from: \ListView::$$list_field_defs
Default valuearray()Details
Type
n/a
Inherited_from
\ListView::$$list_field_defs  
Propertypublic  $list_row_count= 'null'
Default valuenullDetails
Type
n/a
Propertypublic  $local_app_strings= 'null'
inheritedInherited from: \ListView::$$local_app_strings
Default valuenullDetails
Type
n/a
Inherited_from
\ListView::$$local_app_strings  
Propertypublic  $local_current_module= 'null'
inheritedInherited from: \ListView::$$local_current_module
Default valuenullDetails
Type
n/a
Inherited_from
\ListView::$$local_current_module  
Propertypublic  $local_image_path= 'null'
inheritedInherited from: \ListView::$$local_image_path
Default valuenullDetails
Type
n/a
Inherited_from
\ListView::$$local_image_path  
Propertypublic  $local_mod_strings= 'null'
inheritedInherited from: \ListView::$$local_mod_strings
Default valuenullDetails
Type
n/a
Inherited_from
\ListView::$$local_mod_strings  
Propertypublic  $local_theme= 'null'
inheritedInherited from: \ListView::$$local_theme
Default valuenullDetails
Type
n/a
Inherited_from
\ListView::$$local_theme  
Propertypublic  $multi_select_popup= 'false'
inheritedInherited from: \ListView::$$multi_select_popup
Default valuefalseDetails
Type
n/a
Inherited_from
\ListView::$$multi_select_popup  
Propertypublic  $no_record_found= 'false'
Default valuefalseDetails
Type
n/a
Propertypublic  $offset_key_mismatch= 'false'
Default valuefalseDetails
Type
n/a
Propertypublic  $process_for_popups= 'false'
inheritedInherited from: \ListView::$$process_for_popups
Default valuefalseDetails
Type
n/a
Inherited_from
\ListView::$$process_for_popups  
Propertypublic  $query_limit= '-1'
inheritedInherited from: \ListView::$$query_limit
Default value-1Details
Type
n/a
Inherited_from
\ListView::$$query_limit  
Propertypublic  $query_orderby= 'null'
inheritedInherited from: \ListView::$$query_orderby
Default valuenullDetails
Type
n/a
Inherited_from
\ListView::$$query_orderby  
Propertypublic  $query_where= 'null'
inheritedInherited from: \ListView::$$query_where
Default valuenullDetails
Type
n/a
Inherited_from
\ListView::$$query_where  
Propertypublic  $query_where_has_changed= 'false'
inheritedInherited from: \ListView::$$query_where_has_changed
Default valuefalseDetails
Type
n/a
Inherited_from
\ListView::$$query_where_has_changed  
Propertypublic  $records_per_page= '20'
inheritedInherited from: \ListView::$$records_per_page
Default value20Details
Type
n/a
Inherited_from
\ListView::$$records_per_page  
Propertypublic  $related_field_name= ''''
inheritedInherited from: \ListView::$$related_field_name
Default value''Details
Type
n/a
Inherited_from
\ListView::$$related_field_name  
Propertypublic  $return_to_list_only= 'false'
Default valuefalseDetails
Type
n/a
Propertypublic  $seed_data= 'null'
inheritedInherited from: \ListView::$$seed_data
Default valuenullDetails
Type
n/a
Inherited_from
\ListView::$$seed_data  
Propertypublic  $shouldProcess= 'false'
inheritedInherited from: \ListView::$$shouldProcess
Default valuefalseDetails
Type
n/a
Inherited_from
\ListView::$$shouldProcess  
Propertypublic  $show_delete_button= 'true'
inheritedInherited from: \ListView::$$show_delete_button
Default valuetrueDetails
Type
n/a
Inherited_from
\ListView::$$show_delete_button  
Propertypublic  $show_export_button= 'true'
inheritedInherited from: \ListView::$$show_export_button
Default valuetrueDetails
Type
n/a
Inherited_from
\ListView::$$show_export_button  
Propertypublic  $show_mass_update= 'true'
inheritedInherited from: \ListView::$$show_mass_update
Default valuetrueDetails
Type
n/a
Inherited_from
\ListView::$$show_mass_update  
Propertypublic  $show_mass_update_form= 'true'
inheritedInherited from: \ListView::$$show_mass_update_form
Default valuetrueDetails
Type
n/a
Inherited_from
\ListView::$$show_mass_update_form  
Propertypublic  $show_paging= 'true'
inheritedInherited from: \ListView::$$show_paging
Default valuetrueDetails
Type
n/a
Inherited_from
\ListView::$$show_paging  
Propertypublic  $show_select_menu= 'true'
inheritedInherited from: \ListView::$$show_select_menu
Default valuetrueDetails
Type
n/a
Inherited_from
\ListView::$$show_select_menu  
Propertypublic  $sort_order= ''''
inheritedInherited from: \ListView::$$sort_order
Default value''Details
Type
n/a
Inherited_from
\ListView::$$sort_order  
Propertypublic  $start_link_wrapper= ''''
inheritedInherited from: \ListView::$$start_link_wrapper
Default value''Details
Type
n/a
Inherited_from
\ListView::$$start_link_wrapper  
Propertypublic  $xTemplate= 'null'
inheritedInherited from: \ListView::$$xTemplate
Default valuenullDetails
Type
n/a
Inherited_from
\ListView::$$xTemplate  
Propertypublic  $xTemplatePath= 'null'
inheritedInherited from: \ListView::$$xTemplatePath
Default valuenullDetails
Type
n/a
Inherited_from
\ListView::$$xTemplatePath  

Methods

methodpublicDetailView( ) : void

methodpublicListView( ) : void
inherited

Inherited from: \ListView::ListView()
methodpubliccalculateSortOrder( 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
Name Type Description
$sortOrderList array
  • contains options
Returns
Type Description
string 'asc' | 'desc'
methodpubliccreateXTemplate( ) : void
inherited

Inherited from: \ListView::createXTemplate()
methodpublicdisplayArrow( ) : void
inherited

Inherited from: \ListView::displayArrow()
methodpublicgetAdditionalHeader( ) : void
inherited

Inherited from: \ListView::getAdditionalHeader()
methodpublicgetArrowEnd( ) : void
inherited

Inherited from: \ListView::getArrowEnd()
methodpublicgetArrowImageSize( ) : void
inherited

Inherited from: \ListView::getArrowImageSize()
methodpublicgetArrowStart( ) : void
inherited

Inherited from: \ListView::getArrowStart()
methodpublicgetArrowUpDownEnd(  $upDown ) : void
inherited

Inherited from: \ListView::getArrowUpDownEnd()
Parameters
Name Type Description
$upDown
methodpublicgetArrowUpDownImageSize(  $upDown ) : void
inherited

Inherited from: \ListView::getArrowUpDownImageSize()
Parameters
Name Type Description
$upDown
methodpublicgetArrowUpDownStart(  $upDown ) : void
inherited

Inherited from: \ListView::getArrowUpDownStart()
Parameters
Name Type Description
$upDown
methodpublicgetBaseURL(  $html_varName ) : void
inherited

Inherited from: \ListView::getBaseURL()
Parameters
Name Type Description
$html_varName
methodpublicgetLayoutManager( ) : void
inherited

Inherited from: \ListView::getLayoutManager()
methodpublicgetListViewRowCount( ) : void

methodpublicgetLocalSessionVariable(  $localVarName,  $varName ) : void
inherited

Inherited from: \ListView::getLocalSessionVariable()
Parameters
Name Type Description
$localVarName
$varName
methodpublicgetOffset(  $localVarName ) : void
inherited

Inherited from: \ListView::getOffset()
Parameters
Name Type Description
$localVarName
methodpublicgetOrderBy(  $varName,  $defaultOrderBy = '',  $force_sortorder = '' ) : void
inherited

Inherited from: \ListView::getOrderBy()
Parameters
Name Type Description
$varName
$defaultOrderBy
$force_sortorder
methodpublicgetOrderByInfo(  $html_varName ) : void
inherited

Inherited from: \ListView::getOrderByInfo()
Parameters
Name Type Description
$html_varName
methodpublicgetSessionVariable(  $localVarName,  $varName ) : void
inherited

Inherited from: \ListView::getSessionVariable()
Parameters
Name Type Description
$localVarName
$varName
methodpublicgetSessionVariableName( \unknown $localVarName, \unknown $varName ) : void
inherited

Inherited from: \ListView::getSessionVariableName()
Parameters
Name Type Description
$localVarName \unknown
$varName \unknown
Details
Desc
INTERNAL FUNCTION returns the session/query variable name Portions created by SugarCRM are Copyright (C) SugarCRM, Inc. All Rights Reserved. Contributor(s): ______________________________________..  
methodpublicgetUserVariable(  $localVarName,  $varName ) : void
inherited

Inherited from: \ListView::getUserVariable()
Parameters
Name Type Description
$localVarName
$varName
methodpublicgetVariableFromSession( \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
  • the name of the variable to set in the session
$value \unknown_type
  • the value of the variable to set
methodpublicgetXTemplate( ) : void
inherited

Inherited from: \ListView::getXTemplate()
methodpublicinitNewXTemplate(  $XTemplatePath,  $modString,  $imagePath = null ) : void
inherited

Inherited from: \ListView::initNewXTemplate()
Parameters
Name Type Description
$XTemplatePath
$modString
$imagePath
methodpublicisRequestFromListView(  $html_varName ) : void

Parameters
Name Type Description
$html_varName
methodpublicloadListFieldDefs(  $subpanel_fields,  $child_focus ) : void
inherited

Inherited from: \ListView::loadListFieldDefs()
Parameters
Name Type Description
$subpanel_fields
$child_focus
methodpublicpopulateQueryWhere(  $isfirstview,  $html_varName ) : void

Parameters
Name Type Description
$isfirstview
$html_varName
methodpublicprocessListNavigation(  $xtpl, \unknown $html_varName,  $current_offset,  $display_audit_link = false ) : void

Parameters
Name Type Description
$xtpl
$html_varName \unknown
$current_offset
$display_audit_link
methodpublicprocessListRows( \unknown $data,  $xtemplateSection, \unknown $html_varName ) : void
inherited

Inherited from: \ListView::processListRows()
Parameters
Name Type Description
$data \unknown
$xtemplateSection
$html_varName \unknown
Details
Desc
INTERNAL FUNCTION handles the rows Portions created by SugarCRM are Copyright (C) SugarCRM, Inc. All Rights Reserved. Contributor(s): ______________________________________..  
methodpublicprocessListView(  $seed,  $xTemplateSection,  $html_varName ) : void
inherited

Inherited from: \ListView::processListView()
Parameters
Name Type Description
$seed
$xTemplateSection
$html_varName
methodpublicprocessListViewMulti(  $seed,  $xTemplateSection,  $html_varName ) : void
inherited

Inherited from: \ListView::processListViewMulti()
Parameters
Name Type Description
$seed
$xTemplateSection
$html_varName
methodpublicprocessListViewTwo( \unknown $seed, \unknown $xTemplateSection, \unknown $html_varName ) : void
inherited

Inherited from: \ListView::processListViewTwo()
Parameters
Name Type Description
$seed \unknown
$xTemplateSection \unknown
$html_varName \unknown
Details
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): ______________________________________..  
methodpublicprocessOrderBy(  $html_varName ) : void
inherited

Inherited from: \ListView::processOrderBy()
Parameters
Name Type Description
$html_varName
methodpublicprocessSortArrows(  $html_varName ) : void
inherited

Inherited from: \ListView::processSortArrows()
Parameters
Name Type Description
$html_varName
methodpublicprocessSugarBean( \unknown $html_varName, \unknown $seed,  $offset,  $isfirstview = 0 ) : void

Parameters
Name Type Description
$html_varName \unknown
$seed \unknown
$offset
$isfirstview
methodpublicprocessUnionBeans(  $sugarbean,  $subpanel_def,  $html_var = 'CELL' ) : void
inherited

Inherited from: \ListView::processUnionBeans()
Parameters
Name Type Description
$sugarbean
$subpanel_def
$html_var
methodpublicprocess_dynamic_listview(  $source_module,  $sugarbean,  $subpanel_def ) : void
inherited

Inherited from: \ListView::process_dynamic_listview()
Parameters
Name Type Description
$source_module
$sugarbean
$subpanel_def
methodpublicprocess_dynamic_listview_header(  $source_module,  $subpanel_def,  $html_var = 'CELL' ) : void
Parameters
Name Type Description
$source_module
$subpanel_def
$html_var
methodpublicprocess_dynamic_listview_rows( \unknown $data,  $parent_data,  $xtemplateSection, \unknown $html_varName,  $subpanel_def ) : void
inherited

Inherited from: \ListView::process_dynamic_listview_rows()
Parameters
Name Type Description
$data \unknown
$parent_data
$xtemplateSection
$html_varName \unknown
$subpanel_def
Details
Desc
INTERNAL FUNCTION handles the rows  
methodpublicsetAdditionalDetails(  $value = true,  $function = '' ) : void
inherited

Inherited from: \ListView::setAdditionalDetails()
Parameters
Name Type Description
$value
$function
methodpublicsetAppStrings(  $app_strings ) : void
inherited

Inherited from: \ListView::setAppStrings()
Parameters
Name Type Description
$app_strings
methodpublicsetCurrentModule(  $currentModule ) : void
inherited

Inherited from: \ListView::setCurrentModule()
Parameters
Name Type Description
$currentModule
methodpublicsetDataArray(  $value ) : void
inherited

Inherited from: \ListView::setDataArray()
Parameters
Name Type Description
$value
methodpublicsetDisplayHeaderAndFooter(  $bool ) : void
inherited

Inherited from: \ListView::setDisplayHeaderAndFooter()
Parameters
Name Type Description
$bool
methodpublicsetHeaderText(  $value ) : void
inherited

Inherited from: \ListView::setHeaderText()
Parameters
Name Type Description
$value
methodpublicsetHeaderTitle(  $value ) : void
inherited

Inherited from: \ListView::setHeaderTitle()
Parameters
Name Type Description
$value
methodpublicsetImagePath(  $image_path ) : void
inherited

Inherited from: \ListView::setImagePath()
Parameters
Name Type Description
$image_path
methodpublicsetListViewRowCount(  $count ) : void

Parameters
Name Type Description
$count
methodpublicsetLocalSessionVariable(  $localVarName,  $varName,  $value ) : void
inherited

Inherited from: \ListView::setLocalSessionVariable()
Parameters
Name Type Description
$localVarName
$varName
$value
methodpublicsetModStrings(  $mod_strings ) : void
inherited

Inherited from: \ListView::setModStrings()
Parameters
Name Type Description
$mod_strings
methodpublicsetOffset(  $localVarName,  $value ) : void
inherited

Inherited from: \ListView::setOffset()
Parameters
Name Type Description
$localVarName
$value
methodpublicsetQuery(  $where,  $limit,  $orderBy,  $varName,  $allowOrderByOveride = true ) : void
inherited

Inherited from: \ListView::setQuery()
Parameters
Name Type Description
$where
$limit
$orderBy
$varName
$allowOrderByOveride
methodpublicsetRecordsPerPage(  $count ) : void
inherited

Inherited from: \ListView::setRecordsPerPage()
Parameters
Name Type Description
$count
methodpublicsetSessionVariable(  $localVarName,  $varName,  $value ) : void
inherited

Inherited from: \ListView::setSessionVariable()
Parameters
Name Type Description
$localVarName
$varName
$value
methodpublicsetTheme(  $theme ) : void
inherited

Inherited from: \ListView::setTheme()
Parameters
Name Type Description
$theme
methodpublicsetUserVariable(  $localVarName,  $varName,  $value ) : void
inherited

Inherited from: \ListView::setUserVariable()
Parameters
Name Type Description
$localVarName
$varName
$value
methodpublicsetXTemplate(  $newXTemplate ) : void
inherited

Inherited from: \ListView::setXTemplate()
Parameters
Name Type Description
$newXTemplate
methodpublicsetXTemplatePath(  $value ) : void
inherited

Inherited from: \ListView::setXTemplatePath()
Parameters
Name Type Description
$value
methodpublicset_base_URL(  $html_varName ) : void

Parameters
Name Type Description
$html_varName
methodpublicunique_id( ) : void
inherited

Inherited from: \ListView::unique_id()
methodpublicxTemplateAssign(  $name,  $value ) : void
inherited

Inherited from: \ListView::xTemplateAssign()
Parameters
Name Type Description
$name
$value
Documentation was generated by DocBlox 0.18.1.