Merge pull request fuel#354 from billmn/1.3/develop

Added documentation for Arr::is_multi() method

Author: frankdejonge

classes/arr.html

@@ -49,6 +49,71 @@ <h2>Arr Class</h2>
 
 			<p>The arr class is a set of helper functions for working with arrays.</p>
 
+			<article>
+				<h4 class="method" id="method_is_multi">is_multi($arr, $all_keys = false)</h4>
+				<p>The <strong>is_multi</strong> method checks if the array passed is multi-dimensional array or not.</p>
+				<table class="method">
+					<tbody>
+					<tr>
+						<th class="legend">Static</th>
+						<td>Yes</td>
+					</tr>
+					<tr>
+						<th>Parameters</th>
+						<td>
+							<table class="parameters">
+								<tr>
+									<th>Param</th>
+									<th>Default</th>
+									<th class="description">Description</th>
+								</tr>
+								<tr>
+									<th><kbd>$arr</kbd></th>
+									<td><em>required</em></td>
+									<td>The array to check.</td>
+								</tr>
+								<tr>
+									<th><kbd>$all_keys</kbd></th>
+									<td>
+										<pre class="php"><span class="keyword">false</span></pre>
+									</td>
+									<td>Check that all elements are arrays.</td>
+								</tr>
+							</table>
+						</td>
+					</tr>
+					<tr>
+						<th>Returns</th>
+						<td>bool</td>
+					</tr>
+					<tr>
+						<th>Example</th>
+						<td>
+							<pre class="php"><code>
+// Single array
+$arr = array('one' => 1, 'two' => 2);
+Arr::is_multi($arr);
+// Result: false
+
+
+// Multi-dimensional array
+$arr = array('one' => array('test' => 1), 'two' => array('test' => 2), 'three' => array('test' => 3));
+Arr::is_multi($arr);
+// Result: true
+
+
+// Multi-dimensional array with elements check
+$arr = array('one' => array('test' => 1), 'two' => array('test' => 2), 'three' => 3);
+
+Arr::is_multi($arr, false); // Result: true
+Arr::is_multi($arr, true);  // Result: false
+</code></pre>
+						</td>
+					</tr>
+					</tbody>
+				</table>
+			</article>
+
 			<article>
 				<h4 class="method" id="method_is_assoc">is_assoc($arr)</h4>
 				<p>The <strong>is_assoc</strong> method checks if the array passed is an associative array or not.</p>