phpDocumentor CCL
[ class tree: CCL ] [ index: CCL ] [ all elements ]

Class: Enum

Source Location: /Enum.php

Class Enum

Descendants
Child Class Description
Set Set parameter class

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From Param

Param::$allow_html
Param::$default
Param::$display
Param::$hint
Param::$input_class
Param::$name
Param::$primary_key
Param::$required
Param::$title
Param::$type

Inherited From Param

Param::__construct()
Constructs parameter object
Param::cast()
Casts a value due to parameter type
Param::display()
Renders param value display in a correct way
Param::display_input()
Renders param input display in a correct way
Param::import()
Imports parameter value from user input
Param::prepare()
Prepares a parameter value for use in database statement

[ Top ]
Property Summary
array   $captions  
array   $values  

[ Top ]
Method Summary
Enum   __construct()   Parameter constructor
string   display()   Renders param value display in a correct way
string   display_input()   Renders param input display in a correct way
array   get_alternatives()   Gets an array of acceptable alternative values for this enumeration
mixed   import()   Imports parameter value from user input

[ Top ]
Properties
array   $captions = array() [line 21]
API Tags:
Access:  public


[ Top ]
array   $values = array() [line 17]
API Tags:
Access:  public


[ Top ]
Methods
Constructor __construct  [line 33]

  Enum __construct( int $type, string $name, array $values, [string $default = NULL], [bool $display = TRUE], [bool $required = FALSE]  )

Parameter constructor

Parameters:
int   $type:  Value type
string   $name:  Parameter name
array   $values:  Value alternatives
string   $default:  Default value
bool   $display:  Render it in templates
bool   $required:  Require it from user input

API Tags:
Access:  public


Redefinition of:
Param::__construct()
Constructs parameter object

[ Top ]
display  [line 124]

  string display( mixed $value  )

Renders param value display in a correct way

Parameters:
mixed   $value: 

API Tags:
Return:  Rendered display element
Access:  public


Redefinition of:
Param::display()
Renders param value display in a correct way

Redefined in descendants as:

[ Top ]
display_input  [line 144]

  string display_input( [mixed $value = NULL], [string $prefix = '']  )

Renders param input display in a correct way

Parameters:
mixed   $value: 
string   $prefix:  Input name prefix

API Tags:
See:  Param::title, Param::hint
Access:  public


Redefinition of:
Param::display_input()
Renders param input display in a correct way

Redefined in descendants as:

[ Top ]
get_alternatives  [line 53]

  array get_alternatives( )

Gets an array of acceptable alternative values for this enumeration


API Tags:
Return:  Possible values
Access:  public


[ Top ]
import  [line 94]

  mixed import( [string $method = 'P'], [string $prefix = '']  )

Imports parameter value from user input

Parameters:
string   $method:  Request method: P - post, G - get.
string   $prefix:  Input name prefix

API Tags:
Return:  Value on success or NULL if validation failed
Access:  public


Redefinition of:
Param::import()
Imports parameter value from user input

Redefined in descendants as:

[ Top ]

Documentation generated on Thu, 09 Jul 2009 14:11:34 +0400 by phpDocumentor 1.4.1