Difference between revisions of "Function Template"
From Whirlwind eCommerce Wiki
Ukaqicuryx (Talk | contribs) |
m (Reverted edits by Ukaqicuryx (Talk) to last version by 71.163.185.8) |
||
Line 1: | Line 1: | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
== Description == | == Description == | ||
Function() performs a function that does stuff | Function() performs a function that does stuff | ||
Line 24: | Line 16: | ||
Return var type or false under conditions. Example returned object structure: | Return var type or false under conditions. Example returned object structure: | ||
− | + | <pre> | |
Array | Array | ||
( | ( | ||
− | [0] = | + | [0] => Array |
( | ( | ||
// elements group 1 | // elements group 1 | ||
− | [element1] = | + | [element1] => INT |
− | [element2] = | + | [element2] => STRING // this is element 2 notes |
// elements group 2 | // elements group 2 | ||
− | [element3] = | + | [element3] => STRING // this is element 3 notes |
) | ) | ||
− | [1] = | + | [1] => Array ... |
) | ) | ||
− | + | </pre> | |
Defining the returned object: | Defining the returned object: | ||
Line 48: | Line 40: | ||
|Example | |Example | ||
|- | |- | ||
− | | | + | |<b>Title for this section of elements</b> |
|- | |- | ||
|element1 | |element1 | ||
Line 58: | Line 50: | ||
|XYZ | |XYZ | ||
|- | |- | ||
− | | | + | |<b>Title for another section of elements</b> |
|- | |- | ||
|element3 | |element3 | ||
Line 67: | Line 59: | ||
== Examples == | == Examples == | ||
;example 1 | ;example 1 | ||
− | + | <source lang="php"> | |
// example code 1 | // example code 1 | ||
− | + | </source> | |
;example 2 | ;example 2 | ||
− | + | <source lang="php"> | |
// example code 2 | // example code 2 | ||
− | + | </source> | |
== See Also == | == See Also == |
Latest revision as of 16:52, 1 December 2010
Description
Function() performs a function that does stuff
Syntax
$returnValue = Function(type $attrib1, type $attrib2 [,type $optionalAttrib3]);
Paramaters
- attrib1
- description of attribute 1
- attrib 2
- description of attribute 2
- attrib 3
- description of attribute 3
Return Values
Return var type or false under conditions. Example returned object structure:
Array ( [0] => Array ( // elements group 1 [element1] => INT [element2] => STRING // this is element 2 notes // elements group 2 [element3] => STRING // this is element 3 notes ) [1] => Array ... )
Defining the returned object:
Elements from the child page associative array are as follows:
Element | Description | Example |
Title for this section of elements | ||
element1 | INT - description of element 1 | 6 |
element2 | STRING - description of element 2 | XYZ |
Title for another section of elements | ||
element3 | INT - description of element 3 | 2 |
Examples
- example 1
// example code 1
- example 2
// example code 2