canvas.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2010-2018  Regis Houssin   <regis.houssin@inodbox.com>
 * Copyright (C) 2011     Laurent Destailleur <eldy@users.sourceforge.net>
 * Copyright (C) 2024   MDW         <mdeweerd@users.noreply.github.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 <https://www.gnu.org/licenses/>.
 */
 
class Canvas
{
  public $db;
 
  public $error = '';
 
  public $errors = array();
 
  public $actiontype;
 
  public $dirmodule; // Module directory
  public $targetmodule; // Module concerned by canvas (ex: thirdparty, contact, ...)
  public $canvas; // Name of canvas (ex: company, individual, product, service, ...)
  public $card; // Tab (sub-canvas)
 
  public $template_dir;
  public $control; // Initialized by getCanvas with controller instance
 
 
  public function __construct($db, $actiontype = 'view')
  {
    $this->db = $db;
 
    $this->actiontype = $this->_cleanaction($actiontype);
  }
 
  private function _cleanaction($action)
  {
    $newaction = $action;
    if ($newaction == 'add') {
      $newaction = 'create';
    }
    if ($newaction == 'update') {
      $newaction = 'edit';
    }
    if (empty($newaction) || $newaction == 'delete' || $newaction == 'create_user' || $newaction == 'presend' || $newaction == 'send') {
      $newaction = 'view';
    }
    return $newaction;
  }
 
 
  public function getCanvas($module, $card, $canvas)
  {
    // Set properties with value specific to dolibarr core: this->targetmodule, this->card, this->canvas
    $this->targetmodule = $module;
    $this->canvas = $canvas;
    $this->card = $card;
    $this->dirmodule = $module;
    // Correct values if canvas is into an external module
    $regs = array();
    if (preg_match('/^([^@]+)@([^@]+)$/i', $canvas, $regs)) {
      $this->canvas = $regs[1];
      $this->dirmodule = $regs[2];
    }
    // For compatibility
    if ($this->dirmodule == 'thirdparty') {
      $this->dirmodule = 'societe';
    }
 
    // Control file
    $controlclassfile = dol_buildpath('/'.$this->dirmodule.'/canvas/'.$this->canvas.'/actions_'.$this->card.'_'.$this->canvas.'.class.php');
    if (file_exists($controlclassfile)) {
      // Include actions class (controller)
      require_once $controlclassfile;
 
      // Instantiate actions class (controller)
      $controlclassname = 'Actions'.ucfirst($this->card).ucfirst($this->canvas);
      $this->control = new $controlclassname($this->db, $this->dirmodule, $this->targetmodule, $this->canvas, $this->card);
    }
 
    // Template dir
    $this->template_dir = dol_buildpath('/'.$this->dirmodule.'/canvas/'.$this->canvas.'/tpl/');
    if (!is_dir($this->template_dir)) {
      $this->template_dir = '';
    }
 
    //print 'dimodule='.$dirmodule.' canvas='.$this->canvas.'<br>';
    //print ' => template_dir='.$this->template_dir.'<br>';
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function assign_values(&$action = 'view', $id = 0, $ref = '')
  {
    // phpcs:enable
    if (is_object($this->control) && method_exists($this->control, 'assign_values')) {
      $this->control->assign_values($action, $id, $ref);
    }
  }
 
  public function displayCanvasExists($action)
  {
    // template_dir should be '/'.$this->dirmodule.'/canvas/'.$this->canvas.'/tpl/', for example '/mymodule/canvas/product/tpl'
    if (empty($this->template_dir)) {
      return 0;
    }
 
    $newaction = $action;
    if ($action && !in_array($action, array('create', 'view', 'edit', 'list'))) {
      $newaction = 'view';
    }
 
    if (file_exists($this->template_dir.(!empty($this->card) ? $this->card.'_' : '').$this->_cleanaction($newaction).'.tpl.php')) {
      return 1;
    } else {
      return 0;
    }
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function display_canvas($action)
  {
    // phpcs:enable
    global $db, $conf, $langs, $user, $canvas;  // used into include
    global $form, $formfile;          // used into include
 
    $newaction = $action;
    if ($action && !in_array($action, array('create', 'view', 'edit', 'list'))) {
      $newaction = 'view';
    }
 
    //var_dump($this->card.'-'.$action);
    include $this->template_dir.(!empty($this->card) ? $this->card.'_' : '').$this->_cleanaction($newaction).'.tpl.php'; // Include native PHP template
  }
 
 
  // This functions should not be used anymore because canvas should contains only templates.
  // https://wiki.dolibarr.org/index.php/Canvas_development
 
  public function hasActions()
  {
    return (is_object($this->control));
  }
 
  public function doActions(&$action = 'view', $id = 0)
  {
    $control = $this->control;
    if (method_exists($control, 'doActions')) {
      $ret = $control->doActions($action, $id);
      return $ret;
    }
    return null;
  }
}