dolibarr 20.0.5
cashcontrol.class.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2008 Laurent Destailleur <eldy@users.sourceforge.net>
3 * Copyright (C) 2009 Regis Houssin <regis.houssin@capnetworks.com>
4 * Copyright (C) 2016 Marcos García <marcosgdf@gmail.com>
5 * Copyright (C) 2018 Andreu Bisquerra <jove@bisquerra.com>
6 * Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
7 * Copyright (C) 2024 Frédéric France <frederic.france@free.fr>
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 3 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program. If not, see <https://www.gnu.org/licenses/>.
21 */
22
33{
37 public $element = 'cashcontrol';
38
42 public $table_element = 'pos_cash_fence';
43
47 public $picto = 'cash-register';
48
74 public $fields = array(
75 'rowid' => array('type' => 'integer', 'label' => 'TechnicalID', 'enabled' => 1, 'visible' => -2, 'notnull' => 1, 'position' => 10),
76 'entity' => array('type' => 'integer', 'label' => 'Entity', 'enabled' => 1, 'visible' => 0, 'notnull' => 1, 'position' => 15),
77 'ref' => array('type' => 'varchar(64)', 'label' => 'Ref', 'enabled' => 1, 'visible' => 1, 'notnull' => 1, 'position' => 18),
78 'posmodule' => array('type' => 'varchar(30)', 'label' => 'Module', 'enabled' => 1, 'visible' => 1, 'notnull' => 1, 'position' => 19),
79 'posnumber' => array('type' => 'varchar(30)', 'label' => 'Terminal', 'enabled' => 1, 'visible' => 1, 'notnull' => 1, 'position' => 20, 'css' => 'center'),
80 'label' => array('type' => 'varchar(255)', 'label' => 'Label', 'enabled' => 1, 'visible' => 0, 'position' => 24),
81 'opening' => array('type' => 'price', 'label' => 'Opening', 'enabled' => 1, 'visible' => 1, 'position' => 25, 'csslist' => 'amount'),
82 'cash' => array('type' => 'price', 'label' => 'Cash', 'enabled' => 1, 'visible' => 1, 'position' => 30, 'csslist' => 'amount'),
83 'cheque' => array('type' => 'price', 'label' => 'Cheque', 'enabled' => 1, 'visible' => 1, 'position' => 33, 'csslist' => 'amount'),
84 'card' => array('type' => 'price', 'label' => 'CreditCard', 'enabled' => 1, 'visible' => 1, 'position' => 36, 'csslist' => 'amount'),
85 'year_close' => array('type' => 'integer', 'label' => 'Year close', 'enabled' => 1, 'visible' => 1, 'notnull' => 1, 'position' => 50, 'css' => 'center'),
86 'month_close' => array('type' => 'integer', 'label' => 'Month close', 'enabled' => 1, 'visible' => 1, 'position' => 55, 'css' => 'center'),
87 'day_close' => array('type' => 'integer', 'label' => 'Day close', 'enabled' => 1, 'visible' => 1, 'position' => 60, 'css' => 'center'),
88 'date_creation' => array('type' => 'datetime', 'label' => 'DateCreation', 'enabled' => 1, 'visible' => -1, 'notnull' => 1, 'position' => 500),
89 'date_valid' => array('type' => 'datetime', 'label' => 'DateValidation', 'enabled' => 1, 'visible' => -1, 'notnull' => 1, 'position' => 502),
90 'tms' => array('type' => 'timestamp', 'label' => 'Tms', 'enabled' => 1, 'visible' => 0, 'notnull' => 1, 'position' => 505),
91 'fk_user_creat' => array('type' => 'integer:User', 'label' => 'UserCreation', 'enabled' => 1, 'visible' => -1, 'notnull' => 1, 'position' => 600),
92 'fk_user_valid' => array('type' => 'integer:User', 'label' => 'UserValidation', 'enabled' => 1, 'visible' => -1, 'notnull' => 1, 'position' => 602),
93 'import_key' => array('type' => 'varchar(14)', 'label' => 'Import key', 'enabled' => 1, 'visible' => 0, 'position' => 700),
94 'status' => array('type' => 'integer', 'label' => 'Status', 'enabled' => 1, 'visible' => 1, 'position' => 1000, 'notnull' => 1, 'index' => 1, 'arrayofkeyval' => array('0' => 'Draft', '1' => 'Validated')),
95 );
96
100 public $id;
101 public $label;
102 public $opening;
103 public $status;
104 public $year_close;
105 public $month_close;
106 public $day_close;
107 public $posmodule;
108 public $posnumber;
109 public $cash;
110 public $cheque;
111 public $card;
112
116 public $date_creation;
117 public $fk_user_creat;
118
122 public $date_modification;
123
127 public $date_valid;
128 public $fk_user_valid;
129
130
131 const STATUS_DRAFT = 0;
132 const STATUS_VALIDATED = 1;
133 const STATUS_CLOSED = 1; // For the moment CLOSED = VALIDATED
134
135
141 public function __construct(DoliDB $db)
142 {
143 $this->db = $db;
144
145 $this->ismultientitymanaged = 1;
146 $this->isextrafieldmanaged = 0;
147 }
148
149
157 public function create(User $user, $notrigger = 0)
158 {
159 global $conf;
160
161 $error = 0;
162
163 // Clean data
164 if (empty($this->cash)) {
165 $this->cash = 0;
166 }
167 if (empty($this->cheque)) {
168 $this->cheque = 0;
169 }
170 if (empty($this->card)) {
171 $this->card = 0;
172 }
173
174 // Insert request
175 $sql = "INSERT INTO ".MAIN_DB_PREFIX."pos_cash_fence (";
176 $sql .= "entity";
177 //$sql .= ", ref";
178 $sql .= ", opening";
179 $sql .= ", status";
180 $sql .= ", date_creation";
181 $sql .= ", posmodule";
182 $sql .= ", posnumber";
183 $sql .= ", day_close";
184 $sql .= ", month_close";
185 $sql .= ", year_close";
186 $sql .= ", cash";
187 $sql .= ", cheque";
188 $sql .= ", card";
189 $sql .= ", fk_user_creat";
190 $sql .= ") VALUES (";
191 //$sql .= "'(PROV)', ";
192 $sql .= ((int) $conf->entity);
193 $sql .= ", ".(is_numeric($this->opening) ? price2num($this->opening, 'MT') : 0);
194 $sql .= ", 0"; // Draft by default
195 $sql .= ", '".$this->db->idate(dol_now())."'";
196 $sql .= ", '".$this->db->escape($this->posmodule)."'";
197 $sql .= ", '".$this->db->escape($this->posnumber)."'";
198 $sql .= ", ".($this->day_close > 0 ? $this->day_close : "null");
199 $sql .= ", ".($this->month_close > 0 ? $this->month_close : "null");
200 $sql .= ", ".((int) $this->year_close);
201 $sql .= ", ".price2num($this->cash, 'MT');
202 $sql .= ", ".price2num($this->cheque, 'MT');
203 $sql .= ", ".price2num($this->card, 'MT');
204 $sql .= ", ".((int) $user->id);
205 $sql .= ")";
206
207 $this->db->begin();
208
209 dol_syslog(get_class($this)."::create", LOG_DEBUG);
210 $resql = $this->db->query($sql);
211 if (!$resql) {
212 $error++;
213 $this->errors[] = "Error ".$this->db->lasterror();
214 }
215
216 if (!$error) {
217 $this->id = $this->db->last_insert_id(MAIN_DB_PREFIX."pos_cash_fence");
218
219 $sql = 'UPDATE '.MAIN_DB_PREFIX.'pos_cash_fence SET ref = rowid where rowid = '.((int) $this->id);
220 $this->db->query($sql);
221 }
222
223 // Commit or rollback
224 if ($error) {
225 foreach ($this->errors as $errmsg) {
226 dol_syslog(get_class($this)."::create ".$errmsg, LOG_ERR);
227 $this->error .= ($this->error ? ', '.$errmsg : $errmsg);
228 }
229 $this->db->rollback();
230 return -1 * $error;
231 } else {
232 $this->db->commit();
233 return $this->id;
234 }
235 }
236
244 public function valid(User $user, $notrigger = 0)
245 {
246 global $conf, $langs;
247 require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
248
249 $error = 0;
250
251 // Protection
252 if ($this->status == self::STATUS_VALIDATED) {
253 dol_syslog(get_class($this)."::valid action abandoned: already validated", LOG_WARNING);
254 return 0;
255 }
256
257 $now = dol_now();
258
259 // Update request
260 $sql = "UPDATE ".MAIN_DB_PREFIX."pos_cash_fence";
261 $sql .= " SET status = ".self::STATUS_VALIDATED.",";
262 $sql .= " date_valid='".$this->db->idate($now)."',";
263 $sql .= " fk_user_valid = ".$user->id;
264 $sql .= " WHERE rowid=".((int) $this->id);
265
266 $this->db->begin();
267
268 dol_syslog(get_class($this)."::close", LOG_DEBUG);
269 $resql = $this->db->query($sql);
270 if (!$resql) {
271 $error++;
272 $this->errors[] = "Error ".$this->db->lasterror();
273 }
274
275 if (!$error) {
276 $this->status = self::STATUS_VALIDATED;
277 $this->date_valid = $now;
278 $this->fk_user_valid = $user->id;
279 }
280
281 if (!$error && !$notrigger) {
282 // Call trigger
283 $result = $this->call_trigger('CASHCONTROL_VALIDATE', $user);
284 if ($result < 0) {
285 $error++;
286 }
287 // End call triggers
288 }
289
290 // Commit or rollback
291 if ($error) {
292 foreach ($this->errors as $errmsg) {
293 dol_syslog(get_class($this)."::create ".$errmsg, LOG_ERR);
294 $this->error .= ($this->error ? ', '.$errmsg : $errmsg);
295 }
296 $this->db->rollback();
297 return -1 * $error;
298 } else {
299 $this->db->commit();
300 return $this->id;
301 }
302 }
303
304
312 public function fetch($id, $ref = null)
313 {
314 $result = $this->fetchCommon($id, $ref);
315 //if ($result > 0 && !empty($this->table_element_line)) $this->fetchLines();
316 return $result;
317 }
318
326 public function update(User $user, $notrigger = 0)
327 {
328 return $this->updateCommon($user, $notrigger);
329 }
330
338 public function delete(User $user, $notrigger = 0)
339 {
340 return $this->deleteCommon($user, $notrigger);
341 //return $this->deleteCommon($user, $notrigger, 1);
342 }
343
350 public function getLibStatut($mode = 0)
351 {
352 return $this->LibStatut($this->status, $mode);
353 }
354
355 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
363 public function LibStatut($status, $mode = 0)
364 {
365 // phpcs:enable
366 if (empty($this->labelStatus) || empty($this->labelStatusShort)) {
367 global $langs;
368 //$langs->load("mymodule");
369 $this->labelStatus[0] = $langs->transnoentitiesnoconv('Draft');
370 $this->labelStatus[1] = $langs->transnoentitiesnoconv('Closed');
371 $this->labelStatusShort[0] = $langs->transnoentitiesnoconv('Draft');
372 $this->labelStatusShort[1] = $langs->transnoentitiesnoconv('Closed');
373 }
374
375 $statusType = 'status0';
376 if ($status == self::STATUS_VALIDATED) {
377 $statusType = 'status6';
378 }
379
380 return dolGetStatus($this->labelStatus[$status], $this->labelStatusShort[$status], '', $statusType, $mode);
381 }
382
393 public function getNomUrl($withpicto = 0, $option = '', $notooltip = 0, $morecss = '', $save_lastsearch_value = -1)
394 {
395 global $conf, $langs, $hookmanager;
396
397 if (!empty($conf->dol_no_mouse_hover)) {
398 $notooltip = 1; // Force disable tooltips
399 }
400
401 $result = '';
402
403 $newref = ($this->ref ? $this->ref : $this->id);
404
405 $label = '<u>'.$langs->trans("CashControl").'</u>';
406 $label .= '<br>';
407 $label .= '<b>'.$langs->trans('Ref').':</b> '.($this->ref ? $this->ref : $this->id);
408
409 $url = DOL_URL_ROOT.'/compta/cashcontrol/cashcontrol_card.php?id='.$this->id;
410
411 if ($option != 'nolink') {
412 // Add param to save lastsearch_values or not
413 $add_save_lastsearch_values = ($save_lastsearch_value == 1 ? 1 : 0);
414 if ($save_lastsearch_value == -1 && isset($_SERVER["PHP_SELF"]) && preg_match('/list\.php/', $_SERVER["PHP_SELF"])) {
415 $add_save_lastsearch_values = 1;
416 }
417 if ($add_save_lastsearch_values) {
418 $url .= '&save_lastsearch_values=1';
419 }
420 }
421
422 $linkclose = '';
423 if (empty($notooltip)) {
424 if (getDolGlobalString('MAIN_OPTIMIZEFORTEXTBROWSER')) {
425 $label = $langs->trans("ShowMyObject");
426 $linkclose .= ' alt="'.dol_escape_htmltag($label, 1).'"';
427 }
428 $linkclose .= ' title="'.dol_escape_htmltag($label, 1).'"';
429 $linkclose .= ' class="classfortooltip'.($morecss ? ' '.$morecss : '').'"';
430 } else {
431 $linkclose = ($morecss ? ' class="'.$morecss.'"' : '');
432 }
433
434 $linkstart = '<a href="'.$url.'"';
435 $linkstart .= $linkclose.'>';
436 $linkend = '</a>';
437
438 $result .= $linkstart;
439 if ($withpicto) {
440 $result .= img_object(($notooltip ? '' : $label), ($this->picto ? $this->picto : 'generic'), ($notooltip ? (($withpicto != 2) ? 'class="paddingright"' : '') : 'class="'.(($withpicto != 2) ? 'paddingright ' : '').'classfortooltip"'), 0, 0, $notooltip ? 0 : 1);
441 }
442 if ($withpicto != 2) {
443 $result .= $this->ref;
444 }
445 $result .= $linkend;
446 //if ($withpicto != 2) $result.=(($addlabel && $this->label) ? $sep . dol_trunc($this->label, ($addlabel > 1 ? $addlabel : 0)) : '');
447
448 global $action;
449 $hookmanager->initHooks(array('cashfencedao'));
450 $parameters = array('id' => $this->id, 'getnomurl' => &$result);
451 $reshook = $hookmanager->executeHooks('getNomUrl', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
452 if ($reshook > 0) {
453 $result = $hookmanager->resPrint;
454 } else {
455 $result .= $hookmanager->resPrint;
456 }
457
458 return $result;
459 }
460
468 public function getKanbanView($option = '', $arraydata = null)
469 {
470 global $langs;
471
472 $selected = (empty($arraydata['selected']) ? 0 : $arraydata['selected']);
473
474 $return = '<div class="box-flex-item box-flex-grow-zero">';
475 $return .= '<div class="info-box info-box-sm">';
476 $return .= '<span class="info-box-icon bg-infobox-action">';
477 $return .= img_picto('', $this->picto);
478 //var_dump($this->fields['rowid']);exit;
479 $return .= '</span>';
480 $return .= '<div class="info-box-content">';
481 $return .= '<span class="info-box-ref inline-block tdoverflowmax150 valignmiddle">'.(method_exists($this, 'getNomUrl') ? $this->getNomUrl(1, 1) : $this->ref).'</span>';
482 if ($selected >= 0) {
483 $return .= '<input id="cb'.$this->id.'" class="flat checkforselect fright" type="checkbox" name="toselect[]" value="'.$this->id.'"'.($selected ? ' checked="checked"' : '').'>';
484 }
485 if (property_exists($this, 'posmodule')) {
486 $return .= '<br><span class="opacitymedium">'.substr($langs->trans("Module/Application"), 0, 12).'</span> : <span class="info-box-label">'.$this->posmodule.'</span>';
487 }
488 if (property_exists($this, 'year_close')) {
489 $return .= '<br><span class="info-box-label opacitymedium" >'.$langs->trans("Year").'</span> : <span>'.$this->year_close.'</span>';
490 }
491 if (method_exists($this, 'getLibStatut')) {
492 $return .= '<br><div class="info-box-status">'.$this->getLibStatut(3).'</div>';
493 }
494 $return .= '</div>';
495 $return .= '</div>';
496 $return .= '</div>';
497 return $return;
498 }
499}
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:637
$object ref
Definition info.php:79
Class to manage cash fence.
getKanbanView($option='', $arraydata=null)
Return clicable link of object (with eventually picto)
LibStatut($status, $mode=0)
Return the status.
valid(User $user, $notrigger=0)
Validate cash fence.
update(User $user, $notrigger=0)
Update object into database.
getNomUrl($withpicto=0, $option='', $notooltip=0, $morecss='', $save_lastsearch_value=-1)
Return clicable link of object (with eventually picto)
$fields
'type' field format ('integer', 'integer:ObjectClass:PathToClass[:AddCreateButtonOrNot[:Filter]]',...
create(User $user, $notrigger=0)
Create in database.
getLibStatut($mode=0)
Return label of the status.
__construct(DoliDB $db)
Constructor.
fetch($id, $ref=null)
Load object in memory from the database.
Parent class of all other business classes (invoices, contracts, proposals, orders,...
updateCommon(User $user, $notrigger=0)
Update object into database.
fetchCommon($id, $ref=null, $morewhere='', $noextrafields=0)
Load object in memory from the database.
deleteCommon(User $user, $notrigger=0, $forcechilddeletion=0)
Delete object in database.
call_trigger($triggerName, $user)
Call trigger based on this instance.
Class to manage Dolibarr database access.
Class to manage Dolibarr users.
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)
price2num($amount, $rounding='', $option=0)
Function that return a number with universal decimal format (decimal separator is '.
dol_now($mode='auto')
Return date for now.
getDolGlobalString($key, $default='')
Return dolibarr global constant string value.
dol_syslog($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='', $logcontext=null)
Write log message into outputs.