ZurmoPaginationHelper Class Reference

Public Member Functions

 setListPageSize ($value)
 setSubListPageSize ($value)
 setModalListPageSize ($value)
 setDashboardListPageSize ($value)
 setMassEditProgressPageSize ($value)
 setImportPageSize ($value)
 setAutoCompleteListPageSize ($value)
 setMassDeleteProgressPageSize ($value)
 setReportResultsListPageSize ($value)
 setReportResultsSubListPageSize ($value)
 setApiListPageSize ($value)
 resolveActiveForCurrentUserByType ($type, $moduleName=null)
 getForCurrentUserByType ($type, $moduleName=null)
 setForCurrentUserByType ($type, $value, $moduleName=null)
 getByUserAndType ($user, $type, $moduleName=null)
 setByUserAndType ($user, $type, $value, $moduleName=null)
 getGlobalValueByType ($type, $moduleName=null)
 setGlobalValueByType ($type, $value, $moduleName=null)

Protected Member Functions

 getKeyByTypeAndModuleName ($type, $moduleName=null)

Static Protected Member Functions

static getAvailablePageSizeNames ()

Protected Attributes

 $_listPageSize
 $_subListPageSize
 $_modalListPageSize
 $_dashboardListPageSize
 $_massEditProgressPageSize
 $_importPageSize
 $_autoCompleteListPageSize
 $_apiListPageSize
 $_massDeleteProgressPageSize
 $_reportResultsListPageSize
 $_reportResultsSubListPageSize

Detailed Description

Helper class for handling pagination settings in the application. Pagination settings by module will default to the general 'type'pageSize setting if its configuration value is not found. This component is available via Yii::app()->pagination.

Definition at line 42 of file ZurmoPaginationHelper.php.


Member Function Documentation

setListPageSize ( value  ) 

This is set from the value in the application common config file. It is used as the final fall back if no other configuration settings are found.

Definition at line 104 of file ZurmoPaginationHelper.php.

setSubListPageSize ( value  ) 

This is set from the value in the application common config file. It is used as the final fall back if no other configuration settings are found.

Definition at line 113 of file ZurmoPaginationHelper.php.

setModalListPageSize ( value  ) 

This is set from the value in the application common config file. It is used as the final fall back if no other configuration settings are found.

Definition at line 122 of file ZurmoPaginationHelper.php.

setDashboardListPageSize ( value  ) 

This is set from the value in the application common config file. It is used as the final fall back if no other configuration settings are found.

Definition at line 131 of file ZurmoPaginationHelper.php.

setMassEditProgressPageSize ( value  ) 

This is set from the value in the application common config file. It is used as the final fall back if no other configuration settings are found.

Definition at line 140 of file ZurmoPaginationHelper.php.

setImportPageSize ( value  ) 

This is set from the value in the application common config file. It is used as the final fall back if no other configuration settings are found.

Definition at line 149 of file ZurmoPaginationHelper.php.

setAutoCompleteListPageSize ( value  ) 

This is set from the value in the application common config file. It is used as the final fall back if no other configuration settings are found.

Definition at line 158 of file ZurmoPaginationHelper.php.

setMassDeleteProgressPageSize ( value  ) 

This is set from the value in application common config file. It is used as the final fall back if no other configuration settings are found.

Definition at line 166 of file ZurmoPaginationHelper.php.

setReportResultsListPageSize ( value  ) 

This is set from the value in the application common config file. It is used as the final fall back if no other configuration settings are found.

Definition at line 175 of file ZurmoPaginationHelper.php.

setReportResultsSubListPageSize ( value  ) 

This is set from the value in the application common config file. It is used as the final fall back if no other configuration settings are found.

Definition at line 184 of file ZurmoPaginationHelper.php.

setApiListPageSize ( value  ) 

This is set from the value in the application common config file. It is used as the final fall back if no other configuration settings are found.

Definition at line 193 of file ZurmoPaginationHelper.php.

resolveActiveForCurrentUserByType ( type,
moduleName = null 
)

Call method to get the active value for a particular pagination type. If the active value doesnt exist as a state on the currenet user, set the active value from the configuration setting and return the active value.

Parameters:
$type - pagination type
$moduleName - optional. Module class name.
Returns:
$pageSize - integer.

Definition at line 206 of file ZurmoPaginationHelper.php.

getForCurrentUserByType ( type,
moduleName = null 
)

Get the pagination value for the current user by pagination type.

Parameters:
$type - pagination type
$moduleName - optional. Module class name.
Returns:
$pageSize - integer.

Definition at line 225 of file ZurmoPaginationHelper.php.

setForCurrentUserByType ( type,
value,
moduleName = null 
)

Set the pagination value for the current user by pagination type. Also sets value as active state value by key.

Parameters:
$type - pagination type
$moduleName - optional. Module class name.

Definition at line 243 of file ZurmoPaginationHelper.php.

getByUserAndType ( user,
type,
moduleName = null 
)

Get the pagination value for the specified user by pagination type.

Parameters:
$user - user model
$type - pagination type
$moduleName - optional. Module class name.
Returns:
$pageSize - integer.

Definition at line 260 of file ZurmoPaginationHelper.php.

setByUserAndType ( user,
type,
value,
moduleName = null 
)

Set the pagination value for the specified user by pagination type.

Parameters:
$user - user model
$type - pagination type
$moduleName - optional. Module class name.

Definition at line 279 of file ZurmoPaginationHelper.php.

getGlobalValueByType ( type,
moduleName = null 
)

Get the global pagination value by pagination type.

Parameters:
$type - pagination type
$moduleName - optional. Module class name.
Returns:
$pageSize - integer.

Definition at line 295 of file ZurmoPaginationHelper.php.

setGlobalValueByType ( type,
value,
moduleName = null 
)

Set the global pagination value by pagination type.

Parameters:
$type - pagination type
$value - integer pagination value.
$moduleName - optional. Module class name.

Definition at line 313 of file ZurmoPaginationHelper.php.


Field Documentation

$_listPageSize [protected]

general list page size.

Definition at line 47 of file ZurmoPaginationHelper.php.

$_subListPageSize [protected]

Detailview's sub view lists page size.

Definition at line 52 of file ZurmoPaginationHelper.php.

$_modalListPageSize [protected]

Popup/Modal list page size.

Definition at line 57 of file ZurmoPaginationHelper.php.

$_dashboardListPageSize [protected]

Dashboard portlets list page size.

Definition at line 62 of file ZurmoPaginationHelper.php.

$_massEditProgressPageSize [protected]

When a mass edit must complete using a progress bar, this is how many are processed at once.

Definition at line 67 of file ZurmoPaginationHelper.php.

$_importPageSize [protected]

How many records to import at one time.

Definition at line 72 of file ZurmoPaginationHelper.php.

$_autoCompleteListPageSize [protected]

When using the auto complete functionality on an input field, this is how many values are returned per search.

Definition at line 78 of file ZurmoPaginationHelper.php.

$_apiListPageSize [protected]

Default list page size for api calls.

Definition at line 83 of file ZurmoPaginationHelper.php.

$_massDeleteProgressPageSize [protected]

When a mass delete must complete using a progress bar, this is how many are processed at once.

Definition at line 88 of file ZurmoPaginationHelper.php.

$_reportResultsListPageSize [protected]

The report results list page size

Definition at line 93 of file ZurmoPaginationHelper.php.

$_reportResultsSubListPageSize [protected]

The report results drill-down page size

Definition at line 98 of file ZurmoPaginationHelper.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Thu Aug 17 07:10:32 2017