-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsource-class-Base_Helpers_Render_Fields.html
More file actions
235 lines (216 loc) · 22.8 KB
/
source-class-Base_Helpers_Render_Fields.html
File metadata and controls
235 lines (216 loc) · 22.8 KB
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
<!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 helpers/render_fields.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 class="active"><a href="package-None.html">None</a>
</li>
<li><a href="package-WPMVCBase.html">WPMVCBase<span></span></a>
<ul>
<li><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 class="active"><a href="class-Base_Helpers_Render_Fields.html">Base_Helpers_Render_Fields</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-None.html" title="Summary of None"><span>Package</span></a>
</li>
<li>
<a href="class-Base_Helpers_Render_Fields.html" title="Summary of Base_Helpers_Render_Fields"><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-keyword1">if</span>( ! <span class="php-keyword2">class_exists</span>( <span class="php-quote">'Base_Helpers_Render_Fields'</span> ) ):
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a> <span class="php-comment">/**
</span></span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-comment"> * Helper functions for rendering input fields
</span></span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment"> *
</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> * @since
</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-keyword1">final</span> <span class="php-keyword1">class</span> <a id="Base_Helpers_Render_Fields" href="#Base_Helpers_Render_Fields">Base_Helpers_Render_Fields</a>
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a> {
</span><span id="10" class="l"><a class="l" href="#10"> 10: </a> <span class="php-comment">/**
</span></span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment"> * Render a checkbox input field.
</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"> * @param string $input_id The css id selector.
</span></span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-comment"> * @param string $name The css name selector
</span></span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-comment"> * @param string $value The field value.
</span></span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment"> * @return string The html string.
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment"> * @access public
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment"> * @static
</span></span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-comment"> * @since 0.2
</span></span><span id="20" class="l"><a class="l" href="#20"> 20: </a><span class="php-comment"> * @todo Add the ability to add content after the field
</span></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-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_render_input_checkbox" href="#_render_input_checkbox">render_input_checkbox</a>( <span class="php-var">$input_id</span>, <span class="php-var">$name</span>, <span class="php-var">$value</span> )
</span><span id="23" class="l"><a class="l" href="#23"> 23: </a> {
</span><span id="24" class="l"><a class="l" href="#24"> 24: </a> <span class="php-var">$html</span> = <span class="php-keyword2">sprintf</span>( <span class="php-quote">'<input type="checkbox" id="%1$s" name="%2$s" value="1" %3$s/>'</span>,
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a> <span class="php-var">$input_id</span>,
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a> <span class="php-var">$name</span>,
</span><span id="27" class="l"><a class="l" href="#27"> 27: </a> <span class="php-var">$value</span> ? <span class="php-quote">'checked '</span> : <span class="php-quote">''</span>
</span><span id="28" class="l"><a class="l" href="#28"> 28: </a> );
</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-keyword1">return</span> <span class="php-var">$html</span>;
</span><span id="31" class="l"><a class="l" href="#31"> 31: </a> }
</span><span id="32" class="l"><a class="l" href="#32"> 32: </a>
</span><span id="33" class="l"><a class="l" href="#33"> 33: </a> <span class="php-comment">/**
</span></span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-comment"> * Render a text input field.
</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-comment"> * @param string $input_id The css id selector.
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> * @param string $name The css name selector
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment"> * @param string $value The field value.
</span></span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-comment"> * @param string $placeholder The input field placeholder element.
</span></span><span id="40" class="l"><a class="l" href="#40"> 40: </a><span class="php-comment"> * @param string $after Content to render after the input field. This can be the absolute path to a
</span></span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment"> * file to be included or an HTML string.
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> * @return string The heml string.
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment"> * @access public
</span></span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-comment"> * @static
</span></span><span id="45" class="l"><a class="l" href="#45"> 45: </a><span class="php-comment"> * @since 0.3
</span></span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment"> */</span>
</span><span id="47" class="l"><a class="l" href="#47"> 47: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_render_input_text" href="#_render_input_text">render_input_text</a>( <span class="php-var">$input_id</span>, <span class="php-var">$name</span>, <span class="php-var">$value</span> = <span class="php-keyword1">null</span>, <span class="php-var">$placeholder</span> = <span class="php-keyword1">null</span>, <span class="php-var">$after</span> = <span class="php-keyword1">null</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-keyword1">isset</span> ( <span class="php-var">$after</span> ) && <span class="php-keyword2">is_file</span>( <span class="php-var">$after</span> ) ):
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a> <span class="php-keyword2">ob_start</span>();
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a> <span class="php-keyword1">require</span>( <span class="php-var">$after</span> );
</span><span id="52" class="l"><a class="l" href="#52"> 52: </a> <span class="php-var">$after</span> = <span class="php-keyword2">ob_get_clean</span>();
</span><span id="53" class="l"><a class="l" href="#53"> 53: </a> <span class="php-keyword1">endif</span>;
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a>
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a> <span class="php-var">$html</span> = <span class="php-keyword2">sprintf</span>( <span class="php-quote">'<input type="text" id="%1$s" name="%2$s" value="%3$s" %4$s />%5$s'</span>,
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a> <span class="php-var">$input_id</span>,
</span><span id="57" class="l"><a class="l" href="#57"> 57: </a> <span class="php-var">$name</span>,
</span><span id="58" class="l"><a class="l" href="#58"> 58: </a> <span class="php-keyword1">isset</span>( <span class="php-var">$value</span> ) ? <span class="php-var">$value</span> : <span class="php-quote">''</span>,
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a> <span class="php-keyword1">isset</span>( <span class="php-var">$placeholder</span> ) ? <span class="php-keyword2">sprintf</span>( <span class="php-quote">'placeholder="%s"'</span>, <span class="php-var">$placeholder</span> ) : <span class="php-quote">''</span>,
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a> <span class="php-keyword1">isset</span>( <span class="php-var">$after</span> ) ? <span class="php-var">$after</span> : <span class="php-quote">''</span>
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a> );
</span><span id="62" class="l"><a class="l" href="#62"> 62: </a>
</span><span id="63" class="l"><a class="l" href="#63"> 63: </a> <span class="php-keyword1">return</span> <span class="php-var">$html</span>;
</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"> * Render a select input field.
</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"> * @param string $input_id The css id selector.
</span></span><span id="70" class="l"><a class="l" href="#70"> 70: </a><span class="php-comment"> * @param string $name The css name selector
</span></span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment"> * @param array $options An array containing select options as key/value pairs.
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * @return string The html string.
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> * @access public
</span></span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-comment"> * @static
</span></span><span id="75" class="l"><a class="l" href="#75"> 75: </a><span class="php-comment"> * @since 0.2
</span></span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment"> * @todo Add the ability to add content after the field
</span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment"> */</span>
</span><span id="78" class="l"><a class="l" href="#78"> 78: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_render_input_select" href="#_render_input_select">render_input_select</a>( <span class="php-var">$input_id</span>, <span class="php-var">$name</span>, <span class="php-var">$options</span>, <span class="php-var">$value</span> = <span class="php-keyword1">null</span> )
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a> {
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a> <span class="php-var">$html</span> = <span class="php-keyword2">sprintf</span>( <span class="php-quote">'<select id="%1$s" name="%2$s">%3$s</select>'</span>,
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a> <span class="php-var">$input_id</span>,
</span><span id="82" class="l"><a class="l" href="#82"> 82: </a> <span class="php-var">$name</span>,
</span><span id="83" class="l"><a class="l" href="#83"> 83: </a> self::_render_input_select_options( <span class="php-var">$options</span>, <span class="php-var">$value</span> )
</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 class="php-keyword1">return</span> <span class="php-var">$html</span>;
</span><span id="87" class="l"><a class="l" href="#87"> 87: </a> }
</span><span id="88" class="l"><a class="l" href="#88"> 88: </a>
</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"> * Render a select input field options block.
</span></span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment"> *
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> * @param array $options A key/value pair of values and option display strings.
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment"> * @param string $current_value The current value for this option field.
</span></span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-comment"> * @access private
</span></span><span id="95" class="l"><a class="l" href="#95"> 95: </a><span class="php-comment"> * @static
</span></span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment"> * @since 0.2
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> */</span>
</span><span id="98" class="l"><a class="l" href="#98"> 98: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="__render_input_select_options" href="#__render_input_select_options">_render_input_select_options</a>( <span class="php-var">$options</span>, <span class="php-var">$current_value</span> )
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a> {
</span><span id="100" class="l"><a class="l" href="#100">100: </a> <span class="php-var">$html</span> = <span class="php-keyword2">sprintf</span>( <span class="php-quote">'<option value="">Select…</option>'</span>,
</span><span id="101" class="l"><a class="l" href="#101">101: </a> _x( <span class="php-quote">'Select…'</span>, <span class="php-quote">'Select an option'</span>, <span class="php-quote">'wpmvcb'</span> ) );
</span><span id="102" class="l"><a class="l" href="#102">102: </a>
</span><span id="103" class="l"><a class="l" href="#103">103: </a> <span class="php-keyword1">if</span>( <span class="php-keyword2">is_array</span>( <span class="php-var">$options</span> ) ):
</span><span id="104" class="l"><a class="l" href="#104">104: </a> <span class="php-keyword1">foreach</span>( <span class="php-var">$options</span> <span class="php-keyword1">as</span> <span class="php-var">$key</span> => <span class="php-var">$val</span> ):
</span><span id="105" class="l"><a class="l" href="#105">105: </a> <span class="php-var">$html</span> .= <span class="php-keyword2">sprintf</span> ( <span class="php-quote">'<option value="%1$s" %2$s>%3$s</option>'</span>,
</span><span id="106" class="l"><a class="l" href="#106">106: </a> <span class="php-var">$key</span>,
</span><span id="107" class="l"><a class="l" href="#107">107: </a> <span class="php-var">$current_value</span> == <span class="php-var">$key</span> ? <span class="php-quote">'selected'</span> : <span class="php-quote">''</span>,
</span><span id="108" class="l"><a class="l" href="#108">108: </a> <span class="php-var">$val</span>
</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">endforeach</span>;
</span><span id="111" class="l"><a class="l" href="#111">111: </a> <span class="php-keyword1">endif</span>;
</span><span id="112" class="l"><a class="l" href="#112">112: </a>
</span><span id="113" class="l"><a class="l" href="#113">113: </a> <span class="php-keyword1">return</span> <span class="php-var">$html</span>;
</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><span id="116" class="l"><a class="l" href="#116">116: </a> <span class="php-comment">/**
</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment"> * Return a text area input
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment"> *
</span></span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-comment"> * @param string $input_id The css id selector.
</span></span><span id="120" class="l"><a class="l" href="#120">120: </a><span class="php-comment"> * @param string $name The css name selector
</span></span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment"> * @param string $value The field value.
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment"> * @param string $placeholder The input field placeholder element.
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment"> * @access private
</span></span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-comment"> * @since 0.2
</span></span><span id="125" class="l"><a class="l" href="#125">125: </a><span class="php-comment"> * @todo Add the ability to add content after the field
</span></span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment"> */</span>
</span><span id="127" class="l"><a class="l" href="#127">127: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_render_input_textarea" href="#_render_input_textarea">render_input_textarea</a>( <span class="php-var">$input_id</span>, <span class="php-var">$name</span>, <span class="php-var">$value</span> = <span class="php-keyword1">null</span>, <span class="php-var">$placeholder</span> = <span class="php-keyword1">null</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-var">$html</span> = <span class="php-keyword2">sprintf</span>( <span class="php-quote">'<textarea id="%1$s" name="%2$s" %4$s>%3$s</textarea>'</span>,
</span><span id="130" class="l"><a class="l" href="#130">130: </a> <span class="php-var">$input_id</span>,
</span><span id="131" class="l"><a class="l" href="#131">131: </a> <span class="php-var">$name</span>,
</span><span id="132" class="l"><a class="l" href="#132">132: </a> <span class="php-keyword1">isset</span>( <span class="php-var">$value</span> ) ? <span class="php-var">$value</span> : <span class="php-quote">''</span>,
</span><span id="133" class="l"><a class="l" href="#133">133: </a> <span class="php-keyword1">isset</span>( <span class="php-var">$placeholder</span> ) ? <span class="php-keyword2">sprintf</span>( <span class="php-quote">'placeholder="%s"'</span>, <span class="php-var">$placeholder</span> ) : <span class="php-quote">''</span>
</span><span id="134" class="l"><a class="l" href="#134">134: </a> );
</span><span id="135" class="l"><a class="l" href="#135">135: </a>
</span><span id="136" class="l"><a class="l" href="#136">136: </a> <span class="php-keyword1">return</span> <span class="php-var">$html</span>;
</span><span id="137" class="l"><a class="l" href="#137">137: </a> }
</span><span id="138" class="l"><a class="l" href="#138">138: </a> }
</span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-keyword1">endif</span>; <span class="php-comment">//class exists</span>
</span><span id="140" class="l"><a class="l" href="#140">140: </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>