dolibarr 20.0.0
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 public $fk_statut;
124 // END MODULEBUILDER PROPERTIES
125
126
132 protected function getOrderStatic()
133 {
134 if (!$this->order_static) {
135 $this->order_static = new Commande($this->db);
136 }
137
138 return $this->order_static;
139 }
140
146 public function __construct(DoliDB $db)
147 {
148 global $langs;
149
150 $this->db = $db;
151
152 $this->isextrafieldmanaged = 0;
153
154 $this->getOrderStatic();
155 }
156
164 public function getTooltipContentArray($params)
165 {
166 global $conf, $langs;
167
168 $datas = [];
169
170 if (getDolGlobalInt('MAIN_OPTIMIZEFORTEXTBROWSER')) {
171 return ['optimize' => $langs->trans("WebPortalOrder")];
172 }
173 $datas['picto'] = img_picto('', $this->picto) . ' <u>' . $langs->trans("WebPortalOrder") . '</u>';
174 if (isset($this->status)) {
175 $datas['picto'] .= ' ' . $this->getLibStatut(5);
176 }
177 $datas['ref'] .= '<br><b>' . $langs->trans('Ref') . ':</b> ' . $this->ref;
178
179 return $datas;
180 }
181
195 public function getNomUrl($withpicto = 0, $option = '', $max = 0, $short = 0, $notooltip = 0, $save_lastsearch_value = -1, $addlinktonotes = 0, $target = '')
196 {
197 global $conf, $langs, $hookmanager;
198
199 if (!empty($conf->dol_no_mouse_hover)) {
200 $notooltip = 1; // Force disable tooltips
201 }
202
203 $result = '';
204
205 $url = '';
206
207 $option = 'nolink';
208
209 if ($short) {
210 return $url;
211 }
212 $params = [
213 'id' => $this->id,
214 'objecttype' => $this->element,
215 'option' => $option,
216 'nofetch' => 1,
217 ];
218 $classfortooltip = 'classfortooltip';
219 $dataparams = '';
220 if (getDolGlobalInt('MAIN_ENABLE_AJAX_TOOLTIP')) {
221 $classfortooltip = 'classforajaxtooltip';
222 $dataparams = ' data-params="' . dol_escape_htmltag(json_encode($params)) . '"';
223 $label = '';
224 } else {
225 $label = implode($this->getTooltipContentArray($params));
226 }
227
228 $linkclose = '';
229
230 $linkstart = '<a href="' . $url . '"';
231 $linkstart .= $linkclose . '>';
232 $linkend = '</a>';
233
234 if ($option === 'nolink') {
235 $linkstart = '';
236 $linkend = '';
237 }
238
239 $result .= $linkstart;
240 if ($withpicto) {
241 $result .= img_object(($notooltip ? '' : $label), $this->picto, (($withpicto != 2) ? 'class="paddingright"' : ''), 0, 0, $notooltip ? 0 : 1);
242 }
243 if ($withpicto != 2) {
244 $result .= $this->ref;
245 }
246 $result .= $linkend;
247
248 global $action;
249 $hookmanager->initHooks(array($this->element . 'dao'));
250 $parameters = array('id' => $this->id, 'getnomurl' => &$result);
251 $reshook = $hookmanager->executeHooks('getNomUrl', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
252 if ($reshook > 0) {
253 $result = $hookmanager->resPrint;
254 } else {
255 $result .= $hookmanager->resPrint;
256 }
257 return $result;
258 }
259
267 public function getKanbanView($option = '', $arraydata = null)
268 {
269 global $langs, $conf;
270
271 $selected = (empty($arraydata['selected']) ? 0 : $arraydata['selected']);
272
273 $return = '<div class="box-flex-item box-flex-grow-zero">';
274 $return .= '<div class="info-box info-box-sm">';
275 $return .= '<div class="info-box-icon bg-infobox-action">';
276 $return .= img_picto('', 'order');
277 $return .= '</div>';
278 $return .= '<div class="info-box-content">';
279 $return .= '<span class="info-box-ref inline-block tdoverflowmax150 valignmiddle">' . (method_exists($this, 'getNomUrl') ? $this->getNomUrl() : $this->ref) . '</span>';
280 $return .= '<input id="cb' . $this->id . '" class="flat checkforselect fright" type="checkbox" name="toselect[]" value="' . $this->id . '"' . ($selected ? ' checked="checked"' : '') . '>';
281
282 if (property_exists($this, 'thirdparty') && is_object($this->thirdparty)) {
283 $return .= '<br><div class="info-box-ref tdoverflowmax150">' . $this->thirdparty->getNomUrl(1) . '</div>';
284 }
285 if (property_exists($this, 'total_ht')) {
286 $return .= '<div class="info-box-ref amount">' . price($this->total_ht, 0, $langs, 0, -1, -1, $conf->currency) . ' ' . $langs->trans('HT') . '</div>';
287 }
288 if (method_exists($this, 'getLibStatut')) {
289 $return .= '<div class="info-box-status margintoponly">' . $this->getLibStatut(5) . '</div>';
290 }
291 $return .= '</div>';
292 $return .= '</div>';
293 $return .= '</div>';
294
295 return $return;
296 }
297
304 public function getLabelStatus($mode = 0)
305 {
306 return $this->LibStatut($this->fk_statut, $this->billed, $mode);
307 }
308
315 public function getLibStatut($mode = 0)
316 {
317 return $this->LibStatut($this->fk_statut, $this->billed, $mode);
318 }
319
320 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
330 public function LibStatut($status, $billed, $mode, $donotshowbilled = 0)
331 {
332 // phpcs:enable
333 return $this->getOrderStatic()->LibStatut($status, $billed, $mode, $donotshowbilled);
334 }
335}
print $langs trans("AuditedSecurityEvents").'</strong >< span class="opacitymedium"></span >< br > status
Or an array listing all the potential status of the object: array: int of the status => translated la...
Definition security.php:636
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 clicable 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 clicable link of object (with eventually picto)
__construct(DoliDB $db)
Constructor.
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...