Yoast_GA_Dashboards

Dashboards class.

Defined (1)

The class is defined in the following location(s).

/admin/dashboards/class-admin-dashboards.php  
  1. class Yoast_GA_Dashboards { 
  2.  
  3.     /** 
  4.      * @var Yoast_GA_Dashboards_Collector $aggregator Store the data aggregator 
  5.      */ 
  6.     public $aggregator; 
  7.  
  8.     /** 
  9.      * @var array $data Store the Data instance 
  10.      */ 
  11.     public $data; 
  12.  
  13.     /** 
  14.      * @var array $active_metrics Store the active metrics 
  15.      */ 
  16.     public $active_metrics; 
  17.  
  18.     /** 
  19.      * Store the valid metrics which are available in the Google API, more can be added 
  20.      * 
  21.      * @var array 
  22.      * 
  23.      * @link https://ga-dev-tools.appspot.com/explorer/ 
  24.      */ 
  25.     private $valid_metrics = array( 'sessions', 'bounces', 'users', 'newUsers', 'percentNewSessions', 'bounceRate', 'sessionDuration', 'avgSessionDuration', 'hits' ); 
  26.  
  27.     /** 
  28.      * Store this instance 
  29.      * 
  30.      * @var null 
  31.      */ 
  32.     private static $instance = null; 
  33.  
  34.     /** 
  35.      * @var boolean $dashboards_disabled Store the Dashboards disabled bool 
  36.      */ 
  37.     private $dashboards_disabled; 
  38.  
  39.     /** 
  40.      * Construct on the dashboards class for GA 
  41.      */ 
  42.     protected function __construct() { 
  43.         add_filter( 'ga_extend_dashboards', array( $this, 'extend_dashboards' ), 10, 1 ); 
  44.  
  45.         $this->dashboards_disabled = Yoast_GA_Settings::get_instance()->dashboards_disabled(); 
  46.     } 
  47.  
  48.     /** 
  49.      * Init the dashboards 
  50.      * 
  51.      * @param integer $ga_profile_id 
  52.      */ 
  53.     public function init_dashboards( $ga_profile_id ) { 
  54.         if ( ! $this->dashboards_disabled ) { 
  55.             $dashboards = $this->get_default_dashboards(); 
  56.  
  57.             $this->extend_dashboards( $dashboards ); 
  58.  
  59.             // Register the active metrics 
  60.             $register = array_keys( $dashboards ); 
  61.  
  62.             $this->aggregator = new Yoast_GA_Dashboards_Collector( $ga_profile_id, $register, $this->valid_metrics ); 
  63.  
  64.             $this->register( $register ); 
  65.         } 
  66.     } 
  67.  
  68.     /** 
  69.      * Adding dashboards for front-end 
  70.      * 
  71.      * By hook as filter: $dashboards = apply_filters( 'ga_extend_dashboards', $dashboards); 
  72.      * 
  73.      * @param array $dashboards 
  74.      * 
  75.      * @return mixed 
  76.      */ 
  77.     public function extend_dashboards( $dashboards ) { 
  78.         // Initialize the dashboard graphs 
  79.         Yoast_GA_Dashboards_Display::get_instance()->add_dashboards( $dashboards ); 
  80.  
  81.         return $dashboards; 
  82.     } 
  83.  
  84.     /** 
  85.      * Get the instance 
  86.      * 
  87.      * @return Yoast_GA_Dashboards 
  88.      */ 
  89.     public static function get_instance() { 
  90.         if ( is_null( self::$instance ) ) { 
  91.             self::$instance = new self(); 
  92.         } 
  93.  
  94.         return self::$instance; 
  95.     } 
  96.  
  97.     /** 
  98.      * Register the dashboard types 
  99.      * 
  100.      * @param array|string $types 
  101.      * 
  102.      * @return bool 
  103.      */ 
  104.     public function register( $types ) { 
  105.         if ( is_array( $types ) == false ) { 
  106.             $types = array( $types ); 
  107.         } 
  108.  
  109.         if ( is_array( $types ) && count( $types ) >= 1 ) { 
  110.             if ( $this->validate_dashboard_types( $types ) ) { 
  111.                 $this->active_metrics = $types; 
  112.  
  113.                 return true; 
  114.             } 
  115.         } 
  116.  
  117.         return false; 
  118.     } 
  119.  
  120.     /** 
  121.      * Adding translations to ga-admin-dashboard 
  122.      */ 
  123.     public function add_dashboard_js_translations() { 
  124.         // Now we can localize the script with our data. 
  125.         $translation_array = array( 
  126.             // For datatables 
  127.             'sort_ascending' => __( ': activate to sort column ascending', 'google-analytics-for-wordpress' ),  
  128.             'sort_descending' => __( ': activate to sort column descending', 'google-analytics-for-wordpress' ),  
  129.             'empty_table' => __( 'No data available', 'google-analytics-for-wordpress' ),  
  130.             'info' => _x( 'Showing _START_ to _END_ of _TOTAL_ rows', '_START_, _END_ and _TOTAL_ will be replaced by JS (See: http://datatables.net/reference/option/language.info)', 'google-analytics-for-wordpress' ),  
  131.             'info_empty' => __( 'No rows to show', 'google-analytics-for-wordpress' ),  
  132.             'info_filtered' => _x( '(filtered from _MAX_ total rows)', '_MAX_ will be replaced by JS (See: http://datatables.net/reference/option/language.infoFiltered)', 'google-analytics-for-wordpress' ),  
  133.             'length_menu' => _x( 'Show _MENU_ rows', '_MAX_ will be replaced by JS', 'google-analytics-for-wordpress' ),  
  134.             'loading_records' => __( 'Loading...', 'google-analytics-for-wordpress' ),  
  135.             'pagination_first' => __( 'First', 'google-analytics-for-wordpress' ),  
  136.             'pagination_last' => __( 'Last', 'google-analytics-for-wordpress' ),  
  137.             'pagination_next' => __( 'Next', 'google-analytics-for-wordpress' ),  
  138.             'pagination_previous' => __( 'Previous', 'google-analytics-for-wordpress' ),  
  139.             'processing' => __( 'Processing...', 'google-analytics-for-wordpress' ),  
  140.             'search_placeholder' => __( 'Search', 'google-analytics-for-wordpress' ),  
  141.             'zero_records' => __( 'No matching records found', 'google-analytics-for-wordpress' ),  
  142.  
  143.             // For dimensions 
  144.             'dimensions' => __( 'Reports', 'google-analytics-for-wordpress' ),  
  145.             'custom_dimensions' => __( 'Custom dimension reports', 'google-analytics-for-wordpress' ),  
  146.  ); 
  147.  
  148.         wp_localize_script( 'ga-admin-dashboard', 'dashboard_translate', $translation_array ); 
  149.     } 
  150.  
  151.     /** 
  152.      * Reset all dashboards data by removing the options of the registered dashboards 
  153.      * 
  154.      * @return bool 
  155.      */ 
  156.     public function reset_dashboards_data() { 
  157.         if ( ! $this->dashboards_disabled ) { 
  158.             $dashboards = $this->get_default_dashboards(); 
  159.  
  160.             if ( is_array( $dashboards ) && count( $dashboards ) >= 1 ) { 
  161.                 foreach ( $dashboards as $name => $board ) { 
  162.                     Yoast_GA_Dashboards_Data::reset( $name ); 
  163.                 } 
  164.  
  165.                 // Make sure we fetch new data if we enable the dashboards by updating the last_run option 
  166.                 update_option( 'yst_ga_last_wp_run', date( 'Y-m-d', strtotime( '-2 days' ) ) ); 
  167.  
  168.                 return true; 
  169.             } 
  170.         } 
  171.  
  172.         return false; 
  173.     } 
  174.  
  175.     /** 
  176.      * Get the defaults dashboard array to register 
  177.      * 
  178.      * @return array 
  179.      */ 
  180.     private function get_default_dashboards() { 
  181.         return array( 
  182.             'sessions' => array( 
  183.                 'title' => __( 'Sessions', 'google-analytics-for-wordpress' ),  
  184.                 'help' => __( 'A session is a group of interactions that take place on your website within a given time frame. For example a single session can contain multiple screen or page views, events, social interactions, and ecommerce transactions. <a href="http://yoa.st/gasessions" target="_blank">[Learn more]</a>', 'google-analytics-for-wordpress' ),  
  185.                 'type' => 'graph',  
  186.                 'tab' => 'general',  
  187.  ),  
  188.             'bounceRate' => array( 
  189.                 'title' => __( 'Bounce rate', 'google-analytics-for-wordpress' ),  
  190.                 'help' => __( 'Bounce Rate is the percentage of single-page sessions (i.e. sessions in which the person left your site from the entrance page without interacting with the page). <a href="http://yoa.st/gabounce" target="_blank">[Learn more]</a>', 'google-analytics-for-wordpress' ),  
  191.                 'data-percent' => true,  
  192.                 'type' => 'graph',  
  193.                 'tab' => 'general',  
  194.  ),  
  195.             'source' => array( 
  196.                 'title' => __( 'Traffic sources', 'google-analytics-for-wordpress' ),  
  197.                 'help' => __( 'Every referral to a web site has an origin, or (traffic) source. Possible sources include: *google* (the name of a search engine), *facebook.com* (the name of a referring site), *spring_newsletter* (the name of one of your newsletters), and *direct* (users that typed your URL directly into their browser, or who had bookmarked your site). <a href="http://yoa.st/gabnce" target="_blank">[Learn more]</a>', 'google-analytics-for-wordpress' ),  
  198.                 'type' => 'table',  
  199.                 'columns' => array( 
  200.                     __( 'Sessions', 'google-analytics-for-wordpress' ) 
  201.  ),  
  202.                 'tab' => 'dimensions',  
  203.  ),  
  204.             'top_pageviews' => array( 
  205.                 'title' => __( 'Popular pages', 'google-analytics-for-wordpress' ),  
  206.                 'help' => __( 'Pages by url.', 'google-analytics-for-wordpress' ),  
  207.                 'type' => 'table',  
  208.                 'columns' => array( 
  209.                     __( 'Sessions', 'google-analytics-for-wordpress' ) 
  210.  ),  
  211.                 'tab' => 'dimensions',  
  212.  ),  
  213.             'top_countries' => array( 
  214.                 'title' => __( 'Countries', 'google-analytics-for-wordpress' ),  
  215.                 'help' => __( 'The country or territory from which visits originated. <a href="http://yoa.st/gacountry" target="_blank">[Learn more]</a>', 'google-analytics-for-wordpress' ),  
  216.                 'type' => 'table',  
  217.                 'columns' => array( 
  218.                     __( 'Sessions', 'google-analytics-for-wordpress' ) 
  219.  ),  
  220.                 'tab' => 'dimensions',  
  221.  ),  
  222.  ); 
  223.     } 
  224.  
  225.     /** 
  226.      * Validate the registered types of dashboards 
  227.      * 
  228.      * @param array $types 
  229.      * 
  230.      * @return bool 
  231.      */ 
  232.     private function validate_dashboard_types( $types ) { 
  233.         $valid = true; 
  234.  
  235.         if ( is_array( $types ) ) { 
  236.             foreach ( $types as $check_type ) { 
  237.                 if ( ! in_array( $check_type, $this->valid_metrics ) ) { 
  238.                     $valid = false; 
  239.                 } 
  240.             } 
  241.         } 
  242.  
  243.         return $valid; 
  244.     } 
  245. }