dolibarr  9.0.0
Public Member Functions | List of all members
FormProjets Class Reference

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

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 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='')
 Output a combo list with projects qualified for a third party / user. More...
 
 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')
 Returns an array with projects qualified for a third party. More...
 
 selectTasks ($socid=-1, $selected='', $htmlname='taskid', $maxlength=24, $option_only=0, $show_empty='1', $discard_closed=0, $forcefocus=0, $disabled=0, $morecss='maxwidth500', $projectsListId='', $showproject='all', $usertofilter=null)
 Output a combo list with tasks qualified for a third party. More...
 
 select_element ($table_element, $socid=0, $morecss='', $limitonstatus=-2, $projectkey="fk_projet")
 Build a HTML select list of element of same thirdparty to suggest to link them to project. More...
 
 selectOpportunityStatus ($htmlname, $preselected='-1', $showempty=1, $useshortlabel=0, $showallnone=0, $showpercent=0, $morecss='')
 Build a HTML select list of element of same thirdparty to suggest to link them to project. More...
 

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 48 of file html.formprojet.class.php.

Member Function Documentation

◆ select_element()

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

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
Returns
int|string The HTML select list of element or '' if nothing or -1 if KO

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

◆ 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 = '' 
)

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$selectedId project preselected ('' or id of project)
string$htmlnameName of HTML field
int$maxlengthMaximum length of label
int$option_onlyReturn only html options lines without the select tag
int$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 JSON mode
string$filterkeyKey to filter
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
Returns
string Return html content

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

◆ 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' 
)

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$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
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
Returns
int Nb of project if OK, <0 if KO

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

◆ selectOpportunityStatus()

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

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
Returns
int|string The HTML select list of element or '' if nothing or -1 if KO

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

◆ 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 = '',
  $showproject = '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$showproject'all' = Show project info, ''=Hide project info
User$usertofilterUser object to use for filtering
Returns
int Nbr of project if OK, <0 if KO

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


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