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

Class: Set

Source Location: /Set.php

Class Set

Class Overview

Set parameter class

Located in /Set.php [line 13]

Param
   |
   --Enum
      |
      --Set

Methods

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

Inherited From Enum

Enum::$captions
Enum::$values

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 Enum

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

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 ]
Method Summary
string   display()   Renders param value display in a correct way
string   display_input()   Renders param input display in a correct way
array   import()   Imports parameter value from user input
string   prepare()   Prepares a parameter value for use in database statement

[ Top ]
Methods
display  [line 77]

  string display( array $value  )

Renders param value display in a correct way

Parameters:
array   $value: 

API Tags:
Return:  Rendered display element
Access:  public


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

[ Top ]
display_input  [line 98]

  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:
Enum::display_input()
Renders param input display in a correct way

[ Top ]
import  [line 21]

  array 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:
Enum::import()
Imports parameter value from user input

[ Top ]
prepare  [line 60]

  string prepare( array $value  )

Prepares a parameter value for use in database statement

Parameters:
array   $value:  Source value

API Tags:
Return:  Prepared value
Access:  public


Redefinition of:
Param::prepare()
Prepares a parameter value for use in database statement

[ Top ]

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