Core Function isVarArray

From Sputnik Wiki
(Difference between revisions)
Jump to: navigation, search
(Created page with "= isArray( $variable ) = === Description === Checks if a variable is an array type. === Parameters === ==== variable ==== The variable to check. === Return Value === Succe...")
 
m (1 revision)
 
(10 intermediate revisions by one user not shown)
Line 1: Line 1:
= isArray( $variable ) =
+
<pre>
 +
isVarArray( $variable )
 +
</pre>
  
 
=== Description ===
 
=== Description ===
Line 13: Line 15:
 
=== Return Value ===
 
=== Return Value ===
  
Success: Returns 1.
+
Success: Returns true.
Failure: Returns 0 if parameter is not an array variable.  
+
 
 +
Failure: Returns false.
  
 
=== Remarks ===
 
=== Remarks ===
Line 23: Line 26:
  
 
<syntaxhighlight lang="sputnik">
 
<syntaxhighlight lang="sputnik">
$var1 = array(1, 2, 3, 4)
+
$var1 = array(1, 2, 3, 4);
$var2 = "Hello"
+
$var2 = "Hello";
 +
 
 +
println( "Var1: " . isVarArray($var1) );
 +
// Alternative
 +
println( "Var1: " . ($var1 is array)  );
 +
// Alternative
 +
println( "Var1: " . ($var1 ~~ array)  );
 +
 
  
println( "Var1: " . isArray($var1) )
+
println( "Var2: " . isVarArray($var2) );
println( "Var2: " . isArray($var2) )
+
// Alternative
 +
println( "Var2: " . ($var2 is array)  );
 +
// Alternative
 +
println( "Var2: " . ($var2 ~~ array) );
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
[[Category:Core Function]]
 
[[Category:Core Function]]

Latest revision as of 12:38, 14 June 2015

isVarArray( $variable )

Contents

Description

Checks if a variable is an array type.

Parameters

variable

The variable to check.

Return Value

Success: Returns true.

Failure: Returns false.

Remarks

Can be useful to validate array/non-array parameters to user-defined functions.

Example

$var1 = array(1, 2, 3, 4);
$var2 = "Hello";
 
println( "Var1: " . isVarArray($var1) );
// Alternative
println( "Var1: " . ($var1 is array)  );
// Alternative
println( "Var1: " . ($var1 ~~ array)  );
 
 
println( "Var2: " . isVarArray($var2) );
// Alternative
println( "Var2: " . ($var2 is array)  );
// Alternative
println( "Var2: " . ($var2 ~~ array)  );
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox