dolibarr/htdocs/core/class/menu.class.php

<?php
/* Copyright (C) 2002-2006 Rodolphe Quiedeville <rodolphe@quiedeville.org>
 * Copyright (C) 2005-2012 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 <http://www.gnu.org/licenses/>.
 */

/**
 *  \file       htdocs/core/class/menu.class.php
 *  \ingroup    core
 *  \brief      Fichier de la classe de gestion du menu gauche
 */


/**
 *	Class to manage left menus
 */
class Menu
{
    var $liste;

    /**
	 *	Constructor
     */
    function __construct()
    {
      	$this->liste = array();
    }

    /**
     * Clear property ->liste
     *
     * @return	void
     */
    function clear()
    {
        $this->liste = array();
    }

    /**
     * Add a menu entry into this->liste (at end)
     *
     * @param	string	$url        Url to follow on click (does not include DOL_URL_ROOT)
     * @param   string	$titre      Label of menu to add
     * @param   integer	$level      Level of menu to add
     * @param   int		$enabled    Menu active or not (0=Not active, 1=Active, 2=Active but grey)
     * @param   string	$target		Target link
     * @param	string	$mainmenu	Main menu ('home', 'companies', 'products', ...)
     * @param	string	$leftmenu	Left menu ('setup', 'system', 'admintools', ...)
     * @param	int		$position	Position (not used yet)
     * @param	string	$id			Id
     * @param	string	$idsel		Id sel
     * @param	string	$classname	Class name
     * @param	string	$prefix		Prefix to title (image or picto)
     * @return	void
     */
    function add($url, $titre, $level=0, $enabled=1, $target='',$mainmenu='',$leftmenu='',$position=0, $id='', $idsel='', $classname='', $prefix='')
    {
    	$this->liste[]=array('url'=>$url,'titre'=>$titre,'level'=>$level,'enabled'=>$enabled,'target'=>$target,'mainmenu'=>$mainmenu,'leftmenu'=>$leftmenu, 'position'=>$position, 'id'=>$id, 'idsel'=>$idsel, 'classname'=>$classname, 'prefix'=>$prefix);
    }

    /**
     * Insert a menu entry into this->liste
     *
     * @param   int		$idafter	Array key after which inserting new entry
     * @param	string	$url        Url to follow on click
     * @param   string	$titre      Label of menu to add
     * @param   integer	$level      Level of menu to add
     * @param   int		$enabled    Menu active or not
     * @param   string	$target		Target link
     * @param	string	$mainmenu	Main menu ('home', 'companies', 'products', ...)
     * @param	string	$leftmenu	Left menu ('setup', 'system', 'admintools', ...)
     * @param	int		$position	Position (not used yet)
     * @param	string	$id			Id
     * @param	string	$idsel		Id sel
     * @param	string	$classname	Class name
     * @param	string	$prefix		Prefix to title (image or picto)
     * @return	void
     */
    function insert($idafter, $url, $titre, $level=0, $enabled=1, $target='',$mainmenu='',$leftmenu='',$position=0, $id='', $idsel='', $classname='', $prefix='')
    {
        $array_start = array_slice($this->liste,0,($idafter+1));
        $array_new   = array(0=>array('url'=>$url,'titre'=>$titre,'level'=>$level,'enabled'=>$enabled,'target'=>$target,'mainmenu'=>$mainmenu,'leftmenu'=>$leftmenu,'position'=>$position, 'id'=>$id, 'idsel'=>$idsel, 'classname'=>$classname, 'prefix'=>$prefix));
        $array_end   = array_slice($this->liste,($idafter+1));
        $this->liste=array_merge($array_start,$array_new,$array_end);
    }

    // phpcs:disable PEAR.NamingConventions.ValidFunctionName.NotCamelCaps
    /**
     * Remove a menu entry from this->liste
     *
     * @return	void
     */
    function remove_last()
    {
        // phpcs:enable
        if (count($this->liste) > 1) {
            array_pop($this->liste);
        }
    }

    /**
     * Return number of visible entries (gray or not)
     *
     *  @return int     Number of visible (gray or not) menu entries
     */
    function getNbOfVisibleMenuEntries()
    {
        $nb=0;
        foreach($this->liste as $val)
        {
            if (! empty($val['enabled'])) $nb++;
        }
        return $nb;
    }
}