dolibarr 21.0.0-alpha
WebPortalOrder Class Reference

Class for WebPortalOrder. More...

Inheritance diagram for WebPortalOrder:
Collaboration diagram for WebPortalOrder:

Public Member Functions

 __construct (DoliDB $db)
 Constructor.
 
 getTooltipContentArray ($params)
 getTooltipContentArray
 
 getNomUrl ($withpicto=0, $option='', $max=0, $short=0, $notooltip=0, $save_lastsearch_value=-1, $addlinktonotes=0, $target='')
 Return clickable link of object (with eventually picto)
 
 getKanbanView ($option='', $arraydata=null)
 Return clickable link of object (with eventually picto)
 
 getLabelStatus ($mode=0)
 Return the label of the status.
 
 getLibStatut ($mode=0)
 Return the label of the status.
 
 LibStatut ($status, $billed, $mode, $donotshowbilled=0)
 Return label of status.
 
- Public Member Functions inherited from Commande
 __construct ($db)
 Constructor.
 
 getNextNumRef ($soc)
 Returns the reference to the following non used Order depending on the active numbering module defined into COMMANDE_ADDON.
 
 valid ($user, $idwarehouse=0, $notrigger=0)
 Validate order.
 
 setDraft ($user, $idwarehouse=-1)
 Set draft status.
 
 set_reopen ($user)
 Tag the order as validated (opened) Function used when order is reopend after being closed.
 
 cloture ($user, $notrigger=0)
 Close order.
 
 cancel ($idwarehouse=-1)
 Cancel an order If stock is decremented on order validation, we must reincrement it.
 
 create ($user, $notrigger=0)
 Create order Note that this->ref can be set or empty.
 
 createFromClone (User $user, $socid=0)
 Load an object from its id and create a new one in database.
 
 createFromProposal ($object, User $user)
 Load an object from a proposal and create a new order into database.
 
 addline ($desc, $pu_ht, $qty, $txtva, $txlocaltax1=0, $txlocaltax2=0, $fk_product=0, $remise_percent=0, $info_bits=0, $fk_remise_except=0, $price_base_type='HT', $pu_ttc=0, $date_start='', $date_end='', $type=0, $rang=-1, $special_code=0, $fk_parent_line=0, $fk_fournprice=null, $pa_ht=0, $label='', $array_options=array(), $fk_unit=null, $origin='', $origin_id=0, $pu_ht_devise=0, $ref_ext='', $noupdateafterinsertline=0)
 Add an order line into database (linked to product/service or not)
 
 add_product ($idproduct, $qty, $remise_percent=0.0, $date_start='', $date_end='')
 Add line into array $this->client must be loaded.
 
 fetch ($id, $ref='', $ref_ext='', $notused='')
 Get object from database.
 
 insert_discount ($idremise)
 Add a discount line into a sale order (as a sale order line) using an existing absolute discount (Consume the discount)
 
 fetch_lines ($only_product=0, $loadalsotranslation=0)
 Load array lines.
 
 getNbOfProductsLines ()
 Return number of line with type product.
 
 getNbOfServicesLines ()
 Return number of line with type service.
 
 getNbOfShipments ()
 Count number of shipments for this order.
 
 loadExpeditions ($filtre_statut=-1, $fk_product=0)
 Load array this->expeditions of lines of shipments with nb of products sent for each order line Note: For a dedicated shipment, the fetch_lines can be used to load the qty_asked and qty_shipped.
 
 countNbOfShipments ()
 Returns an array with expeditions lines number.
 
 deleteLine ($user=null, $lineid=0, $id=0)
 Return a array with the pending stock by product.
 
 set_remise ($user, $remise, $notrigger=0)
 Applique une remise relative.
 
 setDiscount ($user, $remise, $notrigger=0)
 Set a percentage discount.
 
 set_date ($user, $date, $notrigger=0)
 Set a fixed amount discount.
 
 set_date_livraison ($user, $delivery_date, $notrigger=0)
 Set delivery date.
 
 setDeliveryDate ($user, $delivery_date, $notrigger=0)
 Set the planned delivery date.
 
 liste_array ($shortlist=0, $draft=0, $excluser=null, $socid=0, $limit=0, $offset=0, $sortfield='c.date_commande', $sortorder='DESC')
 Return list of orders (eventuelly filtered on a user) into an array.
 
 availability ($availability_id, $notrigger=0)
 Update delivery delay.
 
 demand_reason ($demand_reason_id, $notrigger=0)
 Update order demand_reason.
 
 set_ref_client ($user, $ref_client, $notrigger=0)
 Set customer ref.
 
 classifyBilled (User $user, $notrigger=0)
 Classify the order as invoiced.
 
 classifyUnBilled (User $user, $notrigger=0)
 Classify the order as not invoiced.
 
 updateline ($rowid, $desc, $pu, $qty, $remise_percent, $txtva, $txlocaltax1=0.0, $txlocaltax2=0.0, $price_base_type='HT', $info_bits=0, $date_start='', $date_end='', $type=0, $fk_parent_line=0, $skip_update_total=0, $fk_fournprice=null, $pa_ht=0, $label='', $special_code=0, $array_options=array(), $fk_unit=null, $pu_ht_devise=0, $notrigger=0, $ref_ext='', $rang=0)
 Update a line in database.
 
 update (User $user, $notrigger=0)
 Update database.
 
 delete ($user, $notrigger=0)
 Delete the sales order.
 
 load_board ($user, $mode)
 Load indicators for dashboard (this->nbtodo and this->nbtodolate)
 
 getLabelSource ()
 Return source label of order.
 
 info ($id)
 Charge les information d'ordre info dans l'objet commande.
 
 initAsSpecimen ()
 Initialise an instance with random values.
 
 loadStateBoard ()
 Load the indicators this->nb for the state board.
 
 getLinesArray ()
 Create an array of order lines.
 
 generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0, $moreparams=null)
 Create a document onto disk according to template module.
 
 hasDelay ()
 Is the sales order delayed?
 
 showDelay ()
 Show the customer delayed info.
 
 setSignedStatus (User $user, int $status=0, int $notrigger=0, $triggercode='')
 Set signed status.
 
- Public Member Functions inherited from CommonOrder
 getNbLinesProductOrServiceOnBuy ($ignoreFree=false)
 return nb of fines of order where products or services that can be bought
 
- Public Member Functions inherited from CommonObject
 isEmpty ()
 isEmpty We consider CommonObject isEmpty if this->id is empty
 
 setErrorsFromObject ($object)
 setErrorsFromObject
 
 getTooltipContent ($params)
 getTooltipContent
 
 errorsToString ()
 Method to output saved errors.
 
 getFormatedCustomerRef ($objref)
 Return customer ref for screen output.
 
 getFormatedSupplierRef ($objref)
 Return supplier ref for screen output.
 
 getFullAddress ($withcountry=0, $sep="\n", $withregion=0, $extralangcode='')
 Return full address of contact.
 
 getLastMainDocLink ($modulepart, $initsharekey=0, $relativelink=0)
 Return the link of last main doc file for direct public download.
 
 add_contact ($fk_socpeople, $type_contact, $source='external', $notrigger=0)
 Add a link between element $this->element and a contact.
 
 copy_linked_contact ($objFrom, $source='internal')
 Copy contact from one element to current.
 
 update_contact ($rowid, $statut, $type_contact_id=0, $fk_socpeople=0)
 Update a link to contact line.
 
 delete_contact ($rowid, $notrigger=0)
 Delete a link to contact line.
 
 delete_linked_contact ($source='', $code='')
 Delete all links between an object $this and all its contacts in llx_element_contact.
 
 liste_contact ($statusoflink=-1, $source='external', $list=0, $code='', $status=-1, $arrayoftcids=array())
 Get array of all contacts for an object.
 
 swapContactStatus ($rowid)
 Update status of a contact linked to object.
 
 liste_type_contact ($source='internal', $order='position', $option=0, $activeonly=0, $code='')
 Return array with list of possible values for type of contacts.
 
 listeTypeContacts ($source='internal', $option=0, $activeonly=0, $code='', $element='', $excludeelement='')
 Return array with list of possible values for type of contacts.
 
 getIdContact ($source, $code, $status=0)
 Return id of contacts for a source and a contact code.
 
 fetch_contact ($contactid=null)
 Load object contact with id=$this->contact_id into $this->contact.
 
 fetch_thirdparty ($force_thirdparty_id=0)
 Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty.
 
 fetchOneLike ($ref)
 Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set.
 
 fetch_barcode ()
 Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode.
 
 fetchProject ()
 Load the project with id $this->fk_project into this->project.
 
 fetch_project ()
 Load the project with id $this->fk_project into this->project.
 
 fetch_projet ()
 Load the project with id $this->fk_project into this->project.
 
 fetch_product ()
 Load the product with id $this->fk_product into this->product.
 
 fetch_user ($userid)
 Load the user with id $userid into this->user.
 
 fetch_origin ()
 Read linked origin object.
 
 fetchObjectFrom ($table, $field, $key, $element=null)
 Load object from specific field.
 
 getValueFrom ($table, $id, $field)
 Getter generic.
 
 setValueFrom ($field, $value, $table='', $id=null, $format='', $id_field='', $fuser=null, $trigkey='', $fk_user_field='fk_user_modif')
 Setter generic.
 
 load_previous_next_ref ($filter, $fieldid, $nodbprefix=0)
 Load properties id_previous and id_next by comparing $fieldid with $this->ref.
 
 getListContactId ($source='external')
 Return list of id of contacts of object.
 
 setProject ($projectid, $notrigger=0)
 Link element with a project.
 
 setPaymentMethods ($id)
 Change the payments methods.
 
 setMulticurrencyCode ($code)
 Change the multicurrency code.
 
 setPaymentTerms ($id, $deposit_percent=null)
 Change the payments terms.
 
 setTransportMode ($id)
 Change the transport mode methods.
 
 setRetainedWarrantyPaymentTerms ($id)
 Change the retained warranty payments terms.
 
 setDeliveryAddress ($id)
 Define delivery address.
 
 setShippingMethod ($shipping_method_id, $notrigger=0, $userused=null)
 Change the shipping method.
 
 setWarehouse ($warehouse_id)
 Change the warehouse.
 
 setDocModel ($user, $modelpdf)
 Set last model used by doc generator.
 
 setBankAccount ($fk_account, $notrigger=0, $userused=null)
 Change the bank account.
 
 line_order ($renum=false, $rowidorder='ASC', $fk_parent_line=true)
 Save a new position (field rang) for details lines.
 
 getChildrenOfLine ($id, $includealltree=0)
 Get children of line.
 
 line_up ($rowid, $fk_parent_line=true)
 Update a line to have a lower rank.
 
 line_down ($rowid, $fk_parent_line=true)
 Update a line to have a higher rank.
 
 updateRangOfLine ($rowid, $rang)
 Update position of line (rang)
 
 line_ajaxorder ($rows)
 Update position of line with ajax (rang)
 
 updateLineUp ($rowid, $rang)
 Update position of line up (rang)
 
 updateLineDown ($rowid, $rang, $max)
 Update position of line down (rang)
 
 getRangOfLine ($rowid)
 Get position of line (rang)
 
 getIdOfLine ($rang)
 Get rowid of the line relative to its position.
 
 line_max ($fk_parent_line=0)
 Get max value used for position of line (rang)
 
 update_ref_ext ($ref_ext)
 Update external ref of element.
 
 update_note ($note, $suffix='', $notrigger=0)
 Update note of element.
 
 update_note_public ($note)
 Update public note (kept for backward compatibility)
 
 update_price ($exclspec=0, $roundingadjust='auto', $nodatabaseupdate=0, $seller=null)
 Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines).
 
 add_object_linked ($origin=null, $origin_id=null, $f_user=null, $notrigger=0)
 Add an object link into llx_element_element.
 
 getElementType ()
 Return an element type string formatted like element_element target_type and source_type.
 
 fetchObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $clause='OR', $alsosametype=1, $orderby='sourcetype', $loadalsoobjects=1)
 Fetch array of objects linked to current object (object of enabled modules only).
 
 clearObjectLinkedCache ()
 Clear the cache saying that all linked object were already loaded.
 
 updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $f_user=null, $notrigger=0)
 Update object linked of a current object.
 
 deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid=0, $f_user=null, $notrigger=0)
 Delete all links between an object $this.
 
 setStatut ($status, $elementId=null, $elementType='', $trigkey='', $fieldstatus='fk_statut')
 Set status of an object.
 
 getCanvas ($id=0, $ref='')
 Load type of canvas of an object if it exists.
 
 getSpecialCode ($lineid)
 Get special code of a line.
 
 isObjectUsed ($id=0, $entity=0)
 Function to check if an object is used by others (by children).
 
 hasProductsOrServices ($predefined=-1)
 Function to say how many lines object contains.
 
 getTotalDiscount ()
 Function that returns the total amount HT of discounts applied for all lines.
 
 getTotalWeightVolume ()
 Return into unit=0, the calculated total of weight and volume of all lines * qty Calculate by adding weight and volume of each product line, so properties ->volume/volume_units/weight/weight_units must be loaded on line.
 
 setExtraParameters ()
 Set extra parameters.
 
 formAddObjectLine ($dateSelector, $seller, $buyer, $defaulttpldir='/core/tpl')
 Show add free and predefined products/services form.
 
 printObjectLines ($action, $seller, $buyer, $selected=0, $dateSelector=0, $defaulttpldir='/core/tpl')
 Return HTML table for object lines TODO Move this into an output class file (htmlline.class.php) If lines are into a template, title must also be into a template But for the moment we don't know if it's possible as we keep a method available on overloaded objects.
 
 printObjectLine ($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected=0, $extrafields=null, $defaulttpldir='/core/tpl')
 Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php)
 
 printOriginLinesList ($restrictlist='', $selectedLines=array())
 Return HTML table table of source object lines TODO Move this and previous function into output html class file (htmlline.class.php).
 
 printOriginLine ($line, $var, $restrictlist='', $defaulttpldir='/core/tpl', $selectedLines=array())
 Return HTML with a line of table array of source object lines TODO Move this and previous function into output html class file (htmlline.class.php).
 
 add_element_resource ($resource_id, $resource_type, $busy=0, $mandatory=0)
 Add resources to the current object : add entry into llx_element_resources Need $this->element & $this->id.
 
 delete_resource ($rowid, $element, $notrigger=0)
 Delete a link to resource line.
 
 __clone ()
 Overwrite magic function to solve problem of cloning object that are kept as references.
 
 indexFile ($destfull, $update_main_doc_field)
 Index a file into the ECM database.
 
 addThumbs ($file)
 Build thumb.
 
 delThumbs ($file)
 Delete thumbs.
 
 getDefaultCreateValueFor ($fieldname, $alternatevalue=null, $type='alphanohtml')
 Return the default value to use for a field when showing the create form of object.
 
 call_trigger ($triggerName, $user)
 Call trigger based on this instance.
 
 fetchValuesForExtraLanguages ()
 Function to get alternative languages of a data into $this->array_languages This method is NOT called by method fetch of objects but must be called separately.
 
 setValuesForExtraLanguages ($onlykey='')
 Fill array_options property of object by extrafields value (using for data sent by forms)
 
 fetchNoCompute ($id)
 Function to make a fetch but set environment to avoid to load computed values before.
 
 fetch_optionals ($rowid=null, $optionsArray=null)
 Function to get extra fields of an object into $this->array_options This method is in most cases called by method fetch of objects but you can call it separately.
 
 deleteExtraFields ()
 Delete all extra fields values for the current object.
 
 insertExtraFields ($trigger='', $userused=null)
 Add/Update all extra fields values for the current object.
 
 insertExtraLanguages ($trigger='', $userused=null)
 Add/Update all extra fields values for the current object.
 
 updateExtraField ($key, $trigger=null, $userused=null)
 Update 1 extra field value for the current object.
 
 getExtraField ($key)
 Convenience method for retrieving the value of an extrafield without actually fetching it from the database.
 
 setExtraField ($key, $value)
 Convenience method for setting the value of an extrafield without actually updating it in the database.
 
 updateExtraLanguages ($key, $trigger=null, $userused=null)
 Update an extra language value for the current object.
 
 showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $morecss=0, $nonewbutton=0)
 Return HTML string to put an input field into a page Code very similar with showInputField of extra fields.
 
 clearFieldError ($fieldKey)
 clear validation message result for a field
 
 setFieldError ($fieldKey, $msg='')
 set validation error message a field
 
 getFieldError ($fieldKey)
 get field error message
 
 validateField ($fields, $fieldKey, $fieldValue)
 Return validation test result for a field.
 
 showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd='', $display_type='card')
 Function to show lines of extrafields with output data.
 
 getJSListDependancies ($type='_extra')
 
 getRights ()
 Returns the rights used for this class.
 
 defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0)
 Get buy price to use for margin calculation.
 
 getDataToShowPhoto ($modulepart, $imagesize)
 Function used to get the logos or photos of an object.
 
 show_photos ($modulepart, $sdir, $size=0, $nbmax=0, $nbbyrow=5, $showfilename=0, $showaction=0, $maxHeight=120, $maxWidth=160, $nolink=0, $overwritetitle=0, $usesharelink=0, $cache='', $addphotorefcss='photoref')
 Show photos of an object (nbmax maximum), into several columns.
 
 isDate ($info)
 Function test if type is date.
 
 isDuration ($info)
 Function test if type is duration.
 
 isInt ($info)
 Function test if type is integer.
 
 isFloat ($info)
 Function test if type is float.
 
 isText ($info)
 Function test if type is text.
 
 setVarsFromFetchObj (&$obj)
 Function to load data from a SQL pointer into properties of current object $this.
 
 emtpyObjectVars ()
 Sets all object fields to null.
 
 getFieldList ($alias='', $excludefields=array())
 Function to concat keys of fields.
 
 createCommon (User $user, $notrigger=0)
 Create object in the database.
 
 fetchCommon ($id, $ref=null, $morewhere='', $noextrafields=0)
 Load object in memory from the database.
 
 fetchLinesCommon ($morewhere='', $noextrafields=0)
 Load object in memory from the database.
 
 updateCommon (User $user, $notrigger=0)
 Update object into database.
 
 deleteCommon (User $user, $notrigger=0, $forcechilddeletion=0)
 Delete object in database.
 
 deleteByParentField ($parentId=0, $parentField='', $filter='', $filtermode="AND")
 Delete all child object from a parent ID.
 
 deleteLineCommon (User $user, $idline, $notrigger=0)
 Delete a line of object in database.
 
 setStatusCommon ($user, $status, $notrigger=0, $triggercode='')
 Set to a status.
 
 initAsSpecimenCommon ()
 Initialise object with example values Id must be 0 if object instance is a specimen.
 
 fetchComments ()
 Load comments linked with current task.
 
 getNbComments ()
 Return nb comments already posted.
 
 trimParameters ($parameters)
 Trim object parameters.
 
 getCategoriesCommon ($type_categ)
 Sets object to given categories.
 
 setCategoriesCommon ($categories, $type_categ='', $remove_existing=true)
 Sets object to given categories.
 
 cloneCategories ($fromId, $toId, $type='')
 Copy related categories to another object.
 
 deleteEcmFiles ($mode=0)
 Delete related files of object in database.
 

Public Attributes

const ARRAY_STATUS_LABEL
 Status list (short label)
 
- Public Attributes inherited from Commande
const STOCK_NOT_ENOUGH_FOR_ORDER = -3
 ERR Not enough stock.
 
const STATUS_CANCELED = -1
 Canceled status.
 
const STATUS_DRAFT = 0
 Draft status.
 
const STATUS_VALIDATED = 1
 Validated status.
 
const STATUS_SHIPMENTONPROCESS = 2
 Shipment on process.
 
const STATUS_ACCEPTED = 2
 For backward compatibility.
 
const STATUS_CLOSED = 3
 Closed (Sent, billed or not)
 
- Public Attributes inherited from CommonObject
 $origin_object
 

Protected Member Functions

 getOrderStatic ()
 Get order for static method.
 
- Protected Member Functions inherited from CommonObject
 deprecatedProperties ()
 Provide list of deprecated properties and replacements.
 
 commonGenerateDocument ($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null)
 Common function for all objects extending CommonObject for generating documents.
 
 isArray ($info)
 Function test if type is array.
 
 canBeNull ($info)
 Function test if field can be null.
 
 isForcedToNullIfZero ($info)
 Function test if field is forced to null if zero or empty.
 
 isIndex ($info)
 Function test if is indexed.
 
 setSaveQuery ()
 Function to return the array of data key-value from the ->fields and all the ->properties of an object.
 
 quote ($value, $fieldsentry)
 Add quote to field value if necessary.
 

Additional Inherited Members

- Static Public Member Functions inherited from Commande
static replaceThirdparty (DoliDB $dbs, $origin_id, $dest_id)
 Function used to replace a thirdparty id with another one.
 
static replaceProduct (DoliDB $db, $origin_id, $dest_id)
 Function used to replace a product id with another one.
 
- Static Public Member Functions inherited from CommonObject
static isExistingObject ($element, $id, $ref='', $ref_ext='')
 Check if an object id or ref exists If you don't need or want to instantiate the object and just need to know if the object exists, use this method instead of fetch.
 
static getAllItemsLinkedByObjectID ($fk_object_where, $field_select, $field_where, $table_element)
 Function used to get an array with all items linked to an object id in association table.
 
static getCountOfItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
 Count items linked to an object id in association table.
 
static deleteAllItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
 Function used to remove all items linked to an object id in association table.
 
static commonReplaceThirdparty (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a thirdparty id with another one.
 
static commonReplaceProduct (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a product id with another one.
 
- Protected Attributes inherited from Commande
 $table_ref_field = 'ref'
 {}
 

Detailed Description

Class for WebPortalOrder.

Definition at line 33 of file webportalorder.class.php.

Constructor & Destructor Documentation

◆ __construct()

WebPortalOrder::__construct ( DoliDB $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 150 of file webportalorder.class.php.

References getOrderStatic().

Member Function Documentation

◆ getKanbanView()

WebPortalOrder::getKanbanView ( $option = '',
$arraydata = null )

Return clickable link of object (with eventually picto)

Parameters
string$optionWhere point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link)
array{string,mixed}$arraydata Array of data
Returns
string HTML Code for Kanban thumb.

Reimplemented from CommonOrder.

Definition at line 270 of file webportalorder.class.php.

References getLibStatut(), getNomUrl(), img_picto(), and price().

◆ getLabelStatus()

WebPortalOrder::getLabelStatus ( $mode = 0)

Return the label of the status.

Parameters
int$mode0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto
Returns
string Label of status

Definition at line 307 of file webportalorder.class.php.

References LibStatut().

◆ getLibStatut()

WebPortalOrder::getLibStatut ( $mode = 0)

Return the label of the status.

Parameters
int$mode0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto
Returns
string Label of status

Reimplemented from Commande.

Definition at line 318 of file webportalorder.class.php.

References LibStatut().

Referenced by getKanbanView(), and getTooltipContentArray().

◆ getNomUrl()

WebPortalOrder::getNomUrl ( $withpicto = 0,
$option = '',
$max = 0,
$short = 0,
$notooltip = 0,
$save_lastsearch_value = -1,
$addlinktonotes = 0,
$target = '' )

Return clickable link of object (with eventually picto)

Parameters
int$withpictoAdd picto into link
string$optionWhere point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link)
int$maxMax length to show
int$shortShort
int$notooltip1=Disable tooltip
int$save_lastsearch_value-1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking
int$addlinktonotesAdd link to notes
string$targetAttribute target for link
Returns
string String with URL

Reimplemented from Commande.

Definition at line 198 of file webportalorder.class.php.

References dol_escape_htmltag(), getDolGlobalInt(), getTooltipContentArray(), and img_object().

Referenced by getKanbanView().

◆ getOrderStatic()

WebPortalOrder::getOrderStatic ( )
protected

Get order for static method.

Returns
Commande

Definition at line 136 of file webportalorder.class.php.

Referenced by __construct(), and LibStatut().

◆ getTooltipContentArray()

WebPortalOrder::getTooltipContentArray ( $params)

getTooltipContentArray

Parameters
array<string,mixed>$params params to construct tooltip data
Since
v18
Returns
array{picto?:string,ref?:string,refsupplier?:string,label?:string,date?:string,date_echeance?:string,amountht?:string,total_ht?:string,totaltva?:string,amountlt1?:string,amountlt2?:string,amountrevenustamp?:string,totalttc?:string}|array{optimize:string}

Reimplemented from Commande.

Definition at line 167 of file webportalorder.class.php.

References getDolGlobalInt(), getLibStatut(), img_picto(), and status.

Referenced by getNomUrl().

◆ LibStatut()

WebPortalOrder::LibStatut ( $status,
$billed,
$mode,
$donotshowbilled = 0 )

Return label of status.

Parameters
int$statusId status
int$billedIf invoiced
int$mode0=Long label, 1=Short label, 2=Picto + Short label, 3=Picto, 4=Picto + Long label, 5=Short label + Picto, 6=Long label + Picto
int$donotshowbilledDo not show billed status after order status
Returns
string Label of status

Reimplemented from Commande.

Definition at line 333 of file webportalorder.class.php.

References getOrderStatic().

Referenced by getLabelStatus(), and getLibStatut().


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