File classes/admin/AdminController.php | HJI WP Membership Code Reference

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279

<?php
namespace hji\users\admin;


use hji\common\utils\HTTP;
use hji\membership\Membership;
use hji\users\core\Controller;
use hji\users\Users;


class AdminController extends Controller
{
    private $pageName;
    private $pageSlug;

    private $menuItems = array();

    private $router = array();

    private $controllerInstance;


    function __construct()
    {
        $this->pageName = Users::NAME;
        $this->pageSlug = Users::$slug;
    }


    /**
     * Sets up Admin Front for the plugin
     */
    function setup()
    {
        if (is_admin())
        {
            add_action('init', array($this, 'setPageRouter'));

            add_action('init', array($this, 'setActionHooks'));

            // Load admin Menu

            add_action('admin_menu', array($this, 'addMenu'));

            // Load admin Scripts

            add_action('admin_enqueue_scripts', array($this, 'loadScripts'));
        }
    }


    /**
     * Sets action hooks for the current page's controller
     */
    function setActionHooks()
    {
        if ($controller = $this->getControllerInstance())
        {
            $controller->setActionHooks();
        }
    }


    /**
     * Creates Admin Menu pages in the sidebar
     */
    function addMenu()
    {
        add_menu_page(
            $this->pageName,
            $this->pageName,
            // changing capability to allow Editor role  access leads
            'delete_published_pages', // manage_options.
            $this->pageSlug,
            false,
            Membership::$url . '/resources/images/admin-menu.png'
        );

        $this->menuItems[] = $this->pageSlug;

        $this->_addSubMenu();
    }


    /**
     * Loads styles and scripts on the Users Admin pages
     */
    function loadScripts()
    {
        global $plugin_page;

        $action = HTTP::getParameter('action');
        $tab    = HTTP::getParameter('tab');

        // Only load scripts on the admin pages created by the plugin.

        if (in_array($plugin_page, $this->menuItems))
        {
            wp_enqueue_style('hji-users-admin', Users::$url . '/resources/styles/admin.min.css');

            wp_enqueue_script('jquery-ui-datepicker');
            wp_enqueue_script('hji-users', Users::$url . '/resources/scripts/build/lib/admin.js', array('jquery'));

            wp_enqueue_style('dashicons');
            wp_enqueue_style('hji-jquery-ui', Membership::$url . '/third-party/hji-jquery-ui/jquery.ui.datepicker.min.css');

            if ($action == 'view' && $tab == 'searches')
            {
                wp_enqueue_script('jquery');
                wp_enqueue_script('jquery-ui-core');
                wp_enqueue_script('jquery-ui-tabs');
                wp_enqueue_script('jquery-ui-dialog');

                wp_enqueue_style('jquery-ui-dialog');

                $jquery_ui_css = 'http://code.jquery.com/ui/1.10.3/themes/smoothness/jquery-ui.css';
                wp_register_style('jquery_ui_css', $jquery_ui_css);
            }

        }
    }


    /**
     * Creates Admin Sub-menu pages in the sidebar
     */
    private function _addSubMenu()
    {
        if (!empty($this->router))
        {
            foreach ($this->router as &$route)
            {
                // Create a sub-menu item

                $pageHook = add_submenu_page(
                    $this->pageSlug,
                    $route['model']::$pageTitle . ' | User Management',
                    $route['model']::$pageTitle,
                    // changing capability to allow Editor role  access leads
                    'delete_published_pages', // manage_options.
                    $route['model']::$pageSlug,
                    array($this, 'renderPage')
                );

                // Add page slug to an array.
                // We check current page against this array before loading scripts.

                $this->menuItems[] = $route['model']::$pageSlug;

                // Add page hook to the router,
                // so it can be passed to its respective model when it's created.

                $route['hook'] = $pageHook;
            }
        }
    }


    /**
     * Renders current page
     */
    function renderPage()
    {
        if ($controller = $this->getControllerInstance())
        {
            $controller->renderPage();
        }
    }


    /**
     * Returns instance of the current page's controller
     *
     * @return object
     */
    function getControllerInstance()
    {
        global $plugin_page;

        $ajaxAction = strtolower(HTTP::getParameter('action'));

        if (!$this->controllerInstance)
        {
            foreach ($this->router as $route)
            {
                // Instantiate page classes only if:
                //   1. model's page slug equals current plugin page value
                //   2. OR it's an ajax call and ajax action refers to current controller action.

                if ($route['model']::$pageSlug == $plugin_page || $this->_isAjaxControllerAction($ajaxAction, $route['controller']))
                {
                    $model      = $this->di()->create(trim($route['model'], '\\'));
                    $controller = $this->di()->create(trim($route['controller'], '\\'), array($model));

                    if (isset($page['hook']))
                    {
                        $model->setPageHook($page['hook']);
                    }

                    $this->controllerInstance = $controller;

                    break;
                }
            }
        }

        return $this->controllerInstance;
    }


    /**
     * Determines if current ajax action belongs to the given controller
     *
     * @param $ajaxAction
     * @param $className
     * @return bool
     */
    private function _isAjaxControllerAction($ajaxAction, $className)
    {
        $parts = explode('_', $ajaxAction);

        if (count($parts) != 2)
        {
            return false;
        }

        $controllerNameParts = explode('\\', $className);
        $controllerName = array_pop($controllerNameParts);

        if ($parts[0] == strtolower($controllerName) && method_exists($className, $parts[1]))
        {
            return true;
        }

        return false;
    }


    /**
     * Sets up a router array where each route has respective model and controller name
     */
    function setPageRouter()
    {
        // Dynamically load admin models and controllers from file system

        $modelsPath     = dirname(__FILE__) . '/models';
        $files          = array_diff(scandir($modelsPath), array('..', '.'));

        // Reversing sort of file names, because we need Manage Users menu to be first.
        // It has the same slug as main menu and overwrites it, otherwise it won't work,
        // and will display a duplicate menu item that does nothing.

        rsort($files);

        if (!empty($files))
        {
            foreach ($files as $file)
            {
                // Load Model and corresponding Controller

                $modelName          = str_replace('.php', '', $file);
                $controllerName     = str_replace('Model', 'Controller', $modelName);

                $modelClass         = '\hji\users\admin\models\\' . $modelName;
                $controllerClass    = '\hji\users\admin\controllers\\' . $controllerName;

                if (class_exists($modelClass) && class_exists($controllerClass))
                {

                    $this->router[$modelClass::$pageSlug] = array(
                        'model'         => $modelClass,
                        'controller'    => $controllerClass
                    );
                }
            }
        }
    }

}

Namespaces

Classes

Interfaces

Functions