dolibarr 21.0.0-beta
webportalorder.class.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2023-2024 Laurent Destailleur <eldy@users.sourceforge.net>
3 * Copyright (C) 2023-2024 Lionel Vessiller <lvessiller@easya.solutions>
4 * Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
5 * Copyright (C) 2024 Frédéric France <frederic.france@free.fr>
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
19 */
20
27// Put here all includes required by your class file
28require_once DOL_DOCUMENT_ROOT . '/commande/class/commande.class.php';
29
34{
38 public $module = 'webportal';
39
43 const ARRAY_STATUS_LABEL = array(
44 Commande::STATUS_DRAFT => 'StatusOrderDraftShort',
45 Commande::STATUS_VALIDATED => 'StatusOrderValidated',
46 Commande::STATUS_SHIPMENTONPROCESS => 'StatusOrderSentShort',
47 Commande::STATUS_CLOSED => 'StatusOrderDelivered',
48 Commande::STATUS_CANCELED => 'StatusOrderCanceledShort',
49 );
50
54 protected $order_static = null;
55
95 // BEGIN MODULEBUILDER PROPERTIES
99 public $fields = array(
100 'rowid' => array('type' => 'integer', 'label' => 'TechnicalID', 'enabled' => 1, 'visible' => 0, 'notnull' => 1, 'position' => 10,),
101 'entity' => array('type' => 'integer', 'label' => 'Entity', 'default' => '1', 'enabled' => 1, 'visible' => -2, 'notnull' => 1, 'position' => 20, 'index' => 1,),
102 'ref' => array('type' => 'varchar(30)', 'label' => 'Ref', 'enabled' => 1, 'visible' => 2, 'notnull' => 1, 'showoncombobox' => 1, 'position' => 25,),
103 'date_commande' => array('type' => 'date', 'label' => 'Date', 'enabled' => 1, 'visible' => 2, 'position' => 60,),
104 'date_livraison' => array('type' => 'date', 'label' => 'DateDeliveryPlanned', 'enabled' => 1, 'visible' => 2, 'position' => 70,),
105 'total_ht' => array('type' => 'price', 'label' => 'TotalHT', 'enabled' => 1, 'visible' => 2, 'position' => 125, 'isameasure' => 1,),
106 'total_tva' => array('type' => 'price', 'label' => 'VAT', 'enabled' => 1, 'visible' => 2, 'position' => 130, 'isameasure' => 1,),
107 'total_ttc' => array('type' => 'price', 'label' => 'TotalTTC', 'enabled' => 1, 'visible' => 2, 'position' => 145, 'isameasure' => 1,),
108 'multicurrency_total_ht' => array('type' => 'price', 'label' => 'MulticurrencyAmountHT', 'enabled' => 'isModEnabled("multicurrency")', 'visible' => -2, 'position' => 255, 'isameasure' => 1,),
109 'multicurrency_total_tva' => array('type' => 'price', 'label' => 'MulticurrencyAmountVAT', 'enabled' => 'isModEnabled("multicurrency")', 'visible' => -2, 'position' => 260, 'isameasure' => 1,),
110 'multicurrency_total_ttc' => array('type' => 'price', 'label' => 'MulticurrencyAmountTTC', 'enabled' => 'isModEnabled("multicurrency")', 'visible' => -2, 'position' => 265, 'isameasure' => 1,),
111 'fk_statut' => array('type' => 'smallint(6)', 'label' => 'Status', 'enabled' => 1, 'visible' => 2, 'position' => 500, 'notnull' => -5, 'arrayofkeyval' => self::ARRAY_STATUS_LABEL,),
112 );
113 //public $rowid;
114 //public $ref;
115 //public $date_commande;
116 //public $date_livraison;
117 //public $total_ht;
118 //public $total_tva;
119 //public $total_ttc;
120 //public $multicurrency_total_ht;
121 //public $multicurrency_total_tva;
122 //public $multicurrency_total_ttc;
123
127 public $fk_statut;
128 // END MODULEBUILDER PROPERTIES
129
130
136 protected function getOrderStatic()
137 {
138 if (!$this->order_static) {
139 $this->order_static = new Commande($this->db);
140 }
141
142 return $this->order_static;
143 }
144
150 public function __construct(DoliDB $db)
151 {
152 global $langs;
153
154 $this->db = $db;
155
156 $this->isextrafieldmanaged = 0;
157
158 $this->getOrderStatic();
159 }
160
167 public function getTooltipContentArray($params)
168 {
169 global $conf, $langs;
170
171 $datas = [];
172
173 if (getDolGlobalInt('MAIN_OPTIMIZEFORTEXTBROWSER')) {
174 return ['optimize' => $langs->trans("WebPortalOrder")];
175 }
176 $datas['picto'] = img_picto('', $this->picto) . ' <u>' . $langs->trans("WebPortalOrder") . '</u>';
177 if (isset($this->status)) {
178 $datas['picto'] .= ' ' . $this->getLibStatut(5);
179 }
180 $datas['ref'] .= '<br><b>' . $langs->trans('Ref') . ':</b> ' . $this->ref;
181
182 return $datas;
183 }
184
198 public function getNomUrl($withpicto = 0, $option = '', $max = 0, $short = 0, $notooltip = 0, $save_lastsearch_value = -1, $addlinktonotes = 0, $target = '')
199 {
200 global $conf, $langs, $hookmanager;
201
202 if (!empty($conf->dol_no_mouse_hover)) {
203 $notooltip = 1; // Force disable tooltips
204 }
205
206 $result = '';
207
208 $url = '';
209
210 $option = 'nolink';
211
212 if ($short) {
213 return $url;
214 }
215 $params = [
216 'id' => $this->id,
217 'objecttype' => $this->element,
218 'option' => $option,
219 'nofetch' => 1,
220 ];
221 $classfortooltip = 'classfortooltip';
222 $dataparams = '';
223 if (getDolGlobalInt('MAIN_ENABLE_AJAX_TOOLTIP')) {
224 $classfortooltip = 'classforajaxtooltip';
225 $dataparams = ' data-params="' . dol_escape_htmltag(json_encode($params)) . '"';
226 $label = '';
227 } else {
228 $label = implode($this->getTooltipContentArray($params));
229 }
230
231 $linkclose = '';
232
233 $linkstart = '<a href="' . $url . '"';
234 $linkstart .= $linkclose . '>';
235 $linkend = '</a>';
236
237 if ($option === 'nolink') {
238 $linkstart = '';
239 $linkend = '';
240 }
241
242 $result .= $linkstart;
243 if ($withpicto) {
244 $result .= img_object(($notooltip ? '' : $label), $this->picto, (($withpicto != 2) ? 'class="paddingright"' : ''), 0, 0, $notooltip ? 0 : 1);
245 }
246 if ($withpicto != 2) {
247 $result .= $this->ref;
248 }
249 $result .= $linkend;
250
251 global $action;
252 $hookmanager->initHooks(array($this->element . 'dao'));
253 $parameters = array('id' => $this->id, 'getnomurl' => &$result);
254 $reshook = $hookmanager->executeHooks('getNomUrl', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
255 if ($reshook > 0) {
256 $result = $hookmanager->resPrint;
257 } else {
258 $result .= $hookmanager->resPrint;
259 }
260 return $result;
261 }
262
270 public function getKanbanView($option = '', $arraydata = null)
271 {
272 global $langs, $conf;
273
274 $selected = (empty($arraydata['selected']) ? 0 : $arraydata['selected']);
275
276 $return = '<div class="box-flex-item box-flex-grow-zero">';
277 $return .= '<div class="info-box info-box-sm">';
278 $return .= '<div class="info-box-icon bg-infobox-action">';
279 $return .= img_picto('', 'order');
280 $return .= '</div>';
281 $return .= '<div class="info-box-content">';
282 $return .= '<span class="info-box-ref inline-block tdoverflowmax150 valignmiddle">' . (method_exists($this, 'getNomUrl') ? $this->getNomUrl() : $this->ref) . '</span>';
283 $return .= '<input id="cb' . $this->id . '" class="flat checkforselect fright" type="checkbox" name="toselect[]" value="' . $this->id . '"' . ($selected ? ' checked="checked"' : '') . '>';
284
285 if (property_exists($this, 'thirdparty') && is_object($this->thirdparty)) {
286 $return .= '<br><div class="info-box-ref tdoverflowmax150">' . $this->thirdparty->getNomUrl(1) . '</div>';
287 }
288 if (property_exists($this, 'total_ht')) {
289 $return .= '<div class="info-box-ref amount">' . price($this->total_ht, 0, $langs, 0, -1, -1, $conf->currency) . ' ' . $langs->trans('HT') . '</div>';
290 }
291 if (method_exists($this, 'getLibStatut')) {
292 $return .= '<div class="info-box-status margintoponly">' . $this->getLibStatut(5) . '</div>';
293 }
294 $return .= '</div>';
295 $return .= '</div>';
296 $return .= '</div>';
297
298 return $return;
299 }
300
307 public function getLabelStatus($mode = 0)
308 {
309 return $this->LibStatut($this->fk_statut, $this->billed, $mode);
310 }
311
318 public function getLibStatut($mode = 0)
319 {
320 return $this->LibStatut($this->fk_statut, $this->billed, $mode);
321 }
322
323 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
333 public function LibStatut($status, $billed, $mode, $donotshowbilled = 0)
334 {
335 // phpcs:enable
336 return $this->getOrderStatic()->LibStatut($status, $billed, $mode, $donotshowbilled);
337 }
338}
Class to manage customers orders.
const STATUS_SHIPMENTONPROCESS
Shipment on process.
const STATUS_CLOSED
Closed (Sent, billed or not)
const STATUS_CANCELED
Canceled status.
const STATUS_DRAFT
Draft status.
const STATUS_VALIDATED
Validated status.
Class to manage Dolibarr database access.
Class for WebPortalOrder.
getOrderStatic()
Get order for static method.
getTooltipContentArray($params)
getTooltipContentArray
getLabelStatus($mode=0)
Return the label of the status.
getKanbanView($option='', $arraydata=null)
Return clickable link of object (with eventually picto)
getLibStatut($mode=0)
Return the label of the status.
LibStatut($status, $billed, $mode, $donotshowbilled=0)
Return label of status.
const ARRAY_STATUS_LABEL
Status list (short label)
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)
__construct(DoliDB $db)
Constructor.
print $langs trans("Ref").' m titre as m m statut as status
Or an array listing all the potential status of the object: array: int of the status => translated la...
Definition index.php:171
img_object($titlealt, $picto, $moreatt='', $pictoisfullpath=0, $srconly=0, $notitle=0)
Show a picto called object_picto (generic function)
img_picto($titlealt, $picto, $moreatt='', $pictoisfullpath=0, $srconly=0, $notitle=0, $alt='', $morecss='', $marginleftonlyshort=2)
Show picto whatever it's its name (generic function)
price($amount, $form=0, $outlangs='', $trunc=1, $rounding=-1, $forcerounding=-1, $currency_code='')
Function to format a value into an amount for visual output Function used into PDF and HTML pages.
getDolGlobalInt($key, $default=0)
Return a Dolibarr global constant int value.
dol_escape_htmltag($stringtoescape, $keepb=0, $keepn=0, $noescapetags='', $escapeonlyhtmltags=0, $cleanalsojavascript=0)
Returns text escaped for inclusion in HTML alt or title or value tags, or into values of HTML input f...
global $conf
The following vars must be defined: $type2label $form $conf, $lang, The following vars may also be de...
Definition member.php:79