DBFieldDateTime Class Reference
[Model]

A date and time field in DB. More...

Inheritance diagram for DBFieldDateTime:

List of all members.

Public Member Functions
	convert_result ($value)
	Transform result from SELECT to native.
	format ($value)
	Reformat passed value to DB format.
	format_select ()
	Allow replacements for field in select from clause.
	format_where ($value)
	Format for use in WHERE clause.
	get_field_default ()
	Returns the default value for this field.
	validate ($value)
	Returns true, if the value passed fits the fields restrictions.
Public Attributes
const	NOW = 'now'
const	TIMESTAMP = 32
Protected Member Functions
	format_date_value ($value)
	Formats a value for use in DB.
	get_db_now_constant ()
	Returns fucntion or constant to set current time in DB (like NOW() or CURRENT_TIMESTAMP).

---

Detailed Description

A date and time field in DB.

Author:

Gerd Riesselmann

Definition at line 8 of file dbfield.datetime.cls.php.

---

Member Function Documentation

DBFieldDateTime::convert_result

(

$

value

)

Transform result from SELECT to native.

Parameters:

mixed

$value

Returns:

mixed

Reimplemented from DBField.

Definition at line 121 of file dbfield.datetime.cls.php.

                                               {
                return is_null($value) ? null : GyroDate::datetime($value);
        }       

DBFieldDateTime::format

(

$

value

)

Reformat passed value to DB format.

Parameters:

mixed

$value

Returns:

string

Reimplemented from DBField.

Definition at line 34 of file dbfield.datetime.cls.php.

                                       {
                if ($this->has_policy(self::TIMESTAMP)) {
                        return 'DEFAULT';        
                }
                
                // Treat '', false and 0 as NULL in updates and inserts
                if (empty($value)) {
                        return $this->do_format_null(null);
                }
                else {
                        return $this->format_where($value);
                }
        }

DBFieldDateTime::format_date_value

(

$

value

)

[protected]

Formats a value for use in DB.

Parameters:

datetime

$value

Returns:

string

Reimplemented in DBFieldDate, and DBFieldTime.

Definition at line 104 of file dbfield.datetime.cls.php.

                                                     {
                return $this->quote(GyroDate::mysql_date($value));      
        }

DBFieldDateTime::format_select

(

)

Allow replacements for field in select from clause.

Reimplemented from DBField.

Reimplemented in DBFieldTime.

Definition at line 111 of file dbfield.datetime.cls.php.

                                        {
                return 'UNIX_TIMESTAMP(' . parent::format_select() . ')';       
        }

DBFieldDateTime::format_where

(

$

value

)

Format for use in WHERE clause.

Parameters:

mixed

$value

Returns:

string

Reimplemented from DBField.

Definition at line 54 of file dbfield.datetime.cls.php.

                                             {
                if ($this->is_null($value)) {
                        return parent::format($value);
                }
                else if ($value == self::NOW) {
                        return $this->get_db_now_constant();
                } 
                else {
                        return $this->format_date_value(GyroDate::datetime($value));;
                }
        }       

DBFieldDateTime::get_db_now_constant

(

)

[protected]

Returns fucntion or constant to set current time in DB (like NOW() or CURRENT_TIMESTAMP).

Returns:

string

Reimplemented in DBFieldDate, and DBFieldTime.

Definition at line 94 of file dbfield.datetime.cls.php.

                                                 {
                return 'CURRENT_TIMESTAMP';
        }

DBFieldDateTime::get_field_default

(

)

Returns the default value for this field.

Returns:

mixed

Reimplemented from DBField.

Definition at line 17 of file dbfield.datetime.cls.php.

                                            {
                if ($this->has_policy(self::TIMESTAMP)) {
                        return null; // Timestamps are managed entirely by DB
                }
                $ret = parent::get_field_default();
                if ($ret == self::NOW) {
                        $ret = time();
                }
                return $ret;            
        }

DBFieldDateTime::validate

(

$

value

)

Returns true, if the value passed fits the fields restrictions.

Parameters:

mixed

$value

Returns:

Status

Reimplemented from DBField.

Definition at line 72 of file dbfield.datetime.cls.php.

                                         {
                $ret = parent::validate($value);
                if ($ret->is_ok()) {
                        $test = GyroDate::datetime($value);
                        if ($test === false) {
                                $ret->append(tr(
                                        '%field must be a date and time value', 
                                        'core', 
                                        array(
                                                '%field' => $this->get_field_name_translation()
                                        )
                                ));
                        }
                }
                return $ret;
        }       

---

Member Data Documentation

const DBFieldDateTime::NOW = 'now'

Definition at line 9 of file dbfield.datetime.cls.php.

const DBFieldDateTime::TIMESTAMP = 32

Definition at line 10 of file dbfield.datetime.cls.php.

---

The documentation for this class was generated from the following file:

• gyro/core/model/base/fields/dbfield.datetime.cls.php