Add analytics
[bus.git] / busui / owa / modules / base / handlers / sessionCommerceSummaryHandlers.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
<?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$
//
 
if(!class_exists('owa_observer')) {
        require_once(OWA_DIR.'owa_observer.php');
}       
require_once(OWA_DIR.'owa_lib.php');
 
/**
 * Session Commerce Summary Event handlers
 *
 * Listens for commerce.transaction event and does an idempotent update of the session's
 * commerce realted summary columns.
 * 
 * @author      Peter Adams <peter@openwebanalytics.com>
 * @copyright   Copyright &copy; 2006-2011 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_sessionCommerceSummaryHandlers extends owa_observer {
        
    /**
     * Notify handler method
     *
     * @param   object  $event
     * @access  public
     * @return  boolean
     */
    function notify($event) {
                                
        $s = owa_coreAPI::entityFactory( 'base.session' );
                $pk = $event->get( 'session_id' );
                
                // just in case events slip thorugh that have no session_id
                // look for the original session id param
                if ( ! $pk ) {
                        $pk = $event->get( 'original_session_id' );
                        if ($pk) {
                                $event->set('session_id', $pk);
                        }
                }
                
                $s->getByPk( 'id', $pk );
                $id = $s->get('id'); 
                
                if ($id) {
                        // summarze the transaction
                        $summary = owa_coreAPI::summarize(array(
                        'entity'                => 'base.commerce_transaction_fact',
                        'columns'               => array(
                                        'id'            => 'count',
                                        'total_revenue'         => 'sum',
                                        'tax_revenue'           => 'sum',
                                        'shipping_revenue'      => 'sum'),
                        'constraints'   => array( 'session_id' => $id ) ) );
                        
                        $s->set( 'commerce_trans_count', $summary['id_count'] );
                        $s->set( 'commerce_trans_revenue', $summary['total_revenue_sum'] );
                        $s->set( 'commerce_tax_revenue', $summary['tax_revenue_sum'] );
                        $s->set( 'commerce_shipping_revenue', $summary['shipping_revenue_sum'] );
                        
                        // check for items and summarize if needed.
                        $items = $event->get('ct_line_items');
                        
                        if ( ! empty( $items ) ) {
                                $summary = owa_coreAPI::summarize(array(
                        'entity'                => 'base.commerce_line_item_fact',
                        'columns'               => array(
                                        'sku'                           => 'count_distinct',
                                        'item_revenue'          => 'sum',
                                        'quantity'                      => 'sum'),
                        'constraints'   => array( 'session_id' => $id ) ) );
                        
                                $s->set( 'commerce_items_count', $summary['sku_dcount'] );
                                $s->set( 'commerce_items_revenue', $summary['item_revenue_sum'] );
                                $s->set( 'commerce_items_quantity', $summary['quantity_sum'] ); 
                        }
                        
                        $ret = $s->update();
                        
                        if ($ret) {
                                return OWA_EHS_EVENT_HANDLED;   
                        } else {
                                return OWA_EHS_EVENT_FAILED;
                        }
                        
                } else {
                
                        owa_coreAPI::debug('Not Updating session commerce transaction properties. Session does not exist yet.');
                        return OWA_EHS_EVENT_FAILED;
                }       
    }
}
 
?>