class FormListWebPortal (View source)

Class to manage generation of HTML components Only common components for WebPortal must be here.

Properties

DoliDB $db
AbstractListController $controller
string $element
string $contextpage
string $action
FormWebPortal $form
CommonObject $object
string $titleKey
string $titleDescKey
int $limit
int $page
string $sql_select
string $sql_body
string $sql_order
string $emptyValueKey
int $offset
string $sortfield
string $sortorder
array<string, array{type?: string, label: string, checked: int<0, 1>, visible: int<0, 1>, enabled: bool|int<0, 1>, position: int, help: string}> $arrayfields
$search
string $search_all
array<string, string> $fields_to_search_all
string $params
int $nbtotalofrecords
stdClass> $records
int $nbColumn
Societe> $companyStaticList

Methods

__construct(DoliDB $db)

Constructor

void
init(AbstractListController $controller, string $elementEn)

Init

void
doActions()

Do actions

void
setArrayFields()

Set array fields

void
setColumnsVisibility()

Set columns visibility

void
setSearchValues(bool $clear = false)

Set search values

void
setSqlRequest()

set SQL request

void
loadRecords()

Load record from SQL request

void
setParams()

Set params

string
printSearchInput(string $field_key, array<string, mixed> $field_spec)

Print input field for search list

void
setVarsFromFetchObj(stdClass $record)

Function to load data from a SQL pointer into properties of current object $this

string
printValue(string $field_key, array<string, mixed> $field_spec, stdClass $record, int $i, array<string, mixed> $totalarray)

Print value for list

void
setTotalValue(string $field_key, array<string, mixed> $field_spec, stdClass $record, int $i, array<string, mixed> $totalarray)

Set total value for list

string
getClasseCssList(string $field_key, array<string, mixed> $field_spec, bool $for_value = false)

Get class css list

Details

__construct(DoliDB $db)

Constructor

Parameters

DoliDB $db

Database handler

void init(AbstractListController $controller, string $elementEn)

Init

Parameters

AbstractListController $controller

Controller handler

string $elementEn

Element (english) : "propal", "order", "invoice"

Return Value

void

void doActions()

Do actions

Return Value

void

void setArrayFields()

Set array fields

Return Value

void

void setColumnsVisibility()

Set columns visibility

Return Value

void

void setSearchValues(bool $clear = false)

Set search values

Parameters

bool $clear

Clear search values

Return Value

void

void setSqlRequest()

set SQL request

Return Value

void

void loadRecords()

Load record from SQL request

Return Value

void

void setParams()

Set params

Return Value

void

string printSearchInput(string $field_key, array<string, mixed> $field_spec)

Print input field for search list

Parameters

string $field_key

Field key

array<string, mixed> $field_spec

Field specification

Return Value

string

HTML input

void setVarsFromFetchObj(stdClass $record)

Function to load data from a SQL pointer into properties of current object $this

Parameters

stdClass $record

Contain data of object from database

Return Value

void

string printValue(string $field_key, array<string, mixed> $field_spec, stdClass $record, int $i, array<string, mixed> $totalarray)

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

int $i

Index line (0, 1, 2, ...)

array<string, mixed> $totalarray

Array for total line

Return Value

string

HTML input

void setTotalValue(string $field_key, array<string, mixed> $field_spec, stdClass $record, int $i, array<string, mixed> $totalarray)

Set total value for list

Parameters

string $field_key

Field key

array<string, mixed> $field_spec

Field specification

stdClass $record

Contain data of object from database

int $i

Index line (0, 1, 2, ...)

array<string, mixed> $totalarray

Array for total line

Return Value

void

string getClasseCssList(string $field_key, array<string, mixed> $field_spec, bool $for_value = false)

Get class css list

Parameters

string $field_key

Field key

array<string, mixed> $field_spec

Field specification

bool $for_value

For td of value

Return Value

string

Class used for list