Move busui to seperate repository
[bus.git] / goalManager.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
<?php
 
//
// Open Web Analytics - An Open Source Web Analytics Framework
//
// Copyright 2006 Peter Adams. All rights reserved.
//
// Licensed under GPL v2.0 http://www.gnu.org/copyleft/gpl.html
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// $Id$
//
 
/**
 * Goal Manager
 * 
 * @author      Peter Adams <peter@openwebanalytics.com>
 * @copyright   Copyright &copy; 2006 Peter Adams <peter@openwebanalytics.com>
 * @license     http://www.gnu.org/copyleft/gpl.html GPL v2.0
 * @category    owa
 * @package     owa
 * @version             $Revision$            
 * @since               owa 1.4.0
 */
 
 
class owa_goalManager extends owa_base {
 
        var $goals;
        var $activeGoals;
        var $goal_group_labels;
        var $activeGoalGroups;
        var $activeGoalsByGroup;
        var $site_id;
        var $numGoals;
        var $numGoalGroups;
        var $isDirtyGoals;
        var $isDirtyGoalGroups;
        
        /**
         * Constructor
         * 
         * Takes cache directory as param
         *
         * @param $cache_dir string
         */
        function __construct( $site_id ) {
                
                $this->site_id = $site_id;
                $this->numGoals = owa_coreAPI::getSetting('base', 'numGoals');
                $this->numGoalGroups = owa_coreAPI::getSetting('base', 'numGoalGroups');
                $this->loadGoals( $site_id );
                $this->loadGoalGroupLabels ( $site_id );
        }
        
        function setSiteId( $site_id ) {
                
                $this->site_id = $site_id;
        }
        
        function loadGoalGroupLabels( $site_id ) {
                
                $this->goal_group_labels = array();
                for ( $i = 1; $i <= $this->numGoalGroups; $i++ ) {
                        $this->goal_group_labels[$i] = "Goal Group $i"; 
                }
                
                $from_db = owa_coreAPI::getSiteSetting( $site_id , 'goal_groups' );
                
                if ($from_db) {
                
                        foreach($from_db as $k => $goalGroup) {
                                if (array_key_exists($k, $this->goal_group_labels)) {
                                        $this->goal_group_labels[$k] = $goalGroup;
                                }
                        }
                }
        }
        
        function loadGoals( $site_id ) {
                
                $this->goals = array();
                
                for ( $i = 1; $i <= $this->numGoals; $i++ ) {
                        $this->goals[$i] = array(
                                        'goal_number'   => '',
                                        'goal_name'             => '',
                                        'goal_group'    => '',
                                        'goal_status'   => '',
                                        'goal_type'             => ''
                        );      
                }
                
                $from_db = owa_coreAPI::getSiteSetting( $site_id, 'goals' );
                
                if ($from_db) {
                                
                        foreach ($from_db as $k => $goal) {
                                
                                if (array_key_exists($k, $this->goals)) {
                                        // add to goal array
                                        $this->goals[$k] = $goal;
                                        // set active goal lists
                                        if (array_key_exists('goal_status', $goal) && $goal['goal_status'] === 'active') {
                                                // set active goals
                                                $this->activeGoals[] = $goal['goal_number'];
                                                // set active goal groups
                                                if (array_key_exists('goal_group', $goal)) {
                                                        $this->activeGoalGroups[$goal['goal_group']] = $goal['goal_group'];
                                                        // set active goals by group
                                                        $this->activeGoalsByGroup[$goal['goal_group']][] = $goal['goal_number'];
                                                }                       
                                        }
                                }
                        }
                }
        }
        
        function getActiveGoals() {
                if (!empty($this->activeGoals)) {
                        $goals = array();
                        foreach ($this->activeGoals as $goal_number) {
                                $goals[$goal_number] = $this->getGoal($goal_number);
                        }
                        return $goals;
                }
        }
        
        function getAllGoals() {
                
                return $this->goals;
        }
        
        function getActiveGoalGroups() {
        
                return $this->activeGoalGroups;
        }
        
        function getActiveGoalsByGroup($group_number) {
                
                return $this->activeGoalsByGroup[$group_number];
        }
        
        function getGoal($number) {
                
                if ( array_key_exists( $number, $this->goals ) ) {
                        
                        return $this->goals[$number];
                }
        }
        
        function getGoalGroupLabel($number) {
                
                if ( array_key_exists( $number, $this->goal_group_labels ) ) {
                
                        return $this->goal_group_labels[$number];
                }
        }
        
        function getAllGoalGroupLabels() {
                
                return $this->goal_group_labels;
        }
        
        function saveGoal($number, $goal) {
                
                if ( $number <= $this->numGoals ) {
                
                        $goal['goal_number'] = $number;
                        $this->goals[$goal['goal_number']] = $goal;
                        $this->isDirtyGoals = true;
                }
        }
        
        function saveGoalGroupLabel($number, $goal_group) {
                
                $this->goal_group_labels[$number] = $goal_group;
                $this->isDirtyGoalGroups = true;
        }
        
        function __destruct() {
                
                if ( $this->isDirtyGoals ) {
                        
                        owa_coreAPI::persistSiteSetting( $this->site_id, 'goals', $this->goals );
                }
                
                if ( $this->isDirtyGoalGroups ) {
 
                        owa_coreAPI::persistSiteSetting( $this->site_id, 'goal_groups', $this->goal_group_labels );
                }
        }
        
        function getGoalFunnel($goal_number) {
                
                $goal = $this->getGoal($goal_number);
                if ( array_key_exists( 'details', $goal ) && array_key_exists( 'funnel_steps', $goal['details'] ) ) {
                        return $goal['details']['funnel_steps'];
                }
        }
}
 
?>