PHP Class Ouzo\Utilities\Clock

Show file Open project: letsdrink/ouzo Class Usage Examples

Public Properties

Property Type Description
$dateTime
$freeze
$freezeDate DateTim\DateTime | Clock

Public Methods

Method Description
__construct ( DateTime $dateTime )
at ( $date ) : Clock Obtains a Clock set to to a specific point.
format ( $format = null )
freeze ( null $date = null ) Freezes time to a specific point or current time if no time is given.
fromTimestamp ( $timestamp ) : Clock Obtains a Clock set to to a specific point using Unix timestamp.
getTimestamp ( )
isAfter ( Clock $other )
isAfterOrEqualTo ( Clock $other )
isBefore ( Clock $other )
isBeforeOrEqualTo ( Clock $other )
minusDays ( $days )
minusHours ( $hours )
minusMinutes ( $minutes )
minusMonths ( $months )
minusSeconds ( $seconds )
minusYears ( $years )
now ( ) : Clock Obtains a Clock set to the current time.
nowAsString ( string $format = null ) : string Returns current time as a string.
plusDays ( $days )
plusHours ( $hours )
plusMinutes ( $minutes )
plusMonths ( $months )
plusSeconds ( $seconds )
plusYears ( $years )
setTimezone ( $timezone )
toDateTime ( ) : DateTime Converts this object to a DateTime

Private Methods

Method Description
_modify ( $interval )

Method Details

__construct() public method

public __construct ( DateTime $dateTime )
$dateTime DateTime

at() public static method

Obtains a Clock set to to a specific point.
public static at ( $date ) : Clock
$date
return Clock

format() public method

public format ( $format = null )

freeze() public static method

Freezes time to a specific point or current time if no time is given.
public static freeze ( null $date = null )
$date null

fromTimestamp() public static method

Obtains a Clock set to to a specific point using Unix timestamp.
public static fromTimestamp ( $timestamp ) : Clock
$timestamp
return Clock

getTimestamp() public method

public getTimestamp ( )

isAfter() public method

public isAfter ( Clock $other )
$other Clock

isAfterOrEqualTo() public method

public isAfterOrEqualTo ( Clock $other )
$other Clock

isBefore() public method

public isBefore ( Clock $other )
$other Clock

isBeforeOrEqualTo() public method

public isBeforeOrEqualTo ( Clock $other )
$other Clock

minusDays() public method

public minusDays ( $days )

minusHours() public method

public minusHours ( $hours )

minusMinutes() public method

public minusMinutes ( $minutes )

minusMonths() public method

public minusMonths ( $months )

minusSeconds() public method

public minusSeconds ( $seconds )

minusYears() public method

public minusYears ( $years )

now() public static method

Obtains a Clock set to the current time.
public static now ( ) : Clock
return Clock

nowAsString() public static method

Example: Clock::freeze('2011-01-02 12:34'); $result = Clock::nowAsString('Y-m-d'); Result: 2011-01-02
public static nowAsString ( string $format = null ) : string
$format string
return string

plusDays() public method

public plusDays ( $days )

plusHours() public method

public plusHours ( $hours )

plusMinutes() public method

public plusMinutes ( $minutes )

plusMonths() public method

public plusMonths ( $months )

plusSeconds() public method

public plusSeconds ( $seconds )

plusYears() public method

public plusYears ( $years )

setTimezone() public method

public setTimezone ( $timezone )

toDateTime() public method

Converts this object to a DateTime
public toDateTime ( ) : DateTime
return DateTime

Property Details

$dateTime public property

public $dateTime

$freeze public static property

public static $freeze

$freezeDate public static property

public static DateTime,DateTim|Clock,Ouzo\Utilities $freezeDate
return DateTim\DateTime | Clock