Documentation

Users_ListAjax_View extends Users_List_View
in package
Uses ExposeMethod, ClearProcess

Table of Contents

$listViewModel  : Vtiger_ListView_Model
List view model instance.
$exposedMethods  : array<string|int, string>
Control the exposure of methods to be invoked from client (kind-of RPC).
__construct()  : mixed
{@inheritdoc}
checkPermission()  : mixed
Only administrator user can access settings.
getFooterScripts()  : mixed
{@inheritdoc}
getListViewCount()  : mixed
Function to get listView count.
getPageCount()  : total
Function to get the page count for list.
getRecordsCount()  : mixed
Function returns the number of records for the current filter.
initializeListViewContents()  : mixed
Function to initialize the required data in smarty to display the List View Contents.
invokeExposedMethod()  : type
Function invokes exposed methods for this class.
isMethodExposed()  : bool
Function checks if the method is exposed for client usage.
postProcess()  : mixed
Empty pos process.
preProcess()  : mixed
Empty pre process.
process()  : mixed
{@inheritdoc}
exposeMethod()  : mixed
Function that will expose methods for external access.

Properties

$listViewModel

List view model instance.

public Vtiger_ListView_Model $listViewModel

$exposedMethods

Control the exposure of methods to be invoked from client (kind-of RPC).

protected array<string|int, string> $exposedMethods = []

Methods

__construct()

{@inheritdoc}

public __construct() : mixed
Return values
mixed —

getFooterScripts()

{@inheritdoc}

public getFooterScripts(Request $request) : mixed
Parameters
$request : Request
Return values
mixed —

getListViewCount()

Function to get listView count.

public getListViewCount(Request $request) : mixed
Parameters
$request : Request
Return values
mixed —

getPageCount()

Function to get the page count for list.

public getPageCount(Request $request) : total
Parameters
$request : Request
Return values
total —

number of pages

getRecordsCount()

Function returns the number of records for the current filter.

public getRecordsCount(Request $request) : mixed
Parameters
$request : Request
Return values
mixed —

initializeListViewContents()

Function to initialize the required data in smarty to display the List View Contents.

public initializeListViewContents(Request $request, Vtiger_Viewer $viewer) : mixed
Parameters
$request : Request
$viewer : Vtiger_Viewer
Return values
mixed —

invokeExposedMethod()

Function invokes exposed methods for this class.

public invokeExposedMethod() : type
Tags
throws
AppException
Return values
type —

isMethodExposed()

Function checks if the method is exposed for client usage.

public isMethodExposed(string $name) : bool
Parameters
$name : string
  • method name
Return values
bool —

postProcess()

Empty pos process.

public postProcess(Request $request[, bool $display = true ]) : mixed
Parameters
$request : Request
$display : bool = true
Return values
mixed —

preProcess()

Empty pre process.

public preProcess(Request $request[, bool $display = true ]) : mixed
Parameters
$request : Request
$display : bool = true
Return values
mixed —

process()

{@inheritdoc}

public process(Request $request) : mixed
Parameters
$request : Request
Return values
mixed —

exposeMethod()

Function that will expose methods for external access.

protected exposeMethod(string $name) : mixed
Parameters
$name : string
  • method name
Return values
mixed — 

        

        
    




    

    

                

    

        

            
Search results