include/ListView/ListView.php

Show:

inherited

Classes
- \ListView

Table of Contents

\ListView
jump to top

Package: SugarCRM

ListView - list of many objects

Children: \ReportListView; \DetailView
Api

Properties


                 $_additionalDetails= 'false'

Default valuefalseDetails

Type: n/a


                 $additionalDetailsFunction= 'null'

Default valuenullDetails

Type: n/a


                 $baseURL= ''''

Default value''Details

Type: n/a


                 $child_focus= ''''

Default value''Details

Type: n/a


                 $data_array= ''

Details

Type: n/a


                 $display_header_and_footer= 'true'

Default valuetrueDetails

Type: n/a


                 $end_link_wrapper= ''''

Default value''Details

Type: n/a


                 $force_mass_update= 'false'

Default valuefalseDetails

Type: n/a


                 $header_text= ''''

Default value''Details

Type: n/a


                 $header_title= ''''

Default value''Details

Type: n/a


                 $ignorePopulateOnly= 'false'

Default valuefalseDetails

Type: n/a


                 $initialized= 'false'

Default valuefalseDetails

Type: n/a


                 $inline= 'false'

Default valuefalseDetails

Type: n/a


                 $is_dynamic= 'false'

Default valuefalseDetails

Type: n/a


                 $keep_mass_update_form_open= 'false'

Default valuefalseDetails

Type: n/a


                 $layout_manager= 'null'

Default valuenullDetails

Type: n/a


                 $list_field_defs= 'array()'

Default valuearray()Details

Type: n/a


                 $local_app_strings= 'null'

Default valuenullDetails

Type: n/a


                 $local_current_module= 'null'

Default valuenullDetails

Type: n/a


                 $local_image_path= 'null'

Default valuenullDetails

Type: n/a


                 $local_mod_strings= 'null'

Default valuenullDetails

Type: n/a


                 $local_theme= 'null'

Default valuenullDetails

Type: n/a


                 $multi_select_popup= 'false'

Default valuefalseDetails

Type: n/a


                 $process_for_popups= 'false'

Default valuefalseDetails

Type: n/a


                 $query_limit= '-1'

Default value-1Details

Type: n/a


                 $query_orderby= 'null'

Default valuenullDetails

Type: n/a


                 $query_where= 'null'

Default valuenullDetails

Type: n/a


                 $query_where_has_changed= 'false'

Default valuefalseDetails

Type: n/a


                 $records_per_page= '20'

Default value20Details

Type: n/a


                 $related_field_name= ''''

Default value''Details

Type: n/a


                 $seed_data= 'null'

Default valuenullDetails

Type: n/a


                 $shouldProcess= 'false'

Default valuefalseDetails

Type: n/a


                 $show_delete_button= 'true'

Default valuetrueDetails

Type: n/a


                 $show_export_button= 'true'

Default valuetrueDetails

Type: n/a


                 $show_mass_update= 'true'

Default valuetrueDetails

Type: n/a


                 $show_mass_update_form= 'true'

Default valuetrueDetails

Type: n/a


                 $show_paging= 'true'

Default valuetrueDetails

Type: n/a


                 $show_select_menu= 'true'

Default valuetrueDetails

Type: n/a


                 $sort_order= ''''

Default value''Details

Type: n/a


                 $start_link_wrapper= ''''

Default value''Details

Type: n/a


                 $xTemplate= 'null'

Default valuenullDetails

Type: n/a


                 $xTemplatePath= 'null'

Default valuenullDetails

Type: n/a

Methods

ListView(
          
          )
        
        :
          void

calculateSortOrder(
          array $sortOrderList
          )
        
        :
          string

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'

Parameters

Name	Type	Description
$sortOrderList	array	contains options

Returns

Type	Description
string	'asc' \| 'desc'

createXTemplate(
          
          )
        
        :
          void

displayArrow(
          
          )
        
        :
          void

getAdditionalHeader(
          
          )
        
        :
          void

getArrowEnd(
          
          )
        
        :
          void

getArrowImageSize(
          
          )
        
        :
          void

getArrowStart(
          
          )
        
        :
          void

getArrowUpDownEnd(
           $upDown
          )
        
        :
          void

Parameters

Name	Type	Description
$upDown

getArrowUpDownImageSize(
           $upDown
          )
        
        :
          void

Parameters

Name	Type	Description
$upDown

getArrowUpDownStart(
           $upDown
          )
        
        :
          void

Parameters

Name	Type	Description
$upDown

getBaseURL(
           $html_varName
          )
        
        :
          void

Parameters

Name	Type	Description
$html_varName

getLayoutManager(
          
          )
        
        :
          void

getLocalSessionVariable(
           $localVarName,  $varName
          )
        
        :
          void

Parameters

Name	Type	Description
$localVarName
$varName

getOffset(
           $localVarName
          )
        
        :
          void

Parameters

Name	Type	Description
$localVarName

getOrderBy(
           $varName,  $defaultOrderBy
              =
              '',  $force_sortorder
              =
              ''
          )
        
        :
          void

Parameters

Name	Type	Description
$varName
$defaultOrderBy
$force_sortorder

getOrderByInfo(
           $html_varName
          )
        
        :
          void

Parameters

Name	Type	Description
$html_varName

getSessionVariable(
           $localVarName,  $varName
          )
        
        :
          void

Parameters

Name	Type	Description
$localVarName
$varName

getSessionVariableName(
          \unknown $localVarName, \unknown $varName
          )
        
        :
          void

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): ______________________________________..

getUserVariable(
           $localVarName,  $varName
          )
        
        :
          void

Parameters

Name	Type	Description
$localVarName
$varName

getXTemplate(
          
          )
        
        :
          void

initNewXTemplate(
           $XTemplatePath,  $modString,  $imagePath
              =
              null
          )
        
        :
          void

Parameters

Name	Type	Description
$XTemplatePath
$modString
$imagePath

loadListFieldDefs(
           $subpanel_fields,  $child_focus
          )
        
        :
          void

Parameters

Name	Type	Description
$subpanel_fields
$child_focus

processListNavigation(
           $xtemplateSection, \unknown $html_varName,  $current_offset,  $next_offset,  $previous_offset,  $row_count,  $sugarbean
              =
              null,  $subpanel_def
              =
              null,  $col_count
              =
              20
          )
        
        :
          void

Parameters

Name	Type	Description
$xtemplateSection
$html_varName	\unknown
$current_offset
$next_offset
$previous_offset
$row_count
$sugarbean
$subpanel_def
$col_count

Details

Desc: INTERNAL FUNCTION process the List Navigation Portions created by SugarCRM are Copyright (C) SugarCRM, Inc. All Rights Reserved. Contributor(s): ______________________________________..

processListRows(
          \unknown $data,  $xtemplateSection, \unknown $html_varName
          )
        
        :
          void

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): ______________________________________..

processListView(
           $seed,  $xTemplateSection,  $html_varName
          )
        
        :
          void

Parameters

Name	Type	Description
$seed
$xTemplateSection
$html_varName

processListViewMulti(
           $seed,  $xTemplateSection,  $html_varName
          )
        
        :
          void

Parameters

Name	Type	Description
$seed
$xTemplateSection
$html_varName

processListViewTwo(
          \unknown $seed, \unknown $xTemplateSection, \unknown $html_varName
          )
        
        :
          void

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): ______________________________________..

processOrderBy(
           $html_varName
          )
        
        :
          void

Parameters

Name	Type	Description
$html_varName

processSortArrows(
           $html_varName
          )
        
        :
          void

Parameters

Name	Type	Description
$html_varName

processSugarBean(
           $xtemplateSection, \unknown $html_varName, \unknown $seed
          )
        
        :
          void

Parameters

Name	Type	Description
$xtemplateSection
$html_varName	\unknown
$seed	\unknown

Details

Desc: INTERNAL 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 that extends SugarBean Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.. All Rights Reserved.. Contributor(s): ______________________________________..

processUnionBeans(
           $sugarbean,  $subpanel_def,  $html_var
              =
              'CELL'
          )
        
        :
          void

Parameters

Name	Type	Description
$sugarbean
$subpanel_def
$html_var

process_dynamic_listview(
           $source_module,  $sugarbean,  $subpanel_def
          )
        
        :
          void

Parameters

Name	Type	Description
$source_module
$sugarbean
$subpanel_def

process_dynamic_listview_header(
           $source_module,  $subpanel_def,  $html_var
              =
              'CELL'
          )
        
        :
          void

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

Parameters

Name	Type	Description
$data	\unknown
$parent_data
$xtemplateSection
$html_varName	\unknown
$subpanel_def

Details

Desc: INTERNAL FUNCTION handles the rows

setAdditionalDetails(
           $value
              =
              true,  $function
              =
              ''
          )
        
        :
          void

Parameters

Name	Type	Description
$value
$function

setAppStrings(
           $app_strings
          )
        
        :
          void

Parameters

Name	Type	Description
$app_strings

setCurrentModule(
           $currentModule
          )
        
        :
          void

Parameters

Name	Type	Description
$currentModule

setDataArray(
           $value
          )
        
        :
          void

Parameters

Name	Type	Description
$value

setDisplayHeaderAndFooter(
           $bool
          )
        
        :
          void

Parameters

Name	Type	Description
$bool

setHeaderText(
           $value
          )
        
        :
          void

Parameters

Name	Type	Description
$value

setHeaderTitle(
           $value
          )
        
        :
          void

Parameters

Name	Type	Description
$value

setImagePath(
           $image_path
          )
        
        :
          void

Parameters

Name	Type	Description
$image_path

setLocalSessionVariable(
           $localVarName,  $varName,  $value
          )
        
        :
          void

Parameters

Name	Type	Description
$localVarName
$varName
$value

setModStrings(
           $mod_strings
          )
        
        :
          void

Parameters

Name	Type	Description
$mod_strings

setOffset(
           $localVarName,  $value
          )
        
        :
          void

Parameters

Name	Type	Description
$localVarName
$value

setQuery(
           $where,  $limit,  $orderBy,  $varName,  $allowOrderByOveride
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$where
$limit
$orderBy
$varName
$allowOrderByOveride

setRecordsPerPage(
           $count
          )
        
        :
          void

Parameters

Name	Type	Description
$count

setSessionVariable(
           $localVarName,  $varName,  $value
          )
        
        :
          void

Parameters

Name	Type	Description
$localVarName
$varName
$value

setTheme(
           $theme
          )
        
        :
          void

Parameters

Name	Type	Description
$theme

setUserVariable(
           $localVarName,  $varName,  $value
          )
        
        :
          void

Parameters

Name	Type	Description
$localVarName
$varName
$value

setXTemplate(
           $newXTemplate
          )
        
        :
          void

Parameters

Name	Type	Description
$newXTemplate

setXTemplatePath(
           $value
          )
        
        :
          void

Parameters

Name	Type	Description
$value

unique_id(
          
          )
        
        :
          void

xTemplateAssign(
           $name,  $value
          )
        
        :
          void

Parameters

Name	Type	Description
$name
$value

include/ListView/ListView.php

\ListViewjump to top

Properties

Methods

\ListView
jump to top