-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsource-class-Base_Controller_Settings.html
408 lines (389 loc) · 49 KB
/
source-class-Base_Controller_Settings.html
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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<meta name="robots" content="noindex" />
<title>File controllers/class-base-controller-settings.php</title>
<script type="text/javascript" src="resources/combined.js?4058929694"></script>
<script type="text/javascript" src="elementlist.js?2335409893"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Packages</h3>
<ul>
<li><a href="package-None.html">None</a>
</li>
<li class="active"><a href="package-WPMVCBase.html">WPMVCBase<span></span></a>
<ul>
<li class="active"><a href="package-WPMVCBase.Controllers.html">Controllers</a>
</li>
<li><a href="package-WPMVCBase.Helper.html">Helper</a>
</li>
<li><a href="package-WPMVCBase.Models.html">Models</a>
</li>
</ul></li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Base_Controller.html">Base_Controller</a></li>
<li><a href="class-Base_Controller_CPT.html">Base_Controller_CPT</a></li>
<li><a href="class-Base_Controller_Plugin.html">Base_Controller_Plugin</a></li>
<li class="active"><a href="class-Base_Controller_Settings.html">Base_Controller_Settings</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="package-WPMVCBase.Controllers.html" title="Summary of WPMVCBase\Controllers"><span>Package</span></a>
</li>
<li>
<a href="class-Base_Controller_Settings.html" title="Summary of Base_Controller_Settings"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a> <span class="php-comment">/*
</span></span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-comment">This program is free software; you can redistribute it and/or
</span></span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-comment">modify it under the terms of the GNU General Public License
</span></span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment">as published by the Free Software Foundation; either version 2
</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment">of the License, or (at your option) any later version.
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment">
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment">This program is distributed in the hope that it will be useful,
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment">but WITHOUT ANY WARRANTY; without even the implied warranty of
</span></span><span id="10" class="l"><a class="l" href="#10"> 10: </a><span class="php-comment">MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
</span></span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment">GNU General Public License for more details.
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment">
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment">You should have received a copy of the GNU General Public License
</span></span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-comment">along with this program; if not, write to the Free Software
</span></span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-comment">Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
</span></span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment">*/</span>
</span><span id="17" class="l"><a class="l" href="#17"> 17: </a>
</span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-keyword1">if</span> ( ! <span class="php-keyword2">class_exists</span>( <span class="php-quote">'Base_Controller_Settings'</span> ) ) {
</span><span id="19" class="l"><a class="l" href="#19"> 19: </a> <span class="php-keyword1">include_once</span> <span class="php-quote">'class-base-controller.php'</span>;
</span><span id="20" class="l"><a class="l" href="#20"> 20: </a>
</span><span id="21" class="l"><a class="l" href="#21"> 21: </a> <span class="php-comment">/**
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment"> * The base settings controller class.
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment"> *
</span></span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-comment"> * @package WPMVCBase\Controllers
</span></span><span id="25" class="l"><a class="l" href="#25"> 25: </a><span class="php-comment"> * @version 0.2
</span></span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment"> * @since WPMVCBase 0.2
</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> */</span>
</span><span id="28" class="l"><a class="l" href="#28"> 28: </a> <span class="php-keyword1">class</span> <a id="Base_Controller_Settings" href="#Base_Controller_Settings">Base_Controller_Settings</a> <span class="php-keyword1">extends</span> Base_Controller
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a> {
</span><span id="30" class="l"><a class="l" href="#30"> 30: </a> <span class="php-comment">/**
</span></span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment"> * The settings model.
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> *
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment"> * @var object Base_Settings_Model
</span></span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-comment"> * @since WPMVCBase 0.2
</span></span><span id="35" class="l"><a class="l" href="#35"> 35: </a><span class="php-comment"> */</span>
</span><span id="36" class="l"><a class="l" href="#36"> 36: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$model" href="#$model">$model</a></span>;
</span><span id="37" class="l"><a class="l" href="#37"> 37: </a>
</span><span id="38" class="l"><a class="l" href="#38"> 38: </a> <span class="php-comment">/**
</span></span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-comment"> * The class constructor.
</span></span><span id="40" class="l"><a class="l" href="#40"> 40: </a><span class="php-comment"> *
</span></span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment"> * @param object $model The Base_Model_Settings object.
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * @access public
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> * @since WPMVCBase 0.2
</span></span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-comment"> */</span>
</span><span id="45" class="l"><a class="l" href="#45"> 45: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___construct" href="#___construct">__construct</a>( Base_Model_Settings <span class="php-var">$model</span> )
</span><span id="46" class="l"><a class="l" href="#46"> 46: </a> {
</span><span id="47" class="l"><a class="l" href="#47"> 47: </a> <span class="php-var">$this</span>->model = <span class="php-var">$model</span>;
</span><span id="48" class="l"><a class="l" href="#48"> 48: </a>
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a> <span class="php-keyword1">if</span> ( <span class="php-keyword2">is_array</span>( <span class="php-var">$this</span>->model->get_settings_sections() ) ) {
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a> add_action( <span class="php-quote">'admin_init'</span>, <span class="php-keyword1">array</span>( &<span class="php-var">$this</span>, <span class="php-quote">'add_settings_sections'</span> ) );
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a> }
</span><span id="52" class="l"><a class="l" href="#52"> 52: </a>
</span><span id="53" class="l"><a class="l" href="#53"> 53: </a> <span class="php-keyword1">if</span> ( <span class="php-keyword2">is_array</span>( <span class="php-var">$this</span>->model->get_settings_fields() ) ) {
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a> add_action( <span class="php-quote">'admin_init'</span>, <span class="php-keyword1">array</span>( &<span class="php-var">$this</span>, <span class="php-quote">'add_settings_fields'</span> ) );
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a> }
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a>
</span><span id="57" class="l"><a class="l" href="#57"> 57: </a> <span class="php-keyword1">if</span> ( <span class="php-keyword2">is_array</span>( <span class="php-var">$this</span>->model->get_options() ) ) {
</span><span id="58" class="l"><a class="l" href="#58"> 58: </a> add_action( <span class="php-quote">'admin_init'</span>, <span class="php-keyword1">array</span>( &<span class="php-var">$this</span>, <span class="php-quote">'register_options'</span> ) );
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a> }
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a>
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a> <span class="php-keyword1">if</span> ( <span class="php-keyword2">is_array</span>( <span class="php-var">$this</span>->model->get_pages() ) ) {
</span><span id="62" class="l"><a class="l" href="#62"> 62: </a> add_action( <span class="php-quote">'admin_menu'</span>, <span class="php-keyword1">array</span>( &<span class="php-var">$this</span>, <span class="php-quote">'add_menu_pages'</span> ) );
</span><span id="63" class="l"><a class="l" href="#63"> 63: </a> }
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a> }
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a>
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a> <span class="php-comment">/**
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> * Register options.
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> *
</span></span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-comment"> * @internal
</span></span><span id="70" class="l"><a class="l" href="#70"> 70: </a><span class="php-comment"> * @access public
</span></span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment"> * @since WPMVCBase 0.2
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> */</span>
</span><span id="73" class="l"><a class="l" href="#73"> 73: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_register_options" href="#_register_options">register_options</a>()
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a> {
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a> <span class="php-var">$options</span> = <span class="php-var">$this</span>->model->get_options();
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a>
</span><span id="77" class="l"><a class="l" href="#77"> 77: </a> <span class="php-keyword1">if</span> ( <span class="php-keyword2">is_array</span>( <span class="php-var">$options</span> ) ) {
</span><span id="78" class="l"><a class="l" href="#78"> 78: </a> <span class="php-keyword1">foreach</span> ( <span class="php-var">$options</span> <span class="php-keyword1">as</span> <span class="php-var">$option</span> ) {
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a> <span class="php-keyword1">if</span> ( <span class="php-keyword2">is_null</span>( <span class="php-var">$option</span>[<span class="php-quote">'callback'</span>] ) ) {
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a> <span class="php-var">$option</span>[<span class="php-quote">'callback'</span>] = <span class="php-keyword1">array</span>( <span class="php-var">$this</span>->model, <span class="php-quote">'sanitize_input'</span> );
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a> }
</span><span id="82" class="l"><a class="l" href="#82"> 82: </a> register_setting( <span class="php-var">$option</span>[<span class="php-quote">'option_group'</span>], <span class="php-var">$option</span>[<span class="php-quote">'option_name'</span>], <span class="php-var">$option</span>[<span class="php-quote">'callback'</span>] );
</span><span id="83" class="l"><a class="l" href="#83"> 83: </a> }
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a> }
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a> }
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a>
</span><span id="87" class="l"><a class="l" href="#87"> 87: </a> <span class="php-comment">/**
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> * Add the menu pages.
</span></span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-comment"> *
</span></span><span id="90" class="l"><a class="l" href="#90"> 90: </a><span class="php-comment"> * @return bool|object TRUE on success, WP_Error on failure.
</span></span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment"> * @internal
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * @access public
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> * @since WPMVCBase 0.1
</span></span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-comment"> * @link http://codex.wordpress.org/Function_Reference/add_menu_page
</span></span><span id="95" class="l"><a class="l" href="#95"> 95: </a><span class="php-comment"> * @link http://codex.wordpress.org/Function_Reference/add_submenu_page
</span></span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment"> */</span>
</span><span id="97" class="l"><a class="l" href="#97"> 97: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_add_menu_pages" href="#_add_menu_pages">add_menu_pages</a>()
</span><span id="98" class="l"><a class="l" href="#98"> 98: </a> {
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a> <span class="php-var">$menu_pages</span> = apply_filters( <span class="php-quote">'ah_filter_settings_pages'</span>, <span class="php-var">$this</span>->model->get_pages() );
</span><span id="100" class="l"><a class="l" href="#100">100: </a>
</span><span id="101" class="l"><a class="l" href="#101">101: </a> <span class="php-keyword1">if</span> ( <span class="php-keyword2">is_array</span>( <span class="php-var">$menu_pages</span> ) ) {
</span><span id="102" class="l"><a class="l" href="#102">102: </a> <span class="php-keyword1">foreach</span> ( <span class="php-var">$menu_pages</span> <span class="php-keyword1">as</span> <span class="php-var">$key</span> => <span class="php-var">$page</span> ) {
</span><span id="103" class="l"><a class="l" href="#103">103: </a> <span class="php-keyword1">if</span> ( <span class="php-keyword2">is_a</span>( <span class="php-var">$page</span>, <span class="php-quote">'Base_Model_Menu_Page'</span> ) ) {
</span><span id="104" class="l"><a class="l" href="#104">104: </a> <span class="php-keyword1">if</span> ( ! <span class="php-var">$page</span>->get_callback() ) {
</span><span id="105" class="l"><a class="l" href="#105">105: </a> <span class="php-var">$page</span>->set_callback( <span class="php-keyword1">array</span>( <span class="php-var">$this</span>, <span class="php-quote">'render_options_page'</span> ) );
</span><span id="106" class="l"><a class="l" href="#106">106: </a> }
</span><span id="107" class="l"><a class="l" href="#107">107: </a>
</span><span id="108" class="l"><a class="l" href="#108">108: </a> <span class="php-var">$result</span> = <span class="php-var">$page</span>->add();
</span><span id="109" class="l"><a class="l" href="#109">109: </a>
</span><span id="110" class="l"><a class="l" href="#110">110: </a> <span class="php-keyword1">if</span> ( <span class="php-keyword1">false</span> == <span class="php-var">$result</span> ) {
</span><span id="111" class="l"><a class="l" href="#111">111: </a> <span class="php-keyword1">if</span> ( !<span class="php-keyword1">isset</span>( <span class="php-var">$wp_error</span> ) ) {
</span><span id="112" class="l"><a class="l" href="#112">112: </a> <span class="php-var">$wp_error</span> = <span class="php-keyword1">new</span> WP_Error();
</span><span id="113" class="l"><a class="l" href="#113">113: </a> }
</span><span id="114" class="l"><a class="l" href="#114">114: </a>
</span><span id="115" class="l"><a class="l" href="#115">115: </a> <span class="php-var">$wp_error</span>->add(
</span><span id="116" class="l"><a class="l" href="#116">116: </a> <span class="php-quote">'failure'</span>,
</span><span id="117" class="l"><a class="l" href="#117">117: </a> <span class="php-keyword2">sprintf</span>( __( <span class="php-quote">'Unable to add submenu page: %s.'</span>, <span class="php-var">$this</span>->txtdomain ), <span class="php-var">$key</span> ),
</span><span id="118" class="l"><a class="l" href="#118">118: </a> <span class="php-var">$page</span>
</span><span id="119" class="l"><a class="l" href="#119">119: </a> );
</span><span id="120" class="l"><a class="l" href="#120">120: </a> }
</span><span id="121" class="l"><a class="l" href="#121">121: </a> }
</span><span id="122" class="l"><a class="l" href="#122">122: </a>
</span><span id="123" class="l"><a class="l" href="#123">123: </a> <span class="php-comment">//update the page element with these new properites</span>
</span><span id="124" class="l"><a class="l" href="#124">124: </a> <span class="php-var">$this</span>->model->edit_page( <span class="php-var">$key</span>, <span class="php-var">$page</span> );
</span><span id="125" class="l"><a class="l" href="#125">125: </a> } <span class="php-comment">// end foreach</span>
</span><span id="126" class="l"><a class="l" href="#126">126: </a> <span class="php-keyword1">if</span> ( <span class="php-keyword1">isset</span>( <span class="php-var">$wp_error</span> ) ) {
</span><span id="127" class="l"><a class="l" href="#127">127: </a> <span class="php-keyword1">return</span> <span class="php-var">$wp_error</span>;
</span><span id="128" class="l"><a class="l" href="#128">128: </a> }
</span><span id="129" class="l"><a class="l" href="#129">129: </a> } <span class="php-comment">// end if</span>
</span><span id="130" class="l"><a class="l" href="#130">130: </a>
</span><span id="131" class="l"><a class="l" href="#131">131: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">true</span>;
</span><span id="132" class="l"><a class="l" href="#132">132: </a> }
</span><span id="133" class="l"><a class="l" href="#133">133: </a>
</span><span id="134" class="l"><a class="l" href="#134">134: </a> <span class="php-comment">/**
</span></span><span id="135" class="l"><a class="l" href="#135">135: </a><span class="php-comment"> * Add the settings sections.
</span></span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment"> *
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> * @internal
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> * @access public
</span></span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-comment"> * @since WPMVCBase 0.1
</span></span><span id="140" class="l"><a class="l" href="#140">140: </a><span class="php-comment"> */</span>
</span><span id="141" class="l"><a class="l" href="#141">141: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_add_settings_sections" href="#_add_settings_sections">add_settings_sections</a>()
</span><span id="142" class="l"><a class="l" href="#142">142: </a> {
</span><span id="143" class="l"><a class="l" href="#143">143: </a> <span class="php-var">$sections</span> = <span class="php-var">$this</span>->model->get_settings_sections();
</span><span id="144" class="l"><a class="l" href="#144">144: </a>
</span><span id="145" class="l"><a class="l" href="#145">145: </a> <span class="php-keyword1">if</span> ( <span class="php-keyword2">is_array</span>( <span class="php-var">$sections</span> ) ) {
</span><span id="146" class="l"><a class="l" href="#146">146: </a> <span class="php-keyword1">foreach</span> ( <span class="php-var">$sections</span> <span class="php-keyword1">as</span> <span class="php-var">$key</span> => <span class="php-var">$section</span> ) {
</span><span id="147" class="l"><a class="l" href="#147">147: </a> <span class="php-keyword1">if</span> ( <span class="php-keyword2">is_null</span>( <span class="php-var">$section</span>[<span class="php-quote">'callback'</span>] ) ) {
</span><span id="148" class="l"><a class="l" href="#148">148: </a> <span class="php-var">$section</span>[<span class="php-quote">'callback'</span>] = <span class="php-keyword1">array</span>( &<span class="php-var">$this</span>, <span class="php-quote">'render_settings_section'</span> );
</span><span id="149" class="l"><a class="l" href="#149">149: </a> }
</span><span id="150" class="l"><a class="l" href="#150">150: </a>
</span><span id="151" class="l"><a class="l" href="#151">151: </a> <span class="php-var">$section</span>[<span class="php-quote">'callback'</span>] = apply_filters( <span class="php-quote">'ah_filter_settings_section_callback'</span> . <span class="php-var">$key</span>, <span class="php-var">$section</span>[<span class="php-quote">'callback'</span>] );
</span><span id="152" class="l"><a class="l" href="#152">152: </a>
</span><span id="153" class="l"><a class="l" href="#153">153: </a> add_settings_section( <span class="php-var">$key</span>, <span class="php-var">$section</span>[<span class="php-quote">'title'</span>], <span class="php-var">$section</span>[<span class="php-quote">'callback'</span>], <span class="php-var">$section</span>[<span class="php-quote">'page'</span>] );
</span><span id="154" class="l"><a class="l" href="#154">154: </a> }
</span><span id="155" class="l"><a class="l" href="#155">155: </a> }
</span><span id="156" class="l"><a class="l" href="#156">156: </a> }
</span><span id="157" class="l"><a class="l" href="#157">157: </a>
</span><span id="158" class="l"><a class="l" href="#158">158: </a> <span class="php-comment">/**
</span></span><span id="159" class="l"><a class="l" href="#159">159: </a><span class="php-comment"> * Add the settings fields.
</span></span><span id="160" class="l"><a class="l" href="#160">160: </a><span class="php-comment"> *
</span></span><span id="161" class="l"><a class="l" href="#161">161: </a><span class="php-comment"> * @internal
</span></span><span id="162" class="l"><a class="l" href="#162">162: </a><span class="php-comment"> * @access public
</span></span><span id="163" class="l"><a class="l" href="#163">163: </a><span class="php-comment"> * @since WPMVCBase 0.1
</span></span><span id="164" class="l"><a class="l" href="#164">164: </a><span class="php-comment"> */</span>
</span><span id="165" class="l"><a class="l" href="#165">165: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_add_settings_fields" href="#_add_settings_fields">add_settings_fields</a>()
</span><span id="166" class="l"><a class="l" href="#166">166: </a> {
</span><span id="167" class="l"><a class="l" href="#167">167: </a> <span class="php-var">$fields</span> = apply_filters( <span class="php-quote">'ah_filter_settings_fields'</span>, <span class="php-var">$this</span>->model->get_settings_fields() );
</span><span id="168" class="l"><a class="l" href="#168">168: </a>
</span><span id="169" class="l"><a class="l" href="#169">169: </a> <span class="php-keyword1">if</span> ( <span class="php-keyword2">is_array</span>( <span class="php-var">$fields</span> ) ) {
</span><span id="170" class="l"><a class="l" href="#170">170: </a> <span class="php-keyword1">foreach</span> ( <span class="php-var">$fields</span> <span class="php-keyword1">as</span> <span class="php-var">$key</span> => <span class="php-var">$field</span> ) {
</span><span id="171" class="l"><a class="l" href="#171">171: </a> <span class="php-keyword1">if</span> ( <span class="php-keyword2">is_null</span>( <span class="php-var">$field</span>[<span class="php-quote">'callback'</span>] ) ) {
</span><span id="172" class="l"><a class="l" href="#172">172: </a> <span class="php-var">$field</span>[<span class="php-quote">'callback'</span>] = <span class="php-keyword1">array</span>( &<span class="php-var">$this</span>, <span class="php-quote">'render_settings_field'</span> );
</span><span id="173" class="l"><a class="l" href="#173">173: </a> }
</span><span id="174" class="l"><a class="l" href="#174">174: </a>
</span><span id="175" class="l"><a class="l" href="#175">175: </a> <span class="php-var">$field</span> = apply_filters( <span class="php-quote">'ah_filter_settings_field-'</span> . <span class="php-var">$key</span>, <span class="php-var">$field</span> );
</span><span id="176" class="l"><a class="l" href="#176">176: </a>
</span><span id="177" class="l"><a class="l" href="#177">177: </a> <span class="php-keyword1">if</span> ( ! <span class="php-keyword2">is_null</span>( <span class="php-var">$field</span> ) ) {
</span><span id="178" class="l"><a class="l" href="#178">178: </a> add_settings_field( <span class="php-var">$key</span>, <span class="php-var">$field</span>[<span class="php-quote">'title'</span>], <span class="php-var">$field</span>[<span class="php-quote">'callback'</span>], <span class="php-var">$field</span>[<span class="php-quote">'page'</span>], <span class="php-var">$field</span>[<span class="php-quote">'section'</span>], <span class="php-var">$field</span>[<span class="php-quote">'args'</span>] );
</span><span id="179" class="l"><a class="l" href="#179">179: </a> }
</span><span id="180" class="l"><a class="l" href="#180">180: </a> }
</span><span id="181" class="l"><a class="l" href="#181">181: </a> }
</span><span id="182" class="l"><a class="l" href="#182">182: </a> }
</span><span id="183" class="l"><a class="l" href="#183">183: </a>
</span><span id="184" class="l"><a class="l" href="#184">184: </a> <span class="php-comment">/**
</span></span><span id="185" class="l"><a class="l" href="#185">185: </a><span class="php-comment"> * Render an options page.
</span></span><span id="186" class="l"><a class="l" href="#186">186: </a><span class="php-comment"> *
</span></span><span id="187" class="l"><a class="l" href="#187">187: </a><span class="php-comment"> * This function can be used as a generic callback for the WP add_x_page() function. It will render
</span></span><span id="188" class="l"><a class="l" href="#188">188: </a><span class="php-comment"> * the options page template defined in the page object if it exists, otherwise it will use a generic
</span></span><span id="189" class="l"><a class="l" href="#189">189: </a><span class="php-comment"> * template included in this package (views/base_options_page.php).
</span></span><span id="190" class="l"><a class="l" href="#190">190: </a><span class="php-comment"> *
</span></span><span id="191" class="l"><a class="l" href="#191">191: </a><span class="php-comment"> * @internal
</span></span><span id="192" class="l"><a class="l" href="#192">192: </a><span class="php-comment"> * @access public
</span></span><span id="193" class="l"><a class="l" href="#193">193: </a><span class="php-comment"> * @since WPMVCBase 0.1
</span></span><span id="194" class="l"><a class="l" href="#194">194: </a><span class="php-comment"> * @link http://codex.wordpress.org/Function_Reference/add_menu_page
</span></span><span id="195" class="l"><a class="l" href="#195">195: </a><span class="php-comment"> * @link http://codex.wordpress.org/Function_Reference/add_submenu_page
</span></span><span id="196" class="l"><a class="l" href="#196">196: </a><span class="php-comment"> * @link http://codex.wordpress.org/Function_Reference/add_options_page
</span></span><span id="197" class="l"><a class="l" href="#197">197: </a><span class="php-comment"> * @todo Modify this to use get_current_screen()
</span></span><span id="198" class="l"><a class="l" href="#198">198: </a><span class="php-comment"> */</span>
</span><span id="199" class="l"><a class="l" href="#199">199: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_render_options_page" href="#_render_options_page">render_options_page</a>()
</span><span id="200" class="l"><a class="l" href="#200">200: </a> {
</span><span id="201" class="l"><a class="l" href="#201">201: </a> <span class="php-var">$screen</span> = get_current_screen();
</span><span id="202" class="l"><a class="l" href="#202">202: </a>
</span><span id="203" class="l"><a class="l" href="#203">203: </a> <span class="php-keyword1">if</span> ( <span class="php-keyword1">isset</span>( <span class="php-var">$this</span>->model ) ) {
</span><span id="204" class="l"><a class="l" href="#204">204: </a> <span class="php-comment">//get the pages as set up in the settings model</span>
</span><span id="205" class="l"><a class="l" href="#205">205: </a> <span class="php-var">$pages</span> = <span class="php-var">$this</span>->model->get_pages();
</span><span id="206" class="l"><a class="l" href="#206">206: </a>
</span><span id="207" class="l"><a class="l" href="#207">207: </a> <span class="php-comment">//if ( isset( $pages[ $_REQUEST['page'] ] ) ) {</span>
</span><span id="208" class="l"><a class="l" href="#208">208: </a> <span class="php-keyword1">if</span> ( <span class="php-keyword1">isset</span>( <span class="php-var">$pages</span>[ <span class="php-var">$screen</span>->id ] ) ) {
</span><span id="209" class="l"><a class="l" href="#209">209: </a> <span class="php-comment">//get the page being requested</span>
</span><span id="210" class="l"><a class="l" href="#210">210: </a> <span class="php-var">$page</span> = <span class="php-var">$pages</span>[ <span class="php-var">$screen</span>->id ];
</span><span id="211" class="l"><a class="l" href="#211">211: </a>
</span><span id="212" class="l"><a class="l" href="#212">212: </a> <span class="php-comment">//$options is used in the view file</span>
</span><span id="213" class="l"><a class="l" href="#213">213: </a> <span class="php-var">$options</span> = <span class="php-var">$this</span>->model->get_options();
</span><span id="214" class="l"><a class="l" href="#214">214: </a>
</span><span id="215" class="l"><a class="l" href="#215">215: </a> <span class="php-comment">//set the default view</span>
</span><span id="216" class="l"><a class="l" href="#216">216: </a> <span class="php-var">$view</span> = <span class="php-keyword2">dirname</span>( <span class="php-keyword2">dirname</span>( __FILE__ ) ) . <span class="php-quote">'/views/base_options_page.php'</span>;
</span><span id="217" class="l"><a class="l" href="#217">217: </a>
</span><span id="218" class="l"><a class="l" href="#218">218: </a> <span class="php-keyword1">if</span> ( <span class="php-keyword1">isset</span>( <span class="php-var">$page</span>[<span class="php-quote">'view'</span>] ) ) {
</span><span id="219" class="l"><a class="l" href="#219">219: </a> <span class="php-keyword1">if</span> ( <span class="php-keyword2">file_exists</span>( <span class="php-var">$page</span>[<span class="php-quote">'view'</span>] ) ) {
</span><span id="220" class="l"><a class="l" href="#220">220: </a> <span class="php-var">$view</span> = <span class="php-var">$page</span>[<span class="php-quote">'view'</span>];
</span><span id="221" class="l"><a class="l" href="#221">221: </a> }
</span><span id="222" class="l"><a class="l" href="#222">222: </a> }
</span><span id="223" class="l"><a class="l" href="#223">223: </a>
</span><span id="224" class="l"><a class="l" href="#224">224: </a> <span class="php-keyword1">include</span> <span class="php-var">$view</span>;
</span><span id="225" class="l"><a class="l" href="#225">225: </a> }
</span><span id="226" class="l"><a class="l" href="#226">226: </a> }
</span><span id="227" class="l"><a class="l" href="#227">227: </a> }
</span><span id="228" class="l"><a class="l" href="#228">228: </a>
</span><span id="229" class="l"><a class="l" href="#229">229: </a> <span class="php-comment">/**
</span></span><span id="230" class="l"><a class="l" href="#230">230: </a><span class="php-comment"> * Render a settings section.
</span></span><span id="231" class="l"><a class="l" href="#231">231: </a><span class="php-comment"> *
</span></span><span id="232" class="l"><a class="l" href="#232">232: </a><span class="php-comment"> * This function can be used as a generic callback for add_settings_sections().
</span></span><span id="233" class="l"><a class="l" href="#233">233: </a><span class="php-comment"> *
</span></span><span id="234" class="l"><a class="l" href="#234">234: </a><span class="php-comment"> * @param object $section The section object.
</span></span><span id="235" class="l"><a class="l" href="#235">235: </a><span class="php-comment"> * @internal
</span></span><span id="236" class="l"><a class="l" href="#236">236: </a><span class="php-comment"> * @access public
</span></span><span id="237" class="l"><a class="l" href="#237">237: </a><span class="php-comment"> * @since WPMVCBase 0.1
</span></span><span id="238" class="l"><a class="l" href="#238">238: </a><span class="php-comment"> * @link http://codex.wordpress.org/Function_Reference/add_settings_section
</span></span><span id="239" class="l"><a class="l" href="#239">239: </a><span class="php-comment"> */</span>
</span><span id="240" class="l"><a class="l" href="#240">240: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_render_settings_section" href="#_render_settings_section">render_settings_section</a>( <span class="php-var">$section</span> )
</span><span id="241" class="l"><a class="l" href="#241">241: </a> {
</span><span id="242" class="l"><a class="l" href="#242">242: </a> <span class="php-comment">//get the corresponding section</span>
</span><span id="243" class="l"><a class="l" href="#243">243: </a> <span class="php-var">$setting_section</span> = <span class="php-var">$this</span>->model->get_settings_sections( <span class="php-var">$section</span>[<span class="php-quote">'id'</span>] );
</span><span id="244" class="l"><a class="l" href="#244">244: </a>
</span><span id="245" class="l"><a class="l" href="#245">245: </a> <span class="php-keyword1">if</span> ( <span class="php-var">$setting_section</span> ) {
</span><span id="246" class="l"><a class="l" href="#246">246: </a> <span class="php-var">$view</span> = <span class="php-keyword2">dirname</span>( <span class="php-keyword2">dirname</span>( __FILE__ ) ) . <span class="php-quote">'/views/base_settings_section.php'</span>;
</span><span id="247" class="l"><a class="l" href="#247">247: </a>
</span><span id="248" class="l"><a class="l" href="#248">248: </a> <span class="php-comment">//The following clause should be removed, but is currently kept for backwards compatibility</span>
</span><span id="249" class="l"><a class="l" href="#249">249: </a> <span class="php-keyword1">if</span> ( <span class="php-keyword2">file_exists</span>( <span class="php-keyword2">dirname</span>( <span class="php-keyword2">dirname</span>( __FILE__ ) ) . <span class="php-quote">'/views/'</span> . <span class="php-var">$section</span>[<span class="php-quote">'id'</span>] . <span class="php-quote">'.php'</span> ) ) {
</span><span id="250" class="l"><a class="l" href="#250">250: </a> <span class="php-var">$view</span> = <span class="php-keyword2">dirname</span>( <span class="php-keyword2">dirname</span>( __FILE__ ) ) . <span class="php-quote">'/views/'</span> . <span class="php-var">$section</span>[<span class="php-quote">'id'</span>] . <span class="php-quote">'.php'</span>;
</span><span id="251" class="l"><a class="l" href="#251">251: </a> }
</span><span id="252" class="l"><a class="l" href="#252">252: </a>
</span><span id="253" class="l"><a class="l" href="#253">253: </a> <span class="php-keyword1">if</span> ( <span class="php-keyword1">isset</span>( <span class="php-var">$setting_section</span>[<span class="php-quote">'view'</span>] ) ) {
</span><span id="254" class="l"><a class="l" href="#254">254: </a> <span class="php-keyword1">if</span> ( <span class="php-keyword2">file_exists</span>( <span class="php-var">$setting_section</span>[<span class="php-quote">'view'</span>] ) ) {
</span><span id="255" class="l"><a class="l" href="#255">255: </a> <span class="php-var">$view</span> = <span class="php-var">$setting_section</span>[<span class="php-quote">'view'</span>];
</span><span id="256" class="l"><a class="l" href="#256">256: </a> }
</span><span id="257" class="l"><a class="l" href="#257">257: </a> }
</span><span id="258" class="l"><a class="l" href="#258">258: </a>
</span><span id="259" class="l"><a class="l" href="#259">259: </a> <span class="php-keyword1">require</span> <span class="php-var">$view</span>;
</span><span id="260" class="l"><a class="l" href="#260">260: </a> }
</span><span id="261" class="l"><a class="l" href="#261">261: </a> }
</span><span id="262" class="l"><a class="l" href="#262">262: </a>
</span><span id="263" class="l"><a class="l" href="#263">263: </a> <span class="php-comment">/**
</span></span><span id="264" class="l"><a class="l" href="#264">264: </a><span class="php-comment"> * A generic add_settings_field() callback function.
</span></span><span id="265" class="l"><a class="l" href="#265">265: </a><span class="php-comment"> *
</span></span><span id="266" class="l"><a class="l" href="#266">266: </a><span class="php-comment"> * @param array $args The settings field arguments.
</span></span><span id="267" class="l"><a class="l" href="#267">267: </a><span class="php-comment"> * @param string $echo Either echo the output (echo) or return it (any other value). Default is 'echo'.
</span></span><span id="268" class="l"><a class="l" href="#268">268: </a><span class="php-comment"> * @return string|void void on ECHO, HTML string on any other $echo value.
</span></span><span id="269" class="l"><a class="l" href="#269">269: </a><span class="php-comment"> * @access public
</span></span><span id="270" class="l"><a class="l" href="#270">270: </a><span class="php-comment"> * @since WPMVCBase 0.1
</span></span><span id="271" class="l"><a class="l" href="#271">271: </a><span class="php-comment"> */</span>
</span><span id="272" class="l"><a class="l" href="#272">272: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_render_settings_field" href="#_render_settings_field">render_settings_field</a>( <span class="php-var">$args</span>, <span class="php-var">$echo</span> = <span class="php-quote">'echo'</span> )
</span><span id="273" class="l"><a class="l" href="#273">273: </a> {
</span><span id="274" class="l"><a class="l" href="#274">274: </a> <span class="php-keyword1">if</span> ( ! <span class="php-keyword1">isset</span>( <span class="php-var">$args</span>[<span class="php-quote">'type'</span>] ) || ! <span class="php-keyword1">isset</span>( <span class="php-var">$args</span>[<span class="php-quote">'id'</span>] ) || ! <span class="php-keyword1">isset</span>( <span class="php-var">$args</span>[<span class="php-quote">'name'</span>] ) ) {
</span><span id="275" class="l"><a class="l" href="#275">275: </a> <span class="php-keyword2">trigger_error</span>( __( <span class="php-quote">'The settings field type, id and name must be set'</span>, <span class="php-quote">'wpmvcb'</span> ), E_USER_WARNING );
</span><span id="276" class="l"><a class="l" href="#276">276: </a> }
</span><span id="277" class="l"><a class="l" href="#277">277: </a>
</span><span id="278" class="l"><a class="l" href="#278">278: </a> <span class="php-keyword1">include_once</span> <span class="php-keyword2">dirname</span>( <span class="php-keyword2">dirname</span>( __FILE__ ) ) . <span class="php-quote">'/helpers/render_fields.php'</span>;
</span><span id="279" class="l"><a class="l" href="#279">279: </a>
</span><span id="280" class="l"><a class="l" href="#280">280: </a> <span class="php-keyword1">switch</span> ( <span class="php-var">$args</span>[<span class="php-quote">'type'</span>] ) {
</span><span id="281" class="l"><a class="l" href="#281">281: </a> <span class="php-keyword1">case</span> <span class="php-quote">'checkbox'</span>:
</span><span id="282" class="l"><a class="l" href="#282">282: </a> <span class="php-var">$html</span> = Base_Helpers_Render_Fields::render_input_checkbox( <span class="php-var">$args</span>[<span class="php-quote">'id'</span>], <span class="php-var">$args</span>[<span class="php-quote">'name'</span>], <span class="php-var">$args</span>[<span class="php-quote">'value'</span>] );
</span><span id="283" class="l"><a class="l" href="#283">283: </a> <span class="php-keyword1">break</span>;
</span><span id="284" class="l"><a class="l" href="#284">284: </a> <span class="php-keyword1">case</span> <span class="php-quote">'select'</span>:
</span><span id="285" class="l"><a class="l" href="#285">285: </a> <span class="php-keyword1">if</span> ( ! <span class="php-keyword1">isset</span>( <span class="php-var">$args</span>[<span class="php-quote">'options'</span>] ) ) {
</span><span id="286" class="l"><a class="l" href="#286">286: </a> <span class="php-keyword2">trigger_error</span>(
</span><span id="287" class="l"><a class="l" href="#287">287: </a> __( <span class="php-quote">'The options must be set to render a select field.'</span>, <span class="php-quote">'wpmvcb'</span> ),
</span><span id="288" class="l"><a class="l" href="#288">288: </a> E_USER_WARNING
</span><span id="289" class="l"><a class="l" href="#289">289: </a> );
</span><span id="290" class="l"><a class="l" href="#290">290: </a> }
</span><span id="291" class="l"><a class="l" href="#291">291: </a>
</span><span id="292" class="l"><a class="l" href="#292">292: </a> <span class="php-var">$html</span> = Base_Helpers_Render_Fields::render_input_select( <span class="php-var">$args</span>[<span class="php-quote">'id'</span>], <span class="php-var">$args</span>[<span class="php-quote">'name'</span>], <span class="php-var">$args</span>[<span class="php-quote">'options'</span>], <span class="php-var">$args</span>[<span class="php-quote">'value'</span>] );
</span><span id="293" class="l"><a class="l" href="#293">293: </a> <span class="php-keyword1">break</span>;
</span><span id="294" class="l"><a class="l" href="#294">294: </a> <span class="php-keyword1">case</span> <span class="php-quote">'text'</span>:
</span><span id="295" class="l"><a class="l" href="#295">295: </a> <span class="php-var">$html</span> = Base_Helpers_Render_Fields::render_input_text( <span class="php-var">$args</span>[<span class="php-quote">'id'</span>], <span class="php-var">$args</span>[<span class="php-quote">'name'</span>], <span class="php-var">$args</span>[<span class="php-quote">'value'</span>], <span class="php-var">$args</span>[<span class="php-quote">'placeholder'</span>], <span class="php-var">$args</span>[<span class="php-quote">'after'</span>] );
</span><span id="296" class="l"><a class="l" href="#296">296: </a> <span class="php-keyword1">break</span>;
</span><span id="297" class="l"><a class="l" href="#297">297: </a> <span class="php-keyword1">case</span> <span class="php-quote">'textarea'</span>:
</span><span id="298" class="l"><a class="l" href="#298">298: </a> <span class="php-var">$html</span> = Base_Helpers_Render_Fields::render_input_textarea( <span class="php-var">$args</span>[<span class="php-quote">'id'</span>], <span class="php-var">$args</span>[<span class="php-quote">'name'</span>], <span class="php-var">$args</span>[<span class="php-quote">'value'</span>], <span class="php-var">$args</span>[<span class="php-quote">'placeholder'</span>] );
</span><span id="299" class="l"><a class="l" href="#299">299: </a> <span class="php-keyword1">break</span>;
</span><span id="300" class="l"><a class="l" href="#300">300: </a> }
</span><span id="301" class="l"><a class="l" href="#301">301: </a>
</span><span id="302" class="l"><a class="l" href="#302">302: </a> <span class="php-keyword1">if</span> ( <span class="php-var">$echo</span> !== <span class="php-quote">'echo'</span> ) {
</span><span id="303" class="l"><a class="l" href="#303">303: </a> <span class="php-keyword1">return</span> <span class="php-var">$html</span>;
</span><span id="304" class="l"><a class="l" href="#304">304: </a> }
</span><span id="305" class="l"><a class="l" href="#305">305: </a>
</span><span id="306" class="l"><a class="l" href="#306">306: </a> <span class="php-keyword1">echo</span> <span class="php-var">$html</span>;
</span><span id="307" class="l"><a class="l" href="#307">307: </a> }
</span><span id="308" class="l"><a class="l" href="#308">308: </a> }
</span><span id="309" class="l"><a class="l" href="#309">309: </a>}
</span><span id="310" class="l"><a class="l" href="#310">310: </a></span></code></pre>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>