c_input Class Reference

Input parameters given by SCRIPT command. More...

List of all members.

Public Member Functions

 get_channel ()
 Gets channel from SCRIPT command.
 get_param ($index)
 Gets parameter.
 init ($channel)
 Initialization: clean-up.
 set_next_parameter ($value)
 Adds a new parameter to the array.

Public Attributes

 $channel
 Name of channel (if applicable).
 $params
 Array of input parameters.


Detailed Description

Input parameters given by SCRIPT command.

Version:
1
Author:
VooDooMan
Date:
2005

Definition at line 64 of file library_php_2.inc.php.


Member Function Documentation

c_input::get_channel  ) 
 

Gets channel from SCRIPT command.

Version:
1
Author:
VooDooMan
Date:
2005
Returns:
Returns channel name

Definition at line 99 of file library_php_2.inc.php.

00099                            {
00100         return $this->channel;
00101     }

c_input::get_param index  ) 
 

Gets parameter.

Version:
1
Author:
VooDooMan
Date:
2005
Parameters:
index Zero-based index of parameter
Returns:
Returns parameter at given index
Return values:
NULL Returns NULL if index is out of the range

Definition at line 112 of file library_php_2.inc.php.

00113     {
00114         if($index>=count($this->params))
00115             return NULL;
00116         return $this->params[$index];
00117     }

c_input::init channel  ) 
 

Initialization: clean-up.

Version:
1
Author:
VooDooMan
Date:
2005
Parameters:
channel Name of channel

Definition at line 75 of file library_php_2.inc.php.

References $channel.

00075                             {
00076         $this->channel=$channel;
00077         $this->params=array();
00078     }

c_input::set_next_parameter value  ) 
 

Adds a new parameter to the array.

Version:
1
Author:
VooDooMan
Date:
2005
Parameters:
value Value as next parameter
Warning:
For internal use only

Definition at line 88 of file library_php_2.inc.php.

00088                                         {
00089         array_push($this->params,$value);
00090     }


Member Data Documentation

c_input::$channel
 

Name of channel (if applicable).

Definition at line 65 of file library_php_2.inc.php.

Referenced by init().

c_input::$params
 

Array of input parameters.

Definition at line 66 of file library_php_2.inc.php.


The documentation for this class was generated from the following file:
Generated on Sun Jul 24 16:21:26 2005 for Library for "php_2" scripting by  doxygen 1.4.3