wpdk-menu.php

Go to the documentation of this file.

<?php
class WPDKMenu {

  const DEFAULT_CAPABILITY = 'read';
  const GLOBAL_MENU = 'wpdk_menus';
  public $capability;
  public $hookName;
  public $icon;
  public $id;
  public $menuTitle;
  public $position;
  public $subMenus;

  public function __construct( $id, $menu_title, $capability = self::DEFAULT_CAPABILITY, $icon = '', $position = null ) {
    $this->id             = sanitize_title( $id );
    $this->menuTitle      = $menu_title;
    $this->pageTitle      = $menu_title;
    $this->capability     = $capability;
    $this->position       = $position;
    $this->icon           = $icon;
    $this->subMenus       = array();
  }

  public static function sanitizeViewController( $view_controller )
  {
    $result = '';

    if ( is_string( $view_controller ) ) {
      $result = $view_controller;
    }
    elseif ( is_array( $view_controller ) ) {
      $result = get_class( $view_controller[0] ) . '-' . $view_controller[1];
    }
    return $result;
  }

  public static function menu( $view_controller )
  {
    $global_key = self::sanitizeViewController( $view_controller );

    if ( isset( $GLOBALS[self::GLOBAL_MENU] ) ) {
      if ( !empty( $global_key ) && !empty( $GLOBALS[self::GLOBAL_MENU][$global_key] ) ) {
        return $GLOBALS[self::GLOBAL_MENU][$global_key];
      }
    }
    else {
      $GLOBALS[self::GLOBAL_MENU] = array();
    }
    return null;
  }

  public static function url( $view_controller )
  {
    $info = self::menu( $view_controller );

    $url = '';
    if ( !empty( $info ) && isset( $info['parent'] ) ) {

      if ( false === strpos( $info['parent'], '.php' ) ) {
        $url = add_query_arg( array( 'page' => $info['page'] ), admin_url( 'admin.php' ) );
      }
      else {
        $url = add_query_arg( array( 'page' => $info['page'] ), admin_url( $info['parent'] ) );
      }
    }
    return $url;
  }

  public static function hook( $view_controller )
  {
    $info = self::menu( $view_controller );

    if ( !empty( $info ) ) {
      return $info['hook'];
    }
    return false;
  }

  public static function page( $view_controller )
  {
    $info = self::menu( $view_controller );

    if ( !empty( $info ) ) {
      return $info['page'];
    }
    return false;
  }

  public static function renderByArray( $menus ) {

    $result = array();

    foreach ( $menus as $key => $value ) {
      if ( is_array( $value ) ) {

        $menu = new WPDKMenu( $key, $value['menuTitle'], $value['capability'], $value['icon'] );

        foreach ( $value['subMenus'] as $skey => $svalue ) {

          if ( is_string( $svalue ) && WPDKSubMenuDivider::DIVIDER === $svalue ) {
            $menu->addDivider();
          }
          elseif ( is_array( $svalue ) ) {
            if ( isset( $svalue[WPDKSubMenuDivider::DIVIDER] ) ) {
              $menu->addDivider( $svalue[WPDKSubMenuDivider::DIVIDER] );
            }
            else {
              $sub_menu = $menu->addSubMenu( $svalue['menuTitle'], $svalue['viewController'] );
              /* Extra properties for sub menu */
              foreach ( $svalue as $property => $pvalue ) {
                $sub_menu->$property = $pvalue;
              }
            }
          }
        }

        /* Extra properties for menu */
        foreach( $value as $property => $pvalue ) {
          if ( !in_array( $property, array( 'subMenus' ) ) ) {
            $menu->$property = $pvalue;
          }
        }

        /* Over */
        $menu->render();
        $result[$key] = $menu;
      }
    }
    return $result;
  }

  public function addDivider( $title = '' )
  {
    if ( count( $this->subMenus ) > 0 ) {
      $divider                      = new WPDKSubMenuDivider( $this->id, $title );
      $this->subMenus[$divider->id] = $divider;
      return $divider;
    }
    return false;
  }

  public function addSubMenu( $menu_title, $view_controller, $capability = WPDKMenu::DEFAULT_CAPABILITY ) {
    if ( empty( $this->subMenus ) ) {
      $id = $this->id;
    }
    else {
      $id = sprintf( '%s-submenu-%s', $this->id, count( $this->subMenus ) );
    }

    $sub_menu            = new WPDKSubMenu( $this->id, $id, $menu_title, $view_controller, $capability );
    $this->subMenus[$id] = $sub_menu;
    return $sub_menu;
  }

  public function render() {
    $this->hookName = add_menu_page( $this->pageTitle, $this->menuTitle, $this->capability, $this->id, '', $this->icon, $this->position );

    while ( ( $sub_menu = current( $this->subMenus ) ) ) {
      $next = next( $this->subMenus );
      if ( is_a( $sub_menu, 'WPDKSubMenuDivider' ) ) {
        if ( isset( $next ) && isset( $next->capability ) ) {
          $sub_menu->capability = $next->capability;
        }
      }
      $sub_menu->render();
    }
  }

  public static function addSubMenuAt( &$menus, $menu_item, $index )
  {
    $key = key( $menus );
    if ( isset( $menus[$key]['subMenus'] ) ) {
      $index = ( $index < 0 ) ? count( $menus[$key]['subMenus'] ) + 1 : $index;
      $menus[$key]['subMenus'] = WPDKArray::insert( $menus[$key]['subMenus'], array( $menu_item ), $index );
    }
    else {
      $menus[$key] = WPDKArray::insert( $menus[$key], array( $menu_item ), $index );
    }
    return $menus;
  }

  public static function addSubMenusAt( &$menus, $submenus, $index )
  {
    $key = key( $menus );
    if ( isset( $menus[$key]['subMenus'] ) ) {
      $pos = ( $index < 0 ) ? count( $menus[$key]['subMenus'] ) + 1 : $index;
      foreach ( $submenus as $menu ) {
        $menus[$key]['subMenus'] = WPDKArray::insert( $menus[$key]['subMenus'], array( $menu ), $pos++ );
      }
    }
    else {
      $pos = ( $index < 0 ) ? count( $menus[$key] ) + 1 : $index;
      foreach ( $submenus as $menu ) {
        $menus[$key] = WPDKArray::insert( $menus[$key], array( $menu ), $pos++ );
      }
    }
    return $menus;
  }

  public static function isPageWithMenu( $id )
  {
    global $plugin_page;
    if ( $id === $plugin_page ) {
      return true;
    }
    return false;
  }

}

class WPDKSubMenu {

  const DEFAULT_CAPABILITY = 'read';

  public $capability = self::DEFAULT_CAPABILITY;
  public $hookName = '';
  public $id = '';
  public $menuTitle = '';
  public $pageTitle = '';
  public $parent = '';
  public $viewController = '';

  public $query_args = array();

  public function __construct( $parent, $id, $menu_title, $view_controller = '', $capability = self::DEFAULT_CAPABILITY ) {
    $this->parent = $parent;
    if ( is_object( $parent ) && is_a( $parent, 'WPDKMenu' ) ) {
      $this->parent = $parent->id;
    }
    $this->id             = sanitize_title( $id );
    $this->menuTitle      = $menu_title;
    $this->pageTitle      = $menu_title;
    $this->capability     = $capability;
    $this->viewController = $view_controller;
  }

  public static function renderByArray( $sub_menus ) {
    $result = array();
    $index  = 1;
    foreach ( $sub_menus as $parent => $sub_menu ) {
      foreach ( $sub_menu as $sub_item ) {
        $item = false;
        if ( is_string( $sub_item ) && WPDKSubMenuDivider::DIVIDER === $sub_item ) {
          $item = new WPDKSubMenuDivider( $parent );
        }
        elseif ( is_array( $sub_item ) ) {
          if ( isset( $sub_item[WPDKSubMenuDivider::DIVIDER] ) ) {
            $item = new WPDKSubMenuDivider( $parent, $sub_item[WPDKSubMenuDivider::DIVIDER] );
          }
          else {
            if( is_array( $sub_item['viewController'] ) ) {
              $id = sprintf( '%s-submenu-%s', sanitize_title( $sub_item['viewController'][1] ), $index++ );
            } else {
              $id = sprintf( '%s-submenu-%s', sanitize_title( $sub_item['viewController'] ), $index++ );
            }
            $item = new WPDKSubMenu( $parent, $id, $sub_item['menuTitle'], $sub_item['viewController'] );
            /* Extra properties */
            foreach ( $sub_item as $property => $svalue ) {
              $item->$property = $svalue;
            }
          }
        }
        if( !empty( $item ) ) {
          $item->render();
        }
      }
      if( !empty( $item ) ) {
        $result[] = $item;
      }
    }
    return $result;
  }

  public function render()
  {

    global $plugin_page;

    $hook       = '';
    $global_key = WPDKMenu::sanitizeViewController( $this->viewController );

    if ( !empty( $this->viewController ) && is_string( $this->viewController ) && !function_exists( $this->viewController ) && class_exists( $this->viewController ) ) {

      // Check for static ::init() method
      if ( method_exists( $this->viewController, 'init' ) ) {
        $hook = create_function( '', sprintf( '%s::init()->display();', $this->viewController ) );
      }
      else {
        $hook = create_function( '', sprintf( '$view_controller = new %s; $view_controller->display();', $this->viewController ) );
      }

    }
    // If the callable is in the form array( obj, method ), I have to properly init $hook anyway
    elseif ( is_callable( $this->viewController ) ) {
      $hook = $this->viewController;
    }

    if( !empty( $global_key ) ) {

      //  Create a global list of my own menu.
      $GLOBALS[WPDKMenu::GLOBAL_MENU][$global_key ] = array(
        'parent'     => $this->parent,
        'page'       => $this->id,
        'hook'       => '',
        'menu_title' => ''
      );
    }

    /* Apply filter for change the title. */
    $menu_title = apply_filters( 'wpdk_submenu_title', $this->menuTitle, $this->id, $this->parent );

    /* Create the menu item. */
    $this->hookName = add_submenu_page( $this->parent, $this->pageTitle, $menu_title, $this->capability, $this->id, $hook );

    /* Check for query args. */
    if ( isset( $this->query_args ) && !empty( $this->query_args ) ) {
      $stack = array();
      foreach ( $this->query_args as $var => $value ) {
        $stack[] = sprintf( '$_GET["%s"] = $_REQUEST["%s"] = "%s";', $var, $var, $value );
      }
      $func = create_function( '', implode( '', $stack ) );
      add_action( 'load-' . $this->hookName, $func );
    }

    /* Execute this action when the page displayed ids for this submenu view. */
    if( !empty( $plugin_page ) ) {
      if( $this->id === $plugin_page ) {
        do_action( 'wpdk_submenu_page', $this, $plugin_page );
      }
    }

    if ( !empty( $this->viewController ) && is_string( $this->viewController ) && !function_exists( $this->viewController && class_exists( $this->viewController ) ) ) {

      // Check for static ::init() method
      if ( method_exists( $this->viewController, 'init' ) ) {
        $load = create_function( '', sprintf( '%s::init()->load();', $this->viewController ) );
        add_action( 'load-' . $this->hookName, $load );

        $admin_head = create_function( '', sprintf( '$v=%s::init();$v->admin_head();$v->_admin_head();', $this->viewController ) );
        add_action( 'admin_head-' . $this->hookName, $admin_head );
      }
      //
      elseif ( !is_callable( $this->viewController ) && class_exists( $this->viewController ) ) {
        $load = create_function( '', sprintf( '%s::willLoad();', $this->viewController ) );
        add_action( 'load-' . $this->hookName, $load );

        $admin_head = create_function( '', sprintf( '%s::didHeadLoad();', $this->viewController ) );
        add_action( 'admin_head-' . $this->hookName, $admin_head );
      }
    }

    if ( !empty( $global_key ) ) {
      $GLOBALS[WPDKMenu::GLOBAL_MENU][$global_key]['hook']       = $this->hookName;
      $GLOBALS[WPDKMenu::GLOBAL_MENU][$global_key]['menu_title'] = $menu_title;
    }
  }

}

class WPDKSubMenuDivider extends WPDKSubMenu {

  const DEFAULT_CAPABILITY = 'manage_options';
  const DIVIDER = 'wpdk_menu_divider';

  public function __construct( $parent, $title = '' ) {
    static $index = 1;
    $id = sprintf( '%s-%s', self::DIVIDER, $index++ );
    parent::__construct( $parent, $id, $title );
    $this->capability = self::DEFAULT_CAPABILITY;
  }

}