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

Class: DateStamp

Source Location: /DateStamp.php

Class DateStamp

Class Overview

Date parameter class. In Cotonti all date/time types are UNIX timestamps inside

Located in /DateStamp.php [line 13]

Param
   |
   --DateStamp

Methods

[ 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 ]
Method Summary
DateStamp   __construct()   Entity parameter constructor
string   display()   Renders param value display in a correct way
string   display_input()   Renders param input display in a correct way
int   import()   Imports parameter value from user input

[ Top ]
Methods
Constructor __construct  [line 23]

  DateStamp __construct( string $name, [bool $display = TRUE], [bool $required = FALSE], [bool $primary_key = FALSE]  )

Entity parameter constructor

Parameters:
string   $name:  Parameter name
bool   $display:  Render it in templates
bool   $required:  Require it from user input
bool   $primary_key:  Is primary key of the entity

API Tags:
Access:  public


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

[ Top ]
display  [line 81]

  string display( mixed $value  )

Renders param value display in a correct way

Parameters:
mixed   $value: 

API Tags:
Return:  Rendered display element
See:  Date::display_input(), Param::title, Param::hint
Access:  public


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

[ Top ]
display_input  [line 96]

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

Renders param input display in a correct way

Parameters:
mixed   $value: 
string   $prefix:  Input name prefix
bool   $separate:  Display date parts separately

API Tags:
See:  Date::display(), Param::title, Param::hint
Access:  public


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

[ Top ]
import  [line 34]

  int 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

[ Top ]

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