Yoast_GA_Options

Options class.

Defined (1)

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

/includes/class-options.php  
  1. class Yoast_GA_Options { 
  2.  
  3.     /** @var array  */ 
  4.     public $options; 
  5.  
  6.     /** 
  7.      * Holds the settings for the GA plugin and possible subplugins 
  8.      * 
  9.      * @var string 
  10.      */ 
  11.     public $option_name = 'yst_ga'; 
  12.  
  13.     /** 
  14.      * Holds the prefix we use within the option to save settings 
  15.      * 
  16.      * @var string 
  17.      */ 
  18.     public $option_prefix = 'ga_general'; 
  19.  
  20.     /** 
  21.      * Holds the path to the main plugin file 
  22.      * 
  23.      * @var string 
  24.      */ 
  25.     public $plugin_path; 
  26.  
  27.     /** 
  28.      * Holds the URL to the main plugin directory 
  29.      * 
  30.      * @var string 
  31.      */ 
  32.     public $plugin_url; 
  33.  
  34.     /** 
  35.      * Saving instance of it's own in this static var 
  36.      * 
  37.      * @var object 
  38.      */ 
  39.     private static $instance; 
  40.  
  41.     /** 
  42.      * Getting instance of this object. If instance doesn't exists it will be created. 
  43.      * 
  44.      * @return object|Yoast_GA_Options 
  45.      */ 
  46.     public static function instance() { 
  47.  
  48.         if ( is_null( self::$instance ) ) { 
  49.             self::$instance = new Yoast_GA_Options(); 
  50.         } 
  51.  
  52.         return self::$instance; 
  53.  
  54.     } 
  55.  
  56.     /** 
  57.      * Constructor for the options 
  58.      */ 
  59.     public function __construct() { 
  60.         $this->options = $this->get_options(); 
  61.         $this->options = $this->check_options( $this->options ); 
  62.  
  63.         $this->plugin_path = plugin_dir_path( GAWP_FILE ); 
  64.         $this->plugin_url = trailingslashit( plugin_dir_url( GAWP_FILE ) ); 
  65.  
  66.         if ( false == $this->options ) { 
  67.             add_option( $this->option_name, $this->default_ga_values() ); 
  68.             $this->options = $this->get_options(); 
  69.         } 
  70.  
  71.         if ( ! isset( $this->options['version'] ) || $this->options['version'] < GAWP_VERSION ) { 
  72.             $this->upgrade(); 
  73.         } 
  74.  
  75.         // If instance is null, create it. Prevent creating multiple instances of this class 
  76.         if ( is_null( self::$instance ) ) { 
  77.             self::$instance = $this; 
  78.         } 
  79.  
  80.         add_action( 'plugins_loaded', array( $this, 'load_textdomain' ) ); 
  81.     } 
  82.  
  83.     /** 
  84.      * Updates the GA option within the current option_prefix 
  85.      * 
  86.      * @param array $val 
  87.      * 
  88.      * @return bool 
  89.      */ 
  90.     public function update_option( $val ) { 
  91.         $options = get_option( $this->option_name ); 
  92.         $options[ $this->option_prefix ] = $val; 
  93.  
  94.         return update_option( $this->option_name, $options ); 
  95.     } 
  96.  
  97.     /** 
  98.      * Return the Google Analytics options 
  99.      * 
  100.      * @return mixed|void 
  101.      */ 
  102.     public function get_options() { 
  103.         $options = get_option( $this->option_name ); 
  104.  
  105.         return $options[ $this->option_prefix ]; 
  106.     } 
  107.  
  108.     /** 
  109.      * Check if all the options are set, to prevent a notice if debugging is enabled 
  110.      * When we have new changes, the settings are saved to the options class 
  111.      * 
  112.      * @param array $options 
  113.      * 
  114.      * @return mixed 
  115.      */ 
  116.     public function check_options( $options ) { 
  117.  
  118.         $changes = 0; 
  119.         foreach ( $this->default_ga_values() as $key => $value ) { 
  120.             if ( ! isset( $options[ $key ] ) ) { 
  121.                 $options[ $key ] = $value; 
  122.                 $changes ++; 
  123.             } 
  124.         } 
  125.  
  126.         if ( $changes >= 1 ) { 
  127.             $this->update_option( $options ); 
  128.         } 
  129.  
  130.         return $options; 
  131.     } 
  132.  
  133.     /** 
  134.      * Get the Google Analytics tracking code for this website 
  135.      * 
  136.      * @return null 
  137.      */ 
  138.     public function get_tracking_code() { 
  139.         $tracking_code = null; 
  140.         $this->options = $this->get_options(); 
  141.  
  142.         if ( ! empty( $this->options['analytics_profile'] ) && ! empty( $this->options['analytics_profile_code'] ) ) { 
  143.             $tracking_code = $this->options['analytics_profile_code']; 
  144.         } 
  145.         elseif ( ! empty( $this->options['analytics_profile'] ) && empty( $this->options['analytics_profile_code'] ) ) { 
  146.             // Analytics profile is still holding the UA code 
  147.             $tracking_code = $this->options['analytics_profile']; 
  148.         } 
  149.  
  150.         if ( ! empty( $this->options['manual_ua_code_field'] ) && ! empty( $this->options['manual_ua_code'] ) ) { 
  151.             $tracking_code = $this->options['manual_ua_code_field']; 
  152.         } 
  153.  
  154.         return $tracking_code; 
  155.     } 
  156.  
  157.     /** 
  158.      * Convert a option value to a bool 
  159.      * 
  160.      * @param string $option_name 
  161.      * 
  162.      * @return bool 
  163.      */ 
  164.     public function option_value_to_bool( $option_name ) { 
  165.         $this->options = $this->get_options(); 
  166.  
  167.         if ( isset( $this->options[ $option_name ] ) && $this->options[ $option_name ] == 1 ) { 
  168.             return true; 
  169.         } 
  170.  
  171.         return false; 
  172.     } 
  173.  
  174.     /** 
  175.      * Upgrade the settings when settings are changed. 
  176.      * 
  177.      * @since 5.0.1 
  178.      */ 
  179.     private function upgrade() { 
  180.         if ( ! isset( $this->options['version'] ) && is_null( $this->get_tracking_code() ) ) { 
  181.             $old_options = get_option( 'Yoast_Google_Analytics' ); 
  182.             if ( isset( $old_options ) && is_array( $old_options ) ) { 
  183.                 if ( isset( $old_options['uastring'] ) && '' !== trim( $old_options['uastring'] ) ) { 
  184.                     // Save UA as manual UA, instead of saving all the old GA crap 
  185.                     $this->options['manual_ua_code'] = 1; 
  186.                     $this->options['manual_ua_code_field'] = $old_options['uastring']; 
  187.                 } 
  188.                 // Other settings 
  189.                 $this->options['allow_anchor'] = $old_options['allowanchor']; 
  190.                 $this->options['add_allow_linker'] = $old_options['allowlinker']; 
  191.                 $this->options['anonymous_data'] = $old_options['anonymizeip']; 
  192.                 $this->options['track_outbound'] = $old_options['trackoutbound']; 
  193.                 $this->options['track_internal_as_outbound'] = $old_options['internallink']; 
  194.                 $this->options['track_internal_as_label'] = $old_options['internallinklabel']; 
  195.                 $this->options['extensions_of_files'] = $old_options['dlextensions']; 
  196.             } 
  197.             delete_option( 'Yoast_Google_Analytics' ); 
  198.         } 
  199.         // 5.0.0 to 5.0.1 fix of ignore users array 
  200.         if ( ! isset( $this->options['version'] ) || version_compare( $this->options['version'], '5.0.1', '<' ) ) { 
  201.             if ( isset( $this->options['ignore_users'] ) && ! is_array( $this->options['ignore_users'] ) ) { 
  202.                 $this->options['ignore_users'] = (array) $this->options['ignore_users']; 
  203.             } 
  204.         } 
  205.         // 5.1.2+ Remove firebug_lite from options, if set 
  206.         if ( ! isset ( $this->options['version'] ) || version_compare( $this->options['version'], '5.1.2', '<' ) ) { 
  207.             if ( isset( $this->options['firebug_lite'] ) ) { 
  208.                 unset( $this->options['firebug_lite'] ); 
  209.             } 
  210.         } 
  211.         // 5.2.8+ Add disabled dashboards option 
  212.         if ( ! isset ( $this->options['dashboards_disabled'] ) || version_compare( $this->options['version'], '5.2.8', '>' ) ) { 
  213.             $this->options['dashboards_disabled'] = 0; 
  214.         } 
  215.         // Check is API option already exists - if not add it 
  216.         $yst_ga_api = get_option( 'yst_ga_api' ); 
  217.         if ( $yst_ga_api === false ) { 
  218.             add_option( 'yst_ga_api', array(), '', 'no' ); 
  219.         } 
  220.         // Fallback to make sure every default option has a value 
  221.         $defaults = $this->default_ga_values(); 
  222.         if ( is_array( $defaults ) ) { 
  223.             foreach ( $defaults[ $this->option_prefix ] as $key => $value ) { 
  224.                 if ( ! isset( $this->options[ $key ] ) ) { 
  225.                     $this->options[ $key ] = $value; 
  226.                 } 
  227.             } 
  228.         } 
  229.         // Set to the current version now that we've done all needed upgrades 
  230.         $this->options['version'] = GAWP_VERSION; 
  231.         $this->update_option( $this->options ); 
  232.     } 
  233.  
  234.     /** 
  235.      * Set the default GA settings here 
  236.      * @return array 
  237.      */ 
  238.     public function default_ga_values() { 
  239.         $options = array( 
  240.             $this->option_prefix => array( 
  241.                 'analytics_profile' => null,  
  242.                 'analytics_profile_code' => null,  
  243.                 'manual_ua_code' => 0,  
  244.                 'manual_ua_code_field' => null,  
  245.                 'track_internal_as_outbound' => null,  
  246.                 'track_internal_as_label' => null,  
  247.                 'track_outbound' => 0,  
  248.                 'anonymous_data' => 0,  
  249.                 'enable_universal' => 1,  
  250.                 'demographics' => 0,  
  251.                 'ignore_users' => array( 'administrator', 'editor' ),  
  252.                 'dashboards_disabled' => 0,  
  253.                 'anonymize_ips' => 0,  
  254.                 'track_download_as' => 'event',  
  255.                 'extensions_of_files' => 'doc, exe, js, pdf, ppt, tgz, zip, xls',  
  256.                 'track_full_url' => 'domain',  
  257.                 'subdomain_tracking' => null,  
  258.                 'tag_links_in_rss' => 0,  
  259.                 'allow_anchor' => 0,  
  260.                 'add_allow_linker' => 0,  
  261.                 'enhanced_link_attribution' => 0,  
  262.                 'custom_code' => null,  
  263.                 'debug_mode' => 0,  
  264.  ) 
  265.  ); 
  266.         $options = apply_filters( 'yst_ga_default-ga-values', $options, $this->option_prefix ); 
  267.  
  268.         return $options; 
  269.     } 
  270.  
  271.     /** 
  272.      * Load plugin textdomain 
  273.      */ 
  274.     public static function load_textdomain() { 
  275.         load_plugin_textdomain( 'google-analytics-for-wordpress', false, dirname( plugin_basename( GAWP_FILE ) ) . '/languages/' ); 
  276.     } 
  277.  
  278. }