dolibarr 24.0.0-beta
DocumentListController Class Reference

Class for DocumentListController. More...

Inheritance diagram for DocumentListController:
Collaboration diagram for DocumentListController:

Public Member Functions

 checkAccess ()
 Check access rights for this page.
 
 action ()
 Action method is called before HTML output.
 
 display ()
 Build and display the page.
 
- Public Member Functions inherited from Controller
 __construct ()
 Constructor.
 
 display404 ()
 Display error template.
 
 hookDoAction ($parameters=array())
 Execute hook doActions.
 
 hookPrintPageView ($parameters=array())
 Execute hook PrintPageView.
 
 loadTemplate ($templateName, $vars=false)
 Load a template .tpl file.
 

Additional Inherited Members

- Protected Member Functions inherited from AbstractDocumentController
 displayDocumentTable ($title, $itemList, $emptyMessage, array $linkBuilder)
 Renders an HTML file browser table for a given list of files and directories.
 

Detailed Description

Class for DocumentListController.

@method void display404() @method bool loadTemplate(string $templateName, false|mixed $vars = false)

Definition at line 37 of file documentlist.controller.class.php.

Member Function Documentation

◆ action()

DocumentListController::action ( )

Action method is called before HTML output.

Returns
int Returns >0 on success, <0 on error.

Reimplemented from Controller.

Definition at line 55 of file documentlist.controller.class.php.

References $context, and Context\getInstance().

◆ checkAccess()

DocumentListController::checkAccess ( )

Check access rights for this page.

Returns
bool

Reimplemented from Controller.

Definition at line 44 of file documentlist.controller.class.php.

References getDolGlobalInt().

◆ display()

DocumentListController::display ( )

Build and display the page.

Returns
void

Get url for file (anonymous function)

Parameters
array<string,mixed>$file File (array) to get url for
Returns
string Url for file

Reimplemented from Controller.

Definition at line 76 of file documentlist.controller.class.php.

References $conf, $context, Controller\display404(), AbstractDocumentController\displayDocumentTable(), dol_dir_list(), Context\getInstance(), and Controller\loadTemplate().


The documentation for this class was generated from the following file: