Difference between revisions of "FOREACH"

From Recital Documentation Wiki
Jump to: navigation, search
 
 
(11 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{YLM to do}}
 
 
==Class==
 
 
 
 
 
==Purpose==
 
==Purpose==
 
+
Iterate over each element of an array or member of an object
  
  
 
==Syntax==
 
==Syntax==
 +
FOREACH <array> AS <value> | FOREACH <array> AS <key> => <value>
  
 +
<statements>
 +
 +
ENDFOR
  
  
 
==See Also==
 
==See Also==
 
+
[[AADD()]], [[AAVERAGE()]], [[ABROWSE()]], [[ACHOICE()]], [[ACLASS()]], [[ACOL()]], [[ACOPY()]], [[ADDPROPERTY()]], [[ADEL()]], [[ADESC()]], [[ADIR()]], [[AELEMENT()]], [[AFIELDS()]], [[AFILL()]], [[AINS()]], [[ALEN()]], [[AMAX()]], [[AMEMBERS()]], [[AMIN()]], [[APPEND FROM ARRAY]], [[AROW()]], [[ARRAY()]], [[ASIZE()]], [[ASORT()]], [[ASTORE()]], [[ASTRING()]], [[ASUBSCRIPT()]], [[ASUM()]], [[CLASS]], [[CLASS - Methods]], [[CLASS - Parameters]], [[CLASS - Properties]], [[CLASS - Scoping]], [[COMPOBJ()]], [[COPY TO ARRAY]], [[CREATEOBJECT()]], [[DECLARE]], [[DEFINE CLASS]], [[DIMENSION]], [[DISPLAY CLASSES]], [[DO WHILE]], [[DODEFAULT()]], [[FOR]], [[GATHER]], [[IN_ARRAY()]], [[LIST CLASSES]], [[LOADOBJECT()]], [[LOCAL]], [[METHOD]], [[NEWOBJECT()]], [[OBJECT()]], [[PRINT_HTML()]], [[PRINT_JSON()]], [[PRINT_R()]], [[PRINT_XML()]], [[PRIVATE]], [[PUBLIC]], [[REMOVEPROPERTY()]], [[RELEASE]], [[RESTORE]], [[REQUIRE_ONCE()]], [[SAVE]], [[SAVEOBJECT()]], [[SCATTER]], [[SET CLASSLIBRARY]], [[SQL SELECT]], [[WITH]]
  
  
 
==Description==
 
==Description==
 
+
The FOREACH...ENDFOR command is used to iterate over each element in an array or member in an object.  The <array> must be the name of an existing array or object.  The <value> is a reference to be loaded with the contents of each element or member in turn.  Using the <key> => <value> syntax, the member names of an object or associative array can also be accessed.
  
  
 
==Example==
 
==Example==
 
<code lang="recital">
 
<code lang="recital">
 +
numbers = array(1,2,3,4,5,6,7,8,9,10)
 +
foreach numbers as elem
 +
    ? elem * elem
 +
endfor
  
 +
// associative array
 +
private myarray = array("Name" => "Recital", "Description" => "database")
 +
foreach myarray as key => value
 +
    echo "key=" + key + " value=" + value + "\n"
 +
endfor
 
</code>
 
</code>
  
 
==Products==
 
==Products==
 +
Recital, Recital Server, Recital Web
  
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Commands]]
 
[[Category:Commands]]
 +
[[Category:Looping Commands]]
 +
[[Category:Objects]]
 +
[[Category:Objects Commands]]
 +
[[Category:Array Processing]]
 +
[[Category:Array Processing Commands]]

Latest revision as of 14:35, 23 July 2010

Purpose

Iterate over each element of an array or member of an object


Syntax

FOREACH <array> AS <value> | FOREACH <array> AS <key> => <value>

<statements>

ENDFOR


See Also

AADD(), AAVERAGE(), ABROWSE(), ACHOICE(), ACLASS(), ACOL(), ACOPY(), ADDPROPERTY(), ADEL(), ADESC(), ADIR(), AELEMENT(), AFIELDS(), AFILL(), AINS(), ALEN(), AMAX(), AMEMBERS(), AMIN(), APPEND FROM ARRAY, AROW(), ARRAY(), ASIZE(), ASORT(), ASTORE(), ASTRING(), ASUBSCRIPT(), ASUM(), CLASS, CLASS - Methods, CLASS - Parameters, CLASS - Properties, CLASS - Scoping, COMPOBJ(), COPY TO ARRAY, CREATEOBJECT(), DECLARE, DEFINE CLASS, DIMENSION, DISPLAY CLASSES, DO WHILE, DODEFAULT(), FOR, GATHER, IN_ARRAY(), LIST CLASSES, LOADOBJECT(), LOCAL, METHOD, NEWOBJECT(), OBJECT(), PRINT_HTML(), PRINT_JSON(), PRINT_R(), PRINT_XML(), PRIVATE, PUBLIC, REMOVEPROPERTY(), RELEASE, RESTORE, REQUIRE_ONCE(), SAVE, SAVEOBJECT(), SCATTER, SET CLASSLIBRARY, SQL SELECT, WITH


Description

The FOREACH...ENDFOR command is used to iterate over each element in an array or member in an object. The <array> must be the name of an existing array or object. The <value> is a reference to be loaded with the contents of each element or member in turn. Using the <key> => <value> syntax, the member names of an object or associative array can also be accessed.


Example

numbers = array(1,2,3,4,5,6,7,8,9,10)
foreach numbers as elem
    ? elem * elem
endfor
 
// associative array
private myarray = array("Name" => "Recital", "Description" => "database")
foreach myarray as key => value
    echo "key=" + key + " value=" + value + "\n"
endfor

Products

Recital, Recital Server, Recital Web