Node::Node()   A
last analyzed

Complexity

Conditions 2
Paths 2

Size

Total Lines 10
Code Lines 7

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 6

Importance

Changes 2
Bugs 2 Features 1
Metric Value
cc 2
eloc 7
c 2
b 2
f 1
nc 2
nop 3
dl 0
loc 10
ccs 0
cts 10
cp 0
crap 6
rs 9.4285
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-2013 SugarCRM Inc.
6
7
 * SuiteCRM is an extension to SugarCRM Community Edition developed by Salesagility Ltd.
8
 * Copyright (C) 2011 - 2014 Salesagility Ltd.
9
 *
10
 * This program is free software; you can redistribute it and/or modify it under
11
 * the terms of the GNU Affero General Public License version 3 as published by the
12
 * Free Software Foundation with the addition of the following permission added
13
 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
14
 * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
15
 * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
16
 *
17
 * This program is distributed in the hope that it will be useful, but WITHOUT
18
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
19
 * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
20
 * details.
21
 *
22
 * You should have received a copy of the GNU Affero General Public License along with
23
 * this program; if not, see http://www.gnu.org/licenses or write to the Free
24
 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
25
 * 02110-1301 USA.
26
 *
27
 * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
28
 * SW2-130, Cupertino, CA 95014, USA. or at email address [email protected].
29
 *
30
 * The interactive user interfaces in modified source and object code versions
31
 * of this program must display Appropriate Legal Notices, as required under
32
 * Section 5 of the GNU Affero General Public License version 3.
33
 *
34
 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
35
 * these Appropriate Legal Notices must retain the display of the "Powered by
36
 * SugarCRM" logo and "Supercharged by SuiteCRM" logo. If the display of the logos is not
37
 * reasonably feasible for  technical reasons, the Appropriate Legal Notices must
38
 * display the words  "Powered by SugarCRM" and "Supercharged by SuiteCRM".
39
 ********************************************************************************/
40
41
//node the tree view. no need to add a root node,a invisible root node will be added to the
42
//tree by default.
43
//predefined properties for a node are  id, label, target and href. label is required property.
44
//set the target and href property for cases where target is an iframe.
45
class Node {
46
	//predefined node properties.
47
	var $_label;		//this is the only required property for a node.
48
	var $_href;
49
	var $_id;
50
51
	//ad-hoc collection of node properties
52
	var $_properties=array();
53
	//collection of parmeter properties;
54
	var $_params=array();
55
56
	//sent to the javascript.
57
	var $uid; 		//unique id for the node.
58
59
	var $nodes=array();
60
	var $dynamic_load=false; //false means child records are pre-loaded.
61
	var $dynamicloadfunction='loadDataForNode'; //default script to load node data (children)
62
	var $expanded=false;  //show node expanded during initial load.
63
64
	function __construct($id,$label,$show_expanded=false) {
65
		$this->_label=$label;
66
		$this->_properties['label']=$label;
67
		$this->uid = create_guid();
68
		$this->set_property('id',$id);
69
        $this->expanded = $show_expanded;
70
	}
71
72
    /**
73
     * @deprecated deprecated since version 7.6, PHP4 Style Constructors are deprecated and will be remove in 7.8, please update your code, use __construct instead
74
     */
75
    function Node($id,$label,$show_expanded=false){
76
        $deprecatedMessage = 'PHP4 Style Constructors are deprecated and will be remove in 7.8, please update your code';
77
        if(isset($GLOBALS['log'])) {
78
            $GLOBALS['log']->deprecated($deprecatedMessage);
79
        }
80
        else {
81
            trigger_error($deprecatedMessage, E_USER_DEPRECATED);
82
        }
83
        self::__construct($id, $label, $show_expanded);
84
    }
85
86
87
	//properties set here will be accessible via
88
	//node.data object in javascript.
89
	//users can add a collection of paramaters that will
90
	//be passed to objects responding to tree events
91
 	function set_property($name, $value, $is_param=false) {
92
 		if(!empty($name) && ($value === 0 || !empty($value))) {
93
 			if ($is_param==false) {
0 ignored issues
show
Coding Style Best Practice introduced by
It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

When comparing two booleans, it is generally considered safer to use the strict comparison operator.

Loading history...
94
 				$this->_properties[$name]=$value;
95
 			} else {
96
 				$this->_params[$name]=$value;
97
 			}
98
 		}
99
 	}
100
101
	//add a child node.
102
 	function add_node($node) {
103
  		$this->nodes[$node->uid]=$node;
104
  	}
105
106
	//return definition of the node. the definition is a multi-dimension array and has 3 parts.
107
	// data-> definition of the current node.
108
	// attributes=> collection of additional attributes such as style class etc..
109
	// nodes: definition of children nodes.
110
 	function get_definition() {
111
 		$ret=array();
112
113
 		$ret['data']=$this->_properties;
114
 		if (count($this->_params) > 0) {
115
 			$ret['data']['param']=$this->_params;
116
 		}
117
118
		$ret['custom']['dynamicload']=$this->dynamic_load;
119
		$ret['custom']['dynamicloadfunction']=$this->dynamicloadfunction;
120
		$ret['custom']['expanded']=$this->expanded;
121
122
 		foreach ($this->nodes as $node) {
123
 			$ret['nodes'][]=$node->get_definition();
124
 		}
125
		return $ret;
126
 	}
127
}
128
?>