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 function smarty_function_sugar_menu($params, &$smarty)
  89 {
  90     $root_options = array(
  91         "id" => array_key_exists('id', $params) ? $params['id'] : ""
  92     );
  93     if(array_key_exists('htmlOptions', $params)) {
  94         foreach($params['htmlOptions'] as $attr => $value) {
  95             $root_options[$attr] = $value;
  96         }
  97     }
  98     $output = open_tag("ul", $root_options);
  99     foreach($params['items'] as $item) {
 100         if(strpos($item['html'], "</") === 0) {
 101             $output .= $item['html'];
 102             continue;
 103         }
 104         $output .= open_tag('li', !empty($params['itemOptions']) ? $params['itemOptions'] : array()).$item['html'];
 105         if(isset($item['items']) && count($item['items'])) {
 106             $output .= smarty_function_sugar_menu(array(
 107                 'items' => $item['items'],
 108                 'htmlOptions' => !empty($params['submenuHtmlOptions']) ? $params['submenuHtmlOptions'] : array()
 109             ), $smarty);
 110         }
 111         $output .= "</li>";
 112     }
 113     $output .= '</ul>';
 114     return $output;
 115 }
 116
 117 function open_tag($tagName, $params = array(), $self_closing = false) {
 118
 119     $options = "";
 120     $self_closing_tag = ($self_closing) ? "/" : "";
 121     if(empty($params))
 122         return "<{$tagName}{$self_closing_tag}>";
 123
 124     foreach($params as $attr => $value) {
 125         if($value)
 126             $options .= $attr.'="'.$value.'" ';
 127     }
 128     return "<{$tagName} {$options}{$self_closing_tag}>";
 129 }
 130
 131 function parse_html_tag($code) {
 132     $SINGLE_QUOTE = "'";
 133     $DOUBLE_QUOTE = '"';
 134     $ASSIGN_SIGN = "=";
 135     $TAG_BEGIN = "<";
 136     $TAG_END = ">";
 137     $quote_encoded = false;
 138     $cache = array();
 139     $var_name = '';
 140     $var_assign = false;
 141     $start_pos = strpos($code, ' ') ? strpos($code, ' ') : strpos($code, $TAG_END);
 142     if(substr($code, 0, 1) != $TAG_BEGIN || $start_pos === false) {
 143         return $code;
 144     }
 145     $tag = substr($code, 1, $start_pos - 1);
 146     $closing_tag = '</'.$tag;
 147     $end_pos = strpos($code, $closing_tag, $start_pos + 1);
 148     $output = array(
 149         'tag' => $tag
 150     );
 151     if($end_pos === false) {
 152         $output['self_closing'] = true;
 153         $end_pos = (substr($code, -2) == '/>') ? -2 : -1;
 154         $code = substr($code, $start_pos + 1, $end_pos);
 155     } else {
 156         $output['self_closing'] = false;
 157         $code = substr($code, $start_pos + 1, $end_pos - $start_pos - 1);
 158     }
 159     for($i = 0; $i < strlen($code) ; $i ++) {
 160         $char = $code[$i];
 161         if($char == $SINGLE_QUOTE || $char == $DOUBLE_QUOTE) {
 162             if(empty($quote_type)) {
 163                 $quote_encoded = true;
 164                 $quote_type = $char;
 165             } else if ($quote_type == $char) {
 166                 if(!empty($cache)) {
 167                     $string = implode('', $cache);
 168                     if(empty($var_name)) {
 169                         $var_name = $string;
 170                     } else if($var_assign) {
 171                         $output[$var_name] = $string;
 172                         unset($var_name);
 173                     }
 174                 }
 175                 $quote_type = '';
 176                 $var_assign = false;
 177                 $cache = array();
 178                 $quote_encoded = false;
 179             } else {
 180                 array_push($cache, $char);
 181             }
 182         } else if ( !$quote_encoded && $char == ' ' ) {
 183             if(!empty($cache)) {
 184                 $string = implode('', $cache);
 185                 if(empty($var_name)) {
 186                     $var_name = $string;
 187                 } else if($var_assign) {
 188                     $output[$var_name] = $string;
 189                     unset($var_name);
 190                 }
 191                 $quote_encoded = false;
 192                 $var_assign = false;
 193                 $cache = array();
 194             }
 195         } else if ( !$quote_encoded && $char == $ASSIGN_SIGN ) {
 196             if(!empty($var_name)) {
 197                 $output[$var_name] = '';
 198             }
 199             $string = implode('', $cache);
 200             $var_name = $string;
 201             $var_assign = true;
 202             $cache = array();
 203         } else if ( !$quote_encoded && $char == $TAG_END ) {
 204             break;
 205         } else {
 206             array_push($cache, $char);
 207         }
 208     }
 209     if($output['self_closing'] === false) {
 210         $output['container'] = substr($code, $i + 1);
 211     }
 212     return $output;
 213 }