dolibarr 21.0.0-beta
companypaymentmode.class.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2017 Laurent Destailleur <eldy@users.sourceforge.net>
3 * Copyright (C) 2024 Frédéric France <frederic.france@free.fr>
4 * Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <https://www.gnu.org/licenses/>.
18 */
19
26// Put here all includes required by your class file
27require_once DOL_DOCUMENT_ROOT.'/core/class/commonobject.class.php';
28//require_once DOL_DOCUMENT_ROOT . '/societe/class/societe.class.php';
29//require_once DOL_DOCUMENT_ROOT . '/product/class/product.class.php';
30
35{
39 public $element = 'companypaymentmode';
40
44 public $table_element = 'societe_rib';
45
49 public $picto = 'generic';
50
51
52 const STATUS_ENABLED = 1;
53 const STATUS_CANCELED = 0;
54
55
73 // BEGIN MODULEBUILDER PROPERTIES
77 public $fields = array(
78 'rowid' => array('type' => 'integer', 'label' => 'Rowid', 'enabled' => 1, 'visible' => -2, 'notnull' => 1, 'position' => 10),
79 'fk_soc' => array('type' => 'integer', 'label' => 'Fk soc', 'enabled' => 1, 'visible' => -2, 'notnull' => 1, 'position' => 15),
80 'label' => array('type' => 'varchar(30)', 'label' => 'Label', 'enabled' => 1, 'visible' => -2, 'position' => 30),
81 'bank' => array('type' => 'varchar(255)', 'label' => 'Bank', 'enabled' => 1, 'visible' => -2, 'position' => 35),
82 'code_banque' => array('type' => 'varchar(128)', 'label' => 'Code banque', 'enabled' => 1, 'visible' => -2, 'position' => 40),
83 'code_guichet' => array('type' => 'varchar(6)', 'label' => 'Code guichet', 'enabled' => 1, 'visible' => -2, 'position' => 45),
84 'number' => array('type' => 'varchar(255)', 'label' => 'Number', 'enabled' => 1, 'visible' => -2, 'position' => 50),
85 'cle_rib' => array('type' => 'varchar(5)', 'label' => 'Cle rib', 'enabled' => 1, 'visible' => -2, 'position' => 55),
86 'bic' => array('type' => 'varchar(20)', 'label' => 'Bic', 'enabled' => 1, 'visible' => -2, 'position' => 60),
87 'iban_prefix' => array('type' => 'varchar(34)', 'label' => 'Iban prefix', 'enabled' => 1, 'visible' => -2, 'position' => 65),
88 'domiciliation' => array('type' => 'varchar(255)', 'label' => 'Domiciliation', 'enabled' => 1, 'visible' => -2, 'position' => 70),
89 'proprio' => array('type' => 'varchar(60)', 'label' => 'Proprio', 'enabled' => 1, 'visible' => -2, 'position' => 75),
90 'owner_address' => array('type' => 'text', 'label' => 'Owner address', 'enabled' => 1, 'visible' => -2, 'position' => 80),
91 'default_rib' => array('type' => 'tinyint(4)', 'label' => 'Default rib', 'enabled' => 1, 'visible' => -2, 'notnull' => 1, 'position' => 85),
92 'rum' => array('type' => 'varchar(32)', 'label' => 'Rum', 'enabled' => 1, 'visible' => -2, 'position' => 90),
93 'date_rum' => array('type' => 'date', 'label' => 'Date rum', 'enabled' => 1, 'visible' => -2, 'position' => 95),
94 'frstrecur' => array('type' => 'varchar(16)', 'label' => 'Frstrecur', 'enabled' => 1, 'visible' => -2, 'position' => 100),
95 'type' => array('type' => 'varchar(32)', 'label' => 'Type', 'enabled' => 1, 'visible' => -2, 'position' => 110),
96 'last_four' => array('type' => 'varchar(4)', 'label' => 'Last four', 'enabled' => 1, 'visible' => -2, 'position' => 115),
97 'card_type' => array('type' => 'varchar(255)', 'label' => 'Card type', 'enabled' => 1, 'visible' => -2, 'position' => 120),
98 'cvn' => array('type' => 'varchar(255)', 'label' => 'Cvn', 'enabled' => 1, 'visible' => -2, 'position' => 125),
99 'exp_date_month' => array('type' => 'integer', 'label' => 'Exp date month', 'enabled' => 1, 'visible' => -2, 'position' => 130),
100 'exp_date_year' => array('type' => 'integer', 'label' => 'Exp date year', 'enabled' => 1, 'visible' => -2, 'position' => 135),
101 'country_code' => array('type' => 'varchar(10)', 'label' => 'Country code', 'enabled' => 1, 'visible' => -2, 'position' => 140),
102 'approved' => array('type' => 'integer', 'label' => 'Approved', 'enabled' => 1, 'visible' => -2, 'position' => 145),
103 'email' => array('type' => 'varchar(255)', 'label' => 'Email', 'enabled' => 1, 'visible' => -2, 'position' => 150),
104 'max_total_amount_of_all_payments' => array('type' => 'double(24,8)', 'label' => 'Max total amount of all payments', 'enabled' => 1, 'visible' => -2, 'position' => 155),
105 'preapproval_key' => array('type' => 'varchar(255)', 'label' => 'Preapproval key', 'enabled' => 1, 'visible' => -2, 'position' => 160),
106 'total_amount_of_all_payments' => array('type' => 'double(24,8)', 'label' => 'Total amount of all payments', 'enabled' => 1, 'visible' => -2, 'position' => 165),
107 'stripe_card_ref' => array('type' => 'varchar(128)', 'label' => 'ExternalSystemID', 'enabled' => 1, 'visible' => -2, 'position' => 170, 'help' => 'IDOfPaymentInAnExternalSystem'),
108 'stripe_account' => array('type' => 'varchar(128)', 'label' => 'ExternalSystemCustomerAccount', 'enabled' => 1, 'visible' => -2, 'position' => 171, 'help' => 'IDOfCustomerInAnExternalSystem'),
109 'ext_payment_site' => array('type' => 'varchar(128)', 'label' => 'ExternalSystem', 'enabled' => 1, 'visible' => -2, 'position' => 172, 'help' => 'NameOfExternalSystem'),
110 'status' => array('type' => 'integer', 'label' => 'Status', 'enabled' => 1, 'visible' => -2, 'notnull' => 1, 'position' => 175),
111 'starting_date' => array('type' => 'date', 'label' => 'Starting date', 'enabled' => 1, 'visible' => -2, 'position' => 180),
112 'ending_date' => array('type' => 'date', 'label' => 'Ending date', 'enabled' => 1, 'visible' => -2, 'position' => 185),
113 'datec' => array('type' => 'datetime', 'label' => 'DateCreation', 'enabled' => 1, 'visible' => -2, 'position' => 20),
114 'tms' => array('type' => 'timestamp', 'label' => 'Tms', 'enabled' => 1, 'visible' => -2, 'notnull' => 1, 'position' => 25),
115 'import_key' => array('type' => 'varchar(14)', 'label' => 'Import key', 'enabled' => 1, 'visible' => -2, 'position' => 105),
116 //'aaa' =>array('type'=>'date', 'label'=>'Ending date', 'enabled'=>0, 'visible'=>-2, 'position'=>185),
117 );
118
122 public $rowid;
123
127 public $fk_soc;
128
132 public $label;
133
137 public $bank;
141 public $code_banque;
145 public $code_guichet;
149 public $number;
153 public $cle_rib;
157 public $bic;
158
164 public $iban;
165
169 public $iban_prefix;
170
175 public $domiciliation;
176
180 public $address;
181
186 public $proprio;
187
191 public $owner_name;
192
196 public $owner_address;
197
201 public $default_rib;
205 public $rum;
209 public $date_rum;
213 public $frstrecur;
217 public $type;
221 public $last_four;
225 public $card_type;
229 public $cvn;
233 public $exp_date_month;
237 public $exp_date_year;
241 public $country_code;
245 public $approved;
249 public $email;
253 public $max_total_amount_of_all_payments;
257 public $preapproval_key;
261 public $total_amount_of_all_payments;
265 public $stripe_card_ref; // External system payment mode ID
269 public $stripe_account; // External system customer ID
273 public $ext_payment_site; // External system 'StripeLive', 'StripeTest', 'StancerLive', 'StancerTest', ...
274
278 public $status;
279
283 public $starting_date;
287 public $ending_date;
288
294 public $datec;
295
299 public $import_key;
300 // END MODULEBUILDER PROPERTIES
301
302
308 public function __construct(DoliDB $db)
309 {
310 global $conf;
311
312 $this->db = $db;
313
314 $this->ismultientitymanaged = 'fk_soc@societe';
315 $this->isextrafieldmanaged = 0;
316
317 if (!getDolGlobalString('MAIN_SHOW_TECHNICAL_ID') && isset($this->fields['rowid'])) {
318 $this->fields['rowid']['visible'] = 0;
319 }
320 if (!isModEnabled('multicompany') && isset($this->fields['entity'])) {
321 $this->fields['entity']['enabled'] = 0;
322 }
323 }
324
332 public function create(User $user, $notrigger = 0)
333 {
334 $idpayment = $this->createCommon($user, $notrigger);
335
336 return $idpayment;
337 }
338
346 public function createFromClone(User $user, $fromid)
347 {
348 global $hookmanager, $langs;
349 $error = 0;
350
351 dol_syslog(__METHOD__, LOG_DEBUG);
352
353 $object = new self($this->db);
354
355 $this->db->begin();
356
357 // Load source object
358 $object->fetchCommon($fromid);
359 // Reset some properties
360 unset($object->id);
361 unset($object->fk_user_creat);
362 unset($object->import_key);
363
364 // Clear fields
365 $object->ref = "copy_of_".$object->ref;
366 // $object->title = $langs->trans("CopyOf")." ".$object->title;
367
368 // Create clone
369 $object->context['createfromclone'] = 'createfromclone';
370 $result = $object->createCommon($user);
371 if ($result < 0) {
372 $error++;
373 $this->error = $object->error;
374 $this->errors = $object->errors;
375 }
376
377 unset($object->context['createfromclone']);
378
379 // End
380 if (!$error) {
381 $this->db->commit();
382 return $object;
383 } else {
384 $this->db->rollback();
385 return -1;
386 }
387 }
388
399 public function fetch($id, $ref = null, $socid = 0, $type = '', $morewhere = '')
400 {
401 if ($socid) {
402 $morewhere .= " AND fk_soc = ".((int) $socid)." AND default_rib = 1";
403 }
404 if ($type) {
405 $morewhere .= " AND type = '".$this->db->escape($type)."'";
406 }
407
408 $result = $this->fetchCommon($id, $ref, $morewhere);
409
410 $this->iban_prefix = dolDecrypt($this->iban_prefix);
411
412 // For backward compatibility
413 $this->iban = $this->iban_prefix;
414 $this->date_modification = $this->tms;
415
416 //if ($result > 0 && !empty($this->table_element_line)) $this->fetchLines();
417 return $result;
418 }
419
425 /*public function fetchLines()
426 {
427 $this->lines=array();
428
429 // Load lines with object CompanyPaymentModeLine
430
431 return count($this->lines)?1:0;
432 }*/
433
441 public function update(User $user, $notrigger = 0)
442 {
443 return $this->updateCommon($user, $notrigger);
444 }
445
453 public function delete(User $user, $notrigger = 0)
454 {
455 return $this->deleteCommon($user, $notrigger);
456 }
457
468 public function getNomUrl($withpicto = 0, $option = '', $notooltip = 0, $morecss = '', $save_lastsearch_value = -1)
469 {
470 global $db, $conf, $langs;
471 global $dolibarr_main_authentication, $dolibarr_main_demo;
472 global $menumanager;
473
474 if (!empty($conf->dol_no_mouse_hover)) {
475 $notooltip = 1; // Force disable tooltips
476 }
477
478 $result = '';
479 $companylink = '';
480
481 $label = '<u>'.$langs->trans("CompanyPaymentMode").'</u>';
482 $label .= '<br>';
483 $label .= '<b>'.$langs->trans('Ref').':</b> '.$this->ref;
484
485 $url = '';
486
487 if ($option != 'nolink') {
488 // Add param to save lastsearch_values or not
489 $add_save_lastsearch_values = ($save_lastsearch_value == 1 ? 1 : 0);
490 if ($save_lastsearch_value == -1 && isset($_SERVER["PHP_SELF"]) && preg_match('/list\.php/', $_SERVER["PHP_SELF"])) {
491 $add_save_lastsearch_values = 1;
492 }
493 if ($add_save_lastsearch_values) {
494 $url .= '&save_lastsearch_values=1';
495 }
496 }
497
498 $linkclose = '';
499 if (empty($notooltip)) {
500 if (getDolGlobalString('MAIN_OPTIMIZEFORTEXTBROWSER')) {
501 $label = $langs->trans("ShowCompanyPaymentMode");
502 $linkclose .= ' alt="'.dol_escape_htmltag($label, 1).'"';
503 }
504 $linkclose .= ' title="'.dol_escape_htmltag($label, 1).'"';
505 $linkclose .= ' class="classfortooltip'.($morecss ? ' '.$morecss : '').'"';
506 } else {
507 $linkclose = ($morecss ? ' class="'.$morecss.'"' : '');
508 }
509
510 $linkstart = '<a href="'.$url.'"';
511 $linkstart .= $linkclose.'>';
512 $linkend = '</a>';
513
514 $result .= $linkstart;
515 if ($withpicto) {
516 $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);
517 }
518 if ($withpicto != 2) {
519 $result .= $this->ref;
520 }
521 $result .= $linkend;
522 //if ($withpicto != 2) $result.=(($addlabel && $this->label) ? $sep . dol_trunc($this->label, ($addlabel > 1 ? $addlabel : 0)) : '');
523
524 return $result;
525 }
526
534 public function setAsDefault($id = 0, $alltypes = 0)
535 {
536 $sql1 = "SELECT rowid as id, fk_soc, type FROM ".MAIN_DB_PREFIX."societe_rib";
537 $sql1 .= " WHERE rowid = ".((int) ($id ? $id : $this->id));
538
539 dol_syslog(get_class($this).'::setAsDefault', LOG_DEBUG);
540 $result1 = $this->db->query($sql1);
541 if ($result1) {
542 if ($this->db->num_rows($result1) == 0) {
543 return 0;
544 } else {
545 $obj = $this->db->fetch_object($result1);
546
547 $type = '';
548 if (empty($alltypes)) {
549 $type = $obj->type;
550 }
551
552 $this->db->begin();
553
554 $sql2 = "UPDATE ".MAIN_DB_PREFIX."societe_rib SET default_rib = 0, tms = tms";
555 $sql2 .= " WHERE default_rib <> 0 AND fk_soc = ".((int) $obj->fk_soc);
556 if ($type) {
557 $sql2 .= " AND type = '".$this->db->escape($type)."'";
558 }
559 dol_syslog(get_class($this).'::setAsDefault', LOG_DEBUG);
560 $result2 = $this->db->query($sql2);
561
562 $sql3 = "UPDATE ".MAIN_DB_PREFIX."societe_rib SET default_rib = 1";
563 $sql3 .= " WHERE rowid = ".((int) $obj->id);
564 if ($type) {
565 $sql3 .= " AND type = '".$this->db->escape($type)."'";
566 }
567 dol_syslog(get_class($this).'::setAsDefault', LOG_DEBUG);
568 $result3 = $this->db->query($sql3);
569
570 if (!$result2 || !$result3) {
571 dol_print_error($this->db);
572 $this->db->rollback();
573 return -1;
574 } else {
575 $this->db->commit();
576 return 1;
577 }
578 }
579 } else {
580 dol_print_error($this->db);
581 return -1;
582 }
583 }
584
591 public function getLibStatut($mode = 0)
592 {
593 return $this->LibStatut($this->status, $mode);
594 }
595
596 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
604 public function LibStatut($status, $mode = 0)
605 {
606 // phpcs:enable
607 if (empty($this->labelStatus) || empty($this->labelStatusShort)) {
608 global $langs;
609 //$langs->load("mymodule");
610 $this->labelStatus[self::STATUS_ENABLED] = $langs->transnoentitiesnoconv('Enabled');
611 $this->labelStatus[self::STATUS_CANCELED] = $langs->transnoentitiesnoconv('Disabled');
612 $this->labelStatusShort[self::STATUS_ENABLED] = $langs->transnoentitiesnoconv('Enabled');
613 $this->labelStatusShort[self::STATUS_CANCELED] = $langs->transnoentitiesnoconv('Disabled');
614 }
615
616 $statusType = 'status5';
617 if ($status == self::STATUS_ENABLED) {
618 $statusType = 'status4';
619 }
620
621 return dolGetStatus($this->labelStatus[$status], $this->labelStatusShort[$status], '', $statusType, $mode);
622 }
623
630 public function info($id)
631 {
632 $sql = 'SELECT rowid, date_creation as datec, tms as datem,';
633 $sql .= ' fk_user_creat, fk_user_modif';
634 $sql .= ' FROM '.MAIN_DB_PREFIX.$this->table_element.' as t';
635 $sql .= ' WHERE t.rowid = '.((int) $id);
636 $result = $this->db->query($sql);
637 if ($result) {
638 if ($this->db->num_rows($result)) {
639 $obj = $this->db->fetch_object($result);
640
641 $this->id = $obj->rowid;
642
643 $this->user_creation_id = $obj->fk_user_creat;
644 $this->user_modification_id = $obj->fk_user_modif;
645 $this->date_creation = $this->db->jdate($obj->datec);
646 $this->date_modification = empty($obj->datem) ? '' : $this->db->jdate($obj->datem);
647 }
648
649 $this->db->free($result);
650 } else {
651 dol_print_error($this->db);
652 }
653 }
654
661 public function initAsSpecimen()
662 {
663 return $this->initAsSpecimenCommon();
664 }
665}
if( $user->socid > 0) if(! $user->hasRight('accounting', 'chartofaccount')) $object
Definition card.php:66
Parent class of all other business classes (invoices, contracts, proposals, orders,...
createCommon(User $user, $notrigger=0)
Create object in the database.
updateCommon(User $user, $notrigger=0)
Update object into database.
initAsSpecimenCommon()
Initialise object with example values Id must be 0 if object instance is a specimen.
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.
Class for CompanyPaymentMode.
create(User $user, $notrigger=0)
Create object into database.
update(User $user, $notrigger=0)
Load object lines in memory from the database.
info($id)
Load the info information in the object.
setAsDefault($id=0, $alltypes=0)
Set a Payment mode as Default.
getLibStatut($mode=0)
Return label of the status.
__construct(DoliDB $db)
Constructor.
getNomUrl($withpicto=0, $option='', $notooltip=0, $morecss='', $save_lastsearch_value=-1)
Return a link to the object card (with optionally the picto)
initAsSpecimen()
Initialise object with example values Id must be 0 if object instance is a specimen.
fetch($id, $ref=null, $socid=0, $type='', $morewhere='')
Load object in memory from the database.
LibStatut($status, $mode=0)
Return the status.
createFromClone(User $user, $fromid)
Clone and object into another one.
Class to manage Dolibarr database access.
Class to manage Dolibarr users.
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)
dolGetStatus($statusLabel='', $statusLabelShort='', $html='', $statusType='status0', $displayMode=0, $url='', $params=array())
Output the badge of a status.
dol_print_error($db=null, $error='', $errors=null)
Displays error message system with all the information to facilitate the diagnosis and the escalation...
getDolGlobalString($key, $default='')
Return a Dolibarr global constant string value.
dol_syslog($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='', $logcontext=null)
Write log message into outputs.
global $conf
The following vars must be defined: $type2label $form $conf, $lang, The following vars may also be de...
Definition member.php:79
dolDecrypt($chain, $key='')
Decode a string with a symmetric encryption.