include/ytree/Node.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 //node the tree view. no need to add a root node,a invisible root node will be added to the
  39 //tree by default.
  40 //predefined properties for a node are  id, label, target and href. label is required property.
  41 //set the target and href property for cases where target is an iframe.
  42 class Node {
  43         //predefined node properties.
  44         var $_label;            //this is the only required property for a node.
  45         var $_href;
  46         var $_id;
  47
  48         //ad-hoc collection of node properties
  49         var $_properties=array();
  50         //collection of parmeter properties;
  51         var $_params=array();
  52
  53         //sent to the javascript.
  54         var $uid;               //unique id for the node.
  55
  56         var $nodes=array();
  57         var $dynamic_load=false; //false means child records are pre-loaded.
  58         var $dynamicloadfunction='loadDataForNode'; //default script to load node data (children)
  59         var $expanded=false;  //show node expanded during initial load.
  60
  61         function Node($id,$label,$show_expanded=false) {
  62                 $this->_label=$label;
  63                 $this->_properties['label']=$label;
  64                 $this->uid = create_guid();
  65                 $this->set_property('id',$id);
  66         $this->expanded = $show_expanded;
  67         }
  68
  69         //properties set here will be accessible via
  70         //node.data object in javascript.
  71         //users can add a collection of paramaters that will
  72         //be passed to objects responding to tree events
  73         function set_property($name, $value, $is_param=false) {
  74                 if(!empty($name) && ($value === 0 || !empty($value))) {
  75                         if ($is_param==false) {
  76                                 $this->_properties[$name]=$value;
  77                         } else {
  78                                 $this->_params[$name]=$value;
  79                         }
  80                 }
  81         }
  82
  83         //add a child node.
  84         function add_node($node) {
  85                 $this->nodes[$node->uid]=$node;
  86         }
  87
  88         //return definition of the node. the definition is a multi-dimension array and has 3 parts.
  89         // data-> definition of the current node.
  90         // attributes=> collection of additional attributes such as style class etc..
  91         // nodes: definition of children nodes.
  92         function get_definition() {
  93                 $ret=array();
  94
  95                 $ret['data']=$this->_properties;
  96                 if (count($this->_params) > 0) {
  97                         $ret['data']['param']=$this->_params;
  98                 }
  99
 100                 $ret['custom']['dynamicload']=$this->dynamic_load;
 101                 $ret['custom']['dynamicloadfunction']=$this->dynamicloadfunction;
 102                 $ret['custom']['expanded']=$this->expanded;
 103
 104                 foreach ($this->nodes as $node) {
 105                         $ret['nodes'][]=$node->get_definition();
 106                 }
 107                 return $ret;
 108         }
 109 }
 110 ?>