include/Smarty/plugins/function.sugar_menu.php

   1 <?php
   2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
   3 /*********************************************************************************
   4  * SugarCRM Community Edition is a customer relationship management program developed by
   5  * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU Affero General Public License version 3 as published by the
   9  * Free Software Foundation with the addition of the following permission added
  10  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  11  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  12  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License along with
  20  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  21  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22  * 02110-1301 USA.
  23  *
  24  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  25  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  26  *
  27  * The interactive user interfaces in modified source and object code versions
  28  * of this program must display Appropriate Legal Notices, as required under
  29  * Section 5 of the GNU Affero General Public License version 3.
  30  *
  31  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  32  * these Appropriate Legal Notices must retain the display of the "Powered by
  33  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  34  * technical reasons, the Appropriate Legal Notices must display the words
  35  * "Powered by SugarCRM".
  36  ********************************************************************************/
  37
  38 /**
  39  * Smarty plugin
  40  * @package Smarty
  41  * @subpackage plugins
  42  */
  43
  44 /**
  45  * Smarty plugin:
  46  * This is a Smarty plugin to create a multi-level menu using nasted ul lists.
  47  * The generated structure looks like this.
  48  * <ul $htmlOptions>
  49  *      <li $itemOptions>
  50  *          <elem></elem>
  51  *          <ul $submenuHtmlOptions>
  52  *              <li $itemOptions></li>
  53  *              <li $itemOptions>
  54  *                  <elem></elem>
  55  *                  <ul $submenuHtmlOptions>
  56  *                      <li $itemOptions></li>
  57  *                      ...
  58  *                  </ul>
  59  *              </li>
  60  *              ...
  61  *          </ul>
  62  *      </li>
  63  *      ...
  64  *  </ul>
  65  *
  66  *
  67  * @param $params array - look up the bellow example
  68  * @param $smarty
  69  * @return string - generated HTML code
  70  *
  71  * <pre>
  72  * smarty_function_sugar_menu(array(
  73  *      'id' => $string, //id property that is applied in root UL
  74  *      'items' => array(
  75  *          array(
  76  *              'html' => $html_string, //html container that renders in the LI tag
  77  *              'items' => array(), //nasted ul lists
  78  *          )
  79  *      ),
  80  *      'htmlOptions' => attributes that is applied in root UL, such as class, or align.
  81  *      'itemOptions' => attributes that is applied in LI items, such as class, or align.
  82  *      'submenuHtmlOptions' => attributes that is applied in child UL, such as class, or align.
  83  * ), $smarty);
  84  *
  85  * </pre>
  86  * * @author Justin Park (jpark@sugarcrm.com)
  87  */
  88 require_once('include/SugarHtml/SugarHtml.php');
  89 function smarty_function_sugar_menu($params, &$smarty)
  90 {
  91     $root_options = array(
  92         "id" => array_key_exists('id', $params) ? $params['id'] : ""
  93     );
  94     if(array_key_exists('htmlOptions', $params)) {
  95         foreach($params['htmlOptions'] as $attr => $value) {
  96             $root_options[$attr] = $value;
  97         }
  98     }
  99     $output = SugarHtml::createOpenTag("ul", $root_options);
 100     foreach($params['items'] as $item) {
 101         if(strpos($item['html'], "</") === 0) {
 102             $output .= $item['html'];
 103             continue;
 104         }
 105         $output .= SugarHtml::createOpenTag('li', !empty($params['itemOptions']) ? $params['itemOptions'] : array())
 106             .$item['html'];
 107         if(isset($item['items']) && count($item['items'])) {
 108             $output .= smarty_function_sugar_menu(array(
 109                 'items' => $item['items'],
 110                 'htmlOptions' => !empty($params['submenuHtmlOptions']) ? $params['submenuHtmlOptions'] : array()
 111             ), $smarty);
 112         }
 113         $output .= SugarHtml::createCloseTag("li");
 114     }
 115     $output .= SugarHtml::createCloseTag("ul");
 116     return $output;
 117 }