modules/Reports/ListViewReports.php

Show:

inherited

Classes
- \ListViewReports

Table of Contents

\ListViewReports
jump to top

Package:

Parent(s): \ListViewSmarty < \ListViewDisplay

Properties


                 $actionsMenuExtraItems= 'array()'

inheritedInherited from: \ListViewDisplay::$$actionsMenuExtraItems \ListViewSmarty::$$actionsMenuExtraItems

Default valuearray()Details

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


                 $contextMenus= 'true'

inheritedInherited from: \ListViewSmarty::$$contextMenus

Default valuetrueDetails

Type: n/a
Inherited_from: \ListViewSmarty::$$contextMenus


                 $data= ''

inheritedInherited from: \ListViewSmarty::$$data

Details

Type: n/a
Inherited_from: \ListViewSmarty::$$data


                 $delete= 'true'

inheritedInherited from: \ListViewSmarty::$$delete

Default valuetrueDetails

Type: n/a
Inherited_from: \ListViewSmarty::$$delete


                 $displayColumns= ''

inheritedInherited from: \ListViewSmarty::$$displayColumns

Details

Type: n/a
Inherited_from: \ListViewSmarty::$$displayColumns


                 $displayEndTpl= ''

Details

Type: n/a


                 $email= 'true'

inheritedInherited from: \ListViewSmarty::$$email

Default valuetrueDetails

Type: n/a
Inherited_from: \ListViewSmarty::$$email


                 $export= 'true'

inheritedInherited from: \ListViewSmarty::$$export

Default valuetrueDetails

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


                 $listViewCounter= '0'

staticinheritedInherited from: \ListViewDisplay::$$listViewCounter \ListViewSmarty::$$listViewCounter

Default value0Details

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


                 $lvd= ''

inheritedInherited from: \ListViewSmarty::$$lvd

Details

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


                 $mailMerge= 'true'

inheritedInherited from: \ListViewSmarty::$$mailMerge

Default valuetrueDetails

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


                 $mass= 'null'

inheritedInherited from: \ListViewDisplay::$$mass \ListViewSmarty::$$mass

Default valuenullDetails

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


                 $menu_location= ''top''

inheritedInherited from: \ListViewSmarty::$$menu_location

Default value'top'Details

Type: n/a
Inherited_from: \ListViewSmarty::$$menu_location


                 $mergeDisplayColumns= 'false'

inheritedInherited from: \ListViewDisplay::$$mergeDisplayColumns \ListViewSmarty::$$mergeDisplayColumns

Default valuefalseDetails

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


                 $mergeduplicates= 'true'

inheritedInherited from: \ListViewSmarty::$$mergeduplicates

Default valuetrueDetails

Type: n/a
Inherited_from: \ListViewSmarty::$$mergeduplicates


                 $moduleString= ''

inheritedInherited from: \ListViewSmarty::$$moduleString

Details

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


                 $multiSelect= 'true'

inheritedInherited from: \ListViewSmarty::$$multiSelect

Default valuetrueDetails

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


                 $multi_select_popup= ''

inheritedInherited from: \ListViewDisplay::$$multi_select_popup \ListViewSmarty::$$multi_select_popup

Details

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


                 $quickViewLinks= 'true'

inheritedInherited from: \ListViewSmarty::$$quickViewLinks

Default valuetrueDetails

Type: n/a
Inherited_from: \ListViewSmarty::$$quickViewLinks


                 $rowCount= ''

inheritedInherited from: \ListViewDisplay::$$rowCount \ListViewSmarty::$$rowCount

Details

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


                 $searchColumns= ''

inheritedInherited from: \ListViewSmarty::$$searchColumns

Details

Type: n/a
Inherited_from: \ListViewSmarty::$$searchColumns


                 $seed= ''

inheritedInherited from: \ListViewDisplay::$$seed \ListViewSmarty::$$seed

Details

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


                 $select= 'true'

inheritedInherited from: \ListViewSmarty::$$select

Default valuetrueDetails

Type: n/a
Inherited_from: \ListViewSmarty::$$select


                 $should_process= 'true'

inheritedInherited from: \ListViewDisplay::$$should_process \ListViewSmarty::$$should_process

Default valuetrueDetails

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


                 $showMassupdateFields= 'true'

inheritedInherited from: \ListViewSmarty::$$showMassupdateFields

Default valuetrueDetails

Type: n/a
Inherited_from: \ListViewSmarty::$$showMassupdateFields


                 $show_action_dropdown= 'true'

inheritedInherited from: \ListViewDisplay::$$show_action_dropdown \ListViewSmarty::$$show_action_dropdown

Default valuetrueDetails

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


                 $show_mass_update_form= 'false'

inheritedInherited from: \ListViewDisplay::$$show_mass_update_form \ListViewSmarty::$$show_mass_update_form

Default valuefalseDetails

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


                 $show_plus= 'false'

inheritedInherited from: \ListViewDisplay::$$show_plus \ListViewSmarty::$$show_plus

Default valuefalseDetails

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


                 $ss= ''

inheritedInherited from: \ListViewSmarty::$$ss

Details

Type: n/a
Inherited_from: \ListViewSmarty::$$ss


                 $targetList= 'false'

inheritedInherited from: \ListViewSmarty::$$targetList

Default valuefalseDetails

Type: n/a
Inherited_from: \ListViewSmarty::$$targetList


                 $tpl= ''

inheritedInherited from: \ListViewSmarty::$$tpl

Details

Type: n/a
Inherited_from: \ListViewSmarty::$$tpl

Methods

ListViewDisplay(
          
          )
        
        :
          null

inherited

Constructor

Inherited from: \ListViewDisplay::ListViewDisplay()\ListViewSmarty::ListViewDisplay()

Returns

Type	Description
null

ListViewSmarty(
          
          )
        
        :
          void

inherited

Constructor, Smarty object immediately available after

Inherited from: \ListViewSmarty::ListViewSmarty()

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

inherited

Display the actions link

Inherited from: \ListViewDisplay::buildActionsLink()\ListViewSmarty::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()\ListViewSmarty::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()\ListViewSmarty::buildDeleteLink()

Parameters

Name	Type	Description
$loc

Returns

Type	Description
string	HTML

buildExportLink(
           $loc
              =
              'top'
          )
        
        :
          string

inherited

Builds the export link

Inherited from: \ListViewDisplay::buildExportLink()\ListViewSmarty::buildExportLink()

Parameters

Name	Type	Description
$loc

Returns

Type	Description
string	HTML

buildMassUpdateLink(
           $loc
              =
              'top'
          )
        
        :
          string

inherited

Builds the massupdate link

Inherited from: \ListViewDisplay::buildMassUpdateLink()\ListViewSmarty::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()\ListViewSmarty::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()\ListViewSmarty::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()\ListViewSmarty::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()\ListViewSmarty::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()\ListViewSmarty::buildTargetList()

Parameters

Name	Type	Description
$loc

Returns

Type	Description
string	HTML

display(
          
          )
        
        :
          string

Displays the xtpl, either echo or returning the contents

Returns

Type	Description
string	ListView contents

displayEnd(
          
          )
        
        :
          string

Display the bottom of the ListView (ie MassUpdate

Returns

Type	Description
string	contents

getMassUpdate(
          
          )
        
        :
          \MassUpdate

inherited

Inherited from: \ListViewDisplay::getMassUpdate()\ListViewSmarty::getMassUpdate()

Returns

Type	Description
\MassUpdate	instance

getMultiSelectData(
          
          )
        
        :
          string

inherited

Display the multi select data box etc.

Inherited from: \ListViewDisplay::getMultiSelectData()\ListViewSmarty::getMultiSelectData()

Returns

Type	Description
string	contents

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

inherited

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

Inherited from: \ListViewSmarty::process()

Parameters

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

processArrows(
          \ordering $ordering
          )
        
        :
          void

inherited

Assigns the sort arrows in the tpl

Inherited from: \ListViewSmarty::processArrows()

Parameters

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

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()\ListViewSmarty::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()\ListViewSmarty::setupFilterFields()

Parameters

Name	Type	Description
$filter_fields

shouldProcess(
           $moduleDir
          )
        
        :
          void

inherited

Inherited from: \ListViewDisplay::shouldProcess()\ListViewSmarty::shouldProcess()

Parameters

Name	Type	Description
$moduleDir

modules/Reports/ListViewReports.php

\ListViewReportsjump to top

Properties

Methods

\ListViewReports
jump to top