accountingjournal.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2017   Alexandre Spangaro   <aspangaro@zendsi.com>
 *
 * 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 <http://www.gnu.org/licenses/>.
 */

class AccountingJournal extends CommonObject
{
  public $element='accounting_journal';

  public $table_element='accounting_journal';

  public $fk_element = '';

  public $ismultientitymanaged = 0;

  public $picto = 'generic';

  public $rowid;

  public $code;

    public $label;

  public $nature;   // 1:various operations, 2:sale, 3:purchase, 4:bank, 5:expense-report, 8:inventory, 9: has-new
  public $active;

  public $lines;

    function __construct($db)
    {
    $this->db = $db;
  }

  function fetch($rowid = null, $journal_code = null)
  {
    global $conf;

    if ($rowid || $journal_code)
    {
      $sql = "SELECT rowid, code, label, nature, active";
      $sql.= " FROM ".MAIN_DB_PREFIX."accounting_journal";
      $sql .= " WHERE";
      if ($rowid) {
        $sql .= " rowid = " . (int) $rowid;
      }
      elseif ($journal_code)
      {
        $sql .= " code = '" . $this->db->escape($journal_code) . "'";
        $sql .= " AND entity  = " . $conf->entity;
      }

      dol_syslog(get_class($this)."::fetch sql=" . $sql, LOG_DEBUG);
      $result = $this->db->query($sql);
      if ($result)
      {
        $obj = $this->db->fetch_object($result);

        if ($obj) {
          $this->id     = $obj->rowid;
          $this->rowid    = $obj->rowid;

          $this->code     = $obj->code;
          $this->ref      = $obj->code;
          $this->label    = $obj->label;
          $this->nature   = $obj->nature;
          $this->active   = $obj->active;

          return $this->id;
        } else {
          return 0;
        }
      }
      else
      {
        $this->error = "Error " . $this->db->lasterror();
        $this->errors[] = "Error " . $this->db->lasterror();
      }
    }
    return -1;
  }

    function fetchAll($sortorder = '', $sortfield = '', $limit = 0, $offset = 0, array $filter = array(), $filtermode = 'AND')
    {
    $sql = "SELECT rowid, code, label, nature, active";
    $sql .= ' FROM ' . MAIN_DB_PREFIX . $this->table_element . ' as t';
    // Manage filter
    $sqlwhere = array();
    if (count($filter) > 0) {
      foreach ( $filter as $key => $value ) {
        if ($key == 't.code' || $key == 't.label' || $key == 't.nature') {
          $sqlwhere[] = $key . '\'' . $this->db->escape($value) . '\'';
        } elseif ($key == 't.rowid' || $key == 't.active') {
          $sqlwhere[] = $key . '=' . $value;
        }
      }
    }
    $sql .= ' WHERE 1 = 1';
    $sql .= " AND entity IN (" . getEntity('accountancy') . ")";
    if (count($sqlwhere) > 0) {
      $sql .= ' AND ' . implode(' ' . $filtermode . ' ', $sqlwhere);
    }

    if (! empty($sortfield)) {
      $sql .= $this->db->order($sortfield, $sortorder);
    }
    if (! empty($limit)) {
      $sql .= ' ' . $this->db->plimit($limit + 1, $offset);
    }
    $this->lines = array();

    dol_syslog(get_class($this) . "::fetch sql=" . $sql, LOG_DEBUG);
    $resql = $this->db->query($sql);
    if ($resql) {
      $num = $this->db->num_rows($resql);

      while ( $obj = $this->db->fetch_object($resql) ) {
        $line = new self($this->db);

        $line->id = $obj->rowid;
        $line->code = $obj->code;
        $line->label = $obj->label;
        $line->nature = $obj->nature;
        $line->active = $obj->active;

        $this->lines[] = $line;
      }

      $this->db->free($resql);

      return $num;
    } else {
      $this->errors[] = 'Error ' . $this->db->lasterror();
      dol_syslog(__METHOD__ . ' ' . join(',', $this->errors), LOG_ERR);

      return - 1;
    }
  }

  function getNomUrl($withpicto = 0, $withlabel = 0, $nourl = 0, $moretitle='',$notooltip=0)
  {
    global $langs, $conf, $user;

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

    $result = '';

    $url = DOL_URL_ROOT . '/accountancy/admin/journals_list.php?id=35';

    $label = '<u>' . $langs->trans("ShowAccountingJournal") . '</u>';
    if (! empty($this->code))
      $label .= '<br><b>'.$langs->trans('Code') . ':</b> ' . $this->code;
    if (! empty($this->label))
      $label .= '<br><b>'.$langs->trans('Label') . ':</b> ' . $this->label;
    if ($moretitle) $label.=' - '.$moretitle;

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

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

    if ($nourl)
    {
      $linkstart = '';
      $linkclose = '';
      $linkend = '';
    }

    $label_link = $this->code;
    if ($withlabel) $label_link .= ' - ' . $this->label;

    $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.= $label_link;
    $result .= $linkend;

    return $result;
  }

  function getLibType($mode=0)
  {
    return $this->LibType($this->nature,$mode);
  }

    // phpcs:disable PEAR.NamingConventions.ValidFunctionName.NotCamelCaps
  function LibType($nature,$mode=0)
  {
        // phpcs:enable
    global $langs;

    $langs->loadLangs(array("accountancy"));

    if ($mode == 0)
    {
      $prefix='';
      if ($nature == 9) return $langs->trans('AccountingJournalType9');
      if ($nature == 5) return $langs->trans('AccountingJournalType5');
      if ($nature == 4) return $langs->trans('AccountingJournalType4');
      if ($nature == 3) return $langs->trans('AccountingJournalType3');
      if ($nature == 2) return $langs->trans('AccountingJournalType2');
      if ($nature == 1) return $langs->trans('AccountingJournalType1');
    }
    if ($mode == 1)
    {
      if ($nature == 9) return $langs->trans('AccountingJournalType9');
      if ($nature == 5) return $langs->trans('AccountingJournalType5');
      if ($nature == 4) return $langs->trans('AccountingJournalType4');
      if ($nature == 3) return $langs->trans('AccountingJournalType3');
      if ($nature == 2) return $langs->trans('AccountingJournalType2');
      if ($nature == 1) return $langs->trans('AccountingJournalType1');
    }
  }
}