include/ListView/ListViewXTPL.php

Show:

inherited

Classes
- \ListViewXTPL

Table of Contents

\ListViewXTPL
jump to top

Package:

Parent(s): \ListViewDisplay

Properties


                 $actionsMenuExtraItems= 'array()'

inheritedInherited from: \ListViewDisplay::$$actionsMenuExtraItems

Default valuearray()Details

Type: n/a
Inherited_from: \ListViewDisplay::$$actionsMenuExtraItems


                 $data= ''

Details

Type: n/a


                 $export= 'true'

inheritedInherited from: \ListViewDisplay::$$export

Default valuetrueDetails

Type: n/a
Inherited_from: \ListViewDisplay::$$export


                 $listViewCounter= '0'

staticinheritedInherited from: \ListViewDisplay::$$listViewCounter

Default value0Details

Type: n/a
Inherited_from: \ListViewDisplay::$$listViewCounter


                 $lvd= ''

inheritedInherited from: \ListViewDisplay::$$lvd

Details

Type: n/a
Inherited_from: \ListViewDisplay::$$lvd


                 $mailMerge= 'true'

inheritedInherited from: \ListViewDisplay::$$mailMerge

Default valuetrueDetails

Type: n/a
Inherited_from: \ListViewDisplay::$$mailMerge


                 $main_block= ''main''

Default value'main'Details

Type: n/a


                 $mass= 'null'

inheritedInherited from: \ListViewDisplay::$$mass

Default valuenullDetails

Type: n/a
Inherited_from: \ListViewDisplay::$$mass


                 $mergeDisplayColumns= 'false'

inheritedInherited from: \ListViewDisplay::$$mergeDisplayColumns

Default valuefalseDetails

Type: n/a
Inherited_from: \ListViewDisplay::$$mergeDisplayColumns


                 $moduleString= ''

inheritedInherited from: \ListViewDisplay::$$moduleString

Details

Type: n/a
Inherited_from: \ListViewDisplay::$$moduleString


                 $multiSelect= 'true'

inheritedInherited from: \ListViewDisplay::$$multiSelect

Default valuetrueDetails

Type: n/a
Inherited_from: \ListViewDisplay::$$multiSelect


                 $multi_select_popup= ''

inheritedInherited from: \ListViewDisplay::$$multi_select_popup

Details

Type: n/a
Inherited_from: \ListViewDisplay::$$multi_select_popup


                 $nav_block= ''main.list_nav_row''

Default value'main.list_nav_row'Details

Type: n/a


                 $os_block= ''main.row.os''

Default value'main.row.os'Details

Type: n/a


                 $pro_block= ''main.row.pro''

Default value'main.row.pro'Details

Type: n/a


                 $pro_nav_block= ''main.pro_nav''

Default value'main.pro_nav'Details

Type: n/a


                 $rowCount= ''

inheritedInherited from: \ListViewDisplay::$$rowCount

Details

Type: n/a
Inherited_from: \ListViewDisplay::$$rowCount


                 $row_block= ''main.row''

Default value'main.row'Details

Type: n/a


                 $seed= ''

inheritedInherited from: \ListViewDisplay::$$seed

Details

Type: n/a
Inherited_from: \ListViewDisplay::$$seed


                 $should_process= 'true'

inheritedInherited from: \ListViewDisplay::$$should_process

Default valuetrueDetails

Type: n/a
Inherited_from: \ListViewDisplay::$$should_process


                 $show_action_dropdown= 'true'

inheritedInherited from: \ListViewDisplay::$$show_action_dropdown

Default valuetrueDetails

Type: n/a
Inherited_from: \ListViewDisplay::$$show_action_dropdown


                 $show_mass_update_form= 'false'

inheritedInherited from: \ListViewDisplay::$$show_mass_update_form

Default valuefalseDetails

Type: n/a
Inherited_from: \ListViewDisplay::$$show_mass_update_form


                 $show_plus= 'false'

inheritedInherited from: \ListViewDisplay::$$show_plus

Default valuefalseDetails

Type: n/a
Inherited_from: \ListViewDisplay::$$show_plus


                 $xtpl= ''

Details

Type: n/a

Methods

ListViewDisplay(
          
          )
        
        :
          null

inherited

Constructor

Inherited from: \ListViewDisplay::ListViewDisplay()

Returns

Type	Description
null

ListViewXTPL(
          
          )
        
        :
          void

buildActionsLink(
          string $id
              =
              'actions_link',  $location
              =
              'top'
          )
        
        :
          string

inherited

Display the actions link

Inherited from: \ListViewDisplay::buildActionsLink()

Parameters

Name	Type	Description
$id	string	link id attribute, defaults to 'actions_link'
$location

Returns

Type	Description
string	HTML source

buildComposeEmailLink(
           $totalCount,  $loc
              =
              'top'
          )
        
        :
          string

inherited

Builds the compose email link

Inherited from: \ListViewDisplay::buildComposeEmailLink()

Parameters

Name	Type	Description
$totalCount
$loc

Returns

Type	Description
string	HTML

buildDeleteLink(
           $loc
              =
              'top'
          )
        
        :
          string

inherited

Builds the delete link

Inherited from: \ListViewDisplay::buildDeleteLink()

Parameters

Name	Type	Description
$loc

Returns

Type	Description
string	HTML

buildExportLink(
           $loc
              =
              'top'
          )
        
        :
          string

inherited

Builds the export link

Inherited from: \ListViewDisplay::buildExportLink()

Parameters

Name	Type	Description
$loc

Returns

Type	Description
string	HTML

buildMassUpdateLink(
           $loc
              =
              'top'
          )
        
        :
          string

inherited

Builds the massupdate link

Inherited from: \ListViewDisplay::buildMassUpdateLink()

Parameters

Name	Type	Description
$loc

Returns

Type	Description
string	HTML

buildMergeDuplicatesLink(
           $loc
              =
              'top'
          )
        
        :
          string

inherited

Builds the mail merge link The link can be disabled by setting module level duplicate_merge property to false in the moudle's vardef file.

Inherited from: \ListViewDisplay::buildMergeDuplicatesLink()

Parameters

Name	Type	Description
$loc

Returns

Type	Description
string	HTML

buildMergeLink(
           $modules_array
              =
              null,  $loc
              =
              'top'
          )
        
        :
          string

inherited

Builds the mail merge link

Inherited from: \ListViewDisplay::buildMergeLink()

Parameters

Name	Type	Description
$modules_array
$loc

Returns

Type	Description
string	HTML

buildSelectLink(
          \echo $id
              =
              'select_link',  $total
              =
              0,  $pageTotal
              =
              0,  $location
              =
              "top"
          )
        
        :
          string

inherited

Display the select link

Inherited from: \ListViewDisplay::buildSelectLink()

Parameters

Name	Type	Description
$id	\echo	Bool set true if you want it echo'd, set false to have contents returned
$total
$pageTotal
$location

Returns

Type	Description
string	select link html

buildSelectedObjectsSpan(
           $echo
              =
              true,  $total
              =
              0
          )
        
        :
          string

inherited

Display the selected object span object

Inherited from: \ListViewDisplay::buildSelectedObjectsSpan()

Parameters

Name	Type	Description
$echo
$total

Returns

Type	Description
string	select object span

buildTargetList(
           $loc
              =
              'top'
          )
        
        :
          string

inherited

Builds the add to target list link

Inherited from: \ListViewDisplay::buildTargetList()

Parameters

Name	Type	Description
$loc

Returns

Type	Description
string	HTML

display(
          \echo $echo
              =
              true
          )
        
        :
          string

Displays the xtpl, either echo or returning the contents

Parameters

Name	Type	Description
$echo	\echo	bool echo or return contents

Returns

Type	Description
string	ListView contents

displayEnd(
          
          )
        
        :
          string

inherited

Display the bottom of the ListView (ie MassUpdate

Inherited from: \ListViewDisplay::displayEnd()

Returns

Type	Description
string	contents

getMassUpdate(
          
          )
        
        :
          \MassUpdate

inherited

Inherited from: \ListViewDisplay::getMassUpdate()

Returns

Type	Description
\MassUpdate	instance

getMultiSelectData(
          
          )
        
        :
          string

inherited

Display the multi select data box etc.

Inherited from: \ListViewDisplay::getMultiSelectData()

Returns

Type	Description
string	contents

process(
          \file $file, \data $data, \html_var $html_var
          )
        
        :
          void

Processes the request. Calls ListViewData process. Also assigns all lang strings, export links, This is called from ListViewDisplay

Parameters

Name	Type	Description
$file	\file	file Template file to use
$data	\data	array from ListViewData
$html_var	\html_var	string the corresponding html var in xtpl per row

processArrows(
          \ordering $ordering
          )
        
        :
          void

Assigns the sort arrows in the tpl

Parameters

Name	Type	Description
$ordering	\ordering	array data that contains the ordering info

processPagination(
          
          )
        
        :
          void

Assigns the pagination links at the top and bottom of the listview

setup(
          \seed $seed, \file $file, string $where, \offset:0 | \array:array() $params
              =
              array(),  $offset
              =
              0, \int:-1 $limit
              =
              -1, \string[]:array() $filter_fields
              =
              array(), \string:'id' $id_field
              =
              'id'
          )
        
        :
          void

inherited

Setup the class

Inherited from: \ListViewDisplay::setup()

Parameters

Name	Type	Description
$seed	\seed	SugarBean Seed SugarBean to use
$file	\file	File Template file to use
$where	string
$params	\offset:0 \| \array:array()	int offset to start at
$offset
$limit	\int:-1
$filter_fields	\string[]:array()
$id_field	\string:'id'

setupFilterFields(
           $filter_fields
              =
              array()
          )
        
        :
          void

inherited

Inherited from: \ListViewDisplay::setupFilterFields()

Parameters

Name	Type	Description
$filter_fields

shouldProcess(
           $moduleDir
          )
        
        :
          void

inherited

Inherited from: \ListViewDisplay::shouldProcess()

Parameters

Name	Type	Description
$moduleDir

include/ListView/ListViewXTPL.php

\ListViewXTPLjump to top

Properties

Methods

\ListViewXTPL
jump to top