dolibarr  21.0.0-alpha
Public Member Functions | Static Public Member Functions | List of all members
FormWebPortal Class Reference

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

Inheritance diagram for FormWebPortal:
Inheritance graph
[legend]
Collaboration diagram for FormWebPortal:
Collaboration graph
[legend]

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 inputType ($type, $name, $value='', $id='', $morecss='', $moreparam='', $label='', $addInputLabel='')
 Html for input with label. More...
 
 inputDate ($name, $value='', $placeholder='', $id='', $morecss='', $moreparam='')
 Input for date. More...
 
 getDocumentsLink ($modulepart, $modulesubdir, $filedir, $filter='', $morecss='', $allfiles=0)
 Show a Document icon with link(s) You may want to call this into a div like this: print '. More...
 
 getSignatureLink ($modulepart, $object, $morecss='')
 Show a Signature icon with link You may want to call this into a div like this: print '. More...
 
 selectForForms ($objectdesc, $htmlname, $preselectedvalue, $showempty='', $searchkey='', $placeholder='', $morecss='', $moreparams='', $forcecombo=0, $disabled=0, $selected_input_value='', $objectfield='')
 Generic method to select a component from a combo list. More...
 
 selectForFormsList ($objecttmp, $htmlname, $preselectedvalue, $showempty='', $searchkey='', $placeholder='', $morecss='', $moreparams='', $forcecombo=0, $outputmode=0, $disabled=0, $sortfield='', $filter='')
 Output html form to select an object. More...
 
 showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $morecss='')
 Return HTML string to put an input field into a page Code very similar with showInputField for common object. More...
 
 showOutputFieldForObject ($object, $val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $morecss='')
 Return HTML string to show a field into a page. More...
 
- Public Member Functions inherited from Form
 editfieldkey ($text, $htmlname, $preselected, $object, $perm, $typeofdata='string', $moreparam='', $fieldrequired=0, $notabletag=0, $paramid='id', $help='')
 Output key field for an editable field. More...
 
 editfieldval ($text, $htmlname, $value, $object, $perm, $typeofdata='string', $editvalue='', $extObject=null, $custommsg=null, $moreparam='', $notabletag=1, $formatfunc='', $paramid='id', $gm='auto', $moreoptions=array(), $editaction='')
 Output value of a field for an editable field. More...
 
 widgetForTranslation ($fieldname, $object, $perm, $typeofdata='string', $check='', $morecss='')
 Output edit in place form. More...
 
 textwithtooltip ($text, $htmltext, $tooltipon=1, $direction=0, $img='', $extracss='', $notabs=3, $incbefore='', $noencodehtmltext=0, $tooltiptrigger='', $forcenowrap=0)
 Show a text and picto with tooltip on text or picto. More...
 
 textwithpicto ($text, $htmltext, $direction=1, $type='help', $extracss='', $noencodehtmltext=0, $notabs=3, $tooltiptrigger='', $forcenowrap=0)
 Show a text with a picto and a tooltip on picto. More...
 
 selectMassAction ($selected, $arrayofaction, $alwaysvisible=0, $name='massaction', $cssclass='checkforselect')
 Generate select HTML to choose massaction. More...
 
 select_country ($selected='', $htmlname='country_id', $htmloption='', $maxlength=0, $morecss='minwidth300', $usecodeaskey='', $showempty=1, $disablefavorites=0, $addspecialentries=0, $exclude_country_code=array(), $hideflags=0)
 Return combo list of activated countries, into language of user. More...
 
 select_incoterms ($selected='', $location_incoterms='', $page='', $htmlname='incoterm_id', $htmloption='', $forcecombo=1, $events=array(), $disableautocomplete=0)
 Return select list of incoterms. More...
 
 select_type_of_lines ($selected='', $htmlname='type', $showempty=0, $hidetext=0, $forceall=0, $morecss="")
 Return list of types of lines (product or service) Example: 0=product, 1=service, 9=other (for external module) More...
 
 load_cache_types_fees ()
 Load into cache cache_types_fees, array of types of fees. More...
 
 select_type_fees ($selected='', $htmlname='type', $showempty=0)
 Return list of types of notes. More...
 
 select_company ($selected='', $htmlname='socid', $filter='', $showempty='', $showtype=0, $forcecombo=0, $events=array(), $limit=0, $morecss='minwidth100', $moreparam='', $selected_input_value='', $hidelabel=1, $ajaxoptions=array(), $multiple=false, $excludeids=array(), $showcode=0)
 Output html form to select a third party This call select_thirdparty_list() or ajax depending on setup. More...
 
 select_contact ($socid, $selected='', $htmlname='contactid', $showempty=0, $exclude='', $limitto='', $showfunction=0, $morecss='', $nokeyifsocid=true, $showsoc=0, $forcecombo=0, $events=array(), $moreparam='', $htmlid='', $selected_input_value='', $filter='')
 Output html form to select a contact This call select_contacts() or ajax depending on setup. More...
 
 select_thirdparty_list ($selected='', $htmlname='socid', $filter='', $showempty='', $showtype=0, $forcecombo=0, $events=array(), $filterkey='', $outputmode=0, $limit=0, $morecss='minwidth100', $moreparam='', $multiple=false, $excludeids=array(), $showcode=0)
 Output html form to select a third party. More...
 
 selectcontacts ($socid, $selected=array(), $htmlname='contactid', $showempty=0, $exclude='', $limitto='', $showfunction=0, $morecss='', $options_only=0, $showsoc=0, $forcecombo=0, $events=array(), $moreparam='', $htmlid='', $multiple=false, $disableifempty=0, $filter='')
 Return HTML code of the SELECT of list of all contacts (for a third party or all). More...
 
 select_remises ($selected, $htmlname, $filter, $socid, $maxvalue=0)
 Return HTML combo list of absolute discounts. More...
 
 select_users ($selected='', $htmlname='userid', $show_empty=0, $exclude=null, $disabled=0, $include='', $enableonly=array(), $force_entity='0')
 Return the HTML select list of users. More...
 
 select_dolusers ($selected='', $htmlname='userid', $show_empty=0, $exclude=null, $disabled=0, $include='', $enableonly='', $force_entity='', $maxlength=0, $showstatus=0, $morefilter='', $show_every=0, $enableonlytext='', $morecss='', $notdisabled=0, $outputmode=0, $multiple=false, $forcecombo=0)
 Return select list of users. More...
 
 select_dolusers_forevent ($action='', $htmlname='userid', $show_empty=0, $exclude=null, $disabled=0, $include=array(), $enableonly=array(), $force_entity='0', $maxlength=0, $showstatus=0, $morefilter='', $showproperties=0, $listofuserid=array(), $listofcontactid=array(), $listofotherid=array())
 Return select list of users. More...
 
 select_dolresources_forevent ($action='', $htmlname='userid', $show_empty=0, $exclude=null, $disabled=0, $include=array(), $enableonly=array(), $force_entity='0', $maxlength=0, $showstatus=0, $morefilter='', $showproperties=0, $listofresourceid=array())
 Return select list of resources. More...
 
 select_produits ($selected=0, $htmlname='productid', $filtertype='', $limit=0, $price_level=0, $status=1, $finished=2, $selected_input_value='', $hidelabel=0, $ajaxoptions=array(), $socid=0, $showempty='1', $forcecombo=0, $morecss='', $hidepriceinlabel=0, $warehouseStatus='', $selected_combinations=null, $nooutput=0, $status_purchase=-1)
 Return list of products for customer. More...
 
 select_bom ($selected='', $htmlname='bom_id', $limit=0, $status=1, $type=0, $showempty='1', $morecss='', $nooutput='', $forcecombo=0, $TProducts=[])
 Return list of BOM for customer in Ajax if Ajax activated or go to select_produits_list. More...
 
 select_produits_list ($selected=0, $htmlname='productid', $filtertype='', $limit=20, $price_level=0, $filterkey='', $status=1, $finished=2, $outputmode=0, $socid=0, $showempty='1', $forcecombo=0, $morecss='maxwidth500', $hidepriceinlabel=0, $warehouseStatus='', $status_purchase=-1)
 Return list of products for a customer. More...
 
 select_produits_fournisseurs ($socid, $selected='', $htmlname='productid', $filtertype='', $filtre='', $ajaxoptions=array(), $hidelabel=0, $alsoproductwithnosupplierprice=0, $morecss='', $placeholder='')
 Return list of products for customer (in Ajax if Ajax activated or go to select_produits_fournisseurs_list) More...
 
 select_produits_fournisseurs_list ($socid, $selected='', $htmlname='productid', $filtertype='', $filtre='', $filterkey='', $statut=-1, $outputmode=0, $limit=100, $alsoproductwithnosupplierprice=0, $morecss='', $showstockinlist=0, $placeholder='')
 Return list of suppliers products. More...
 
 select_product_fourn_price ($productid, $htmlname='productfournpriceid', $selected_supplier=0)
 Return list of suppliers prices for a product. More...
 
 load_cache_conditions_paiements ()
 
 load_cache_availability ()
 
 selectAvailabilityDelay ($selected='', $htmlname='availid', $filtertype='', $addempty=0, $morecss='')
 Return the list of type of delay available. More...
 
 loadCacheInputReason ()
 Load into cache cache_demand_reason, array of input reasons. More...
 
 selectInputReason ($selected='', $htmlname='demandreasonid', $exclude='', $addempty=0, $morecss='', $notooltip=0)
 Return list of input reason (events that triggered an object creation, like after sending an emailing, making an advert, ...) List found into table c_input_reason loaded by loadCacheInputReason. More...
 
 load_cache_types_paiements ()
 
 select_conditions_paiements ($selected=0, $htmlname='condid', $filtertype=-1, $addempty=0, $noinfoadmin=0, $morecss='', $deposit_percent=-1, $noprint=0)
 print list of payment modes. More...
 
 getSelectConditionsPaiements ($selected=0, $htmlname='condid', $filtertype=-1, $addempty=0, $noinfoadmin=0, $morecss='', $deposit_percent=-1)
 Return list of payment modes. More...
 
 select_types_paiements ($selected='', $htmlname='paiementtype', $filtertype='', $format=0, $empty=1, $noadmininfo=0, $maxlength=0, $active=1, $morecss='', $nooutput=0)
 Return list of payment methods Constant MAIN_DEFAULT_PAYMENT_TYPE_ID can used to set default value but scope is all application, probably not what you want. More...
 
 selectPriceBaseType ($selected='', $htmlname='price_base_type', $addjscombo=0)
 Selection HT or TTC. More...
 
 load_cache_transport_mode ()
 
 selectTransportMode ($selected='', $htmlname='transportmode', $format=0, $empty=1, $noadmininfo=0, $maxlength=0, $active=1, $morecss='')
 
 selectShippingMethod ($selected='', $htmlname='shipping_method_id', $filtre='', $useempty=0, $moreattrib='', $noinfoadmin=0, $morecss='')
 Return a HTML select list of shipping mode. More...
 
 formSelectShippingMethod ($page, $selected='', $htmlname='shipping_method_id', $addempty=0)
 Display form to select shipping mode. More...
 
 selectSituationInvoices ($selected='', $socid=0)
 Creates HTML last in cycle situation invoices selector. More...
 
 selectUnits ($selected='', $htmlname='units', $showempty=0, $unit_type='')
 Creates HTML units selector (code => label) More...
 
 select_comptes ($selected='', $htmlname='accountid', $status=0, $filtre='', $useempty=0, $moreattrib='', $showcurrency=0, $morecss='', $nooutput=0)
 Return a HTML select list of bank accounts. More...
 
 selectEstablishments ($selected='', $htmlname='entity', $status=0, $filtre='', $useempty=0, $moreattrib='')
 Return a HTML select list of establishment. More...
 
 formSelectAccount ($page, $selected='', $htmlname='fk_account', $addempty=0)
 Display form to select bank account. More...
 
 select_all_categories ($type, $selected='', $htmlname="parent", $maxlength=64, $fromid=0, $outputmode=0, $include=0, $morecss='', $useempty=1)
 Return list of categories having chosen type. More...
 
 form_confirm ($page, $title, $question, $action, $formquestion=array(), $selectedchoice="", $useajax=0, $height=170, $width=500)
 
 formconfirm ($page, $title, $question, $action, $formquestion='', $selectedchoice='', $useajax=0, $height=0, $width=500, $disableformtag=0, $labelbuttonyes='Yes', $labelbuttonno='No')
 
 form_project ($page, $socid, $selected='', $htmlname='projectid', $discard_closed=0, $maxlength=20, $forcefocus=0, $nooutput=0, $textifnoproject='', $morecss='')
 Show a form to select a project. More...
 
 form_conditions_reglement ($page, $selected='', $htmlname='cond_reglement_id', $addempty=0, $type='', $filtertype=-1, $deposit_percent=-1, $nooutput=0)
 Show a form to select payment conditions. More...
 
 form_availability ($page, $selected='', $htmlname='availability', $addempty=0)
 Show a form to select a delivery delay. More...
 
 formInputReason ($page, $selected='', $htmlname='demandreason', $addempty=0)
 Output HTML form to select list of input reason (events that triggered an object creation, like after sending an emailing, making an advert, ...) List found into table c_input_reason loaded by loadCacheInputReason. More...
 
 form_date ($page, $selected, $htmlname, $displayhour=0, $displaymin=0, $nooutput=0, $type='')
 Show a form + html select a date. More...
 
 form_users ($page, $selected='', $htmlname='userid', $exclude=array(), $include=array())
 Show a select form to choose a user. More...
 
 form_modes_reglement ($page, $selected='', $htmlname='mode_reglement_id', $filtertype='', $active=1, $addempty=0, $type='', $nooutput=0)
 Show form with payment mode. More...
 
 formSelectTransportMode ($page, $selected='', $htmlname='transport_mode_id', $active=1, $addempty=0)
 Show form with transport mode. More...
 
 form_multicurrency_code ($page, $selected='', $htmlname='multicurrency_code')
 Show form with multicurrency code. More...
 
 form_multicurrency_rate ($page, $rate=0.0, $htmlname='multicurrency_tx', $currency='')
 Show form with multicurrency rate. More...
 
 form_remise_dispo ($page, $selected, $htmlname, $socid, $amount, $filter='', $maxvalue=0, $more='', $hidelist=0, $discount_type=0)
 Show a select box with available absolute discounts. More...
 
 form_contacts ($page, $societe, $selected='', $htmlname='contactid')
 Show forms to select a contact. More...
 
 form_thirdparty ($page, $selected='', $htmlname='socid', $filter='', $showempty=0, $showtype=0, $forcecombo=0, $events=array(), $nooutput=0, $excludeids=array(), $textifnothirdparty='')
 Output html select to select thirdparty. More...
 
 select_currency ($selected='', $htmlname='currency_id')
 Retourne la liste des devises, dans la langue de l'utilisateur. More...
 
 selectCurrency ($selected='', $htmlname='currency_id', $mode=0, $useempty='')
 Retourne la liste des devises, dans la langue de l'utilisateur. More...
 
 selectMultiCurrency ($selected='', $htmlname='multicurrency_code', $useempty=0, $filter='', $excludeConfCurrency=false, $morecss='')
 Return array of currencies in user language. More...
 
 load_cache_vatrates ($country_code)
 Load into the cache ->cache_vatrates, all the vat rates of a country. More...
 
 load_tva ($htmlname='tauxtva', $selectedrate='', $societe_vendeuse=null, $societe_acheteuse=null, $idprod=0, $info_bits=0, $type='', $options_only=false, $mode=0, $type_vat=0)
 Output an HTML select vat rate. More...
 
 select_date ($set_time='', $prefix='re', $h=0, $m=0, $empty=0, $form_name="", $d=1, $addnowlink=0, $nooutput=0, $disabled=0, $fullday=0, $addplusone='', $adddateof='')
 Show a HTML widget to input a date or combo list for day, month, years and optionally hours and minutes. More...
 
 selectDateToDate ($set_time='', $set_time_end='', $prefix='re', $empty=0, $forcenewline=0)
 Show 2 HTML widget to input a date or combo list for day, month, years and optionally hours and minutes. More...
 
 selectDate ($set_time='', $prefix='re', $h=0, $m=0, $empty=0, $form_name="", $d=1, $addnowlink=0, $disabled=0, $fullday='', $addplusone='', $adddateof='', $openinghours='', $stepminutes=1, $labeladddateof='', $placeholder='', $gm='auto')
 Show a HTML widget to input a date or combo list for day, month, years and optionally hours and minutes. More...
 
 selectTypeDuration ($prefix, $selected='i', $excludetypes=array())
 selectTypeDuration More...
 
 select_duration ($prefix, $iSecond='', $disabled=0, $typehour='select', $minunderhours=0, $nooutput=0)
 Function to show a form to select a duration on a page. More...
 
 selectTickets ($selected='', $htmlname='ticketid', $filtertype='', $limit=0, $status=1, $selected_input_value='', $hidelabel=0, $ajaxoptions=array(), $socid=0, $showempty='1', $forcecombo=0, $morecss='', $selected_combinations=null, $nooutput=0)
 Return list of tickets in Ajax if Ajax activated or go to selectTicketsList. More...
 
 selectTicketsList ($selected='', $htmlname='ticketid', $filtertype='', $limit=20, $filterkey='', $status=1, $outputmode=0, $showempty='1', $forcecombo=0, $morecss='')
 Return list of tickets. More...
 
 selectProjects ($selected='', $htmlname='projectid', $filtertype='', $limit=0, $status=1, $selected_input_value='', $hidelabel=0, $ajaxoptions=array(), $socid=0, $showempty='1', $forcecombo=0, $morecss='', $selected_combinations=null, $nooutput=0)
 Return list of projects in Ajax if Ajax activated or go to selectTicketsList. More...
 
 selectProjectsList ($selected='', $htmlname='projectid', $filtertype='', $limit=20, $filterkey='', $status=1, $outputmode=0, $showempty='1', $forcecombo=0, $morecss='')
 Return list of projects. More...
 
 selectMembers ($selected='', $htmlname='adherentid', $filtertype='', $limit=0, $status=1, $selected_input_value='', $hidelabel=0, $ajaxoptions=array(), $socid=0, $showempty='1', $forcecombo=0, $morecss='', $selected_combinations=null, $nooutput=0)
 Return list of members in Ajax if Ajax activated or go to selectTicketsList. More...
 
 selectMembersList ($selected='', $htmlname='adherentid', $filtertype='', $limit=20, $filterkey='', $status=1, $outputmode=0, $showempty='1', $forcecombo=0, $morecss='')
 Return list of adherents. More...
 
 showCategories ($id, $type, $rendermode=0, $nolink=0)
 Render list of categories linked to object with id $id and type $type. More...
 
 showLinkedObjectBlock ($object, $morehtmlright='', $compatibleImportElementsList=array(), $title='RelatedObjects')
 Show linked object block. More...
 
 showLinkToObjectBlock ($object, $restrictlinksto=array(), $excludelinksto=array())
 Show block with links to link to other objects. More...
 
 selectyesno ($htmlname, $value='', $option=0, $disabled=false, $useempty=0, $addjscombo=0, $morecss='', $labelyes='Yes', $labelno='No')
 Return an html string with a select combo box to choose yes or no. More...
 
 select_export_model ($selected='', $htmlname='exportmodelid', $type='', $useempty=0)
 Return list of export templates. More...
 
 showrefnav ($object, $paramid, $morehtml='', $shownav=1, $fieldid='rowid', $fieldref='ref', $morehtmlref='', $moreparam='', $nodbprefix=0, $morehtmlleft='', $morehtmlstatus='', $morehtmlright='')
 Return a HTML area with the reference of object and a navigation bar for a business object Note: To complete search with a particular filter on select, you can set $object->next_prev_filter set to define SQL criteria. More...
 
 showbarcode (&$object, $width=100, $morecss='')
 Return HTML code to output a barcode. More...
 
 select_dolgroups ($selected=0, $htmlname='groupid', $show_empty=0, $exclude='', $disabled=0, $include='', $enableonly=array(), $force_entity='0', $multiple=false, $morecss='minwidth200')
 Return select list of groups. More...
 
 showFilterButtons ($pos='')
 Return HTML to show the search and clear search button. More...
 
 showCheckAddButtons ($cssclass='checkforaction', $calljsfunction=0, $massactionname="massaction")
 Return HTML to show the search and clear search button. More...
 
 showFilterAndCheckAddButtons ($addcheckuncheckall=0, $cssclass='checkforaction', $calljsfunction=0, $massactionname="massaction")
 Return HTML to show the search and clear search button. More...
 
 selectExpenseCategories ($selected='', $htmlname='fk_c_exp_tax_cat', $useempty=0, $excludeid=array(), $target='', $default_selected=0, $params=array(), $info_admin=1)
 Return HTML to show the select of expense categories. More...
 
 selectExpenseRanges ($selected='', $htmlname='fk_range', $useempty=0)
 Return HTML to show the select ranges of expense range. More...
 
 selectExpense ($selected='', $htmlname='fk_c_type_fees', $useempty=0, $allchoice=1, $useid=0)
 Return HTML to show a select of expense. More...
 
 selectInvoice ($socid=-1, $selected='', $htmlname='invoiceid', $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 invoices qualified for a third party. More...
 
 selectInvoiceRec ($selected='', $htmlname='facrecid', $maxlength=24, $option_only=0, $show_empty='1', $forcefocus=0, $disabled=0, $morecss='maxwidth500')
 Output a combo list with invoices qualified for a third party. More...
 
 searchComponent ($arrayofcriterias, $search_component_params, $arrayofinputfieldsalreadyoutput=array(), $search_component_params_hidden='')
 Output the component to make advanced search criteries. More...
 
 selectModelMail ($prefix, $modelType='', $default=0, $addjscombo=0)
 selectModelMail More...
 
 buttonsSaveCancel ($save_label='Save', $cancel_label='Cancel', $morebuttons=array(), $withoutdiv=false, $morecss='', $dol_openinpopup='')
 Output the buttons to submit a creation/edit form. More...
 
 load_cache_invoice_subtype ()
 Load into cache list of invoice subtypes. More...
 
 getSelectInvoiceSubtype ($selected=0, $htmlname='subtypeid', $addempty=0, $noinfoadmin=0, $morecss='')
 Return list of invoice subtypes. More...
 

Static Public Member Functions

static selectarray ($htmlname, $array, $id='', $show_empty=0, $key_in_label=0, $value_as_key=0, $moreparam='', $translate=0, $maxlen=0, $disabled=0, $sort='', $morecss='minwidth75', $addjscombo=1, $moreparamonempty='', $disablebademail=0, $nohtmlescape=0)
 Return a HTML select string, built from an array of key+value. More...
 
- Static Public Member Functions inherited from Form
static selectArrayAjax ($htmlname, $url, $id='', $moreparam='', $moreparamtourl='', $disabled=0, $minimumInputLength=1, $morecss='', $callurlonselect=0, $placeholder='', $acceptdelayedhtml=0)
 Return a HTML select string, built from an array of key+value, but content returned into select come from an Ajax call of an URL. More...
 
static selectArrayFilter ($htmlname, $array, $id='', $moreparam='', $disableFiltering=0, $disabled=0, $minimumInputLength=1, $morecss='', $callurlonselect=0, $placeholder='', $acceptdelayedhtml=0, $textfortitle='')
 Return a HTML select string, built from an array of key+value, but content returned into select is defined into $array parameter. More...
 
static multiselectarray ($htmlname, $array, $selected=array(), $key_in_label=0, $value_as_key=0, $morecss='', $translate=0, $width=0, $moreattrib='', $elemtype='', $placeholder='', $addjscombo=-1)
 Show a multiselect form from an array. More...
 
static multiSelectArrayWithCheckbox ($htmlname, &$array, $varpage, $pos='')
 Show a multiselect dropbox from an array. More...
 
static showphoto ($modulepart, $object, $width=100, $height=0, $caneditfield=0, $cssclass='photowithmargin', $imagesize='', $addlinktofullsize=1, $cache=0, $forcecapture='', $noexternsourceoverwrite=0)
 Return HTML code to output a photo. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Form
 editInPlace ($object, $value, $htmlname, $condition, $inputType='textarea', $editvalue=null, $extObject=null, $custommsg=null)
 Output edit in place form. More...
 
 constructProductListOption (&$objp, &$opt, &$optJson, $price_level, $selected, $hidepriceinlabel=0, $filterkey='', $novirtualstock=0)
 Function to forge the string with OPTIONs of SELECT. More...
 
 constructTicketListOption (&$objp, &$opt, &$optJson, $selected, $filterkey='')
 constructTicketListOption. More...
 
 constructProjectListOption (&$objp, &$opt, &$optJson, $selected, $filterkey='')
 constructProjectListOption. More...
 
 constructMemberListOption (&$objp, &$opt, &$optJson, $selected, $filterkey='')
 constructMemberListOption. More...
 

Detailed Description

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

Definition at line 35 of file html.formwebportal.class.php.

Constructor & Destructor Documentation

◆ __construct()

FormWebPortal::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Reimplemented from Form.

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

Member Function Documentation

◆ getDocumentsLink()

FormWebPortal::getDocumentsLink (   $modulepart,
  $modulesubdir,
  $filedir,
  $filter = '',
  $morecss = '',
  $allfiles = 0 
)

Show a Document icon with link(s) You may want to call this into a div like this: print '.

'.$formfile->getDocumentsLink($element_doc, $filename, $filedir).'

';

Parameters
string$modulepart'propal', 'facture', 'facture_fourn', ...
string$modulesubdirSub-directory to scan (Example: '0/1/10', 'FA/DD/MM/YY/9999'). Use '' if file is not into subdir of module.
string$filedirFull path to directory to scan
string$filterFilter filenames on this regex string (Example: '.pdf$')
string$morecssAdd more css to the download picto
int$allfiles0=Only generated docs, 1=All files
Returns
string Output string with HTML link of documents (might be empty string). This also fill the array ->infofiles

Definition at line 253 of file html.formwebportal.class.php.

◆ getSignatureLink()

FormWebPortal::getSignatureLink (   $modulepart,
  $object,
  $morecss = '' 
)

Show a Signature icon with link You may want to call this into a div like this: print '.

'.$formfile->getDocumentsLink($element_doc, $filename, $filedir).'

';

Parameters
string$modulepart'proposal', 'facture', 'facture_fourn', ...
Object$objectObject linked to the document to be signed
string$morecssAdd more css to the download picto
Returns
string Output string with HTML link of signature (might be empty string).

Definition at line 352 of file html.formwebportal.class.php.

◆ inputDate()

FormWebPortal::inputDate (   $name,
  $value = '',
  $placeholder = '',
  $id = '',
  $morecss = '',
  $moreparam = '' 
)

Input for date.

Parameters
string$nameName of html input
string$value[=''] Value of input (format : YYYY-MM-DD)
string$placeholder[=''] Placeholder for input (keep empty for no label)
string$id[=''] Id
string$morecss[=''] Class
string$moreparam[=''] Add attributes (checked, required, etc)
Returns
string Html for input date

Definition at line 104 of file html.formwebportal.class.php.

◆ inputType()

FormWebPortal::inputType (   $type,
  $name,
  $value = '',
  $id = '',
  $morecss = '',
  $moreparam = '',
  $label = '',
  $addInputLabel = '' 
)

Html for input with label.

Parameters
string$typeType of input : button, checkbox, color, email, hidden, month, number, password, radio, range, tel, text, time, url, week
string$nameName
string$value[=''] Value
string$id[=''] Id
string$morecss[=''] Class
string$moreparam[=''] Add attributes (checked, required, etc)
string$label[=''] Label
string$addInputLabel[=''] Add label for input
Returns
string Html for input with label

Definition at line 71 of file html.formwebportal.class.php.

◆ selectarray()

static FormWebPortal::selectarray (   $htmlname,
  $array,
  $id = '',
  $show_empty = 0,
  $key_in_label = 0,
  $value_as_key = 0,
  $moreparam = '',
  $translate = 0,
  $maxlen = 0,
  $disabled = 0,
  $sort = '',
  $morecss = 'minwidth75',
  $addjscombo = 1,
  $moreparamonempty = '',
  $disablebademail = 0,
  $nohtmlescape = 0 
)
static

Return a HTML select string, built from an array of key+value.

Note: Do not apply langs->trans function on returned content, content may be entity encoded twice.

Parameters
string$htmlnameName of html select area.
array$arrayArray like array(key => value) or array(key=>array('label'=>..., 'data-...'=>..., 'disabled'=>..., 'css'=>...))
string | string[]$idPreselected key or preselected keys for multiselect. Use 'ifone' to autoselect record if there is only one record.
int | string$show_empty0 no empty value allowed, 1 or string to add an empty value into list (If 1: key is -1 and value is '' or ' ', If placeholder string: key is -1 and value is the string), <0 to add an empty value with key that is this value.
int$key_in_label1 to show key into label with format "[key] value"
int$value_as_key1 to use value as key
string$moreparamAdd more parameters onto the select tag. For example 'style="width: 95%"' to avoid select2 component to go over parent container
int$translate1=Translate and encode value
int$maxlenLength maximum for labels
int$disabledHtml select box is disabled
string$sort'ASC' or 'DESC' = Sort on label, '' or 'NONE' or 'POS' = Do not sort, we keep original order
string$morecssAdd more class to css styles
int$addjscomboAdd js combo
string$moreparamonemptyAdd more param on the empty option line. Not used if show_empty not set
int$disablebademail1=Check if a not valid email, 2=Check string '—', and if found into value, disable and colorize entry
int$nohtmlescapeNo html escaping.
Returns
string HTML select string.

Reimplemented from Form.

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

◆ selectForForms()

FormWebPortal::selectForForms (   $objectdesc,
  $htmlname,
  $preselectedvalue,
  $showempty = '',
  $searchkey = '',
  $placeholder = '',
  $morecss = '',
  $moreparams = '',
  $forcecombo = 0,
  $disabled = 0,
  $selected_input_value = '',
  $objectfield = '' 
)

Generic method to select a component from a combo list.

Can use autocomplete with ajax after x key pressed or a full combo, depending on setup. This is the generic method that will replace all specific existing methods.

Parameters
string$objectdesc'ObjectClass:PathToClass[:AddCreateButtonOrNot[:Filter[:Sortfield]]]'. For hard coded custom needs. Try to prefer method using $objectfield instead of $objectdesc.
string$htmlnameName of HTML select component
int$preselectedvaluePreselected value (ID of element)
string$showempty''=empty values not allowed, 'string'=value show if we allow empty values (for example 'All', ...)
string$searchkeySearch criteria
string$placeholderPlace holder
string$morecssMore CSS
string$moreparamsMore params provided to ajax call
int$forcecomboForce to load all values and output a standard combobox (with no beautification)
int$disabled1=Html component is disabled
string$selected_input_valueValue of preselected input text (for use with ajax)
string$objectfieldObject:Field that contains the definition (in table $fields or $extrafields). Example: 'Object:xxx' or 'Module_Object:xxx' or 'Object:options_xxx' or 'Module_Object:options_xxx'
Returns
string Return HTML string
See also
selectForFormsList(), select_thirdparty_list()

Reimplemented from Form.

Definition at line 387 of file html.formwebportal.class.php.

◆ selectForFormsList()

FormWebPortal::selectForFormsList (   $objecttmp,
  $htmlname,
  $preselectedvalue,
  $showempty = '',
  $searchkey = '',
  $placeholder = '',
  $morecss = '',
  $moreparams = '',
  $forcecombo = 0,
  $outputmode = 0,
  $disabled = 0,
  $sortfield = '',
  $filter = '' 
)

Output html form to select an object.

Note, this function is called by selectForForms or by ajax selectobject.php

Parameters
Object$objecttmpObject to know the table to scan for combo.
string$htmlnameName of HTML select component
int$preselectedvaluePreselected value (ID of element)
string$showempty''=empty values not allowed, 'string'=value show if we allow empty values (for example 'All', ...)
string$searchkeySearch value
string$placeholderPlace holder
string$morecssMore CSS
string$moreparamsMore params provided to ajax call
int$forcecomboForce to load all values and output a standard combobox (with no beautification)
int$outputmode0=HTML select string, 1=Array
int$disabled1=Html component is disabled
string$sortfieldSort field
string$filterAdd more filter (Universal Search Filter)
Returns
string|array Return HTML string
See also
selectForForms()

Reimplemented from Form.

Definition at line 458 of file html.formwebportal.class.php.

◆ showInputField()

FormWebPortal::showInputField (   $val,
  $key,
  $value,
  $moreparam = '',
  $keysuffix = '',
  $keyprefix = '',
  $morecss = '' 
)

Return HTML string to put an input field into a page Code very similar with showInputField for common object.

Parameters
array | null$valArray of properties for field to show
string$keyKey of attribute
string | array$valuePreselected value to show (for date type it must be in timestamp format, for amount or price it must be a php numeric value, for array type must be array)
string$moreparamTo add more parameters on html input tag
string$keysuffixPrefix string to add into name and id of field (can be used to avoid duplicate names)
string$keyprefixSuffix string to add into name and id of field (can be used to avoid duplicate names)
string$morecssValue for css to define style/length of field. May also be a numeric.
Returns
string

Definition at line 632 of file html.formwebportal.class.php.

◆ showOutputFieldForObject()

FormWebPortal::showOutputFieldForObject (   $object,
  $val,
  $key,
  $value,
  $moreparam = '',
  $keysuffix = '',
  $keyprefix = '',
  $morecss = '' 
)

Return HTML string to show a field into a page.

Parameters
CommonObject$objectCommon object
array$valArray of properties of field to show
string$keyKey of attribute
string | string[]$valuePreselected value to show (for date type it must be in timestamp format, for amount or price it must be a php numeric value)
string$moreparamTo add more parameters on html input tag
string$keysuffixPrefix string to add into name and id of field (can be used to avoid duplicate names)
string$keyprefixSuffix string to add into name and id of field (can be used to avoid duplicate names)
mixed$morecssValue for css to define size. May also be a numeric.
Returns
string

Definition at line 985 of file html.formwebportal.class.php.


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