dolibarr 18.0.6
FormProjets Class Reference

Class to manage building of HTML components. More...

Public Member Functions

 __construct ($db)
 Constructor.
 
 select_projects ($socid=-1, $selected='', $htmlname='projectid', $maxlength=16, $option_only=0, $show_empty=1, $discard_closed=0, $forcefocus=0, $disabled=0, $mode=0, $filterkey='', $nooutput=0, $forceaddid=0, $morecss='', $htmlid='', $morefilter='')
 Output a combo list with projects qualified for a third party / user.
 
 select_projects_list ($socid=-1, $selected='', $htmlname='projectid', $maxlength=24, $option_only=0, $show_empty=1, $discard_closed=0, $forcefocus=0, $disabled=0, $mode=0, $filterkey='', $nooutput=0, $forceaddid=0, $htmlid='', $morecss='maxwidth500', $morefilter='')
 Returns an array with projects qualified for a third party.
 
 selectTasks ($socid=-1, $selected='', $htmlname='taskid', $maxlength=24, $option_only=0, $show_empty='1', $discard_closed=0, $forcefocus=0, $disabled=0, $morecss='maxwidth500', $projectsListId='', $showmore='all', $usertofilter=null)
 Output a combo list with tasks qualified for a third party.
 
 select_element ($table_element, $socid=0, $morecss='', $limitonstatus=-2, $projectkey="fk_projet", $placeholder='')
 Build a HTML select list of element of same thirdparty to suggest to link them to project.
 
 selectOpportunityStatus ($htmlname, $preselected='-1', $showempty=1, $useshortlabel=0, $showallnone=0, $showpercent=0, $morecss='', $noadmininfo=0, $addcombojs=0)
 Build a HTML select list of element of same thirdparty to suggest to link them to project.
 
 selectInvoiceAndLine ($selectedInvoiceId=0, $selectedLineId=0, $htmlNameInvoice='invoiceid', $htmlNameInvoiceLine='invoicelineid', $morecss='maxwidth500', $filters=array(), $lineOnly=0)
 Output a combo list with invoices and lines qualified for a project.
 

Detailed Description

Class to manage building of HTML components.

Definition at line 30 of file html.formprojet.class.php.

Constructor & Destructor Documentation

◆ __construct()

FormProjets::__construct ( $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 53 of file html.formprojet.class.php.

Member Function Documentation

◆ select_element()

FormProjets::select_element ( $table_element,
$socid = 0,
$morecss = '',
$limitonstatus = -2,
$projectkey = "fk_projet",
$placeholder = '' )

Build a HTML select list of element of same thirdparty to suggest to link them to project.

Parameters
string$table_elementTable of the element to update
string$socidIf of thirdparty to use as filter or 'id1,id2,...'
string$morecssMore CSS
int$limitonstatusAdd filters to limit length of list to opened status (for example to avoid ERR_RESPONSE_HEADERS_TOO_BIG on project/element.php page). TODO To implement
string$projectkeyEquivalent key to fk_projet for actual table_element
string$placeholderPlaceholder
Returns
int|string The HTML select list of element or '' if nothing or -1 if KO

Definition at line 529 of file html.formprojet.class.php.

References dol_print_error(), dol_syslog(), and getEntity().

◆ select_projects()

FormProjets::select_projects ( $socid = -1,
$selected = '',
$htmlname = 'projectid',
$maxlength = 16,
$option_only = 0,
$show_empty = 1,
$discard_closed = 0,
$forcefocus = 0,
$disabled = 0,
$mode = 0,
$filterkey = '',
$nooutput = 0,
$forceaddid = 0,
$morecss = '',
$htmlid = '',
$morefilter = '' )

Output a combo list with projects qualified for a third party / user.

Parameters
int$socidId third party (-1=all, 0=only projects not linked to a third party, id=projects not linked or linked to third party id)
string | Project$selectedId of preselected project or Project (or ''). Note: If you know the ref, you can also provide it into $selected_input_value to save one request in some cases.
string$htmlnameName of HTML field
int$maxlengthMaximum length of label
int$option_onlyReturn only html options lines without the select tag
int | string$show_emptyAdd an empty line
int$discard_closedDiscard closed projects (0=Keep, 1=hide completely, 2=Disable). Use a negative value to not show the "discarded" tooltip.
int$forcefocusForce focus on field (works with javascript only)
int$disabledDisabled
int$mode0 for HTML mode and 1 for JSON mode
string$filterkeyKey to filter on ref or title
int$nooutputNo print output. Return it only.
int$forceaddidForce to add project id in list, event if not qualified
string$morecssMore css
int$htmlidHtml id to use instead of htmlname
string$morefilterMore filters (Must be a sql sanitized string)
Returns
string Return html content

Definition at line 81 of file html.formprojet.class.php.

References ajax_autocompleter(), and select_projects_list().

◆ select_projects_list()

FormProjets::select_projects_list ( $socid = -1,
$selected = '',
$htmlname = 'projectid',
$maxlength = 24,
$option_only = 0,
$show_empty = 1,
$discard_closed = 0,
$forcefocus = 0,
$disabled = 0,
$mode = 0,
$filterkey = '',
$nooutput = 0,
$forceaddid = 0,
$htmlid = '',
$morecss = 'maxwidth500',
$morefilter = '' )

Returns an array with projects qualified for a third party.

Parameters
int$socidId third party (-1=all, 0=only projects not linked to a third party, id=projects not linked or linked to third party id)
int$selectedId project preselected
string$htmlnameNom de la zone html
int$maxlengthMaximum length of label
int$option_onlyReturn only html options lines without the select tag
int | string$show_emptyAdd an empty line
int$discard_closedDiscard closed projects (0=Keep,1=hide completely,2=Disable)
int$forcefocusForce focus on field (works with javascript only)
int$disabledDisabled
int$mode0 for HTML mode and 1 for array return (to be used by json_encode for example)
string$filterkeyKey to filter on title or ref
int$nooutputNo print output. Return it only.
int$forceaddidForce to add project id in list, event if not qualified
int$htmlidHtml id to use instead of htmlname
string$morecssMore CSS
string$morefilterMore filters (Must be a sql sanitized string)
Returns
int|string|array HTML string or array of option or <0 if KO

Definition at line 150 of file html.formprojet.class.php.

References ajax_combobox(), dol_print_error(), dol_trunc(), getEntity(), and natural_search().

Referenced by select_projects().

◆ selectInvoiceAndLine()

FormProjets::selectInvoiceAndLine ( $selectedInvoiceId = 0,
$selectedLineId = 0,
$htmlNameInvoice = 'invoiceid',
$htmlNameInvoiceLine = 'invoicelineid',
$morecss = 'maxwidth500',
$filters = array(),
$lineOnly = 0 )

Output a combo list with invoices and lines qualified for a project.

Parameters
int$selectedInvoiceIdId invoice preselected
int$selectedLineIdId invoice line preselected
string$htmlNameInvoiceName of HTML select for Invoice
int$htmlNameInvoiceLineName of HTML select for Invoice Line
string$morecssMore css added to the select component
array$filtersArray of filters
int$lineOnlyreturn only option for line
Returns
string HTML Select

Definition at line 771 of file html.formprojet.class.php.

References ajax_combobox(), dol_buildpath(), dol_print_error(), and getEntity().

◆ selectOpportunityStatus()

FormProjets::selectOpportunityStatus ( $htmlname,
$preselected = '-1',
$showempty = 1,
$useshortlabel = 0,
$showallnone = 0,
$showpercent = 0,
$morecss = '',
$noadmininfo = 0,
$addcombojs = 0 )

Build a HTML select list of element of same thirdparty to suggest to link them to project.

Parameters
string$htmlnameHTML name
string$preselectedPreselected (int or 'all' or 'none')
int$showemptyAdd an empty line
int$useshortlabelUse short label
int$showallnoneAdd choice "All" and "None"
int$showpercentShow default probability for status
string$morecssAdd more css
int$noadmininfo0=Add admin info, 1=Disable admin info
int$addcombojs1=Add a js combo
Returns
int|string The HTML select list of element or '' if nothing or -1 if KO

Definition at line 687 of file html.formprojet.class.php.

References ajax_combobox(), dol_syslog(), and info_admin().

◆ selectTasks()

FormProjets::selectTasks ( $socid = -1,
$selected = '',
$htmlname = 'taskid',
$maxlength = 24,
$option_only = 0,
$show_empty = '1',
$discard_closed = 0,
$forcefocus = 0,
$disabled = 0,
$morecss = 'maxwidth500',
$projectsListId = '',
$showmore = 'all',
$usertofilter = null )

Output a combo list with tasks qualified for a third party.

Parameters
int$socidId third party (-1=all, 0=only projects not linked to a third party, id=projects not linked or linked to third party id)
int$selectedId task preselected
string$htmlnameName of HTML select
int$maxlengthMaximum length of label
int$option_onlyReturn only html options lines without the select tag
string$show_emptyAdd an empty line ('1' or string to show for empty line)
int$discard_closedDiscard closed projects (0=Keep, 1=hide completely, 2=Disable)
int$forcefocusForce focus on field (works with javascript only)
int$disabledDisabled
string$morecssMore css added to the select component
string$projectsListId''=Automatic filter on project allowed. List of id=Filter on project ids.
string$showmore'all' = Show project info, 'progress' = Show task progression, ''=Show nothing more
User$usertofilterUser object to use for filtering
Returns
int Nbr of tasks if OK, <0 if KO

Definition at line 336 of file html.formprojet.class.php.

References ajax_combobox(), dol_escape_htmltag(), dol_print_error(), dol_trunc(), getEntity(), Project\STATUS_CLOSED, and Project\STATUS_DRAFT.


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