dolibarr  17.0.3
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) ---Put here your own copyright and developer email---
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 3 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program. If not, see <https://www.gnu.org/licenses/>.
17  */
18 
25 // Put here all includes required by your class file
26 require_once DOL_DOCUMENT_ROOT.'/core/class/commonobject.class.php';
27 //require_once DOL_DOCUMENT_ROOT . '/societe/class/societe.class.php';
28 //require_once DOL_DOCUMENT_ROOT . '/product/class/product.class.php';
29 
34 {
38  public $element = 'companypaymentmode';
39 
43  public $table_element = 'societe_rib';
44 
49  public $ismultientitymanaged = 'fk_soc@societe';
50 
54  public $isextrafieldmanaged = 0;
55 
59  public $picto = 'generic';
60 
61 
62  const STATUS_ENABLED = 1;
63  const STATUS_CANCELED = 0;
64 
65 
83  // BEGIN MODULEBUILDER PROPERTIES
87  public $fields = array(
88  'rowid' =>array('type'=>'integer', 'label'=>'Rowid', 'enabled'=>1, 'visible'=>-2, 'notnull'=>1, 'position'=>10),
89  'fk_soc' =>array('type'=>'integer', 'label'=>'Fk soc', 'enabled'=>1, 'visible'=>-2, 'notnull'=>1, 'position'=>15),
90  'label' =>array('type'=>'varchar(30)', 'label'=>'Label', 'enabled'=>1, 'visible'=>-2, 'position'=>30),
91  'bank' =>array('type'=>'varchar(255)', 'label'=>'Bank', 'enabled'=>1, 'visible'=>-2, 'position'=>35),
92  'code_banque' =>array('type'=>'varchar(128)', 'label'=>'Code banque', 'enabled'=>1, 'visible'=>-2, 'position'=>40),
93  'code_guichet' =>array('type'=>'varchar(6)', 'label'=>'Code guichet', 'enabled'=>1, 'visible'=>-2, 'position'=>45),
94  'number' =>array('type'=>'varchar(255)', 'label'=>'Number', 'enabled'=>1, 'visible'=>-2, 'position'=>50),
95  'cle_rib' =>array('type'=>'varchar(5)', 'label'=>'Cle rib', 'enabled'=>1, 'visible'=>-2, 'position'=>55),
96  'bic' =>array('type'=>'varchar(20)', 'label'=>'Bic', 'enabled'=>1, 'visible'=>-2, 'position'=>60),
97  'iban_prefix' =>array('type'=>'varchar(34)', 'label'=>'Iban prefix', 'enabled'=>1, 'visible'=>-2, 'position'=>65),
98  'domiciliation' =>array('type'=>'varchar(255)', 'label'=>'Domiciliation', 'enabled'=>1, 'visible'=>-2, 'position'=>70),
99  'proprio' =>array('type'=>'varchar(60)', 'label'=>'Proprio', 'enabled'=>1, 'visible'=>-2, 'position'=>75),
100  'owner_address' =>array('type'=>'text', 'label'=>'Owner address', 'enabled'=>1, 'visible'=>-2, 'position'=>80),
101  'default_rib' =>array('type'=>'tinyint(4)', 'label'=>'Default rib', 'enabled'=>1, 'visible'=>-2, 'notnull'=>1, 'position'=>85),
102  'rum' =>array('type'=>'varchar(32)', 'label'=>'Rum', 'enabled'=>1, 'visible'=>-2, 'position'=>90),
103  'date_rum' =>array('type'=>'date', 'label'=>'Date rum', 'enabled'=>1, 'visible'=>-2, 'position'=>95),
104  'frstrecur' =>array('type'=>'varchar(16)', 'label'=>'Frstrecur', 'enabled'=>1, 'visible'=>-2, 'position'=>100),
105  'type' =>array('type'=>'varchar(32)', 'label'=>'Type', 'enabled'=>1, 'visible'=>-2, 'position'=>110),
106  'last_four' =>array('type'=>'varchar(4)', 'label'=>'Last four', 'enabled'=>1, 'visible'=>-2, 'position'=>115),
107  'card_type' =>array('type'=>'varchar(255)', 'label'=>'Card type', 'enabled'=>1, 'visible'=>-2, 'position'=>120),
108  'cvn' =>array('type'=>'varchar(255)', 'label'=>'Cvn', 'enabled'=>1, 'visible'=>-2, 'position'=>125),
109  'exp_date_month' =>array('type'=>'integer', 'label'=>'Exp date month', 'enabled'=>1, 'visible'=>-2, 'position'=>130),
110  'exp_date_year' =>array('type'=>'integer', 'label'=>'Exp date year', 'enabled'=>1, 'visible'=>-2, 'position'=>135),
111  'country_code' =>array('type'=>'varchar(10)', 'label'=>'Country code', 'enabled'=>1, 'visible'=>-2, 'position'=>140),
112  'approved' =>array('type'=>'integer', 'label'=>'Approved', 'enabled'=>1, 'visible'=>-2, 'position'=>145),
113  'email' =>array('type'=>'varchar(255)', 'label'=>'Email', 'enabled'=>1, 'visible'=>-2, 'position'=>150),
114  'max_total_amount_of_all_payments' =>array('type'=>'double(24,8)', 'label'=>'Max total amount of all payments', 'enabled'=>1, 'visible'=>-2, 'position'=>155),
115  'preapproval_key' =>array('type'=>'varchar(255)', 'label'=>'Preapproval key', 'enabled'=>1, 'visible'=>-2, 'position'=>160),
116  'total_amount_of_all_payments' =>array('type'=>'double(24,8)', 'label'=>'Total amount of all payments', 'enabled'=>1, 'visible'=>-2, 'position'=>165),
117  'stripe_card_ref' =>array('type'=>'varchar(128)', 'label'=>'Stripe card ref', 'enabled'=>1, 'visible'=>-2, 'position'=>170),
118  'stripe_account' =>array('type'=>'varchar(128)', 'label'=>'Stripe account', 'enabled'=>1, 'visible'=>-2, 'position'=>171),
119  'status' =>array('type'=>'integer', 'label'=>'Status', 'enabled'=>1, 'visible'=>-2, 'notnull'=>1, 'position'=>175),
120  'starting_date' =>array('type'=>'date', 'label'=>'Starting date', 'enabled'=>1, 'visible'=>-2, 'position'=>180),
121  'ending_date' =>array('type'=>'date', 'label'=>'Ending date', 'enabled'=>1, 'visible'=>-2, 'position'=>185),
122  'datec' =>array('type'=>'datetime', 'label'=>'DateCreation', 'enabled'=>1, 'visible'=>-2, 'position'=>20),
123  'tms' =>array('type'=>'timestamp', 'label'=>'Tms', 'enabled'=>1, 'visible'=>-2, 'notnull'=>1, 'position'=>25),
124  'import_key' =>array('type'=>'varchar(14)', 'label'=>'Import key', 'enabled'=>1, 'visible'=>-2, 'position'=>105),
125  //'aaa' =>array('type'=>'date', 'label'=>'Ending date', 'enabled'=>0, 'visible'=>-2, 'position'=>185),
126  );
127 
131  public $rowid;
132 
136  public $fk_soc;
137 
141  public $label;
142 
143  public $bank;
144  public $code_banque;
145  public $code_guichet;
146  public $number;
147  public $cle_rib;
148  public $bic;
149  public $iban_prefix;
150  public $domiciliation;
151  public $proprio;
152  public $owner_address;
153  public $default_rib;
154  public $rum;
155  public $date_rum;
156  public $frstrecur;
157  public $type;
158  public $last_four;
159  public $card_type;
160  public $cvn;
161  public $exp_date_month;
162  public $exp_date_year;
163  public $country_code;
164  public $approved;
165  public $email;
166  public $max_total_amount_of_all_payments;
167  public $preapproval_key;
168  public $total_amount_of_all_payments;
169  public $stripe_card_ref;
170  public $stripe_account;
171 
175  public $status;
176 
177  public $starting_date;
178  public $ending_date;
179 
185  public $datec;
186 
192  public $tms;
193 
194  public $import_key;
195  // END MODULEBUILDER PROPERTIES
196 
197 
198 
199  // If this object has a subtable with lines
200 
204  //public $table_element_line = 'companypaymentmodedet';
208  //public $fk_element = 'fk_companypaymentmode';
212  //public $class_element_line = 'CompanyPaymentModeline';
216  //protected $childtables=array();
220  //public $lines = array();
221 
222 
223 
229  public function __construct(DoliDB $db)
230  {
231  global $conf;
232 
233  $this->db = $db;
234 
235  if (empty($conf->global->MAIN_SHOW_TECHNICAL_ID) && isset($this->fields['rowid'])) {
236  $this->fields['rowid']['visible'] = 0;
237  }
238  if (!isModEnabled('multicompany') && isset($this->fields['entity'])) {
239  $this->fields['entity']['enabled'] = 0;
240  }
241  }
242 
250  public function create(User $user, $notrigger = false)
251  {
252  $idpayment = $this->createCommon($user, $notrigger);
253 
254  return $idpayment;
255  }
256 
264  public function createFromClone(User $user, $fromid)
265  {
266  global $hookmanager, $langs;
267  $error = 0;
268 
269  dol_syslog(__METHOD__, LOG_DEBUG);
270 
271  $object = new self($this->db);
272 
273  $this->db->begin();
274 
275  // Load source object
276  $object->fetchCommon($fromid);
277  // Reset some properties
278  unset($object->id);
279  unset($object->fk_user_creat);
280  unset($object->import_key);
281 
282  // Clear fields
283  $object->ref = "copy_of_".$object->ref;
284  $object->title = $langs->trans("CopyOf")." ".$object->title;
285  // ...
286 
287  // Create clone
288  $object->context['createfromclone'] = 'createfromclone';
289  $result = $object->createCommon($user);
290  if ($result < 0) {
291  $error++;
292  $this->error = $object->error;
293  $this->errors = $object->errors;
294  }
295 
296  unset($object->context['createfromclone']);
297 
298  // End
299  if (!$error) {
300  $this->db->commit();
301  return $object;
302  } else {
303  $this->db->rollback();
304  return -1;
305  }
306  }
307 
318  public function fetch($id, $ref = null, $socid = 0, $type = '', $morewhere = '')
319  {
320  if ($socid) {
321  $morewhere .= " AND fk_soc = ".((int) $socid)." AND default_rib = 1";
322  }
323  if ($type) {
324  $morewhere .= " AND type = '".$this->db->escape($type)."'";
325  }
326 
327  $result = $this->fetchCommon($id, $ref, $morewhere);
328 
329  // For backward compatibility
330  $this->iban = $this->iban_prefix;
331 
332  //if ($result > 0 && !empty($this->table_element_line)) $this->fetchLines();
333  return $result;
334  }
335 
341  /*public function fetchLines()
342  {
343  $this->lines=array();
344 
345  // Load lines with object CompanyPaymentModeLine
346 
347  return count($this->lines)?1:0;
348  }*/
349 
357  public function update(User $user, $notrigger = false)
358  {
359  return $this->updateCommon($user, $notrigger);
360  }
361 
369  public function delete(User $user, $notrigger = false)
370  {
371  return $this->deleteCommon($user, $notrigger);
372  }
373 
384  public function getNomUrl($withpicto = 0, $option = '', $notooltip = 0, $morecss = '', $save_lastsearch_value = -1)
385  {
386  global $db, $conf, $langs;
387  global $dolibarr_main_authentication, $dolibarr_main_demo;
388  global $menumanager;
389 
390  if (!empty($conf->dol_no_mouse_hover)) {
391  $notooltip = 1; // Force disable tooltips
392  }
393 
394  $result = '';
395  $companylink = '';
396 
397  $label = '<u>'.$langs->trans("CompanyPaymentMode").'</u>';
398  $label .= '<br>';
399  $label .= '<b>'.$langs->trans('Ref').':</b> '.$this->ref;
400 
401  $url = '';
402 
403  if ($option != 'nolink') {
404  // Add param to save lastsearch_values or not
405  $add_save_lastsearch_values = ($save_lastsearch_value == 1 ? 1 : 0);
406  if ($save_lastsearch_value == -1 && preg_match('/list\.php/', $_SERVER["PHP_SELF"])) {
407  $add_save_lastsearch_values = 1;
408  }
409  if ($add_save_lastsearch_values) {
410  $url .= '&save_lastsearch_values=1';
411  }
412  }
413 
414  $linkclose = '';
415  if (empty($notooltip)) {
416  if (!empty($conf->global->MAIN_OPTIMIZEFORTEXTBROWSER)) {
417  $label = $langs->trans("ShowCompanyPaymentMode");
418  $linkclose .= ' alt="'.dol_escape_htmltag($label, 1).'"';
419  }
420  $linkclose .= ' title="'.dol_escape_htmltag($label, 1).'"';
421  $linkclose .= ' class="classfortooltip'.($morecss ? ' '.$morecss : '').'"';
422  } else {
423  $linkclose = ($morecss ? ' class="'.$morecss.'"' : '');
424  }
425 
426  $linkstart = '<a href="'.$url.'"';
427  $linkstart .= $linkclose.'>';
428  $linkend = '</a>';
429 
430  $result .= $linkstart;
431  if ($withpicto) {
432  $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);
433  }
434  if ($withpicto != 2) {
435  $result .= $this->ref;
436  }
437  $result .= $linkend;
438  //if ($withpicto != 2) $result.=(($addlabel && $this->label) ? $sep . dol_trunc($this->label, ($addlabel > 1 ? $addlabel : 0)) : '');
439 
440  return $result;
441  }
442 
450  public function setAsDefault($id = 0, $alltypes = 0)
451  {
452  $sql1 = "SELECT rowid as id, fk_soc, type FROM ".MAIN_DB_PREFIX."societe_rib";
453  $sql1 .= " WHERE rowid = ".($id ? $id : $this->id);
454 
455  dol_syslog(get_class($this).'::setAsDefault', LOG_DEBUG);
456  $result1 = $this->db->query($sql1);
457  if ($result1) {
458  if ($this->db->num_rows($result1) == 0) {
459  return 0;
460  } else {
461  $obj = $this->db->fetch_object($result1);
462 
463  $type = '';
464  if (empty($alltypes)) {
465  $type = $obj->type;
466  }
467 
468  $this->db->begin();
469 
470  $sql2 = "UPDATE ".MAIN_DB_PREFIX."societe_rib SET default_rib = 0, tms = tms";
471  $sql2 .= " WHERE default_rib <> 0 AND fk_soc = ".((int) $obj->fk_soc);
472  if ($type) {
473  $sql2 .= " AND type = '".$this->db->escape($type)."'";
474  }
475  dol_syslog(get_class($this).'::setAsDefault', LOG_DEBUG);
476  $result2 = $this->db->query($sql2);
477 
478  $sql3 = "UPDATE ".MAIN_DB_PREFIX."societe_rib SET default_rib = 1";
479  $sql3 .= " WHERE rowid = ".((int) $obj->id);
480  if ($type) {
481  $sql3 .= " AND type = '".$this->db->escape($type)."'";
482  }
483  dol_syslog(get_class($this).'::setAsDefault', LOG_DEBUG);
484  $result3 = $this->db->query($sql3);
485 
486  if (!$result2 || !$result3) {
487  dol_print_error($this->db);
488  $this->db->rollback();
489  return -1;
490  } else {
491  $this->db->commit();
492  return 1;
493  }
494  }
495  } else {
496  dol_print_error($this->db);
497  return -1;
498  }
499  }
500 
507  public function getLibStatut($mode = 0)
508  {
509  return $this->LibStatut($this->status, $mode);
510  }
511 
512  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
520  public function LibStatut($status, $mode = 0)
521  {
522  // phpcs:enable
523  if (empty($this->labelStatus) || empty($this->labelStatusShort)) {
524  global $langs;
525  //$langs->load("mymodule");
526  $this->labelStatus[self::STATUS_ENABLED] = $langs->transnoentitiesnoconv('Enabled');
527  $this->labelStatus[self::STATUS_CANCELED] = $langs->transnoentitiesnoconv('Disabled');
528  $this->labelStatusShort[self::STATUS_ENABLED] = $langs->transnoentitiesnoconv('Enabled');
529  $this->labelStatusShort[self::STATUS_CANCELED] = $langs->transnoentitiesnoconv('Disabled');
530  }
531 
532  $statusType = 'status5';
533  if ($status == self::STATUS_ENABLED) {
534  $statusType = 'status4';
535  }
536 
537  return dolGetStatus($this->labelStatus[$status], $this->labelStatusShort[$status], '', $statusType, $mode);
538  }
539 
546  public function info($id)
547  {
548  $sql = 'SELECT rowid, date_creation as datec, tms as datem,';
549  $sql .= ' fk_user_creat, fk_user_modif';
550  $sql .= ' FROM '.MAIN_DB_PREFIX.$this->table_element.' as t';
551  $sql .= ' WHERE t.rowid = '.((int) $id);
552  $result = $this->db->query($sql);
553  if ($result) {
554  if ($this->db->num_rows($result)) {
555  $obj = $this->db->fetch_object($result);
556  $this->id = $obj->rowid;
557 
558  $this->user_creation_id = $obj->fk_user_creat;
559  $this->user_modification_id = $obj->fk_user_modif;
560  $this->date_creation = $this->db->jdate($obj->datec);
561  $this->date_modification = empty($obj->datem) ? '' : $this->db->jdate($obj->datem);
562  }
563 
564  $this->db->free($result);
565  } else {
566  dol_print_error($this->db);
567  }
568  }
569 
576  public function initAsSpecimen()
577  {
578  $this->initAsSpecimenCommon();
579  }
580 }
CommonObject\deleteCommon
deleteCommon(User $user, $notrigger=false, $forcechilddeletion=0)
Delete object in database.
Definition: commonobject.class.php:9573
db
$conf db
API class for accounts.
Definition: inc.php:41
CommonObject\fetchCommon
fetchCommon($id, $ref=null, $morewhere='')
Load object in memory from the database.
Definition: commonobject.class.php:9363
CompanyPaymentMode\createFromClone
createFromClone(User $user, $fromid)
Clone and object into another one.
Definition: companypaymentmode.class.php:264
DoliDB
Class to manage Dolibarr database access.
Definition: DoliDB.class.php:30
dol_print_error
dol_print_error($db='', $error='', $errors=null)
Displays error message system with all the information to facilitate the diagnosis and the escalation...
Definition: functions.lib.php:4993
CompanyPaymentMode\initAsSpecimen
initAsSpecimen()
Initialise object with example values Id must be 0 if object instance is a specimen.
Definition: companypaymentmode.class.php:576
CompanyPaymentMode\fetch
fetch($id, $ref=null, $socid=0, $type='', $morewhere='')
Load object in memory from the database.
Definition: companypaymentmode.class.php:318
CompanyPaymentMode\getNomUrl
getNomUrl($withpicto=0, $option='', $notooltip=0, $morecss='', $save_lastsearch_value=-1)
Return a link to the object card (with optionaly the picto)
Definition: companypaymentmode.class.php:384
CommonObject\initAsSpecimenCommon
initAsSpecimenCommon()
Initialise object with example values Id must be 0 if object instance is a specimen.
Definition: commonobject.class.php:9901
CommonObject
Parent class of all other business classes (invoices, contracts, proposals, orders,...
Definition: commonobject.class.php:44
CompanyPaymentMode\LibStatut
LibStatut($status, $mode=0)
Return the status.
Definition: companypaymentmode.class.php:520
CompanyPaymentMode\create
create(User $user, $notrigger=false)
Create object into database.
Definition: companypaymentmode.class.php:250
CompanyPaymentMode\getLibStatut
getLibStatut($mode=0)
Return label of the status.
Definition: companypaymentmode.class.php:507
CommonObject\createCommon
createCommon(User $user, $notrigger=false)
Create object into database.
Definition: commonobject.class.php:9191
CompanyPaymentMode\info
info($id)
Load the info information in the object.
Definition: companypaymentmode.class.php:546
dol_syslog
dol_syslog($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='', $logcontext=null)
Write log message into outputs.
Definition: functions.lib.php:1628
CommonObject\updateCommon
updateCommon(User $user, $notrigger=false)
Update object into database.
Definition: commonobject.class.php:9469
isModEnabled
isModEnabled($module)
Is Dolibarr module enabled.
Definition: functions.lib.php:137
User
Class to manage Dolibarr users.
Definition: user.class.php:46
dolGetStatus
dolGetStatus($statusLabel='', $statusLabelShort='', $html='', $statusType='status0', $displayMode=0, $url='', $params=array())
Output the badge of a status.
Definition: functions.lib.php:10745
img_object
img_object($titlealt, $picto, $moreatt='', $pictoisfullpath=false, $srconly=0, $notitle=0)
Show a picto called object_picto (generic function)
Definition: functions.lib.php:4360
CompanyPaymentMode\update
update(User $user, $notrigger=false)
Load object lines in memory from the database.
Definition: companypaymentmode.class.php:357
CompanyPaymentMode\setAsDefault
setAsDefault($id=0, $alltypes=0)
Set a Payment mode as Default.
Definition: companypaymentmode.class.php:450
CompanyPaymentMode
Class for CompanyPaymentMode.
Definition: companypaymentmode.class.php:33
CompanyPaymentMode\__construct
__construct(DoliDB $db)
Constructor.
Definition: companypaymentmode.class.php:229