squadsUnderSelect

(/rs/public/functions.php)

squadsUnderSelect -- Either a select input or an array of member id's an officer commands.

Description

mixed squadsUnderSelect ($pin, $selOrArray = "sel", $name = "members", $top = "None", $topval = 0)

This function has two possible return types, depending on the 2nd parameter given.

The first parameter, $pin, is the id of the member in question.

The second parameter, $selOrArray, defaults to "sel". If it remains as "sel", then the third through fifth parameters will apply and the function will return the complete html for a select input.

The third parameter, $name, will be the name of the select input. It defaults to "members".

The fourth parameter, $top, will be the text of the first value in the select input. It defaults to "None".

The fifth parameter, $topval, will be the value of the first value in the select input. It defaults to 0.

If the 2nd parameter is given as "array", the 3rd through 5th parameters are ignored, and an array of member pins is returned rather than a select input.

This function will return a select box with only the option specified by $top and $topval on failure when in "sel" mode. It will return an empty array when in "array" mode if it fails.

Examples

squadsUnderSelect (1) /* Returns a select input called "members" with first option "None" with value 0. The other options are members that member with id 1 commands via the fleet-wing-squadron chain of command. */

squadsUnderSelect (1, "array") /* Returns an array containing member id's that member with id 1 commands via the fleet-wing-squadron chain of command. */

Related Functions

None.

Dependencies

getCommandPositions, not_zero

Function Index