controller.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2023-2024  Laurent Destailleur         <eldy@users.sourceforge.net>
 * Copyright (C) 2024       Frédéric France             <frederic.france@free.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/>.
 */
 
class Controller
{
  public $accessNeedLoggedUser = true;
 
  public $accessRight = false;
 
  public $controllerStatus = true;
 
  public $db;
 
  public $tplPath;
 
 
  public function __construct()
  {
    global $db, $hookmanager;
 
    $this->db = $db;
 
    // Initialize a technical object to manage hooks of page. Note that conf->hooks_modules contains an array of hook context
    $hookmanager->initHooks(array('webportalpage', 'webportal'));
  }
 
  public function action()
  {
    $resHook = $this->hookDoAction();
 
    return ($resHook < 0 ? -1 : 1);
  }
 
  public function checkAccess()
  {
    $context = Context::getInstance();
 
    if ($this->accessNeedLoggedUser) {
      if (!$context->userIslog()) {
        return false;
      }
    }
 
    if (!$this->accessRight) {
      return false;
    }
 
    return true;
  }
 
  public function display()
  {
    $context = Context::getInstance();
 
    $this->loadTemplate('header');
 
    $this->hookPrintPageView();
 
    if (!$context->controller_found) {
      $this->loadTemplate('404');
    }
 
    $this->loadTemplate('footer');
  }
 
  public function display404()
  {
    $this->loadTemplate('header');
    $this->loadTemplate('404');
    $this->loadTemplate('footer');
  }
 
  public function hookDoAction($parameters = array())
  {
    global $hookmanager;
 
    $context = Context::getInstance();
 
    /* Use $context singleton to modify menu, */
    $parameters['controller'] = $context->controller;
 
    $reshook = $hookmanager->executeHooks('doActions', $parameters, $context, $context->action);    // Note that $action and $object may have been modified by hook
    if ($reshook < 0) {
      $context->setEventMessages($hookmanager->error, $hookmanager->errors, 'errors');
    }
 
    return $reshook;
  }
 
  public function hookPrintPageView($parameters = array())
  {
    global $hookmanager;
 
    $context = Context::getInstance();
 
    /* Use $context singleton to modify menu, */
    $parameters['controller'] = $context->controller;
 
    $reshook = $hookmanager->executeHooks('PrintPageView', $parameters, $context, $context->action);    // Note that $action and $object may have been modified by hook
    if ($reshook < 0) {
      $context->setEventMessages($hookmanager->error, $hookmanager->errors, 'errors');
    }
 
    return $reshook;
  }
 
  public function loadTemplate($templateName, $vars = false)
  {
    global $conf, $langs, $hookmanager, $db; // may be used into the tpl
 
    $context = Context::getInstance(); // load for tpl
 
    if (!preg_match('/^[0-9\.A-ZaZ_\-]*$/ui', $templateName)) {
      return false;
    }
 
    if (!empty($this->tplPath)) {
      $tplPath = $this->tplPath . '/' . $templateName . '.tpl.php';
      if (file_exists($tplPath)) {
        include $tplPath;
        return true;
      }
    }
 
    $tplPath = $context->tplPath . '/' . $templateName . '.tpl.php';
 
    if (!file_exists($tplPath)) {
      print 'ERROR TPL NOT FOUND : ' . $templateName;
      return false;
    }
 
    $controller = $this; // transmit controller to tpl
 
    include $tplPath;
 
    return true;
  }
}