File classes/controllers/Settings.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

<?php
namespace hji\geofarms\controllers;

use \hji\geofarms\GeoFarms;
use \hji\membership\Membership;
use \hji\common\utils\HTTP;
use \hji\common\utils\String;
use \hji\common\utils\Views;

use \hji\common\models\Notices;

use \hji\geofarms\models\Settings as SettingsModel;

require_once(GeoFarms::$dir . '/classes/models/Settings.php');
require_once(Membership::$dir . '/common/utils/Views.php');

class Settings
{
    private $view;
    private $model;

    public function __construct()
    {
        $this->model = new SettingsModel();
        $this->view = new Views(GeoFarms::$views);

        add_action('admin_init', array($this, 'admin_init'));
        add_action('admin_menu', array($this, 'admin_menu'));
        add_action('admin_notices', array($this, 'admin_notices'));
    }

    function admin_init()
    {
        $settingsKey = $this->model->getSettingsKey();

        // A single setting option is being registered
        // all our setting sections will be merged into it
        // within the validateSettings() method.

        register_setting($settingsKey, $settingsKey, array($this, 'validateSettings'));
    }

    function admin_menu()
    {
        $page = add_submenu_page(
            'edit.php?post_type=' . GeoFarms::$post_type,
            GeoFarms::NAME . ' | Help & Settings',
            'Help & Settings',
            'manage_options',
            GeoFarms::$slug,
            array($this, 'add_submenu_page_callback')
        );

        add_action('admin_print_styles-' . $page, array($this, 'admin_scripts'));
    }

    function admin_scripts()
    {
        // TODO: add admin scripts here
    }

    function admin_notices()
    {
        require_once(Membership::$dir . '/common/utils/HTTP.php');

        $page = strtolower(HTTP::getParameter('page'));

        if ($page != GeoFarms::$slug)
        {
            // TODO: custom notices like "Don't forget the milk!" go here
        }

    }


    function add_submenu_page_callback()
    {
        require_once(Membership::$dir . '/common/utils/HTTP.php');
        require_once(Membership::$dir . '/common/utils/String.php');
        require_once(Membership::$dir . '/common/models/Notices.php');

        $page = strtolower(HTTP::getParameter('page'));

        $notices = new Notices();

        if ($page == GeoFarms::$slug)
        {
            // Generate update notice if settings were updated

            $updated = HTTP::getParameter('settings-updated');

            if (String::toBoolean($updated) == true)
            {
                $notices->addNotice('Your settings have been saved.');
            }

            // Set view variables

            $vars = array();

            // Add page tabs variables;

            $tabs = $this->getOptionTabsVars();
            $vars = array_merge($tabs, $vars);

            $vars['pageSlug'] = GeoFarms::$slug;
            $vars['postType'] = GeoFarms::$post_type;
            $vars['pageTitle'] = GeoFarms::NAME . ' | Help & Settings';
            $vars['settingsModel'] = $this->model;
            $vars['notices'] = $notices;

            // You can get all option values (for the current tab/option group) into $option variable
            // Like this:
            // $vars['options'] = $this->model->getOptions($vars['current_tab']);
            // But in this plugin kit, we'll call settingsModel directly,
            // since options are already loaded - see the templates for details.


            // Render view

            echo $this->view->render('settings', array('vars' => $vars));
        }
    }


    function getOptionTabsVars()
    {
        // Tabs use option group keys

        // Get all option groups - keys => captions

        $optionGroups = $this->model->getOptionGroups();

        // Define default tab (the first one on the list)

        $defaultTab = array_keys($optionGroups);
        $defaultTab = array_shift($defaultTab);

        // Set vars for the view

        $vars['tabs'] = $this->model->getOptionGroups();
        $vars['current_tab'] = isset($_GET['tab']) ? $_GET['tab'] : $defaultTab;

        return $vars;
    }


    /**
     * Validates submitted values
     * Since we're saving ALL options under the same option name
     * we need to merge existing settings with the submitted ones,
     * so the submitted section doesn't overwrite all settings.
     */
    function validateSettings($settings)
    {
        $existingSettings = $this->model->getOptions();

        // do validation here...
        // submitted array look like this:
        // array( 'section_key' => array(values) );
        // you can validate based on section key.

        // Merge existing settings with new ones

        $result = array_merge($existingSettings, $settings);

        return $result;
    }
}

Namespaces

Classes

Interfaces

Functions