Changeset 504

Timestamp:

09/20/08 16:44:57 (4 months ago)

Author:

padams

Message:

refactored widget. added dedcated controller. added pre and post method calls to owa_controlelr as well.

Location:

trunk

Files:

• modules/base/classes/widget.php (added)
• modules/base/dashboardTrendWidget.php (modified) (2 diffs)
• modules/base/reportDashboard.php (modified) (1 diff)
• modules/base/templates/widget.tpl (modified) (3 diffs)
• modules/base/widget.php (modified) (2 diffs)
• owa_controller.php (modified) (4 diffs)
• owa_template.php (modified) (2 diffs)
• owa_view.php (modified) (1 diff)
• public/js/owa.widgets.js (modified) (4 diffs)

trunk/modules/base/dashboardTrendWidget.php

@@ -19 +19 @@
 
 require_once(OWA_BASE_CLASSES_DIR.'owa_lib.php');
-require_once(OWA_BASE_CLASSES_DIR.'owa_controller.php');
+require_once(OWA_BASE_CLASS_DIR.'widget.php');
 require_once(OWA_BASE_CLASSES_DIR.'owa_view.php');
 
-class owa_dashboardTrendWidgetController extends owa_controller {
+class owa_dashboardTrendWidgetController extends owa_widgetController {
 
         function __construct($params) {
@@ -36 +36 @@
         function action() {
                 
+                // Set Title of the Widget
+                $this->data['title'] = 'Dashboard Trend';
+                
+                // enable formats
+                $this->enableFormat('graph', 'Graph');
+                $this->enableFormat('table', 'Table');
+                $this->enableFormat('sparkline', 'Sparkline');
+                
+                //setup Metrics
                 $m = owa_coreApi::metricFactory('base.dashCoreByDay');
-                
                 $m->setConstraint('site_id', $this->params['site_id']);
                 $m->setConstraint('is_browser', 1);
                 $m->setPeriod($this->params['period']);
                 $m->setOrder(OWA_SQL_ASCENDING); 
-                
-                
-                if (array_key_exists('format', $this->params)):
-                        $format = $this->params['format'];
-                else:
-                        $format = 'graph';
-                endif;
                         
-                $data['title'] = 'Dashboard Trend';
-                $data['params'] = $this->params;
-                $data['widget'] = 'base.dashboardTrendWidget';
-                
-                switch ($format) {
+                switch ($this->params['format']) {
                 
                         case 'graph':
                                 
-                                $data['view'] = 'base.openFlashChart';
-                                $data['height'] = $this->params['height'];
-                                $data['width'] = $this->params['width'];
+                                $this->data['view'] = 'base.openFlashChart';
+                                $this->data['height'] = $this->params['height'];
+                                $this->data['width'] = $this->params['width'];
                                 break;
                                 
                         case 'graph-data':
+                        
                                 $results = $m->generate();
                                 $series = owa_lib::deconstruct_assoc($results);
-                                $data['y']['label'] = 'Page Views';
-                                $data['y2']['label'] = 'Visits';
-                                $data['x']['label'] = 'Day';
-                                $data['y']['series'] = $series['page_views'];
-                                $data['y2']['series'] = $series['sessions'];
-                                $data['x']['series'] = owa_lib::makeDateArray($results, "n/j");                         
-                                $data['view'] = 'base.areaBarsFlashChart';
+                                $this->data['y']['label'] = 'Page Views';
+                                $this->data['y2']['label'] = 'Visits';
+                                $this->data['x']['label'] = 'Day';
+                                $this->data['y']['series'] = $series['page_views'];
+                                $this->data['y2']['series'] = $series['sessions'];
+                                $this->data['x']['series'] = owa_lib::makeDateArray($results, "n/j");                           
+                                $this->data['view'] = 'base.areaBarsFlashChart';
                                 break;
                                 
                         case 'table':
+                        
                                 $m->setLimit(5);
                                 $results = $m->generate();
-                                $data['labels'] = $m->getLabels();
-                                $data['rows'] = $results;
-                                $data['view'] = 'base.genericTable';
+                                $this->data['labels'] = $m->getLabels();
+                                $this->data['rows'] = $results;
+                                $this->data['view'] = 'base.genericTable';
                                 break;
-                                
-                        
+                                        
                 }
                 
-                // used to add outer wrapper to widget if it's the first view.
-                if ($this->params['initial_view'] == true):
-                        $data['subview'] = $data['view'];
-                        $data['view'] = 'base.widget';
-                        // we dont want to keep passing this.
-                        unset($data['params']['initial_view']);
-                endif;
-                
-                return $data;
+                return;
                 
         }

trunk/modules/base/reportDashboard.php

@@ -174 +174 @@
                 $this->body->set('top_referers', $data['top_referers_data']);
                 
-                $this->setJs($this->config['public_url']."js/includes/jquery/jquery.js");
-                $this->setJs($this->config['public_url']."js/owa.js");
-                $this->setJs($this->config['public_url']."js/owa.widgets.js");
+                $this->setJs("includes/jquery/jquery.js");
+                $this->setJs("owa.js");
+                $this->setJs("owa.widgets.js");
+                $this->setCss("owa.widgets.css");
 
                 return;

trunk/modules/base/templates/widget.tpl

@@ -1 @@
-<style>
-
-.widget-container {border:1px solid #cccccc; width:100%;}
-.widget-header {color: white;background-color:orange; padding:5px;text-align:left;}
-.widget-title {font-size:20px;text-align:right;font-weight:bold;}
-.widget-title a {color: white;}
-.widget-title-controls {font-size:14px;text-align:right;}
-.widget-controls {text-align:right;padding:10px}
-.widget-content {padding:10px;}
-
-</style>
- 
-
 <script>
 
@@ -24 +11 @@
 </script>
 
-<div id="<?=$widget;?>" class="widget-container">
+<div id="<?=$widget;?>" class="owa_widget-container">
         
-        <div id="<?=$widget;?>_widget-header" class="widget-header">
+        <div id="<?=$widget;?>_widget-header" class="owa_widget-header">
                 <table style="width:100%;">
                         <TR>
                                 <TD>
-                                        <span class="widget-title"><?=$title;?></span>
+                                        <span class="owa_widget-title"><?=$title;?></span>
                                 </TD>
                                 <TD style="text-align:right;">
-                                        <a class="widget-title-controls" href="">Close</a>
+                                        <a class="owa_widget-toggle" href="#<?=$widget;?>_widget-header">Minimize</a> |
+                                        <a class="owa_widget-close" href="#<?=$widget;?>_widget-header">Close</a>
                                 </TD>
                         </TR>
@@ -39 +27 @@
 
         </div>
-
-        <div id="<?=$widget;?>_widget-status" class="widget-status">LOADING</div> 
-
-        <div id="<?=$widget;?>_widget-content" class="widget-content"><?=$subview;?></div>
         
-        <div id="<?=$widget;?>_widget-controls" class="widget-controls">
-                <a class="widget-control" href="#<?=$widget;?>_widget-header" name="graph">Graph</a> | 
-                <a class="widget-control" href="#<?=$widget;?>_widget-header" name="table">Table</a> | 
-                <a class="widget-control" href="#<?=$widget;?>_widget-header" name="sparkline">Sparkline</a>
+        <div class="owa_widget-innercontainer"> 
+                <div id="<?=$widget;?>_widget-status" class="owa_widget-status"><img src="<?=$this->makeImageLink("loading.gif");?>" border="0" align="ABSMIDDLE"> Loading...</div> 
+        
+                <div id="<?=$widget;?>_widget-content" class="owa_widget-content"><?=$subview;?></div>
+                
+                <? if($widget_views): ?>
+                <div id="<?=$widget;?>_widget-controls" class="owa_widget-controls">
+                        <span>Views: </span>
+                        <? foreach ($widget_views as $k => $v): ?>
+                        <a class="owa_widget-control" href="#<?=$widget;?>_widget-header" name="<?=$k;?>"><?=$v;?></a> / 
+                        <? endforeach;?>
+                </div>
+                <? endif; ?>
         </div>
-
         
 </div>

trunk/modules/base/widget.php

@@ -19 +19 @@
 require_once(OWA_BASE_DIR.'/owa_lib.php');
 require_once(OWA_BASE_DIR.'/owa_view.php');
-require_once(OWA_BASE_DIR.'/owa_controller.php');
-
-
-class owa_widgetController extends owa_controller {
-        
-        function owa_widgetController($params) {
-                
-                $this->owa_controller($params);
-                $this->priviledge_level = 'viewer';
-        
-        }
-        
-        function action() {
-                
-                $data = array();
-                $data['params'] = $this->params;
-                
-                // Load the core API
-                $api = &owa_coreAPI::singleton($this->params);
-                
-                $data['widget'] = $this->params['widget'];
-                $data['format'] = $this->params['format'];
-                $data['width'] = $this->params['width'];
-                $data['height'] = $this->params['height'];
-                
-                // flag used to pick the right wrapper template
-                if (array_key_exists('is_external', $this->params)):
-                        $data['is_external'] = $this->params['is_external'];
-                endif;
-                $data['view'] = 'base.widget';
-                $data['view_method'] = 'delegate';
-                
-                return $data;
-        }
-}
-
-
-
 
 /**
@@ -102 +64 @@
                 $this->body->set('params', $data['params']);    
                 $this->body->set('title', $data['title']);
+                $this->body->set('widget_views', $data['widget_views']);
                 $this->body->set('do', $data['widget']);        
                 

trunk/owa_controller.php

@@ -92 +92 @@
          */
         var $capability;
+        
+        /**
+         * Available Views
+         * 
+         * @var Array
+         */
+        var $available_views = array();
+        
         
         /**
@@ -155 +163 @@
                 // if auth was success then procead
                 if ($data['auth_status'] == true):
+                
+                        //set request params
+                        $this->data['params'] = $this->params;
                                         
                         // set status msg
@@ -174 +185 @@
                                         // if errors, do the errorAction instead of the normal action
                                         return $this->errorAction();
-                                else:
-                                        return $this->action();
                                 endif;
-                                
-                        endif;
-                        
-                        return $this->action();
+                        endif;
+                        
+                        // need to check ret for backwards compatability with older 
+                        // controllers that donot use $this->data
+                        
+                        $this->pre();
+                        
+                        $ret = $this->action();
+                        
+                        if (!empty($ret)):
+                                return $ret;
+                        else:
+                                $this->post();
+                                return $this->data;
+                        endif;
                 else:
                          // return the not priviledged error view set by owa_auth.
@@ -251 +271 @@
         }
         
+        function getParam($name) {
+        
+                if (array_key_exists($name, $this->params)):
+                        return $this->params['name'];
+                else:
+                        return false;
+                endif;
+        }
+        
+        function pre() {
+        
+                return false;
+        }
+        
+        function post() {
+                return false;
+        }
+        
 }
 

trunk/owa_template.php

@@ -574 +574 @@
         
         
-        function getWidget($widget, $format, $params = array()) {
+        function getWidget($do, $format, $params = array()) {
                 
                 if (empty($params)):
@@ -580 +580 @@
                 endif;
                 
-                $params['widget'] = $widget;
+                $params['do'] = $do;
                 $params['format'] = $format;
                 $params['initial_view'] = true;
                 
-                return owa_coreAPI::performAction($widget, $params);
+                return owa_coreAPI::performAction($do, $params);
         }
         

trunk/owa_view.php

@@ -318 +318 @@
         }
         
-        function setCss($file) {
-                
-                $this->css[] = $file;
-                return;
-        }
-        
-        function setJs($file) {
-                
-                $this->js[] = $file;
+        function setCss($file, $path = '') {
+                
+                if(empty($path)):
+                        $path = $this->config['public_url'].DIRECTORY_SEPARATOR.'css'.DIRECTORY_SEPARATOR;
+                endif;
+                
+                $this->css[] = $path.$file;
+                return;
+        }
+        
+        function setJs($file, $path = '') {
+                
+                if(empty($path)):
+                        $path = $this->config['public_url'].DIRECTORY_SEPARATOR.'js'.DIRECTORY_SEPARATOR;
+                endif;
+                
+                $this->js[] = $path.$file;
                 return;
         }

trunk/public/js/owa.widgets.js

@@ -20 +20 @@
         current_view: '',
         
+        minimized: false,
+        
         _makeUrl: function(values) {},
                         
         changeView: function(view) {
                         
-                        var widgetcontentid = "#"+this.name+"_widget-content";
+                        var widgetcontentid = "#"+this.dom_id+"_widget-content";
                         
                         this.properties.format = view;
@@ -35 +37 @@
                                 data: OWA.util.nsAll(this.properties), 
                                 //show loading just when link is clicked 
-                                beforeSend: function(){ jQuery(".widget-status").show("fast");}, 
+                                beforeSend: function(){ jQuery(".owa_widget-status").show("slow");}, 
                                 //stop showing loading when the process is complete 
-                                complete: function(){ jQuery(".widget-status").hide("fast");}, 
+                                complete: function(){ jQuery(".owa_widget-status").hide("slow");}, 
                                 //so, if data is retrieved, store it in html
                                 success: function(html){  
@@ -55 +57 @@
 // Bind event handlers
 jQuery(document).ready(function(){   
-        jQuery('.widget-control').click(owa_widget_changeView);
+        jQuery('.owa_widget-control').click(owa_widget_changeView);
+        jQuery('.owa_widget-close').click(owa_widget_close);
+        jQuery('.owa_widget-status').hide("slow");
+        jQuery('.owa_widget-toggle').click(owa_widget_toggle);
 });
-
 
 // Event handler for changeing views
@@ -63 +67 @@
 
         var view = jQuery(this).attr("name");
-        var parentname = jQuery("div").parent(".widget-container").attr("id");
-        //var widgetname2 = parentname.split("_");
-        var widgetname = parentname;
-        //alert(parentname);
-        // add to state object
-        OWA.items[widgetname].name = widgetname;
-        OWA.items[widgetname].changeView(view);
+        var widgetname = jQuery("div").parent(".owa_widget-container").attr("id");      
+        return OWA.items[widgetname].changeView(view);
+        
+}
+
+function owa_widget_close() {
+        
+        return jQuery("div").parent(".owa_widget-container").hide("slow");      
+}
+
+function owa_widget_toggle() {
+
+        jQuery("div").parent(".owa_widget-innercontainer").toggle("slow");
+        jQuery(this).html("Show");
+        var widgetname = jQuery("div").parent(".owa_widget-container").attr("id");      
+        OWA.items[widgetname].minimized = true;
 
         return;