ModeleBoxes Class Reference

Class ModeleBoxes. More...

Inheritance diagram for ModeleBoxes:

Public Member Functions
	__construct ($db, $param='')
	Constructor.
	loadBox ($max=5)
	Load data for box to show them later.
	error ()
	Return last error message.
	fetch ($rowid)
	Load a box line from its rowid.
	showBox ($head=null, $contents=null, $nooutput=0)
	Standard method to show a box (usage by boxes not mandatory, a box can still use its own showBox function)

Static Public Member Functions
static	getWidgetsList ($forcedirwidget=null)
	Return list of widget.

Detailed Description

Class ModeleBoxes.

Boxes parent class

Definition at line 35 of file modules_boxes.php.

Constructor & Destructor Documentation

__construct()

ModeleBoxes::__construct	(		$db,
			$param = '' )

Constructor.

Parameters

DoliDB	$db	Database handler
string	$param	More parameters

Reimplemented in box_accountancy_last_manual_entries, box_accountancy_suspense_account, box_actions, box_actions_future, box_activity, box_birthdays, box_birthdays_members, box_boms, box_bookmarks, box_clients, box_commandes, box_comptes, box_contacts, box_contracts, box_customers_outstanding_bill_reached, box_dolibarr_state_board, box_external_rss, box_factures, box_factures_fourn, box_factures_fourn_imp, box_factures_imp, box_fediverse, box_ficheinter, box_fournisseurs, box_funnel_of_prospection, box_goodcustomers, box_graph_invoices_permonth, box_graph_invoices_peryear, box_graph_invoices_supplier_permonth, box_graph_nb_ticket_last_x_days, box_graph_nb_tickets_type, box_graph_new_vs_close_ticket, box_graph_orders_permonth, box_graph_orders_supplier_permonth, box_graph_product_distribution, box_graph_propales_permonth, box_graph_ticket_by_severity, box_last_knowledgerecord, box_last_modified_knowledgerecord, box_last_modified_ticket, box_last_ticket, box_lastlogin, box_members_by_tags, box_members_by_type, box_members_last_modified, box_members_last_subscriptions, box_members_subscriptions_by_year, box_mos, box_produits, box_produits_alerte_stock, box_project, box_project_opportunities, box_propales, box_prospect, box_scheduled_jobs, box_services_contracts, box_services_expired, box_shipments, box_supplier_orders, box_supplier_orders_awaiting_reception, box_task, and box_validated_projects.

Definition at line 178 of file modules_boxes.php.

Member Function Documentation

error()

ModeleBoxes::error

(

)

Return last error message.

Returns

string Error message

Definition at line 204 of file modules_boxes.php.

fetch()

ModeleBoxes::fetch

(

$rowid

)

Load a box line from its rowid.

Parameters

int

$rowid

Row id to load

Returns

int<-1,1> Return integer <0 if KO, >0 if OK

Definition at line 217 of file modules_boxes.php.

References dol_syslog(), and position.

getWidgetsList()

static ModeleBoxes::getWidgetsList ( $forcedirwidget = null )

static

Return list of widget.

Function used by admin page htdoc/admin/widget. List is sorted by widget filename so by priority to run.

Parameters

?string[]

$forcedirwidget

null=All default directories. This parameter is used by modulebuilder module only.

Returns

array<array{picto:string,file:string,fullpath:string,relpath:string,iscoreorexternal:'external'|'internal',version:string,status:string,info:string}> Array list of widgets

Definition at line 492 of file modules_boxes.php.

References dol_buildpath(), dol_osencode(), img_object(), and img_picto().

loadBox()

ModeleBoxes::loadBox

(

$max = 5

)

Load data for box to show them later.

Parameters

int

$max

Maximum number of records to load

Returns

void

Reimplemented in box_accountancy_last_manual_entries, box_accountancy_suspense_account, box_actions, box_actions_future, box_activity, box_birthdays, box_birthdays_members, box_boms, box_bookmarks, box_clients, box_commandes, box_comptes, box_contacts, box_contracts, box_customers_outstanding_bill_reached, box_dolibarr_state_board, box_factures, box_factures_fourn, box_factures_fourn_imp, box_factures_imp, box_ficheinter, box_fournisseurs, box_funnel_of_prospection, box_goodcustomers, box_graph_invoices_permonth, box_graph_invoices_peryear, box_graph_invoices_supplier_permonth, box_graph_nb_ticket_last_x_days, box_graph_nb_tickets_type, box_graph_new_vs_close_ticket, box_graph_orders_permonth, box_graph_orders_supplier_permonth, box_graph_product_distribution, box_graph_propales_permonth, box_graph_ticket_by_severity, box_last_knowledgerecord, box_last_modified_knowledgerecord, box_last_modified_ticket, box_last_ticket, box_lastlogin, box_members_by_tags, box_members_by_type, box_members_last_modified, box_members_last_subscriptions, box_members_subscriptions_by_year, box_mos, box_produits, box_produits_alerte_stock, box_project, box_project_opportunities, box_propales, box_prospect, box_scheduled_jobs, box_services_contracts, box_services_expired, box_shipments, box_supplier_orders, box_supplier_orders_awaiting_reception, box_task, box_validated_projects, and mymodulewidget1.

Definition at line 191 of file modules_boxes.php.

References dol_syslog().

showBox()

ModeleBoxes::showBox	(		$head = null,
			$contents = null,
			$nooutput = 0 )

Standard method to show a box (usage by boxes not mandatory, a box can still use its own showBox function)

Parameters

?array<array{text?:string,sublink?:string,subtext?:string,subpicto?:?string,picto?:string,nbcol?:int,limit?:int,subclass?:string,graph?:int<0,1>,target?:string}>	$head Array with properties of box title
?array<array{tr?:string,td?:string,target?:string,text?:string,text2?:string,textnoformat?:string,tooltip?:string,logo?:string,url?:string,maxlength?:int,asis?:int<0,1>}>	$contents Array with properties of box lines
int<0,1>	$nooutput No print, only return string

Returns

string

Reimplemented in box_accountancy_last_manual_entries, box_accountancy_suspense_account, box_actions, box_actions_future, box_activity, box_birthdays, box_birthdays_members, box_boms, box_bookmarks, box_clients, box_commandes, box_comptes, box_contacts, box_contracts, box_customers_outstanding_bill_reached, box_dolibarr_state_board, box_external_rss, box_factures, box_factures_fourn, box_factures_fourn_imp, box_factures_imp, box_fediverse, box_ficheinter, box_fournisseurs, box_funnel_of_prospection, box_goodcustomers, box_graph_invoices_permonth, box_graph_invoices_peryear, box_graph_invoices_supplier_permonth, box_graph_nb_ticket_last_x_days, box_graph_nb_tickets_type, box_graph_new_vs_close_ticket, box_graph_orders_permonth, box_graph_orders_supplier_permonth, box_graph_product_distribution, box_graph_propales_permonth, box_graph_ticket_by_severity, box_last_knowledgerecord, box_last_modified_knowledgerecord, box_last_modified_ticket, box_last_ticket, box_lastlogin, box_members_by_tags, box_members_by_type, box_members_last_modified, box_members_last_subscriptions, box_members_subscriptions_by_year, box_mos, box_produits, box_produits_alerte_stock, box_project, box_project_opportunities, box_propales, box_prospect, box_scheduled_jobs, box_services_contracts, box_services_expired, box_shipments, box_supplier_orders, box_supplier_orders_awaiting_reception, box_task, box_validated_projects, and mymodulewidget1.

Definition at line 256 of file modules_boxes.php.

References dol_cache_refresh(), dol_escape_htmltag(), dol_filecache(), dol_readcachefile(), dol_syslog(), dol_trunc(), getDolGlobalString(), img_object(), and img_picto().

---

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

• dolibarr_dev/htdocs/core/boxes/modules_boxes.php