boxes.php

<?php
/* Copyright (C) 2003      Rodolphe Quiedeville <rodolphe@quiedeville.org> 
 * Copyright (C) 2004-2006 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 2 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, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 * $Id$
 * $Source$
 *
 */

/**
	    \file       htdocs/boxes.php
		\brief      Fichier de la classe boxes
		\author     Rodolphe Qiedeville
		\author	    Laurent Destailleur
		\version    $Revision$
*/



/**
        \class      InfoBox
		\brief      Classe permettant la gestion des boxes sur une page
*/

class InfoBox 
{
    var $db;

    /**
     *      \brief      Constructeur de la classe
     *      \param      $DB         Handler d'accs base
     */
    function InfoBox($DB)
    {
        $this->db=$DB;
    }
    

    /**
     *      \brief      Retourne tableau des boites elligibles pour la zone et le user
     *      \param      $zone       ID de la zone (0 pour la Homepage, ...)
     *      \param      $user		Objet user
     *      \return     array       Tableau d'objet box
     */
	function listBoxes($zone,$user)
	{
		global $conf;
		
		$boxes=array();

		$confuserzone='MAIN_BOXES_'.$zone;
		if ($user->id && $user->conf->$confuserzone)
		{
			// Recupere liste des boites d'un user si ce dernier a sa propre liste
			$sql = "SELECT b.rowid, b.box_id, b.position, b.box_order, b.fk_user,";
			$sql.= " d.file, d.note";
			$sql.= " FROM ".MAIN_DB_PREFIX."boxes as b, ".MAIN_DB_PREFIX."boxes_def as d";
			$sql.= " WHERE b.box_id = d.rowid";
			$sql.= " AND b.position = ".$zone;
			$sql.= " AND b.fk_user = ".$user->id;
			$sql.= " ORDER BY b.box_order";
		
			dolibarr_syslog("InfoBox::listBoxes sql=$sql");
			$result = $this->db->query($sql);
			if ($result)
			{
				$num = $this->db->num_rows($result);
				$j = 0;
				while ($j < $num)
				{
					$obj = $this->db->fetch_object($result);
					$boxname=eregi_replace('\.php$','',$obj->file);
					include_once(DOL_DOCUMENT_ROOT."/includes/boxes/".$boxname.".php");
					$box=new $boxname($this->db,$obj->note);
					$box->rowid=$obj->rowid;
					$box->box_id=$obj->box_id;
					$box->position=$obj->position;
					$box->box_order=$obj->box_order;
					$box->fk_user=$obj->fk_user;
					$boxes[$j]=$box;
					$j++;
				}
			}
			else {
				$this->error=$this->db->error();
				dolibarr_syslog("InfoBox::listBoxes Error ".$this->error);
				return array();
			}
		}
		else
		{
			// Recupere liste des boites active par defaut pour tous
			$sql = "SELECT b.rowid, b.box_id, b.position, b.box_order, b.fk_user,";
			$sql.= " d.file, d.note";
			$sql.= " FROM ".MAIN_DB_PREFIX."boxes as b, ".MAIN_DB_PREFIX."boxes_def as d";
			$sql.= " WHERE b.box_id = d.rowid";
			$sql.= " AND b.position = ".$zone;
			$sql.= " AND b.fk_user = 0";
			$sql.= " ORDER BY b.box_order";

			dolibarr_syslog("InfoBox::listBoxes sql=$sql");
			$result = $this->db->query($sql);
			if ($result)
			{
				$num = $this->db->num_rows($result);
				$j = 0;
				while ($j < $num)
				{
					$obj = $this->db->fetch_object($result);
					$boxname=eregi_replace('\.php$','',$obj->file);
					include_once(DOL_DOCUMENT_ROOT."/includes/boxes/".$boxname.".php");
					$box=new $boxname($this->db,$obj->note);
					$box->rowid=$obj->rowid;
					$box->box_id=$obj->box_id;
					$box->position=$obj->position;
					$box->box_order=$obj->box_order;
					$box->fk_user=$obj->fk_user;
					$boxes[$j]=$box;
					$j++;
				}
			}
			else {
				$this->error=$this->db->error();
				dolibarr_syslog("InfoBox::listBoxes Error ".$this->error);
				return array();
			}
		}
		
		return $boxes;
	}


    /**
     *      \brief      Sauvegarde sequencement des boites pour la zone et le user
     *      \param      $zone       ID de la zone (0 pour la Homepage, ...)
     *      \param      $boxid      Id des boites
     *      \param      $boxorder  Liste des boites dans le bon ordre
     *      \param      $userid     Id du user
     *      \return     int         <0 si ko, >= 0 si ok
     */
	function saveboxorder($zone,$boxid,$boxorder,$userid=0)
	{
		dolibarr_syslog("InfoBoxes::saveboxorder zone=".$zone." user=".$userid);

		if (! $userid || $userid == 0) return 0;
		
		$user = new User($this->db,$userid);

		$this->db->begin();

		// Sauve parametre indiquant que le user a une 
		$confuserzone='MAIN_BOXES_'.$zone;
		$tab[$confuserzone]=1;
 		if (! dolibarr_set_user_page_param($this->db, $user, '', $tab))
 		{
			$this->error=$this->db->error();
			$this->db->rollback();
			return -3;
 		}
		
		$sql ="DELETE FROM ".MAIN_DB_PREFIX."boxes";
		$sql.=" WHERE fk_user = ".$userid;
		$sql.=" AND position = ".$zone;
		$result = $this->db->query($sql);
		if ($result)
		{
			for ($ii=0, $ni=sizeof($boxid); $ii < $ni; $ii++)
			{
				$sql = "INSERT INTO ".MAIN_DB_PREFIX."boxes";
		    $sql.= "(box_id, position, box_order, fk_user)";
		    $sql.= " values (";
		    $sql.= " ".$boxid[$ii].",";
		    $sql.= " ".$zone.",";
		    $sql.= " ".$boxorder[$ii].",";
		    $sql.= " ".$userid;
		    $sql.= ")";
		    $result = $this->db->query($sql);
				if ($result < 0)
				{
					$error++;
					break;
				}			
			}
	
			if ($error)
			{
				$this->error=$this->db->error();
				$this->db->rollback();
				return -2;
			}
			else
			{
				$this->db->commit();
				return 1;
			}
		}
		else
		{
			$this->error=$this->db->error();
			$this->db->rollback();
			return -1;
		}
		
	}  
}
?>