# Class Timestamp

The Timestamp complex data type

  AlphaType
  Timestamp implements AlphaTypeInterface

Package: alpha::model::types
Copyright: Copyright (c) 2012, 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.

License: The BSD License
Author: John Collins <dev@alphaframework.org>
Version: $Id: Timestamp.inc 1548 2012-07-29 17:07:07Z alphadevx $
Since: 1.0
Located at model/types/Timestamp.inc

Methods summary
`public` | # `__construct( mixed $timestamp = '' )` Constructor Constructor #### Throws ``IllegalArguementException`` #### Since 1.0
`public` | # `setValue( string $dateTime )` Accepts a full date/time string in YYYY-mm-dd hh:ii:ss format Accepts a full date/time string in YYYY-mm-dd hh:ii:ss format #### Parameters $dateTime `string` $dateTime #### Since 1.0 #### Implementation of `AlphaTypeInterface::setValue()`
`public` | # `setTimestampValue( integer $year, integer $month, integer $day, integer $hour, integer $minute, integer $second )` Setter for the timestamp value Setter for the timestamp value #### Parameters $year `integer` $year $month `integer` $month $day `integer` $day $hour `integer` $hour $minute `integer` $minute $second `integer` $second #### Throws ``IllegalArguementException`` #### Since 1.0
`public string` | # `getValue( )` Getter for the Timestamp value Getter for the Timestamp value #### Returns `string` #### Since 1.0 #### Implementation of `AlphaTypeInterface::getValue()`
`public integer` | # `getUnixValue( )` Return the value in UNIX timestamp format Return the value in UNIX timestamp format #### Returns `integer` #### Since 1.0
`public string` | # `getDate( )` Getter for the date part Getter for the date part #### Returns `string` #### Since 1.0
`public string` | # `getEuroValue( )` Get the date value as a string in the format "DD/MM/YYYY" Get the date value as a string in the format "DD/MM/YYYY" #### Returns `string` #### Since 1.0
`public` | # `setDate( integer $year, integer $month, integer $day )` Setter for the date part Setter for the date part #### Parameters $year `integer` $year $month `integer` $month $day `integer` $day #### Throws ``IllegalArguementException`` #### Since 1.0
`public string` | # `getTime( )` Getter for the time part Getter for the time part #### Returns `string` #### Since 1.0
`public string` | # `getYear( )` Getter for the year part Getter for the year part #### Returns `string` #### Since 1.0
`public string` | # `getMonth( )` Getter for the month part Getter for the month part #### Returns `string` #### Since 1.0
`public string` | # `getDay( )` Getter for the day part Getter for the day part #### Returns `string` #### Since 1.0
`public string` | # `getWeekday( )` Get the textual weekday part, e.g. Monday Get the textual weekday part, e.g. Monday #### Returns `string` #### Since 1.0
`public string` | # `getHour( )` Getter for the hour part Getter for the hour part #### Returns `string` #### Since 1.0
`public string` | # `getMinute( )` Getter for the minute part Getter for the minute part #### Returns `string` #### Since 1.0
`public string` | # `getSecond( )` Getter for the second part Getter for the second part #### Returns `string` #### Since 1.0
`public` | # `setTime( integer $hour, integer $minute, integer $second )` Setter for the time part Setter for the time part #### Parameters $hour `integer` $hour $minute `integer` $minute $second `integer` $second #### Throws ``IllegalArguementException`` #### Since 1.0
`public` | # `populateFromString( string $dateTime )` Accepts a full date/time string in YYYY-mm-dd hh:ii:ss format Accepts a full date/time string in YYYY-mm-dd hh:ii:ss format #### Parameters $dateTime `string` $dateTime #### Throws ``IllegalArguementException`` #### Since 1.0
`public string` | # `getRule( )` Get the validation rule Get the validation rule #### Returns `string` #### Since 1.0
`public` | # `setRule( string $rule )` Set the validation rule Set the validation rule #### Parameters $rule `string` $rule #### Since 1.0
`public string` | # `getHelper( )` Get the validation helper text Get the validation helper text #### Returns `string` #### Since 1.0 #### Overrides `AlphaType::getHelper()` #### Implementation of `AlphaTypeInterface::getHelper()`
`public` | # `setHelper( string $helper )` Set the validation helper text Set the validation helper text #### Parameters $helper `string` $helper #### Since 1.0 #### Overrides `AlphaType::setHelper()` #### Implementation of `AlphaTypeInterface::setHelper()`

Methods inherited from AlphaType
`__toString()`

Properties summary
`private integer` | $year | `` | # The year part The year part #### Since 1.0
`private integer` | $month | `` | # The month part The month part #### Since 1.0
`private integer` | $day | `` | # The day part The day part #### Since 1.0
`private integer` | $hour | `` | # The hour part The hour part #### Since 1.0
`private integer` | $minute | `` | # The minute part The minute part #### Since 1.0
`private integer` | $second | `` | # The second part The second part #### Since 1.0
`private string` | $weekday | `` | # The textual version of the day, e.g. Monday The textual version of the day, e.g. Monday #### Since 1.0
`private string` | $validationRule | `` | # The validation rule (reg-ex) applied to Date values The validation rule (reg-ex) applied to Date values #### Since 1.0
`private string` | $helper | `'Not a valid timestamp value! A timestamp should be in the format YYYY-MM-DD HH:MM:SS.'` | # The error message returned for invalid values The error message returned for invalid values #### Since 1.0