societeaccount.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2007-2017  Laurent Destailleur <eldy@users.sourceforge.net>
 * Copyright (C) 2014-2016  Juanjo Menent       <jmenent@2byte.es>
 * Copyright (C) 2015       Florian Henry       <florian.henry@open-concept.pro>
 * Copyright (C) 2015       Raphaël Doursenaud  <rdoursenaud@gpcsolutions.fr>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

// Put here all includes required by your class file
require_once DOL_DOCUMENT_ROOT.'/core/class/commonobject.class.php';
//require_once DOL_DOCUMENT_ROOT . '/societe/class/societe.class.php';
//require_once DOL_DOCUMENT_ROOT . '/product/class/product.class.php';

class SocieteAccount extends CommonObject
{
  public $element = 'societeaccount';

  public $table_element = 'societe_account';

  public $ismultientitymanaged = 0;

  public $picto = 'lock';


  // BEGIN MODULEBUILDER PROPERTIES
  public $fields = array(
    'rowid' => array('type'=>'integer', 'label'=>'TechnicalID', 'visible'=>-2, 'enabled'=>1, 'position'=>1, 'notnull'=>1, 'index'=>1, 'comment'=>'Id',),
    'entity' => array('type'=>'integer', 'label'=>'Entity', 'visible'=>0, 'enabled'=>1, 'position'=>5, 'default'=>1),
    'login' => array('type'=>'varchar(64)', 'label'=>'Login', 'visible'=>1, 'enabled'=>1, 'notnull'=>1, 'position'=>10, 'showoncombobox'=>1),
    'pass_encoding' => array('type'=>'varchar(24)', 'label'=>'PassEncoding', 'visible'=>0, 'enabled'=>1, 'position'=>30),
    'pass_crypted' => array('type'=>'varchar(128)', 'label'=>'Password', 'visible'=>1, 'enabled'=>1, 'position'=>31, 'notnull'=>1),
    'pass_temp'    => array('type'=>'varchar(128)', 'label'=>'Temp', 'visible'=>0, 'enabled'=>0, 'position'=>32, 'notnull'=>-1,),
    'fk_soc' => array('type'=>'integer:Societe:societe/class/societe.class.php', 'label'=>'ThirdParty', 'visible'=>1, 'enabled'=>1, 'position'=>40, 'notnull'=>-1, 'index'=>1),
    'fk_website' => array('type'=>'integer:Website:website/class/website.class.php', 'label'=>'WebSite', 'visible'=>1, 'enabled'=>1, 'position'=>42, 'notnull'=>-1, 'index'=>1),
    'site' => array('type'=>'varchar(128)', 'label'=>'ExternalSite', 'visible'=>0, 'enabled'=>1, 'position'=>43, 'help'=>'Name of the website or service if this is account on an external website or service'),
    'site_account' => array('type'=>'varchar(128)', 'label'=>'ExternalSiteAccount', 'visible'=>0, 'enabled'=>1, 'position'=>44, 'help'=>'A key to identify the account on external web site if this is an account on an external website'),
    'key_account' => array('type'=>'varchar(128)', 'label'=>'KeyAccount', 'visible'=>0, 'enabled'=>1, 'position'=>48, 'notnull'=>0, 'index'=>1, 'searchall'=>1, 'comment'=>'The id of third party in the external web site (for site_account if site_account defined)',),
    'date_last_login' => array('type'=>'datetime', 'label'=>'LastConnexion', 'visible'=>2, 'enabled'=>1, 'position'=>50, 'notnull'=>0,),
    'date_previous_login' => array('type'=>'datetime', 'label'=>'PreviousConnexion', 'visible'=>2, 'enabled'=>1, 'position'=>51, 'notnull'=>0,),
    //'note_public' => array('type'=>'text', 'label'=>'NotePublic', 'visible'=>-1, 'enabled'=>1, 'position'=>45, 'notnull'=>-1,),
    'note_private' => array('type'=>'text', 'label'=>'NotePrivate', 'visible'=>-1, 'enabled'=>1, 'position'=>46, 'notnull'=>-1,),
    'date_creation' => array('type'=>'datetime', 'label'=>'DateCreation', 'visible'=>-2, 'enabled'=>1, 'position'=>500, 'notnull'=>1,),
    'tms' => array('type'=>'timestamp', 'label'=>'DateModification', 'visible'=>-2, 'enabled'=>1, 'position'=>500, 'notnull'=>1,),
    'fk_user_creat' => array('type'=>'integer', 'label'=>'UserAuthor', 'visible'=>-2, 'enabled'=>1, 'position'=>500, 'notnull'=>1,),
    'fk_user_modif' => array('type'=>'integer', 'label'=>'UserModif', 'visible'=>-2, 'enabled'=>1, 'position'=>500, 'notnull'=>-1,),
    'import_key' => array('type'=>'varchar(14)', 'label'=>'ImportId', 'visible'=>-2, 'enabled'=>1, 'position'=>1000, 'notnull'=>-1, 'index'=>1,),
    'status' => array('type'=>'integer', 'label'=>'Status', 'visible'=>1, 'enabled'=>1, 'position'=>1000, 'notnull'=>1, 'index'=>1, 'default'=>1, 'arrayofkeyval'=>array('1'=>'Active', '0'=>'Disabled')),
  );

  public $rowid;

  public $entity;

  public $key_account;
  public $login;
  public $pass_encoding;
  public $pass_crypted;
  public $pass_temp;

  public $fk_soc;

  public $site;
  public $site_account;

  public $date_last_login;


  public $date_previous_login;
  public $note_private;

  public $date_creation;


  public $tms;

  public $fk_user_creat;

  public $fk_user_modif;

  public $import_key;

  public $status;

  // END MODULEBUILDER PROPERTIES


  public function __construct(DoliDB $db)
  {
    global $conf;

    $this->db = $db;

    if (empty($conf->global->MAIN_SHOW_TECHNICAL_ID)) $this->fields['rowid']['visible'] = 0;
  }

  public function create(User $user, $notrigger = false)
  {
    return $this->createCommon($user, $notrigger);
  }

  public function createFromClone(User $user, $fromid)
  {
    global $hookmanager, $langs;
    $error = 0;

    dol_syslog(__METHOD__, LOG_DEBUG);

    $object = new self($this->db);

    $this->db->begin();

    // Load source object
    $object->fetchCommon($fromid);
    // Reset some properties
    unset($object->id);
    unset($object->fk_user_creat);
    unset($object->import_key);

    // Clear fields
    $object->ref = "copy_of_".$object->ref;
    $object->title = $langs->trans("CopyOf")." ".$object->title;
    // ...

    // Create clone
    $object->context['createfromclone'] = 'createfromclone';
    $result = $object->createCommon($user);
    if ($result < 0) {
      $error++;
      $this->error = $object->error;
      $this->errors = $object->errors;
    }

    unset($object->context['createfromclone']);

    // End
    if (!$error) {
      $this->db->commit();
      return $object;
    } else {
      $this->db->rollback();
      return -1;
    }
  }

  public function fetch($id, $ref = null)
  {
    $result = $this->fetchCommon($id, $ref);
    if ($result > 0 && !empty($this->table_element_line)) $this->fetchLines();
    return $result;
  }

  public function fetchLines()
  {
    $this->lines = array();

    // Load lines with object societeAccountLine

    return count($this->lines) ? 1 : 0;
  }

  public function getCustomerAccount($id, $site, $status = 0, $site_account = '')
  {
    $sql = "SELECT sa.key_account as key_account, sa.entity";
    $sql .= " FROM ".MAIN_DB_PREFIX."societe_account as sa";
    $sql .= " WHERE sa.fk_soc = ".$id;
    $sql .= " AND sa.entity IN (".getEntity('societe').")";
    $sql .= " AND sa.site = '".$this->db->escape($site)."' AND sa.status = ".((int) $status);
    $sql .= " AND sa.key_account IS NOT NULL AND sa.key_account <> ''";
    $sql .= " AND (sa.site_account = '' OR sa.site_account IS NULL OR sa.site_account = '".$this->db->escape($site_account)."')";
    $sql .= " ORDER BY sa.site_account DESC"; // To get the entry with a site_account defined in priority

    dol_syslog(get_class($this)."::getCustomerAccount Try to find the first system customer id for ".$site." of thirdparty id=".$id." (exemple: cus_.... for stripe)", LOG_DEBUG);
    $result = $this->db->query($sql);
    if ($result) {
      if ($this->db->num_rows($result)) {
        $obj = $this->db->fetch_object($result);
        $key = $obj->key_account;
      } else {
        $key = '';
      }
    } else {
      $key = '';
    }

    return $key;
  }

  public function getThirdPartyID($id, $site, $status = 0)
  {
    $socid = 0;

    $sql = "SELECT sa.fk_soc as fk_soc, sa.key_account, sa.entity";
    $sql .= " FROM ".MAIN_DB_PREFIX."societe_account as sa";
    $sql .= " WHERE sa.key_account = '".$this->db->escape($id)."'";
    $sql .= " AND sa.entity IN (".getEntity('societe').")";
    $sql .= " AND sa.site = '".$this->db->escape($site)."' AND sa.status = ".((int) $status);
    $sql .= " AND sa.fk_soc > 0";

    dol_syslog(get_class($this)."::getCustomerAccount Try to find the first thirdparty id for ".$site." for external id=".$id, LOG_DEBUG);
    $result = $this->db->query($sql);
    if ($result) {
      if ($this->db->num_rows($result)) {
        $obj = $this->db->fetch_object($result);
        $socid = $obj->fk_soc;
      }
    }

    return $socid;
  }

  public function update(User $user, $notrigger = false)
  {
    return $this->updateCommon($user, $notrigger);
  }

  public function delete(User $user, $notrigger = false)
  {
    return $this->deleteCommon($user, $notrigger);
  }

  public function getNomUrl($withpicto = 0, $option = '', $notooltip = 0, $morecss = '', $save_lastsearch_value = -1)
  {
    global $db, $conf, $langs;
    global $dolibarr_main_authentication, $dolibarr_main_demo;
    global $menumanager;

    if (!empty($conf->dol_no_mouse_hover)) $notooltip = 1; // Force disable tooltips

    $result = '';

    $this->ref = $this->login;

    $label = '<u>'.$langs->trans("WebsiteAccount").'</u>';
    $label .= '<br>';
    $label .= '<b>'.$langs->trans('Login').':</b> '.$this->ref;
    //$label.= '<b>' . $langs->trans('WebSite') . ':</b> ' . $this->ref;

    $url = dol_buildpath('/website/websiteaccount_card.php', 1).'?id='.$this->id;

    if ($option != 'nolink')
    {
      // Add param to save lastsearch_values or not
      $add_save_lastsearch_values = ($save_lastsearch_value == 1 ? 1 : 0);
      if ($save_lastsearch_value == -1 && preg_match('/list\.php/', $_SERVER["PHP_SELF"])) $add_save_lastsearch_values = 1;
      if ($add_save_lastsearch_values) $url .= '&save_lastsearch_values=1';
    }

    $linkclose = '';
    if (empty($notooltip))
    {
      if (!empty($conf->global->MAIN_OPTIMIZEFORTEXTBROWSER))
      {
        $label = $langs->trans("WebsiteAccount");
        $linkclose .= ' alt="'.dol_escape_htmltag($label, 1).'"';
      }
      $linkclose .= ' title="'.dol_escape_htmltag($label, 1).'"';
      $linkclose .= ' class="classfortooltip'.($morecss ? ' '.$morecss : '').'"';
    } else $linkclose = ($morecss ? ' class="'.$morecss.'"' : '');

    $linkstart = '<a href="'.$url.'"';
    $linkstart .= $linkclose.'>';
    $linkend = '</a>';

    $result .= $linkstart;
    if ($withpicto) $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);
    if ($withpicto != 2) $result .= $this->ref;
    $result .= $linkend;

    return $result;
  }

  public function getLibStatut($mode = 0)
  {
    return $this->LibStatut($this->status, $mode);
  }

  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public static function LibStatut($status, $mode = 0)
  {
    // phpcs:enable
    global $langs;

    if ($mode == 0)
    {
      $prefix = '';
      if ($status == 1) return $langs->trans('Enabled');
      elseif ($status == 0) return $langs->trans('Disabled');
    } elseif ($mode == 1)
    {
      if ($status == 1) return $langs->trans('Enabled');
      elseif ($status == 0) return $langs->trans('Disabled');
    } elseif ($mode == 2)
    {
      if ($status == 1) return img_picto($langs->trans('Enabled'), 'statut4').' '.$langs->trans('Enabled');
      elseif ($status == 0) return img_picto($langs->trans('Disabled'), 'statut5').' '.$langs->trans('Disabled');
    } elseif ($mode == 3)
    {
      if ($status == 1) return img_picto($langs->trans('Enabled'), 'statut4');
      elseif ($status == 0) return img_picto($langs->trans('Disabled'), 'statut5');
    } elseif ($mode == 4)
    {
      if ($status == 1) return img_picto($langs->trans('Enabled'), 'statut4').' '.$langs->trans('Enabled');
      elseif ($status == 0) return img_picto($langs->trans('Disabled'), 'statut5').' '.$langs->trans('Disabled');
    } elseif ($mode == 5)
    {
      if ($status == 1) return $langs->trans('Enabled').' '.img_picto($langs->trans('Enabled'), 'statut4');
      elseif ($status == 0) return $langs->trans('Disabled').' '.img_picto($langs->trans('Disabled'), 'statut5');
    } elseif ($mode == 6)
    {
      if ($status == 1) return $langs->trans('Enabled').' '.img_picto($langs->trans('Enabled'), 'statut4');
      elseif ($status == 0) return $langs->trans('Disabled').' '.img_picto($langs->trans('Disabled'), 'statut5');
    }
  }

  public function info($id)
  {
    $sql = 'SELECT rowid, date_creation as datec, tms as datem,';
    $sql .= ' fk_user_creat, fk_user_modif';
    $sql .= ' FROM '.MAIN_DB_PREFIX.$this->table_element.' as t';
    $sql .= ' WHERE t.rowid = '.$id;
    $result = $this->db->query($sql);
    if ($result)
    {
      if ($this->db->num_rows($result))
      {
        $obj = $this->db->fetch_object($result);
        $this->id = $obj->rowid;
        if ($obj->fk_user_author)
        {
          $cuser = new User($this->db);
          $cuser->fetch($obj->fk_user_author);
          $this->user_creation = $cuser;
        }

        if ($obj->fk_user_valid)
        {
          $vuser = new User($this->db);
          $vuser->fetch($obj->fk_user_valid);
          $this->user_validation = $vuser;
        }

        if ($obj->fk_user_cloture)
        {
          $cluser = new User($this->db);
          $cluser->fetch($obj->fk_user_cloture);
          $this->user_cloture = $cluser;
        }

        $this->date_creation     = $this->db->jdate($obj->datec);
        $this->date_modification = $this->db->jdate($obj->datem);
        $this->date_validation   = $this->db->jdate($obj->datev);
      }

      $this->db->free($result);
    } else {
      dol_print_error($this->db);
    }
  }

  public function initAsSpecimen()
  {
    $this->initAsSpecimenCommon();
  }
}