class OrderListController extends AbstractListController (View source)

Class for OrderListController

Properties

bool $accessNeedLoggedUser

if this controller need logged user or not

from  Controller
bool $accessRight

define current user access

from  Controller
bool $controllerStatus

If controller is active

from  Controller
DoliDB $db from  Controller
string $tplPath from  Controller
FormListWebPortal $formList from  AbstractListController

Methods

void
__construct()

Constructor

int
action()

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

bool
checkAccess()

Check current access to controller

void
display()

Display

void
display404()

Display error template

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

Execute hook doActions

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

Execute hook PrintPageView

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

Load a template .tpl file

void
listSetArrayFields()

Set array fields

void
listSetSearchValues(bool $clear = false)

Set search values

string
listPrintValueBefore(string $field_key, array<string, mixed> $field_spec, stdClass $record)

Called before print value for list

string
listPrintValueAfter(string $field_key, array<string, mixed> $field_spec, stdClass $record, string $out)

Called after print value for list

Details

void __construct()

Constructor

Return Value

void

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

bool checkAccess()

Check current access to controller

Return Value

bool

void display()

Display

Return Value

void

void display404()

Display error template

Return Value

void

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

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

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

void listSetArrayFields()

Set array fields

Return Value

void

void listSetSearchValues(bool $clear = false)

Set search values

Parameters

bool $clear

Clear search values

Return Value

void

string listPrintValueBefore(string $field_key, array<string, mixed> $field_spec, stdClass $record)

Called before print value for list

Parameters

string $field_key

Field key

array<string, mixed> $field_spec

Field specification

stdClass $record

Contain data of object from database

Return Value

string

HTML input

string listPrintValueAfter(string $field_key, array<string, mixed> $field_spec, stdClass $record, string $out)

Called after print value for list

Parameters

string $field_key

Field key

array<string, mixed> $field_spec

Field specification

stdClass $record

Contain data of object from database

string $out

Current HTML input

Return Value

string

HTML input