AbstractDocumentController

abstract class AbstractDocumentController extends Controller (View source)

Abstract Class for Document Controllers Contains the shared logic to display a table of files.

Properties

bool $accessNeedLoggedUser

if this controller need logged user or not

 from  Controller
int $accessRight

Inherited from Controller
bool $controllerStatus

If controller is active

 from  Controller
DoliDB $db

Inherited from Controller
string $tplPath from  Controller
FormListWebPortal $formList from  Controller

Methods

void
__construct()

Constructor

from  Controller
int
action()

Action method is called before html output can be used to manage security and change context

from  Controller
bool
checkAccess()

Check current access to controller

from  Controller
void
display()

Display

from  Controller
void
display404()

Display error template

from  Controller
int
hookDoAction(array<string, mixed> $parameters = array())

Execute hook doActions

from  Controller
int
hookPrintPageView(array<string, mixed> $parameters = array())

Execute hook PrintPageView

from  Controller
bool
loadTemplate(string $templateName, mixed $vars = false)

Load a template .tpl file

from  Controller
void
displayDocumentTable(string $title, array<int, array<string, mixed>> $itemList, string $emptyMessage, array $linkBuilder)

Renders an HTML file browser table for a given list of files and directories.

Details

in Controller at line 70
void __construct()

Constructor

Return Value

void

in Controller at line 86
int action()

Action method is called before html output can be used to manage security and change context

Return Value

int

Return integer < 0 on error, > 0 on success

in Controller at line 98
bool checkAccess()

Check current access to controller

Return Value

bool

in Controller at line 129
void display()

Display

Return Value

void

in Controller at line 149
void display404()

Display error template

Return Value

void

in Controller at line 162
int hookDoAction(array<string, mixed> $parameters = array())

Execute hook doActions

Parameters

array<string, mixed> $parameters Parameters

Return Value

int

Return integer < 0 on error, 0 on success, 1 to replace standard code

in Controller at line 185
int hookPrintPageView(array<string, mixed> $parameters = array())

Execute hook PrintPageView

Parameters

array<string, mixed> $parameters Parameters

Return Value

int

Return integer < 0 on error, 0 on success, 1 to replace standard code

in Controller at line 209
bool loadTemplate(string $templateName, mixed $vars = false)

Load a template .tpl file

Parameters

string $templateName

Template file name (without the .tpl.php)
mixed $vars

Data to transmit to template

Return Value

bool

True if template found, else false

at line 36
protected void displayDocumentTable(string $title, array<int, array<string, mixed>> $itemList, string $emptyMessage, array $linkBuilder)

Renders an HTML file browser table for a given list of files and directories.

Parameters

string $title

The main H2 title for the page.
array<int, array<string, mixed>> $itemList

The list of items from dol_dir_list('all').
string $emptyMessage

The message to display if the list is empty.
array $linkBuilder

An array of functions to build URLs ('dir' and 'file').

Return Value

void