cactioncomm.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2002-2003 Rodolphe Quiedeville <rodolphe@quiedeville.org>
 * Copyright (C) 2004-2014 Laurent Destailleur  <eldy@users.sourceforge.net>
 *
 * 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/>.
 */

class CActionComm
{
  public $error = '';

  public $db;

  public $id;

  public $code;

  public $type;

  public $libelle;

  public $label;

  public $active;

  public $color;

  public $picto;

  public $type_actions = array();


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

  public function fetch($id)
  {
    $sql = "SELECT id, code, type, libelle as label, color, active, picto";
    $sql .= " FROM ".MAIN_DB_PREFIX."c_actioncomm";
    if (is_numeric($id)) $sql .= " WHERE id=".(int) $id;
    else $sql .= " WHERE code='".$this->db->escape($id)."'";

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

        $this->id      = $obj->id;
        $this->code    = $obj->code;
        $this->type    = $obj->type;
        $this->libelle = $obj->label; // deprecated
        $this->label   = $obj->label;
        $this->active  = $obj->active;
        $this->color   = $obj->color;

        $this->db->free($resql);
        return 1;
      } else {
        $this->db->free($resql);
        return 0;
      }
    } else {
      $this->error = $this->db->error();
      return -1;
    }
  }

  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function liste_array($active = '', $idorcode = 'id', $excludetype = '', $onlyautoornot = 0, $morefilter = '', $shortlabel = 0)
  {
    // phpcs:enable
    global $langs, $conf;
    $langs->load("commercial");

    $repid = array();
    $repcode = array();

    $sql = "SELECT id, code, libelle as label, module, type, color, picto";
    $sql .= " FROM ".MAIN_DB_PREFIX."c_actioncomm";
    $sql .= " WHERE 1=1";
    if ($active != '') {
      $sql .= " AND active=".(int) $active;
    }
    if (!empty($excludetype)) $sql .= " AND type <> '".$this->db->escape($excludetype)."'";
    if ($morefilter) $sql .= " AND ".$morefilter;
    $sql .= " ORDER BY module, position, type";

    dol_syslog(get_class($this)."::liste_array", LOG_DEBUG);
    $resql = $this->db->query($sql);
    if ($resql)
    {
      $nump = $this->db->num_rows($resql);
      if ($nump)
      {
        $i = 0;
        while ($i < $nump)
        {
          $obj = $this->db->fetch_object($resql);

          $qualified = 1;

          // $obj->type can be system, systemauto, module, moduleauto, xxx, xxxauto
          if ($qualified && $onlyautoornot > 0 && preg_match('/^system/', $obj->type) && !preg_match('/^AC_OTH/', $obj->code)) $qualified = 0; // We discard detailed system events. We keep only the 2 generic lines (AC_OTH and AC_OTH_AUTO)

          if ($qualified && $obj->module)
          {
            if ($obj->module == 'invoice' && !$conf->facture->enabled)  $qualified = 0;
            if ($obj->module == 'order' && !$conf->commande->enabled) $qualified = 0;
            if ($obj->module == 'propal' && !$conf->propal->enabled)    $qualified = 0;
            if ($obj->module == 'invoice_supplier' && ((!empty($conf->fournisseur->enabled) && empty($conf->global->MAIN_USE_NEW_SUPPLIERMOD)) || !$conf->supplier_invoice->enabled)) $qualified = 0;
            if ($obj->module == 'order_supplier' && ((!empty($conf->fournisseur->enabled) && empty($conf->global->MAIN_USE_NEW_SUPPLIERMOD)) || !$conf->supplier_order->enabled)) $qualified = 0;
            if ($obj->module == 'shipping' && !$conf->expedition->enabled)   $qualified = 0;
          }

          if ($qualified)
          {
            $keyfortrans = '';
            $transcode = '';
            $code = $obj->code;
            if ($onlyautoornot > 0 && $code == 'AC_OTH') $code = 'AC_MANUAL';
            if ($onlyautoornot > 0 && $code == 'AC_OTH_AUTO') $code = 'AC_AUTO';
            if ($shortlabel)
            {
              $keyfortrans = "Action".$code.'Short';
              $transcode = $langs->trans($keyfortrans);
            }
            if (empty($keyfortrans) || $keyfortrans == $transcode)
            {
              $keyfortrans = "Action".$code;
              $transcode = $langs->trans($keyfortrans);
            }
            $label = (($transcode != $keyfortrans) ? $transcode : $langs->trans($obj->label));
            if ($onlyautoornot == -1 && !empty($conf->global->AGENDA_USE_EVENT_TYPE) && !preg_match('/auto/i', $code))
            {
              $label = '&nbsp; '.$label;
              $repid[-99] = $langs->trans("ActionAC_MANUAL");
              $repcode['AC_NON_AUTO'] = $langs->trans("ActionAC_MANUAL");
            }
            $repid[$obj->id] = $label;
            $repcode[$obj->code] = $label;
            if ($onlyautoornot > 0 && preg_match('/^module/', $obj->type) && $obj->module) $repcode[$obj->code] .= ' ('.$langs->trans("Module").': '.$obj->module.')';
          }
          $i++;
        }
      }
      if ($idorcode == 'id') $this->liste_array = $repid;
      if ($idorcode == 'code') $this->liste_array = $repcode;
      return $this->liste_array;
    } else {
      $this->error = $this->db->lasterror();
      return -1;
    }
  }


  public function getNomUrl($withpicto = 0)
  {
    global $langs;

    // Check if translation available
    $transcode = $langs->trans("Action".$this->code);
    if ($transcode != "Action".$this->code) return $transcode;
  }
}