mirror of
https://github.com/codeigniter4/CodeIgniter4.git
synced 2025-02-20 11:44:28 +08:00
Update User Guide
This commit is contained in:
paulbalandan
parent
126b7593c6
commit
de2289cbfb
@ -406,30 +406,31 @@ override this behavior, you may set a third parameter to true (boolean):</p>
|
||||
<p>Each folder name will be an array index, while its contained files will
|
||||
be numerically indexed. Here is an example of a typical array:</p>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="k">Array</span> <span class="p">(</span>
|
||||
<span class="p">[</span><span class="nx">libraries</span><span class="p">]</span> <span class="o">=></span> <span class="k">Array</span>
|
||||
<span class="p">[</span><span class="nx">libraries</span><span class="p">]</span> <span class="o">=></span> <span class="k">Array</span>
|
||||
<span class="p">(</span>
|
||||
<span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">=></span> <span class="nx">benchmark</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">=></span> <span class="nx">config</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="s2">"database/"</span><span class="p">]</span> <span class="o">=></span> <span class="k">Array</span>
|
||||
<span class="p">(</span>
|
||||
<span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">=></span> <span class="nx">benchmark</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">=></span> <span class="nx">config</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="s2">"database/"</span><span class="p">]</span> <span class="o">=></span> <span class="k">Array</span>
|
||||
<span class="p">(</span>
|
||||
<span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">=></span> <span class="nx">query_builder</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">=></span> <span class="nx">binds</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="mi">2</span><span class="p">]</span> <span class="o">=></span> <span class="nx">configuration</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="mi">3</span><span class="p">]</span> <span class="o">=></span> <span class="nx">connecting</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="mi">4</span><span class="p">]</span> <span class="o">=></span> <span class="nx">examples</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="mi">5</span><span class="p">]</span> <span class="o">=></span> <span class="nx">fields</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="mi">6</span><span class="p">]</span> <span class="o">=></span> <span class="nx">index</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="mi">7</span><span class="p">]</span> <span class="o">=></span> <span class="nx">queries</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">)</span>
|
||||
<span class="p">[</span><span class="mi">2</span><span class="p">]</span> <span class="o">=></span> <span class="nx">email</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="mi">3</span><span class="p">]</span> <span class="o">=></span> <span class="nx">file_uploading</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="mi">4</span><span class="p">]</span> <span class="o">=></span> <span class="nx">image_lib</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="mi">5</span><span class="p">]</span> <span class="o">=></span> <span class="nx">input</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="mi">6</span><span class="p">]</span> <span class="o">=></span> <span class="nx">language</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="mi">7</span><span class="p">]</span> <span class="o">=></span> <span class="nx">loader</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="mi">8</span><span class="p">]</span> <span class="o">=></span> <span class="nx">pagination</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="mi">9</span><span class="p">]</span> <span class="o">=></span> <span class="nx">uri</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">=></span> <span class="nx">query_builder</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">=></span> <span class="nx">binds</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="mi">2</span><span class="p">]</span> <span class="o">=></span> <span class="nx">configuration</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="mi">3</span><span class="p">]</span> <span class="o">=></span> <span class="nx">connecting</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="mi">4</span><span class="p">]</span> <span class="o">=></span> <span class="nx">examples</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="mi">5</span><span class="p">]</span> <span class="o">=></span> <span class="nx">fields</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="mi">6</span><span class="p">]</span> <span class="o">=></span> <span class="nx">index</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="mi">7</span><span class="p">]</span> <span class="o">=></span> <span class="nx">queries</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">)</span>
|
||||
<span class="p">[</span><span class="mi">2</span><span class="p">]</span> <span class="o">=></span> <span class="nx">email</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="mi">3</span><span class="p">]</span> <span class="o">=></span> <span class="nx">file_uploading</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="mi">4</span><span class="p">]</span> <span class="o">=></span> <span class="nx">image_lib</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="mi">5</span><span class="p">]</span> <span class="o">=></span> <span class="nx">input</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="mi">6</span><span class="p">]</span> <span class="o">=></span> <span class="nx">language</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="mi">7</span><span class="p">]</span> <span class="o">=></span> <span class="nx">loader</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="mi">8</span><span class="p">]</span> <span class="o">=></span> <span class="nx">pagination</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">[</span><span class="mi">9</span><span class="p">]</span> <span class="o">=></span> <span class="nx">uri</span><span class="o">.</span><span class="nx">html</span>
|
||||
<span class="p">)</span>
|
||||
<span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>If no results are found, this will return an empty array.</p>
|
||||
@ -459,11 +460,11 @@ function will create it.</p>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$data</span> <span class="o">=</span> <span class="s1">'Some file data'</span><span class="p">;</span>
|
||||
<span class="k">if</span> <span class="p">(</span> <span class="o">!</span> <span class="nx">write_file</span><span class="p">(</span><span class="s1">'./path/to/file.php'</span><span class="p">,</span> <span class="nv">$data</span><span class="p">))</span>
|
||||
<span class="p">{</span>
|
||||
<span class="k">echo</span> <span class="s1">'Unable to write the file'</span><span class="p">;</span>
|
||||
<span class="k">echo</span> <span class="s1">'Unable to write the file'</span><span class="p">;</span>
|
||||
<span class="p">}</span>
|
||||
<span class="k">else</span>
|
||||
<span class="p">{</span>
|
||||
<span class="k">echo</span> <span class="s1">'File written!'</span><span class="p">;</span>
|
||||
<span class="k">echo</span> <span class="s1">'File written!'</span><span class="p">;</span>
|
||||
<span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
|
||||
@ -424,7 +424,7 @@ it permits your site to be more portable in the event your URLs ever change.</p>
|
||||
</div>
|
||||
<p>The above example would create a form that points to your base URL plus the
|
||||
“email/send” URI segments, like this:</p>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="nx">form</span> <span class="nx">method</span><span class="o">=</span><span class="s2">"post"</span> <span class="nx">accept</span><span class="o">-</span><span class="nx">charset</span><span class="o">=</span><span class="s2">"utf-8"</span> <span class="nx">action</span><span class="o">=</span><span class="s2">"http://example.com/index.php/email/send"</span><span class="o">></span>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="nx">form</span> <span class="nx">action</span><span class="o">=</span><span class="s2">"http://example.com/index.php/email/send"</span> <span class="nx">method</span><span class="o">=</span><span class="s2">"post"</span> <span class="nx">accept</span><span class="o">-</span><span class="nx">charset</span><span class="o">=</span><span class="s2">"utf-8"</span><span class="o">></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>You can also add {locale} like the following:</p>
|
||||
@ -433,7 +433,7 @@ it permits your site to be more portable in the event your URLs ever change.</p>
|
||||
</div>
|
||||
<p>The above example would create a form that points to your base URL plus the current request locale with
|
||||
“email/send” URI segments, like this:</p>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="nx">form</span> <span class="nx">method</span><span class="o">=</span><span class="s2">"post"</span> <span class="nx">accept</span><span class="o">-</span><span class="nx">charset</span><span class="o">=</span><span class="s2">"utf-8"</span> <span class="nx">action</span><span class="o">=</span><span class="s2">"http://example.com/index.php/en/email/send"</span><span class="o">></span>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="nx">form</span> <span class="nx">action</span><span class="o">=</span><span class="s2">"http://example.com/index.php/en/email/send"</span> <span class="nx">method</span><span class="o">=</span><span class="s2">"post"</span> <span class="nx">accept</span><span class="o">-</span><span class="nx">charset</span><span class="o">=</span><span class="s2">"utf-8"</span><span class="o">></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><strong>Adding Attributes</strong></p>
|
||||
@ -449,16 +449,16 @@ parameter, like this:</p>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The above examples would create a form similar to this:</p>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="nx">form</span> <span class="nx">method</span><span class="o">=</span><span class="s2">"post"</span> <span class="nx">accept</span><span class="o">-</span><span class="nx">charset</span><span class="o">=</span><span class="s2">"utf-8"</span> <span class="nx">action</span><span class="o">=</span><span class="s2">"http://example.com/index.php/email/send"</span> <span class="nx">class</span><span class="o">=</span><span class="s2">"email"</span> <span class="nx">id</span><span class="o">=</span><span class="s2">"myform"</span><span class="o">></span>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="nx">form</span> <span class="nx">action</span><span class="o">=</span><span class="s2">"http://example.com/index.php/email/send"</span> <span class="nx">class</span><span class="o">=</span><span class="s2">"email"</span> <span class="nx">id</span><span class="o">=</span><span class="s2">"myform"</span> <span class="nx">method</span><span class="o">=</span><span class="s2">"post"</span> <span class="nx">accept</span><span class="o">-</span><span class="nx">charset</span><span class="o">=</span><span class="s2">"utf-8"</span><span class="o">></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>If CSRF filter is turned on <cite>form_open()</cite> will generate CSRF field at the beginning of the form. You can specify ID of this field by passing csrf_id as one of the <code class="docutils literal notranslate"><span class="pre">$attribute</span></code> array:</p>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nx">form_open</span><span class="p">(</span><span class="s1">'/u/sign-up'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'csrf_id'</span> <span class="o">=></span> <span class="s1">'my-id'</span><span class="p">]);</span>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">form_open</span><span class="p">(</span><span class="s1">'/u/sign-up'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'csrf_id'</span> <span class="o">=></span> <span class="s1">'my-id'</span><span class="p">]);</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>will return:</p>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="nx">form</span> <span class="nx">action</span><span class="o">=</span><span class="s2">"/u/sign-up"</span> <span class="nx">method</span><span class="o">=</span><span class="s2">"post"</span> <span class="nx">accept</span><span class="o">-</span><span class="nx">charset</span><span class="o">=</span><span class="s2">"utf-8"</span><span class="o">></span>
|
||||
<span class="o"><</span><span class="nx">input</span> <span class="nx">type</span><span class="o">=</span><span class="s2">"hidden"</span> <span class="nx">id</span><span class="o">=</span><span class="s2">"my-id"</span> <span class="nx">name</span><span class="o">=</span><span class="s2">"csrf_field"</span> <span class="nx">value</span><span class="o">=</span><span class="s2">"964ede6e0ae8a680f7b8eab69136717d"</span> <span class="o">/></span>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="nx">form</span> <span class="nx">action</span><span class="o">=</span><span class="s2">"http://example.com/index.php/u/sign-up"</span> <span class="nx">method</span><span class="o">=</span><span class="s2">"post"</span> <span class="nx">accept</span><span class="o">-</span><span class="nx">charset</span><span class="o">=</span><span class="s2">"utf-8"</span><span class="o">></span>
|
||||
<span class="o"><</span><span class="nx">input</span> <span class="nx">type</span><span class="o">=</span><span class="s2">"hidden"</span> <span class="nx">id</span><span class="o">=</span><span class="s2">"my-id"</span> <span class="nx">name</span><span class="o">=</span><span class="s2">"csrf_field"</span> <span class="nx">value</span><span class="o">=</span><span class="s2">"964ede6e0ae8a680f7b8eab69136717d"</span> <span class="o">/></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div></blockquote>
|
||||
@ -472,9 +472,9 @@ third parameter, like this:</p>
|
||||
</div>
|
||||
<p>You can skip the second parameter by passing any false value to it.</p>
|
||||
<p>The above example would create a form similar to this:</p>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="nx">form</span> <span class="nx">method</span><span class="o">=</span><span class="s2">"post"</span> <span class="nx">accept</span><span class="o">-</span><span class="nx">charset</span><span class="o">=</span><span class="s2">"utf-8"</span> <span class="nx">action</span><span class="o">=</span><span class="s2">"http://example.com/index.php/email/send"</span><span class="o">></span>
|
||||
<span class="o"><</span><span class="nx">input</span> <span class="nx">type</span><span class="o">=</span><span class="s2">"hidden"</span> <span class="nx">name</span><span class="o">=</span><span class="s2">"username"</span> <span class="nx">value</span><span class="o">=</span><span class="s2">"Joe"</span> <span class="o">/></span>
|
||||
<span class="o"><</span><span class="nx">input</span> <span class="nx">type</span><span class="o">=</span><span class="s2">"hidden"</span> <span class="nx">name</span><span class="o">=</span><span class="s2">"member_id"</span> <span class="nx">value</span><span class="o">=</span><span class="s2">"234"</span> <span class="o">/></span>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="nx">form</span> <span class="nx">action</span><span class="o">=</span><span class="s2">"http://example.com/index.php/email/send"</span> <span class="nx">method</span><span class="o">=</span><span class="s2">"post"</span> <span class="nx">accept</span><span class="o">-</span><span class="nx">charset</span><span class="o">=</span><span class="s2">"utf-8"</span><span class="o">></span>
|
||||
<span class="o"><</span><span class="nx">input</span> <span class="nx">type</span><span class="o">=</span><span class="s2">"hidden"</span> <span class="nx">name</span><span class="o">=</span><span class="s2">"username"</span> <span class="nx">value</span><span class="o">=</span><span class="s2">"Joe"</span> <span class="o">/></span>
|
||||
<span class="o"><</span><span class="nx">input</span> <span class="nx">type</span><span class="o">=</span><span class="s2">"hidden"</span> <span class="nx">name</span><span class="o">=</span><span class="s2">"member_id"</span> <span class="nx">value</span><span class="o">=</span><span class="s2">"234"</span> <span class="o">/></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div></blockquote>
|
||||
@ -528,54 +528,54 @@ name/value string to create one field:</p>
|
||||
</div>
|
||||
<p>… or you can submit an associative array to create multiple fields:</p>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$data</span> <span class="o">=</span> <span class="p">[</span>
|
||||
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'John Doe'</span><span class="p">,</span>
|
||||
<span class="s1">'email'</span> <span class="o">=></span> <span class="s1">'john@example.com'</span><span class="p">,</span>
|
||||
<span class="s1">'url'</span> <span class="o">=></span> <span class="s1">'http://example.com'</span>
|
||||
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'John Doe'</span><span class="p">,</span>
|
||||
<span class="s1">'email'</span> <span class="o">=></span> <span class="s1">'john@example.com'</span><span class="p">,</span>
|
||||
<span class="s1">'url'</span> <span class="o">=></span> <span class="s1">'http://example.com'</span>
|
||||
<span class="p">];</span>
|
||||
|
||||
<span class="k">echo</span> <span class="nx">form_hidden</span><span class="p">(</span><span class="nv">$data</span><span class="p">);</span>
|
||||
|
||||
<span class="cm">/*</span>
|
||||
<span class="cm"> Would produce:</span>
|
||||
<span class="cm"> <input type="hidden" name="name" value="John Doe" /></span>
|
||||
<span class="cm"> <input type="hidden" name="email" value="john@example.com" /></span>
|
||||
<span class="cm"> <input type="hidden" name="url" value="http://example.com" /></span>
|
||||
<span class="cm"> Would produce:</span>
|
||||
<span class="cm"> <input type="hidden" name="name" value="John Doe" /></span>
|
||||
<span class="cm"> <input type="hidden" name="email" value="john@example.com" /></span>
|
||||
<span class="cm"> <input type="hidden" name="url" value="http://example.com" /></span>
|
||||
<span class="cm">*/</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>You can also pass an associative array to the value field:</p>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$data</span> <span class="o">=</span> <span class="p">[</span>
|
||||
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'John Doe'</span><span class="p">,</span>
|
||||
<span class="s1">'email'</span> <span class="o">=></span> <span class="s1">'john@example.com'</span><span class="p">,</span>
|
||||
<span class="s1">'url'</span> <span class="o">=></span> <span class="s1">'http://example.com'</span>
|
||||
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'John Doe'</span><span class="p">,</span>
|
||||
<span class="s1">'email'</span> <span class="o">=></span> <span class="s1">'john@example.com'</span><span class="p">,</span>
|
||||
<span class="s1">'url'</span> <span class="o">=></span> <span class="s1">'http://example.com'</span>
|
||||
<span class="p">];</span>
|
||||
|
||||
<span class="k">echo</span> <span class="nx">form_hidden</span><span class="p">(</span><span class="s1">'my_array'</span><span class="p">,</span> <span class="nv">$data</span><span class="p">);</span>
|
||||
|
||||
<span class="cm">/*</span>
|
||||
<span class="cm"> Would produce:</span>
|
||||
<span class="cm"> Would produce:</span>
|
||||
|
||||
<span class="cm"> <input type="hidden" name="my_array[name]" value="John Doe" /></span>
|
||||
<span class="cm"> <input type="hidden" name="my_array[email]" value="john@example.com" /></span>
|
||||
<span class="cm"> <input type="hidden" name="my_array[url]" value="http://example.com" /></span>
|
||||
<span class="cm"> <input type="hidden" name="my_array[name]" value="John Doe" /></span>
|
||||
<span class="cm"> <input type="hidden" name="my_array[email]" value="john@example.com" /></span>
|
||||
<span class="cm"> <input type="hidden" name="my_array[url]" value="http://example.com" /></span>
|
||||
<span class="cm">*/</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>If you want to create hidden input fields with extra attributes:</p>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$data</span> <span class="o">=</span> <span class="p">[</span>
|
||||
<span class="s1">'type'</span> <span class="o">=></span> <span class="s1">'hidden'</span><span class="p">,</span>
|
||||
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'email'</span><span class="p">,</span>
|
||||
<span class="s1">'id'</span> <span class="o">=></span> <span class="s1">'hiddenemail'</span><span class="p">,</span>
|
||||
<span class="s1">'value'</span> <span class="o">=></span> <span class="s1">'john@example.com'</span><span class="p">,</span>
|
||||
<span class="s1">'class'</span> <span class="o">=></span> <span class="s1">'hiddenemail'</span>
|
||||
<span class="s1">'type'</span> <span class="o">=></span> <span class="s1">'hidden'</span><span class="p">,</span>
|
||||
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'email'</span><span class="p">,</span>
|
||||
<span class="s1">'id'</span> <span class="o">=></span> <span class="s1">'hiddenemail'</span><span class="p">,</span>
|
||||
<span class="s1">'value'</span> <span class="o">=></span> <span class="s1">'john@example.com'</span><span class="p">,</span>
|
||||
<span class="s1">'class'</span> <span class="o">=></span> <span class="s1">'hiddenemail'</span>
|
||||
<span class="p">];</span>
|
||||
|
||||
<span class="k">echo</span> <span class="nx">form_input</span><span class="p">(</span><span class="nv">$data</span><span class="p">);</span>
|
||||
|
||||
<span class="cm">/*</span>
|
||||
<span class="cm"> Would produce:</span>
|
||||
<span class="cm"> Would produce:</span>
|
||||
|
||||
<span class="cm"> <input type="hidden" name="email" value="john@example.com" id="hiddenemail" class="hiddenemail" /></span>
|
||||
<span class="cm"> <input type="hidden" name="email" value="john@example.com" id="hiddenemail" class="hiddenemail" /></span>
|
||||
<span class="cm">*/</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
@ -608,20 +608,20 @@ the field name and value in the first and second parameter:</p>
|
||||
<p>Or you can pass an associative array containing any data you wish your
|
||||
form to contain:</p>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$data</span> <span class="o">=</span> <span class="p">[</span>
|
||||
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'username'</span><span class="p">,</span>
|
||||
<span class="s1">'id'</span> <span class="o">=></span> <span class="s1">'username'</span><span class="p">,</span>
|
||||
<span class="s1">'value'</span> <span class="o">=></span> <span class="s1">'johndoe'</span><span class="p">,</span>
|
||||
<span class="s1">'maxlength'</span> <span class="o">=></span> <span class="s1">'100'</span><span class="p">,</span>
|
||||
<span class="s1">'size'</span> <span class="o">=></span> <span class="s1">'50'</span><span class="p">,</span>
|
||||
<span class="s1">'style'</span> <span class="o">=></span> <span class="s1">'width:50%'</span>
|
||||
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'username'</span><span class="p">,</span>
|
||||
<span class="s1">'id'</span> <span class="o">=></span> <span class="s1">'username'</span><span class="p">,</span>
|
||||
<span class="s1">'value'</span> <span class="o">=></span> <span class="s1">'johndoe'</span><span class="p">,</span>
|
||||
<span class="s1">'maxlength'</span> <span class="o">=></span> <span class="s1">'100'</span><span class="p">,</span>
|
||||
<span class="s1">'size'</span> <span class="o">=></span> <span class="s1">'50'</span><span class="p">,</span>
|
||||
<span class="s1">'style'</span> <span class="o">=></span> <span class="s1">'width:50%'</span>
|
||||
<span class="p">];</span>
|
||||
|
||||
<span class="k">echo</span> <span class="nx">form_input</span><span class="p">(</span><span class="nv">$data</span><span class="p">);</span>
|
||||
|
||||
<span class="cm">/*</span>
|
||||
<span class="cm"> Would produce:</span>
|
||||
<span class="cm"> Would produce:</span>
|
||||
|
||||
<span class="cm"> <input type="text" name="username" value="johndoe" id="username" maxlength="100" size="50" style="width:50%" /></span>
|
||||
<span class="cm"> <input type="text" name="username" value="johndoe" id="username" maxlength="100" size="50" style="width:50%" /></span>
|
||||
<span class="cm">*/</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
@ -640,9 +640,9 @@ JavaScript, you can pass it as a string in the third parameter:</p>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">form_input</span><span class="p">(</span><span class="s1">'email'</span><span class="p">,</span> <span class="s1">'joe@example.com'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'placeholder'</span> <span class="o">=></span> <span class="s1">'Email Address...'</span><span class="p">],</span> <span class="s1">'email'</span><span class="p">);</span>
|
||||
|
||||
<span class="cm">/*</span>
|
||||
<span class="cm"> Would produce:</span>
|
||||
<span class="cm"> Would produce:</span>
|
||||
|
||||
<span class="cm"> <input type="email" name="email" value="joe@example.com" placeholder="Email Address..." /></span>
|
||||
<span class="cm"> <input type="email" name="email" value="joe@example.com" placeholder="Email Address..." /></span>
|
||||
<span class="cm">*/</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
@ -747,37 +747,37 @@ items through the third parameter, and the helper will create a
|
||||
multiple select for you.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$options</span> <span class="o">=</span> <span class="p">[</span>
|
||||
<span class="s1">'small'</span> <span class="o">=></span> <span class="s1">'Small Shirt'</span><span class="p">,</span>
|
||||
<span class="s1">'med'</span> <span class="o">=></span> <span class="s1">'Medium Shirt'</span><span class="p">,</span>
|
||||
<span class="s1">'large'</span> <span class="o">=></span> <span class="s1">'Large Shirt'</span><span class="p">,</span>
|
||||
<span class="s1">'xlarge'</span> <span class="o">=></span> <span class="s1">'Extra Large Shirt'</span><span class="p">,</span>
|
||||
<span class="s1">'small'</span> <span class="o">=></span> <span class="s1">'Small Shirt'</span><span class="p">,</span>
|
||||
<span class="s1">'med'</span> <span class="o">=></span> <span class="s1">'Medium Shirt'</span><span class="p">,</span>
|
||||
<span class="s1">'large'</span> <span class="o">=></span> <span class="s1">'Large Shirt'</span><span class="p">,</span>
|
||||
<span class="s1">'xlarge'</span> <span class="o">=></span> <span class="s1">'Extra Large Shirt'</span><span class="p">,</span>
|
||||
<span class="p">];</span>
|
||||
|
||||
<span class="nv">$shirts_on_sale</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'small'</span><span class="p">,</span> <span class="s1">'large'</span><span class="p">];</span>
|
||||
<span class="k">echo</span> <span class="nx">form_dropdown</span><span class="p">(</span><span class="s1">'shirts'</span><span class="p">,</span> <span class="nv">$options</span><span class="p">,</span> <span class="s1">'large'</span><span class="p">);</span>
|
||||
|
||||
<span class="cm">/*</span>
|
||||
<span class="cm"> Would produce:</span>
|
||||
<span class="cm"> Would produce:</span>
|
||||
|
||||
<span class="cm"> <select name="shirts"></span>
|
||||
<span class="cm"> <option value="small">Small Shirt</option></span>
|
||||
<span class="cm"> <option value="med">Medium Shirt</option></span>
|
||||
<span class="cm"> <option value="large" selected="selected">Large Shirt</option></span>
|
||||
<span class="cm"> <option value="xlarge">Extra Large Shirt</option></span>
|
||||
<span class="cm"> </select></span>
|
||||
<span class="cm"> <select name="shirts"></span>
|
||||
<span class="cm"> <option value="small">Small Shirt</option></span>
|
||||
<span class="cm"> <option value="med">Medium Shirt</option></span>
|
||||
<span class="cm"> <option value="large" selected="selected">Large Shirt</option></span>
|
||||
<span class="cm"> <option value="xlarge">Extra Large Shirt</option></span>
|
||||
<span class="cm"> </select></span>
|
||||
<span class="cm">*/</span>
|
||||
|
||||
<span class="k">echo</span> <span class="nx">form_dropdown</span><span class="p">(</span><span class="s1">'shirts'</span><span class="p">,</span> <span class="nv">$options</span><span class="p">,</span> <span class="nv">$shirts_on_sale</span><span class="p">);</span>
|
||||
|
||||
<span class="cm">/*</span>
|
||||
<span class="cm"> Would produce:</span>
|
||||
<span class="cm"> Would produce:</span>
|
||||
|
||||
<span class="cm"> <select name="shirts" multiple="multiple"></span>
|
||||
<span class="cm"> <option value="small" selected="selected">Small Shirt</option></span>
|
||||
<span class="cm"> <option value="med">Medium Shirt</option></span>
|
||||
<span class="cm"> <option value="large" selected="selected">Large Shirt</option></span>
|
||||
<span class="cm"> <option value="xlarge">Extra Large Shirt</option></span>
|
||||
<span class="cm"> </select></span>
|
||||
<span class="cm"> <select name="shirts" multiple="multiple"></span>
|
||||
<span class="cm"> <option value="small" selected="selected">Small Shirt</option></span>
|
||||
<span class="cm"> <option value="med">Medium Shirt</option></span>
|
||||
<span class="cm"> <option value="large" selected="selected">Large Shirt</option></span>
|
||||
<span class="cm"> <option value="xlarge">Extra Large Shirt</option></span>
|
||||
<span class="cm"> </select></span>
|
||||
<span class="cm">*/</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
@ -790,8 +790,8 @@ parameter:</p>
|
||||
</div>
|
||||
<p>Or you can pass it as an array:</p>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$js</span> <span class="o">=</span> <span class="p">[</span>
|
||||
<span class="s1">'id'</span> <span class="o">=></span> <span class="s1">'shirts'</span><span class="p">,</span>
|
||||
<span class="s1">'onChange'</span> <span class="o">=></span> <span class="s1">'some_function();'</span>
|
||||
<span class="s1">'id'</span> <span class="o">=></span> <span class="s1">'shirts'</span><span class="p">,</span>
|
||||
<span class="s1">'onChange'</span> <span class="o">=></span> <span class="s1">'some_function();'</span>
|
||||
<span class="p">];</span>
|
||||
<span class="k">echo</span> <span class="nx">form_dropdown</span><span class="p">(</span><span class="s1">'shirts'</span><span class="p">,</span> <span class="nv">$options</span><span class="p">,</span> <span class="s1">'large'</span><span class="p">,</span> <span class="nv">$js</span><span class="p">);</span>
|
||||
</pre></div>
|
||||
@ -853,20 +853,20 @@ syntax, e.g., foo[].</p>
|
||||
<span class="k">echo</span> <span class="nx">form_fieldset_close</span><span class="p">();</span>
|
||||
|
||||
<span class="cm">/*</span>
|
||||
<span class="cm"> Produces:</span>
|
||||
<span class="cm"> Produces:</span>
|
||||
|
||||
<span class="cm"> <fieldset></span>
|
||||
<span class="cm"> <legend>Address Information</legend></span>
|
||||
<span class="cm"> <p>form content here</p></span>
|
||||
<span class="cm"> </fieldset></span>
|
||||
<span class="cm"> <fieldset></span>
|
||||
<span class="cm"> <legend>Address Information</legend></span>
|
||||
<span class="cm"> <p>form content here</p></span>
|
||||
<span class="cm"> </fieldset></span>
|
||||
<span class="cm">*/</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Similar to other functions, you can submit an associative array in the
|
||||
second parameter if you prefer to set additional attributes:</p>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$attributes</span> <span class="o">=</span> <span class="p">[</span>
|
||||
<span class="s1">'id'</span> <span class="o">=></span> <span class="s1">'address_info'</span><span class="p">,</span>
|
||||
<span class="s1">'class'</span> <span class="o">=></span> <span class="s1">'address_info'</span>
|
||||
<span class="s1">'id'</span> <span class="o">=></span> <span class="s1">'address_info'</span><span class="p">,</span>
|
||||
<span class="s1">'class'</span> <span class="o">=></span> <span class="s1">'address_info'</span>
|
||||
<span class="p">];</span>
|
||||
|
||||
<span class="k">echo</span> <span class="nx">form_fieldset</span><span class="p">(</span><span class="s1">'Address Information'</span><span class="p">,</span> <span class="nv">$attributes</span><span class="p">);</span>
|
||||
@ -874,12 +874,12 @@ second parameter if you prefer to set additional attributes:</p>
|
||||
<span class="k">echo</span> <span class="nx">form_fieldset_close</span><span class="p">();</span>
|
||||
|
||||
<span class="cm">/*</span>
|
||||
<span class="cm"> Produces:</span>
|
||||
<span class="cm"> Produces:</span>
|
||||
|
||||
<span class="cm"> <fieldset id="address_info" class="address_info"></span>
|
||||
<span class="cm"> <legend>Address Information</legend></span>
|
||||
<span class="cm"> <p>form content here</p></span>
|
||||
<span class="cm"> </fieldset></span>
|
||||
<span class="cm"> <fieldset id="address_info" class="address_info"></span>
|
||||
<span class="cm"> <legend>Address Information</legend></span>
|
||||
<span class="cm"> <p>form content here</p></span>
|
||||
<span class="cm"> </fieldset></span>
|
||||
<span class="cm">*/</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
@ -940,11 +940,11 @@ the box should be checked or not.</p>
|
||||
<p>Similar to the other form functions in this helper, you can also pass an
|
||||
array of attributes to the function:</p>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$data</span> <span class="o">=</span> <span class="p">[</span>
|
||||
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'newsletter'</span><span class="p">,</span>
|
||||
<span class="s1">'id'</span> <span class="o">=></span> <span class="s1">'newsletter'</span><span class="p">,</span>
|
||||
<span class="s1">'value'</span> <span class="o">=></span> <span class="s1">'accept'</span><span class="p">,</span>
|
||||
<span class="s1">'checked'</span> <span class="o">=></span> <span class="k">TRUE</span><span class="p">,</span>
|
||||
<span class="s1">'style'</span> <span class="o">=></span> <span class="s1">'margin:10px'</span>
|
||||
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'newsletter'</span><span class="p">,</span>
|
||||
<span class="s1">'id'</span> <span class="o">=></span> <span class="s1">'newsletter'</span><span class="p">,</span>
|
||||
<span class="s1">'value'</span> <span class="o">=></span> <span class="s1">'accept'</span><span class="p">,</span>
|
||||
<span class="s1">'checked'</span> <span class="o">=></span> <span class="k">TRUE</span><span class="p">,</span>
|
||||
<span class="s1">'style'</span> <span class="o">=></span> <span class="s1">'margin:10px'</span>
|
||||
<span class="p">];</span>
|
||||
|
||||
<span class="k">echo</span> <span class="nx">form_checkbox</span><span class="p">(</span><span class="nv">$data</span><span class="p">);</span>
|
||||
@ -1015,8 +1015,8 @@ function above except that it uses the “radio” input type.</p>
|
||||
third parameter if you prefer to set additional attributes.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$attributes</span> <span class="o">=</span> <span class="p">[</span>
|
||||
<span class="s1">'class'</span> <span class="o">=></span> <span class="s1">'mycustomclass'</span><span class="p">,</span>
|
||||
<span class="s1">'style'</span> <span class="o">=></span> <span class="s1">'color: #000;'</span>
|
||||
<span class="s1">'class'</span> <span class="o">=></span> <span class="s1">'mycustomclass'</span><span class="p">,</span>
|
||||
<span class="s1">'style'</span> <span class="o">=></span> <span class="s1">'color: #000;'</span>
|
||||
<span class="p">];</span>
|
||||
|
||||
<span class="k">echo</span> <span class="nx">form_label</span><span class="p">(</span><span class="s1">'What is your Name'</span><span class="p">,</span> <span class="s1">'username'</span><span class="p">,</span> <span class="nv">$attributes</span><span class="p">);</span>
|
||||
@ -1102,11 +1102,11 @@ button name and content in the first and second parameter:</p>
|
||||
<p>Or you can pass an associative array containing any data you wish your
|
||||
form to contain:</p>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$data</span> <span class="o">=</span> <span class="p">[</span>
|
||||
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'button'</span><span class="p">,</span>
|
||||
<span class="s1">'id'</span> <span class="o">=></span> <span class="s1">'button'</span><span class="p">,</span>
|
||||
<span class="s1">'value'</span> <span class="o">=></span> <span class="s1">'true'</span><span class="p">,</span>
|
||||
<span class="s1">'type'</span> <span class="o">=></span> <span class="s1">'reset'</span><span class="p">,</span>
|
||||
<span class="s1">'content'</span> <span class="o">=></span> <span class="s1">'Reset'</span>
|
||||
<span class="s1">'name'</span> <span class="o">=></span> <span class="s1">'button'</span><span class="p">,</span>
|
||||
<span class="s1">'id'</span> <span class="o">=></span> <span class="s1">'button'</span><span class="p">,</span>
|
||||
<span class="s1">'value'</span> <span class="o">=></span> <span class="s1">'true'</span><span class="p">,</span>
|
||||
<span class="s1">'type'</span> <span class="o">=></span> <span class="s1">'reset'</span><span class="p">,</span>
|
||||
<span class="s1">'content'</span> <span class="o">=></span> <span class="s1">'Reset'</span>
|
||||
<span class="p">];</span>
|
||||
|
||||
<span class="k">echo</span> <span class="nx">form_button</span><span class="p">(</span><span class="nv">$data</span><span class="p">);</span>
|
||||
@ -1153,24 +1153,21 @@ the tag. For example:</p>
|
||||
<dd><dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>$field</strong> (<em>string</em>) – Field name</p></li>
|
||||
<li><p><strong>$default</strong> (<em>string</em>) – Default value</p></li>
|
||||
<li><p><strong>$html_escape</strong> (<em>bool</em>) – Whether to turn off HTML escaping of the value</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p>Field value</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p>string</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<li><p><strong>$field</strong> (<em>string</em>) – <p>Field name
|
||||
:param string $default: Default value
|
||||
:param bool $html_escape: Whether to turn off HTML escaping of the value
|
||||
:returns: Field value
|
||||
:rtype: string</p>
|
||||
<p>Permits you to set the value of an input form or textarea. You must
|
||||
supply the field name via the first parameter of the function. The
|
||||
second (optional) parameter allows you to set a default value for the
|
||||
form. The third (optional) parameter allows you to turn off HTML escaping
|
||||
of the value, in case you need to use this function in combination with
|
||||
i.e., <a class="reference internal" href="#form_input" title="form_input"><code class="xref php php-func docutils literal notranslate"><span class="pre">form_input()</span></code></a> and avoid double-escaping.</p>
|
||||
</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="nx">input</span> <span class="nx">type</span><span class="o">=</span><span class="s2">"text"</span> <span class="nx">name</span><span class="o">=</span><span class="s2">"quantity"</span> <span class="nx">value</span><span class="o">=</span><span class="s2">"<?= set_value('quantity', '0') ?>"</span> <span class="nx">size</span><span class="o">=</span><span class="s2">"50"</span> <span class="o">/></span>
|
||||
</pre></div>
|
||||
@ -1203,9 +1200,9 @@ parameter must contain the value of each item, and the third (optional)
|
||||
parameter lets you set an item as the default (use boolean TRUE/FALSE).</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="nx">select</span> <span class="nx">name</span><span class="o">=</span><span class="s2">"myselect"</span><span class="o">></span>
|
||||
<span class="o"><</span><span class="nx">option</span> <span class="nx">value</span><span class="o">=</span><span class="s2">"one"</span> <span class="o"><?=</span> <span class="nx">set_select</span><span class="p">(</span><span class="s1">'myselect'</span><span class="p">,</span> <span class="s1">'one'</span><span class="p">,</span> <span class="k">TRUE</span><span class="p">)</span> <span class="cp">?></span>>One<span class="p"></</span><span class="nt">option</span><span class="p">></span>
|
||||
<span class="p"><</span><span class="nt">option</span> <span class="na">value</span><span class="o">=</span><span class="s">"two"</span> <span class="cp"><?</span><span class="o">=</span> <span class="nx">set_select</span><span class="p">(</span><span class="s1">'myselect'</span><span class="p">,</span> <span class="s1">'two'</span><span class="p">)</span> <span class="cp">?></span><span class="p">></span>Two<span class="p"></</span><span class="nt">option</span><span class="p">></span>
|
||||
<span class="p"><</span><span class="nt">option</span> <span class="na">value</span><span class="o">=</span><span class="s">"three"</span> <span class="cp"><?</span><span class="o">=</span> <span class="nx">set_select</span><span class="p">(</span><span class="s1">'myselect'</span><span class="p">,</span> <span class="s1">'three'</span><span class="p">)</span> <span class="cp">?></span><span class="p">></span>Three<span class="p"></</span><span class="nt">option</span><span class="p">></span>
|
||||
<span class="o"><</span><span class="nx">option</span> <span class="nx">value</span><span class="o">=</span><span class="s2">"one"</span> <span class="o"><?=</span> <span class="nx">set_select</span><span class="p">(</span><span class="s1">'myselect'</span><span class="p">,</span> <span class="s1">'one'</span><span class="p">,</span> <span class="k">TRUE</span><span class="p">)</span> <span class="cp">?></span>>One<span class="p"></</span><span class="nt">option</span><span class="p">></span>
|
||||
<span class="p"><</span><span class="nt">option</span> <span class="na">value</span><span class="o">=</span><span class="s">"two"</span> <span class="cp"><?</span><span class="o">=</span> <span class="nx">set_select</span><span class="p">(</span><span class="s1">'myselect'</span><span class="p">,</span> <span class="s1">'two'</span><span class="p">)</span> <span class="cp">?></span><span class="p">></span>Two<span class="p"></</span><span class="nt">option</span><span class="p">></span>
|
||||
<span class="p"><</span><span class="nt">option</span> <span class="na">value</span><span class="o">=</span><span class="s">"three"</span> <span class="cp"><?</span><span class="o">=</span> <span class="nx">set_select</span><span class="p">(</span><span class="s1">'myselect'</span><span class="p">,</span> <span class="s1">'three'</span><span class="p">)</span> <span class="cp">?></span><span class="p">></span>Three<span class="p"></</span><span class="nt">option</span><span class="p">></span>
|
||||
<span class="p"></</span><span class="nt">select</span><span class="p">></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
@ -1217,18 +1214,11 @@ parameter lets you set an item as the default (use boolean TRUE/FALSE).</p>
|
||||
<dd><dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>$field</strong> (<em>string</em>) – Field name</p></li>
|
||||
<li><p><strong>$value</strong> (<em>string</em>) – Value to check for</p></li>
|
||||
<li><p><strong>$default</strong> (<em>string</em>) – Whether the value is also a default one</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p>‘checked’ attribute or an empty string</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p>string</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<li><p><strong>$field</strong> (<em>string</em>) – <p>Field name
|
||||
:param string $value: Value to check for
|
||||
:param string $default: Whether the value is also a default one
|
||||
:returns: ‘checked’ attribute or an empty string
|
||||
:rtype: string</p>
|
||||
<p>Permits you to display a checkbox in the state it was submitted.</p>
|
||||
<p>The first parameter must contain the name of the checkbox, the second
|
||||
parameter must contain its value, and the third (optional) parameter
|
||||
@ -1238,6 +1228,10 @@ lets you set an item as the default (use boolean TRUE/FALSE).</p>
|
||||
<span class="p"><</span><span class="nt">input</span> <span class="na">type</span><span class="o">=</span><span class="s">"checkbox"</span> <span class="na">name</span><span class="o">=</span><span class="s">"mycheck"</span> <span class="na">value</span><span class="o">=</span><span class="s">"2"</span> <span class="cp"><?</span><span class="o">=</span> <span class="nx">set_checkbox</span><span class="p">(</span><span class="s1">'mycheck'</span><span class="p">,</span> <span class="s1">'2'</span><span class="p">)</span> <span class="cp">?></span> <span class="p">/></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
@ -1246,20 +1240,17 @@ lets you set an item as the default (use boolean TRUE/FALSE).</p>
|
||||
<dd><dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>$field</strong> (<em>string</em>) – Field name</p></li>
|
||||
<li><p><strong>$value</strong> (<em>string</em>) – Value to check for</p></li>
|
||||
<li><p><strong>$default</strong> (<em>string</em>) – Whether the value is also a default one</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns</dt>
|
||||
<dd class="field-even"><p>‘checked’ attribute or an empty string</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p>string</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<li><p><strong>$field</strong> (<em>string</em>) – <p>Field name
|
||||
:param string $value: Value to check for
|
||||
:param string $default: Whether the value is also a default one
|
||||
:returns: ‘checked’ attribute or an empty string
|
||||
:rtype: string</p>
|
||||
<p>Permits you to display radio buttons in the state they were submitted.
|
||||
This function is identical to the <a class="reference internal" href="#set_checkbox" title="set_checkbox"><code class="xref php php-func docutils literal notranslate"><span class="pre">set_checkbox()</span></code></a> function above.</p>
|
||||
</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="nx">input</span> <span class="nx">type</span><span class="o">=</span><span class="s2">"radio"</span> <span class="nx">name</span><span class="o">=</span><span class="s2">"myradio"</span> <span class="nx">value</span><span class="o">=</span><span class="s2">"1"</span> <span class="o"><?=</span> <span class="nx">set_radio</span><span class="p">(</span><span class="s1">'myradio'</span><span class="p">,</span> <span class="s1">'1'</span><span class="p">,</span> <span class="k">TRUE</span><span class="p">)</span> <span class="cp">?></span> />
|
||||
<span class="p"><</span><span class="nt">input</span> <span class="na">type</span><span class="o">=</span><span class="s">"radio"</span> <span class="na">name</span><span class="o">=</span><span class="s">"myradio"</span> <span class="na">value</span><span class="o">=</span><span class="s">"2"</span> <span class="cp"><?</span><span class="o">=</span> <span class="nx">set_radio</span><span class="p">(</span><span class="s1">'myradio'</span><span class="p">,</span> <span class="s1">'2'</span><span class="p">)</span> <span class="cp">?></span> <span class="p">/></span>
|
||||
|
||||
@ -386,9 +386,9 @@
|
||||
<p>Usage example:</p>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="k">public</span> <span class="k">function</span> <span class="nf">testUserAccess</span><span class="p">()</span>
|
||||
<span class="p">{</span>
|
||||
<span class="nv">$user</span> <span class="o">=</span> <span class="nx">fake</span><span class="p">(</span><span class="s1">'App\Models\UserModel'</span><span class="p">);</span>
|
||||
<span class="nv">$user</span> <span class="o">=</span> <span class="nx">fake</span><span class="p">(</span><span class="s1">'App\Models\UserModel'</span><span class="p">);</span>
|
||||
|
||||
<span class="nv">$this</span><span class="o">-></span><span class="na">assertTrue</span><span class="p">(</span><span class="nv">$this</span><span class="o">-></span><span class="na">userHasAccess</span><span class="p">(</span><span class="nv">$user</span><span class="p">));</span>
|
||||
<span class="nv">$this</span><span class="o">-></span><span class="na">assertTrue</span><span class="p">(</span><span class="nv">$this</span><span class="o">-></span><span class="na">userHasAccess</span><span class="p">(</span><span class="nv">$user</span><span class="p">));</span>
|
||||
<span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
|
||||
@ -393,9 +393,14 @@ specifies the length. The following choices are available:</p>
|
||||
<li><p><strong>numeric</strong>: Numeric string.</p></li>
|
||||
<li><p><strong>nozero</strong>: Numeric string with no zeros.</p></li>
|
||||
<li><p><strong>md5</strong>: An encrypted random number based on <code class="docutils literal notranslate"><span class="pre">md5()</span></code> (fixed length of 32).</p></li>
|
||||
<li><p><strong>sha1</strong>: An encrypted random number based on <code class="docutils literal notranslate"><span class="pre">sha1()</span></code> (fixed length of 40).</p></li>
|
||||
<li><dl class="simple">
|
||||
<dt><strong>sha1</strong>: An encrypted random number based on <code class="docutils literal notranslate"><span class="pre">sha1()</span></code> (fixed length of 40).</dt><dd><ul>
|
||||
<li><p><strong>crypto</strong>: A random string based on <code class="docutils literal notranslate"><span class="pre">random_bytes()</span></code>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</li>
|
||||
</ul>
|
||||
<p>Usage example:</p>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">random_string</span><span class="p">(</span><span class="s1">'alnum'</span><span class="p">,</span> <span class="mi">16</span><span class="p">);</span>
|
||||
</pre></div>
|
||||
@ -451,7 +456,7 @@ content which has unique titles or slugs.</p>
|
||||
a loop. Example:</p>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="k">for</span> <span class="p">(</span><span class="nv">$i</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span> <span class="nv">$i</span> <span class="o"><</span> <span class="mi">10</span><span class="p">;</span> <span class="nv">$i</span><span class="o">++</span><span class="p">)</span>
|
||||
<span class="p">{</span>
|
||||
<span class="k">echo</span> <span class="nx">alternator</span><span class="p">(</span><span class="s1">'string one'</span><span class="p">,</span> <span class="s1">'string two'</span><span class="p">);</span>
|
||||
<span class="k">echo</span> <span class="nx">alternator</span><span class="p">(</span><span class="s1">'string one'</span><span class="p">,</span> <span class="s1">'string two'</span><span class="p">);</span>
|
||||
<span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
@ -459,7 +464,7 @@ a loop. Example:</p>
|
||||
your loop the next item will be returned.</p>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="k">for</span> <span class="p">(</span><span class="nv">$i</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span> <span class="nv">$i</span> <span class="o"><</span> <span class="mi">10</span><span class="p">;</span> <span class="nv">$i</span><span class="o">++</span><span class="p">)</span>
|
||||
<span class="p">{</span>
|
||||
<span class="k">echo</span> <span class="nx">alternator</span><span class="p">(</span><span class="s1">'one'</span><span class="p">,</span> <span class="s1">'two'</span><span class="p">,</span> <span class="s1">'three'</span><span class="p">,</span> <span class="s1">'four'</span><span class="p">,</span> <span class="s1">'five'</span><span class="p">);</span>
|
||||
<span class="k">echo</span> <span class="nx">alternator</span><span class="p">(</span><span class="s1">'one'</span><span class="p">,</span> <span class="s1">'two'</span><span class="p">,</span> <span class="s1">'three'</span><span class="p">,</span> <span class="s1">'four'</span><span class="p">,</span> <span class="s1">'five'</span><span class="p">);</span>
|
||||
<span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
@ -514,8 +519,8 @@ found in URL protocol prefixes (e.g., http&#58;//).</p>
|
||||
<p>Removes any slashes from an array of strings.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$str</span> <span class="o">=</span> <span class="p">[</span>
|
||||
<span class="s1">'question'</span> <span class="o">=></span> <span class="s2">"Is your name O\'reilly?"</span><span class="p">,</span>
|
||||
<span class="s1">'answer'</span> <span class="o">=></span> <span class="s2">"No, my name is O\'connor."</span>
|
||||
<span class="s1">'question'</span> <span class="o">=></span> <span class="s2">"Is your name O\'reilly?"</span><span class="p">,</span>
|
||||
<span class="s1">'answer'</span> <span class="o">=></span> <span class="s2">"No, my name is O\'connor."</span>
|
||||
<span class="p">];</span>
|
||||
|
||||
<span class="nv">$str</span> <span class="o">=</span> <span class="nx">strip_slashes</span><span class="p">(</span><span class="nv">$str</span><span class="p">);</span>
|
||||
@ -523,8 +528,8 @@ found in URL protocol prefixes (e.g., http&#58;//).</p>
|
||||
</div>
|
||||
<p>The above will return the following array:</p>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="p">[</span>
|
||||
<span class="s1">'question'</span> <span class="o">=></span> <span class="s2">"Is your name O'reilly?"</span><span class="p">,</span>
|
||||
<span class="s1">'answer'</span> <span class="o">=></span> <span class="s2">"No, my name is O'connor."</span>
|
||||
<span class="s1">'question'</span> <span class="o">=></span> <span class="s2">"Is your name O'reilly?"</span><span class="p">,</span>
|
||||
<span class="s1">'answer'</span> <span class="o">=></span> <span class="s2">"No, my name is O'connor."</span>
|
||||
<span class="p">];</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
@ -853,8 +858,8 @@ might not support the new HTML5 mark tag, so it is recommended that you
|
||||
insert the following CSS code into your stylesheet if you need to support
|
||||
such browsers:</p>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nx">mark</span> <span class="p">{</span>
|
||||
<span class="nx">background</span><span class="o">:</span> <span class="c1">#ff0;</span>
|
||||
<span class="nx">color</span><span class="o">:</span> <span class="c1">#000;</span>
|
||||
<span class="nx">background</span><span class="o">:</span> <span class="c1">#ff0;</span>
|
||||
<span class="nx">color</span><span class="o">:</span> <span class="c1">#000;</span>
|
||||
<span class="p">};</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
@ -889,9 +894,10 @@ complete words.</p>
|
||||
<span class="c1">// of text that will help us</span>
|
||||
<span class="c1">// demonstrate this</span>
|
||||
<span class="c1">// function.</span>
|
||||
|
||||
<span class="nx">Excessively</span> <span class="nx">long</span> <span class="nx">words</span> <span class="nx">will</span> <span class="nx">be</span> <span class="nb">split</span><span class="p">,</span> <span class="nx">but</span> <span class="nx">URLs</span> <span class="nx">will</span> <span class="k">not</span> <span class="nx">be</span><span class="o">.</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Excessively long words will be split, but URLs will not be.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
@ -969,13 +975,13 @@ at the end.</p>
|
||||
<span class="s1">arcu. Cras ac ipsum sit amet augue laoreet laoreet. Aenean a risus lacus.</span>
|
||||
<span class="s1">Sed ut tortor diam.'</span><span class="p">;</span>
|
||||
|
||||
<span class="k">echo</span> <span class="nx">excerpt</span><span class="p">(</span><span class="nv">$str</span><span class="p">,</span> <span class="s1">'Donec'</span><span class="p">);</span>
|
||||
<span class="k">echo</span> <span class="nx">excerpt</span><span class="p">(</span><span class="nv">$text</span><span class="p">,</span> <span class="s1">'Donec'</span><span class="p">);</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Produces:</p>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o">...</span> <span class="nx">non</span> <span class="nx">mauris</span> <span class="nx">lectus</span><span class="o">.</span> <span class="nx">Phasellus</span> <span class="nx">eu</span> <span class="nx">sodales</span> <span class="nx">sem</span><span class="o">.</span> <span class="nx">Integer</span> <span class="nx">dictum</span> <span class="nx">purus</span> <span class="nx">ac</span>
|
||||
<span class="nx">enim</span> <span class="nx">hendrerit</span> <span class="nx">gravida</span><span class="o">.</span> <span class="nx">Donec</span> <span class="nx">ac</span> <span class="nx">magna</span> <span class="nx">vel</span> <span class="nx">nunc</span> <span class="nx">tincidunt</span> <span class="nx">molestie</span> <span class="nx">sed</span>
|
||||
<span class="nx">vitae</span> <span class="nx">nisl</span><span class="o">.</span> <span class="nx">Cras</span> <span class="nx">sed</span> <span class="nx">auctor</span> <span class="nx">mauris</span><span class="p">,</span> <span class="nx">non</span> <span class="nx">dictum</span> <span class="o">...</span>
|
||||
<span class="nx">vitae</span> <span class="nx">nisl</span><span class="o">.</span> <span class="nx">Cras</span> <span class="nx">sed</span> <span class="nx">auctor</span> <span class="nx">mauris</span><span class="p">,</span> <span class="nx">non</span> <span class="nx">dictum</span> <span class="nx">tortor</span><span class="o">.</span> <span class="o">...</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
@ -406,7 +406,7 @@ Entity itself at <strong>app/Entities/User.php</strong>.</p>
|
||||
|
||||
<span class="k">class</span> <span class="nc">User</span> <span class="k">extends</span> <span class="nx">Entity</span>
|
||||
<span class="p">{</span>
|
||||
<span class="c1">//</span>
|
||||
<span class="c1">// ...</span>
|
||||
<span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
@ -712,8 +712,8 @@ Unlike the rest of the data types that you can cast properties into, the:</p>
|
||||
<span class="p">{</span>
|
||||
<span class="k">protected</span> <span class="nv">$casts</span> <span class="o">=</span> <span class="p">[</span>
|
||||
<span class="s1">'options'</span> <span class="o">=></span> <span class="s1">'array'</span><span class="p">,</span>
|
||||
<span class="s1">'options_object'</span> <span class="o">=></span> <span class="s1">'json'</span><span class="p">,</span>
|
||||
<span class="s1">'options_array'</span> <span class="o">=></span> <span class="s1">'json-array'</span><span class="p">,</span>
|
||||
<span class="s1">'options_object'</span> <span class="o">=></span> <span class="s1">'json'</span><span class="p">,</span>
|
||||
<span class="s1">'options_array'</span> <span class="o">=></span> <span class="s1">'json-array'</span><span class="p">,</span>
|
||||
<span class="p">];</span>
|
||||
<span class="p">}</span>
|
||||
</pre></div>
|
||||
|
||||
@ -1213,7 +1213,7 @@ from the model. For <code class="docutils literal notranslate"><span class="pre"
|
||||
to the calling context. In order for <code class="docutils literal notranslate"><span class="pre">beforeFind</span></code> to intercept the find workflow it must also return an additional
|
||||
boolean, <code class="docutils literal notranslate"><span class="pre">returnData</span></code>:</p>
|
||||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="k">protected</span> <span class="nv">$beforeFind</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'checkCache'</span><span class="p">];</span>
|
||||
<span class="o">...</span>
|
||||
<span class="c1">// ...</span>
|
||||
<span class="k">protected</span> <span class="k">function</span> <span class="nf">checkCache</span><span class="p">(</span><span class="k">array</span> <span class="nv">$data</span><span class="p">)</span>
|
||||
<span class="p">{</span>
|
||||
<span class="c1">// Check if the requested item is already in our cache</span>
|
||||
@ -1223,7 +1223,7 @@ boolean, <code class="docutils literal notranslate"><span class="pre">returnData
|
||||
<span class="nv">$data</span><span class="p">[</span><span class="s1">'returnData'</span><span class="p">]</span> <span class="o">=</span> <span class="k">true</span><span class="p">;</span>
|
||||
|
||||
<span class="k">return</span> <span class="nv">$data</span><span class="p">;</span>
|
||||
<span class="o">...</span>
|
||||
<span class="c1">// ...</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
File diff suppressed because one or more lines are too long
Loading…
x
Reference in New Issue
Block a user