Yoast_GA_Admin_Menu

This class is for the backend, extendable for all child classes.

Defined (1)

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

/admin/class-admin-menu.php  
  1. class Yoast_GA_Admin_Menu { 
  2.  
  3.     /** 
  4.      * @var object $target_object The property used for storing target object (class admin) 
  5.      */ 
  6.     private $target_object; 
  7.  
  8.     /** 
  9.      * @var boolean $dashboard_disabled The dashboards disabled bool 
  10.      */ 
  11.     private $dashboards_disabled; 
  12.  
  13.     /** 
  14.      * The parent slug for the submenu items based on if the dashboards are disabled or not. 
  15.      * 
  16.      * @var string 
  17.      */ 
  18.     private $parent_slug; 
  19.  
  20.     /** 
  21.      * Setting the target_object and adding actions 
  22.      * 
  23.      * @param object $target_object 
  24.      */ 
  25.     public function __construct( $target_object ) { 
  26.  
  27.         $this->target_object = $target_object; 
  28.  
  29.         add_action( 'admin_menu', array( $this, 'create_admin_menu' ), 10 ); 
  30.  
  31.         if ( ! function_exists( 'is_plugin_active_for_network' ) ) { 
  32.             require_once( ABSPATH . '/wp-admin/includes/plugin.php' ); 
  33.         } 
  34.  
  35.         if ( is_plugin_active_for_network( GAWP_PATH ) ) { 
  36.             add_action( 'network_admin_menu', array( $this, 'create_admin_menu' ), 5 ); 
  37.         } 
  38.  
  39.         $this->dashboards_disabled = Yoast_GA_Settings::get_instance()->dashboards_disabled(); 
  40.         $this->parent_slug = ( ( $this->dashboards_disabled ) ? 'yst_ga_settings' : 'yst_ga_dashboard' ); 
  41.     } 
  42.  
  43.     /** 
  44.      * Create the admin menu 
  45.      */ 
  46.     public function create_admin_menu() { 
  47.         /** 
  48.          * Filter: 'wpga_menu_on_top' - Allows filtering of menu location of the GA plugin, if false is returned, it moves to bottom. 
  49.          * 
  50.          * @api book unsigned 
  51.          */ 
  52.  
  53.         // Base 64 encoded SVG image 
  54.         $icon_svg = 'data:image/svg+xml;base64, PD94<BASE64_ENCODED>'; 
  55.  
  56.         $menu_name = is_network_admin() ? 'extensions' : 'dashboard'; 
  57.  
  58.         if ( $this->dashboards_disabled ) { 
  59.             $menu_name = 'settings'; 
  60.         } 
  61.  
  62.         // Add main page 
  63.         add_menu_page( 
  64.             __( 'Yoast Google Analytics:', 'google-analytics-for-wordpress' ) . ' ' . __( 'General settings', 'google-analytics-for-wordpress' ), __( 'Analytics', 'google-analytics-for-wordpress' ), 'manage_options', 'yst_ga_' . $menu_name,  
  65.             array( 
  66.                 $this->target_object,  
  67.                 'load_page',  
  68.  ),  
  69.             $icon_svg,  
  70.             $this->get_menu_position() 
  71.  ); 
  72.  
  73.         $this->add_submenu_pages(); 
  74.     } 
  75.  
  76.     /** 
  77.      * Get the menu position of the Analytics item 
  78.      * 
  79.      * @return string 
  80.      */ 
  81.     private function get_menu_position() { 
  82.         $on_top = apply_filters( 'wpga_menu_on_top', true ); 
  83.  
  84.         if ( $on_top ) { 
  85.             $position = $this->get_menu_position_value( 'top' ); 
  86.  
  87.         } 
  88.         else { 
  89.             $position = $this->get_menu_position_value( 'bottom' ); 
  90.         } 
  91.  
  92.         // If the dashboards are disabled, force the menu item to stay at the bottom of the menu 
  93.         if ( $this->dashboards_disabled ) { 
  94.             $position = $this->get_menu_position_value( 'bottom' ); 
  95.         } 
  96.  
  97.         return $position; 
  98.     } 
  99.  
  100.     /** 
  101.      * Get the top or bottom menu location number 
  102.      * 
  103.      * @param string $location 
  104.      * 
  105.      * @return string 
  106.      */ 
  107.     private function get_menu_position_value( $location ) { 
  108.         if ( $location == 'top' ) { 
  109.             return '2.00013467543'; 
  110.         } 
  111.  
  112.         return '100.00013467543'; 
  113.     } 
  114.  
  115.     /** 
  116.      * Prepares an array that can be used to add a submenu page to the Google Analytics for Wordpress menu 
  117.      * 
  118.      * @param string $submenu_name 
  119.      * @param string $submenu_slug 
  120.      * @param string $font_color 
  121.      * 
  122.      * @return array 
  123.      */ 
  124.     private function prepare_submenu_page( $submenu_name, $submenu_slug, $font_color = '' ) { 
  125.         return array( 
  126.             'parent_slug' => $this->parent_slug,  
  127.             'page_title' => __( 'Yoast Google Analytics:', 'google-analytics-for-wordpress' ) . ' ' . $submenu_name,  
  128.             'menu_title' => $this->parse_menu_title( $submenu_name, $font_color ),  
  129.             'capability' => 'manage_options',  
  130.             'menu_slug' => 'yst_ga_' . $submenu_slug,  
  131.             'submenu_function' => array( $this->target_object, 'load_page' ),  
  132.  ); 
  133.     } 
  134.  
  135.     /** 
  136.      * Parsing the menutitle 
  137.      * 
  138.      * @param string $menu_title 
  139.      * @param string $font_color 
  140.      * 
  141.      * @return string 
  142.      */ 
  143.     private function parse_menu_title( $menu_title, $font_color ) { 
  144.         if ( ! empty( $font_color ) ) { 
  145.             $menu_title = '<span style="color:' . $font_color . '">' . $menu_title . '</span>'; 
  146.         } 
  147.  
  148.         return $menu_title; 
  149.     } 
  150.  
  151.     /** 
  152.      * Adds a submenu page to the Google Analytics for WordPress menu 
  153.      * 
  154.      * @param array $submenu_page 
  155.      */ 
  156.     private function add_submenu_page( $submenu_page ) { 
  157.         $page = add_submenu_page( $submenu_page['parent_slug'], $submenu_page['page_title'], $submenu_page['menu_title'], $submenu_page['capability'], $submenu_page['menu_slug'], $submenu_page['submenu_function'] ); 
  158.         $is_dashboard = ( 'yst_ga_dashboard' === $submenu_page['menu_slug'] ); 
  159.         $this->add_assets( $page, $is_dashboard ); 
  160.     } 
  161.  
  162.     /** 
  163.      * Adding stylesheets and based on $is_not_dashboard maybe some more styles and scripts. 
  164.      * 
  165.      * @param string  $page 
  166.      * @param boolean $is_dashboard 
  167.      */ 
  168.     private function add_assets( $page, $is_dashboard ) { 
  169.         add_action( 'admin_print_styles-' . $page, array( 'Yoast_GA_Admin_Assets', 'enqueue_styles' ) ); 
  170.         add_action( 'admin_print_styles-' . $page, array( 'Yoast_GA_Admin_Assets', 'enqueue_settings_styles' ) ); 
  171.         add_action( 'admin_print_scripts-' . $page, array( 'Yoast_GA_Admin_Assets', 'enqueue_scripts' ) ); 
  172.         if ( ! $is_dashboard && filter_input( INPUT_GET, 'page' ) === 'yst_ga_dashboard' ) { 
  173.             Yoast_GA_Admin_Assets::enqueue_dashboard_assets(); 
  174.         } 
  175.     } 
  176.  
  177.     /** 
  178.      * Prepares and adds submenu pages to the Google Analytics for Wordpress menu: 
  179.      * - Dashboard 
  180.      * - Settings 
  181.      * - Extensions 
  182.      * 
  183.      * @return void 
  184.      */ 
  185.     private function add_submenu_pages() { 
  186.         foreach ( $this->get_submenu_types() as $submenu ) { 
  187.             if ( isset( $submenu['color'] ) ) { 
  188.                 $submenu_page = $this->prepare_submenu_page( $submenu['label'], $submenu['slug'], $submenu['color'] ); 
  189.             } 
  190.             else { 
  191.                 $submenu_page = $this->prepare_submenu_page( $submenu['label'], $submenu['slug'] ); 
  192.             } 
  193.             $this->add_submenu_page( $submenu_page ); 
  194.         } 
  195.     } 
  196.  
  197.     /** 
  198.      * Determine which submenu types should be added as a submenu page. 
  199.      * 
  200.      * Dashboard can be disables by user 
  201.      * 
  202.      * Dashboard and settings are disables in network admin 
  203.      * 
  204.      * @return array 
  205.      */ 
  206.     private function get_submenu_types() { 
  207.         /** 
  208.          * Array structure: 
  209.          * 
  210.          * array( 
  211.          *   $submenu_name => array( 
  212.          *        'color' => $font_color,  
  213.          *        'label' => __( 'text-label', 'google-analytics-for-wordpress' ),  
  214.          *           'slug' => $menu_slug,  
  215.          * ),  
  216.          *   ..,  
  217.          * ) 
  218.          * 
  219.          * $font_color can be left empty. 
  220.          * 
  221.          */ 
  222.         $submenu_types = array(); 
  223.  
  224.         if ( ! is_network_admin() ) { 
  225.  
  226.             if ( ! $this->dashboards_disabled ) { 
  227.                 $submenu_types['dashboard'] = array( 
  228.                     'label' => __( 'Dashboard', 'google-analytics-for-wordpress' ),  
  229.                     'slug' => 'dashboard',  
  230.  ); 
  231.             } 
  232.  
  233.             $submenu_types['settings'] = array( 
  234.                 'label' => __( 'Settings', 'google-analytics-for-wordpress' ),  
  235.                 'slug' => 'settings',  
  236.  ); 
  237.         } 
  238.  
  239.         $submenu_types['extensions'] = array( 
  240.             'color' => '#f18500',  
  241.             'label' => __( 'Extensions', 'google-analytics-for-wordpress' ),  
  242.             'slug' => 'extensions',  
  243.  ); 
  244.  
  245.         return $submenu_types; 
  246.     } 
  247. }