webPortalTheme.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2023-2024  Laurent Destailleur   <eldy@users.sourceforge.net>
 * Copyright (C) 2023-2024  Lionel Vessiller    <lvessiller@easya.solutions>
 * Copyright (C) 2023-2024  John Botella      <john.botella@atm-consulting.fr>
 * Copyright (C) 2024   Frédéric France     <frederic.france@free.fr>
 * Copyright (C) 2025   Charlene Benke      <charlene@patas-monkey.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/>.
 */
 
 
require_once DOL_DOCUMENT_ROOT . '/core/lib/functions2.lib.php'; // used for color functions
require_once DOL_DOCUMENT_ROOT.'/societe/class/societe.class.php';
require_once DOL_DOCUMENT_ROOT . '/webportal/class/context.class.php';
 
 
class WebPortalTheme
{
  public $primaryColorHex = '#263c5c';
 
  public $primaryColorHsl = array(
    'h' => 216, // Hue
    'l' => 42,  // lightness
    's' => 25,  // Saturation
    'a' =>  1   // Alfa
  );
 
  public $loginLogoUrl;
 
  public $menuLogoUrl;
 
  public $loginBackground;
 
  public $bannerBackground;
 
  public $bannerUseDarkTheme;
 
 
  public function __construct($init = true)
  {
    if ($init) {
      $this->init();
    }
  }
 
  public function init()
  {
    global $db, $conf;
 
    $mysoc = new Societe($db);
    $mysoc->setMysoc($conf);
 
    $this->loadPrimaryColor();
 
    $context = Context::getInstance();
 
    $urllogo = Context::getRootConfigUrl() . 'img/login_logo.svg';
    if ($context->userIsLog()) {
      if (!empty($mysoc->logo_small) && is_readable($conf->mycompany->dir_output . '/logos/thumbs/' . $mysoc->logo_small)) {
        $urllogo = $context->getControllerUrl('viewimage') . '&modulepart=mycompany&entity=' . $conf->entity . '&file=' . urlencode('logos/thumbs/' . $mysoc->logo_small);
      } elseif (!empty($mysoc->logo) && is_readable($conf->mycompany->dir_output . '/logos/' . $mysoc->logo)) {
        $urllogo = $context->getControllerUrl('viewimage') . '&modulepart=mycompany&entity=' . $conf->entity . '&file=' . urlencode('logos/' . $mysoc->logo);
      } elseif (is_readable(DOL_DOCUMENT_ROOT . '/public/webportal/img/dolibarr_logo.svg')) {
        $urllogo = Context::getRootConfigUrl() . 'img/dolibarr_logo.svg';
      }
    }
 
    $this->loginLogoUrl = getDolGlobalString('WEBPORTAL_LOGIN_LOGO_URL', $urllogo);
    $this->menuLogoUrl = getDolGlobalString('WEBPORTAL_MENU_LOGO_URL', $this->loginLogoUrl);
    $this->loginBackground = getDolGlobalString('WEBPORTAL_LOGIN_BACKGROUND');
    $this->bannerBackground = getDolGlobalString('WEBPORTAL_BANNER_BACKGROUND');
    $this->bannerUseDarkTheme = getDolGlobalInt('WEBPORTAL_BANNER_BACKGROUND_IS_DARK');
  }
 
  public function loadPrimaryColor()
  {
    $outColor = '';
 
    if (getDolGlobalString('WEBPORTAL_PRIMARY_COLOR')) {
      $outColor = getDolGlobalString('WEBPORTAL_PRIMARY_COLOR');
    } elseif (getDolGlobalString('THEME_ELDY_TOPMENU_BACK1')) {
      $outColor = colorArrayToHex(colorStringToArray(getDolGlobalString('THEME_ELDY_TOPMENU_BACK1')));
    }
    if (strpos($outColor, '#') !== 0) {
      $outColor = '#'.$outColor;
    }
 
    // If custom color is valid, w e use it
    if (!empty($outColor) && colorValidateHex($outColor)) {
      $this->primaryColorHex = $outColor;
      $this->primaryColorHsl = colorHexToHsl($outColor, 1, true);
    }
  }
 
  static public function getIconImagesUrl()
  {
    // TODO : add hook Or const override
    return Context::getInstance()->getControllerUrl().'/img/icons/';
  }
 
  static public function getIconImagesPath()
  {
    // TODO : add hook Or const override
    return DOL_DOCUMENT_ROOT . '/public/webportal/img/icons';
  }
}