| alpha--model--types

# Class: Timestamp Source Location: /model/types/Timestamp.inc ## Class Timestamp Class Overview
Implements interfaces: AlphaTypeInterface The Timestamp complex data type Located in /model/types/Timestamp.inc [line 51]
    AlphaType
       |
       --Timestamp
Author(s): John Collins <dev@alphaframework.org> Information Tags:
Version: | $Id: Timestamp.inc 1462 2011-12-08 21:06:18Z johnc $
Copyright: | Copyright (c) 2011, John Collins (founder of Alpha Framework). All rights reserved.
     Redistribution and use in source and binary forms, with or
     without modification, are permitted provided that the
     following conditions are met:

     * Redistributions of source code must retain the above
       copyright notice, this list of conditions and the
       following disclaimer.
     * Redistributions in binary form must reproduce the above
       copyright notice, this list of conditions and the
       following disclaimer in the documentation and/or other
       materials provided with the distribution.
     * Neither the name of the Alpha Framework nor the names
       of its contributors may be used to endorse or promote
       products derived from this software without specific
       prior written permission.

     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
     CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
     INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
     MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
     CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
     OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Since: | 1.0
License: | The BSD License
| Methods __construct getDate getDay getEuroValue getHelper getHour getMinute getMonth getRule getSecond getTime getUnixValue getValue getWeekday getYear populateFromString setDate setHelper setRule setTime setTimestampValue setValue
[ Top ] Inherited Properties, Constants, and Methods
Inherited Properties | Inherited Methods | Inherited Constants
--- | --- | ---
| Inherited From AlphaType AlphaType::getHelper() Used to get the validation helper message string AlphaType::setHelper() Set the validation helper text AlphaType::__toString() Used to convert the object to a printable string |
[ Top ] Method Summary
Timestamp | __construct() | Constructor
string | getDate() | Getter for the date part
string | getDay() | Getter for the day part
string | getEuroValue() | Get the date value as a string in the format "DD/MM/YYYY"
string | getHelper() | Get the validation helper text
string | getHour() | Getter for the hour part
string | getMinute() | Getter for the minute part
string | getMonth() | Getter for the month part
string | getRule() | Get the validation rule
string | getSecond() | Getter for the second part
string | getTime() | Getter for the time part
integer | getUnixValue() | Return the value in UNIX timestamp format
string | getValue() | Getter for the Timestamp value
string | getWeekday() | Get the textual weekday part, e.g. Monday
string | getYear() | Getter for the year part
void | populateFromString() | Accepts a full date/time string in YYYY-mm-dd hh:ii:ss format
void | setDate() | Setter for the date part
void | setHelper() | Set the validation helper text
void | setRule() | Set the validation rule
void | setTime() | Setter for the time part
void | setTimestampValue() | Setter for the timestamp value
void | setValue() | Accepts a full date/time string in YYYY-mm-dd hh:ii:ss format
[ Top ] Methods Constructor __construct [line 130]
`Timestamp __construct( [ $timestamp = ''] )`
Constructor Parameters:
| $timestamp: |
API Tags:
Access: | public
Information Tags:
Since: | 1.0
Throws: | IllegalArguementException
[ Top ] getDate [line 241]
`string getDate( )`
Getter for the date part API Tags:
Access: | public
Information Tags:
Since: | 1.0
[ Top ] getDay [line 323]
`string getDay( )`
Getter for the day part API Tags:
Access: | public
Information Tags:
Since: | 1.0
[ Top ] getEuroValue [line 251]
`string getEuroValue( )`
Get the date value as a string in the format "DD/MM/YYYY" API Tags:
Access: | public
Information Tags:
Since: | 1.0
[ Top ] getHelper [line 523]
`string getHelper( )`
Get the validation helper text API Tags:
Access: | public
Information Tags:
Since: | 1.0
Redefinition of: AlphaType::getHelper() Used to get the validation helper message string Implementation of: AlphaTypeInterface::getHelper() Get the validation helper text [ Top ] getHour [line 343]
`string getHour( )`
Getter for the hour part API Tags:
Access: | public
Information Tags:
Since: | 1.0
[ Top ] getMinute [line 353]
`string getMinute( )`
Getter for the minute part API Tags:
Access: | public
Information Tags:
Since: | 1.0
[ Top ] getMonth [line 313]
`string getMonth( )`
Getter for the month part API Tags:
Access: | public
Information Tags:
Since: | 1.0
[ Top ] getRule [line 503]
`string getRule( )`
Get the validation rule API Tags:
Access: | public
Information Tags:
Since: | 1.0
[ Top ] getSecond [line 363]
`string getSecond( )`
Getter for the second part API Tags:
Access: | public
Information Tags:
Since: | 1.0
[ Top ] getTime [line 293]
`string getTime( )`
Getter for the time part API Tags:
Access: | public
Information Tags:
Since: | 1.0
[ Top ] getUnixValue [line 231]
`integer getUnixValue( )`
Return the value in UNIX timestamp format API Tags:
Access: | public
Information Tags:
Since: | 1.0
[ Top ] getValue [line 221]
`string getValue( )`
Getter for the Timestamp value API Tags:
Access: | public
Information Tags:
Since: | 1.0
Implementation of: AlphaTypeInterface::getValue() Get the value [ Top ] getWeekday [line 333]
`string getWeekday( )`
Get the textual weekday part, e.g. Monday API Tags:
Access: | public
Information Tags:
Since: | 1.0
[ Top ] getYear [line 303]
`string getYear( )`
Getter for the year part API Tags:
Access: | public
Information Tags:
Since: | 1.0
[ Top ] populateFromString [line 402]
`void populateFromString( string $dateTime )`
Accepts a full date/time string in YYYY-mm-dd hh:ii:ss format Parameters:
string | $dateTime: |
API Tags:
Access: | public
Information Tags:
Since: | 1.0
Throws: | IllegalArguementException
[ Top ] setDate [line 264]
`void setDate( integer $year, integer $month, integer $day )`
Setter for the date part Parameters:
integer | $year: |
integer | $month: |
integer | $day: |
API Tags:
Access: | public
Information Tags:
Since: | 1.0
Throws: | IllegalArguementException
[ Top ] setHelper [line 533]
`void setHelper( string $helper )`
Set the validation helper text Parameters:
string | $helper: |
API Tags:
Access: | public
Information Tags:
Since: | 1.0
Redefinition of: AlphaType::setHelper() Set the validation helper text Implementation of: AlphaTypeInterface::setHelper() Set the validation helper text [ Top ] setRule [line 513]
`void setRule( string $rule )`
Set the validation rule Parameters:
string | $rule: |
API Tags:
Access: | public
Information Tags:
Since: | 1.0
[ Top ] setTime [line 376]
`void setTime( integer $hour, integer $minute, integer $second )`
Setter for the time part Parameters:
integer | $hour: |
integer | $minute: |
integer | $second: |
Information Tags:
Throws: | IllegalArguementException
Since: | 1.0
[ Top ] setTimestampValue [line 183]
`void setTimestampValue( integer $year, integer $month, integer $day, integer $hour, integer $minute, integer $second )`
Setter for the timestamp value Parameters:
integer | $year: |
integer | $month: |
integer | $day: |
integer | $hour: |
integer | $minute: |
integer | $second: |
API Tags:
Access: | public
Information Tags:
Since: | 1.0
Throws: | IllegalArguementException
[ Top ] setValue [line 167]
`void setValue( string $dateTime )`
Accepts a full date/time string in YYYY-mm-dd hh:ii:ss format Parameters:
string | $dateTime: |
API Tags:
Access: | public
Information Tags:
Since: | 1.0
Implementation of: AlphaTypeInterface::setValue() Set the value of the type [ Top ] Documentation generated on Tue, 13 Dec 2011 20:27:44 +0000 by phpDocumentor 1.4.3