user_guide/helpers/array_helper.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   3 <head>
   4
   5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   6 <title>Array Helper : CodeIgniter User Guide</title>
   7
   8 <style type='text/css' media='all'>@import url('../userguide.css');</style>
   9 <link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
  10
  11 <script type="text/javascript" src="../nav/nav.js"></script>
  12 <script type="text/javascript" src="../nav/prototype.lite.js"></script>
  13 <script type="text/javascript" src="../nav/moo.fx.js"></script>
  14 <script type="text/javascript" src="../nav/user_guide_menu.js"></script>
  15
  16 <meta http-equiv='expires' content='-1' />
  17 <meta http-equiv= 'pragma' content='no-cache' />
  18 <meta name='robots' content='all' />
  19 <meta name='author' content='ExpressionEngine Dev Team' />
  20 <meta name='description' content='CodeIgniter User Guide' />
  21
  22 </head>
  23 <body>
  24
  25 <!-- START NAVIGATION -->
  26 <div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
  27 <div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../images/nav_toggle_darker.jpg" width="154" height="43" border="0" title="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div>
  28 <div id="masthead">
  29 <table cellpadding="0" cellspacing="0" border="0" style="width:100%">
  30 <tr>
  31 <td><h1>CodeIgniter User Guide Version 2.0.2</h1></td>
  32 <td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
  33 </tr>
  34 </table>
  35 </div>
  36 <!-- END NAVIGATION -->
  37
  38
  39 <!-- START BREADCRUMB -->
  40 <table cellpadding="0" cellspacing="0" border="0" style="width:100%">
  41 <tr>
  42 <td id="breadcrumb">
  43 <a href="http://codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
  44 <a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
  45 Array Helper
  46 </td>
  47 <td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="codeigniter.com/user_guide/" />Search User Guide&nbsp; <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" />&nbsp;<input type="submit" class="submit" name="sa" value="Go" /></form></td>
  48 </tr>
  49 </table>
  50 <!-- END BREADCRUMB -->
  51
  52 <br clear="all" />
  53
  54
  55 <!-- START CONTENT -->
  56 <div id="content">
  57
  58
  59 <h1>Array Helper</h1>
  60
  61 <p>The Array Helper file contains functions that assist in working with arrays.</p>
  62
  63
  64 <h2>Loading this Helper</h2>
  65
  66 <p>This helper is loaded using the following code:</p>
  67 <code>$this->load->helper('array');</code>
  68
  69 <p>The following functions are available:</p>
  70
  71 <h2>element()</h2>
  72
  73 <p>Lets you fetch an item from an array.  The function tests whether the array index is set and whether it has a value.  If
  74 a value exists it is returned.  If a value does not exist it returns FALSE, or whatever you've specified as the default value via the third parameter.  Example:</p>
  75
  76 <code>
  77 $array = array('color' => 'red', 'shape' => 'round', 'size' => '');<br />
  78 <br />
  79 // returns "red"<br />
  80 echo element('color', $array);<br />
  81 <br />
  82 // returns NULL<br />
  83 echo element('size', $array, NULL);
  84 </code>
  85
  86
  87 <h2>random_element()</h2>
  88
  89 <p>Takes an array as input and returns a random element from it.  Usage example:</p>
  90
  91 <code>$quotes = array(<br />
  92 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"I find that the harder I work, the more luck I seem to have. - Thomas Jefferson",<br />
  93 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"Don't stay in bed, unless you can make money in bed. - George Burns",<br />
  94 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"We didn't lose the game; we just ran out of time. - Vince Lombardi",<br />
  95 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"If everything seems under control, you're not going fast enough. - Mario Andretti",<br />
  96 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"Reality is merely an illusion, albeit a very persistent one. - Albert Einstein",<br />
  97 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"Chance favors the prepared mind - Louis Pasteur"<br />
  98 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;);<br />
  99 <br />
 100 echo random_element($quotes);</code>
 101
 102
 103 <h2>elements()</h2>
 104
 105 <p>Lets you fetch a number of items from an array.  The function tests whether each of the array indices is set.  If an index does not exist
 106 it is set to FALSE, or whatever you've specified as the default value via the third parameter.  Example:</p>
 107
 108 <code>
 109 $array = array(<br />
 110 &nbsp;&nbsp;&nbsp;&nbsp;'color' => 'red',<br />
 111 &nbsp;&nbsp;&nbsp;&nbsp;'shape' => 'round',<br />
 112 &nbsp;&nbsp;&nbsp;&nbsp;'radius' => '10',<br />
 113 &nbsp;&nbsp;&nbsp;&nbsp;'diameter' => '20'<br />
 114 );<br />
 115 <br />
 116 $my_shape = elements(array('color', 'shape', 'height'), $array);<br />
 117 </code>
 118
 119 <p>The above will return the following array:</p>
 120
 121 <code>
 122 array(<br />
 123 &nbsp;&nbsp;&nbsp;&nbsp;'color' => 'red',<br />
 124 &nbsp;&nbsp;&nbsp;&nbsp;'shape' => 'round',<br />
 125 &nbsp;&nbsp;&nbsp;&nbsp;'height' => FALSE<br />
 126 );
 127 </code>
 128
 129 <p>You can set the third parameter to any default value you like:</p>
 130
 131 <code>
 132 $my_shape = elements(array('color', 'shape', 'height'), $array, NULL);<br />
 133 </code>
 134
 135 <p>The above will return the following array:</p>
 136
 137 <code>
 138 array(<br />
 139 &nbsp;&nbsp;&nbsp;&nbsp;'color' => 'red',<br />
 140 &nbsp;&nbsp;&nbsp;&nbsp;'shape' => 'round',<br />
 141 &nbsp;&nbsp;&nbsp;&nbsp;'height' => NULL<br />
 142 );
 143 </code>
 144
 145 <p>This is useful when sending the <kbd>$_POST</kbd> array to one of your Models.  This prevents users from
 146 sending additional POST data to be entered into your tables:</p>
 147
 148 <code>
 149 $this->load->model('post_model');<br />
 150 <br />
 151 $this->post_model->update(elements(array('id', 'title', 'content'), $_POST));
 152 </code>
 153
 154 <p>This ensures that only the id, title and content fields are sent to be updated.</p>
 155
 156 </div>
 157 <!-- END CONTENT -->
 158
 159
 160 <div id="footer">
 161 <p>
 162 Previous Topic:&nbsp;&nbsp; <a href="../libraries/zip.html">Zip Encoding Class</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
 163 <a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
 164 <a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
 165 Next Topic:&nbsp;&nbsp;<a href="compatibility_helper.html">Compatibility Helper</a></p>
 166 <p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006 - 2011 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">EllisLab, Inc.</a></p>
 167 </div>
 168
 169 </body>
 170 </html>