File zp-extensions/search_statistics.php

  1: <?php
  2: /**
  3:  *
  4:  * This plugin gathers data about searches that users make on your site.
  5:  *
  6:  * Notes on the analysis of the data:
  7:  *
  8:  *      The search results used for Dynamic album processing are ignored.
  9:  *
 10:  *      Analysis presumes that the Theme does a "uniform" set of object retrievals. That
 11:  *      is, the <var>search.php</var> script will always request albums, images, pages, and/or news
 12:  *      consistently. Data collection happens for each of these objects so to "normalize"
 13:  *      the data the analysis will divide the data by the number of objects searched.
 14:  *
 15:  *   So, if for instance, you sometimes enable Zenpage results, sometimes there will be results
 16:  *   for images, albums, pages, and news; and other times there will just be results for
 17:  *   images and albums. In this case the reports will under value the searches done when
 18:  *   Zenpage results were not enabled.
 19:  *
 20:  * @author Stephen Billard (sbillard)
 21:  * @package plugins
 22:  * @subpackage admin
 23:  */
 24: $plugin_is_filter = 2|CLASS_PLUGIN;
 25: $plugin_description = gettext("Collects and displays search criteria.");
 26: $plugin_author = "Stephen Billard (sbillard)";
 27: 
 28: $option_interface = 'search_statistics';
 29: 
 30: zp_register_filter('search_statistics','search_statistics::handler');
 31: zp_register_filter('admin_utilities_buttons', 'search_statistics::button');
 32: 
 33: /**
 34:  * Option handler class
 35:  *
 36:  */
 37: class search_statistics {
 38:     var $ratingstate;
 39:     /**
 40:      * class instantiation function
 41:      *
 42:      * @return jquery_rating
 43:      */
 44:     function __construct() {
 45:         setOptionDefault('search_statistics_threshold', 25);
 46:         setOptionDefault('search_statistics_terms_threshold', 25);
 47:         setOptionDefault('search_statistics_failed_threshold', 10);
 48:         setOptionDefault('search_statistics_ip_threshold', 10);
 49:     }
 50: 
 51: 
 52:     /**
 53:      * Reports the supported options
 54:      *
 55:      * @return array
 56:      */
 57:     function getOptionsSupported() {
 58:         return array(   gettext('Threshold (success)') => array('key' => 'search_statistics_threshold', 'type' => OPTION_TYPE_TEXTBOX,
 59:                                         'order' =>1,
 60:                                         'desc' => gettext('Show the top <em>Threshold</em> criteria of successful searches. (Searches which returned at least one result.)')),
 61:                                     gettext('Threshold (failed)') => array('key' => 'search_statistics_failed_threshold', 'type' => OPTION_TYPE_TEXTBOX,
 62:                                         'order' =>2,
 63:                                         'desc' => gettext('Show the top <em>Threshold</em> criteria of searches that failed.')),
 64:                                     gettext('Threshold (terms)') => array('key' => 'search_statistics_terms_threshold', 'type' => OPTION_TYPE_TEXTBOX,
 65:                                         'order' =>3,
 66:                                         'desc' => gettext('Show the top <em>Threshold</em> terms used in searches.')),
 67:                                     gettext('Threshold (IP)') => array('key' => 'search_statistics_ip_threshold', 'type' => OPTION_TYPE_TEXTBOX,
 68:                                         'order' =>4,
 69:                                         'desc' => gettext('Show the top <em>Threshold</em> IPs that have performed searches.'))
 70:                                     );
 71:     }
 72: 
 73:     function handleOption($option, $currentValue) {
 74:     }
 75: 
 76: 
 77:     static function button($buttons) {
 78:         $buttons[] = array(
 79:                                     'category'=>gettext('Info'),
 80:                                     'enable'=>true,
 81:                                     'button_text'=>gettext('Search statistics'),
 82:                                     'formname'=>'search_statistics_button',
 83:                                     'action'=>PLUGIN_FOLDER.'/search_statistics/search_analysis.php',
 84:                                     'icon'=>'images/bar_graph.png',
 85:                                     'title'=>gettext('Analyze searches'),
 86:                                     'alt'=>'',
 87:                                     'hidden'=> '',
 88:                                     'rights'=> OVERVIEW_RIGHTS,
 89:                                     );
 90:         return $buttons;
 91:     }
 92: 
 93:     /**
 94:      *
 95:      * Logs User searches
 96:      * @param array $search_statistics the search criteria
 97:      * @param string $type 'album', 'image', etc.
 98:      * @param bool $success did the search return a result
 99:      * @param bool $dynamic was it from a dynamic album
100:      * @param int $iteration count of the filters since the search engine instantiation
101:      */
102:     static function handler($search_statistics, $type, $success, $dynamic, $iteration) {
103:         if (!$dynamic) {    // log unique user searches
104:             $store = array('type'=>$type, 'success'=>$success, 'iteration'=>$iteration, 'data'=>$search_statistics);
105:             $sql = 'INSERT INTO '.prefix('plugin_storage').' (`type`, `aux`,`data`) VALUES ("search_statistics", '.db_quote(getUserIP()).','.db_quote(serialize($store)).')';
106:             query($sql);
107:         }
108:         return $search_statistics;
109:     }
110: 
111: }
112: ?>
Packages

Classes

Exceptions

Functions
