Code Coverage
	Classes and Traits			Functions and Methods				Lines
Total		n/a	0 / 0		n/a	0 / 0	CRAP		n/a	0 / 0

1	<?php
2
3	namespace Popy\Calendar\ValueObject;
4
5	use DateTimeZone;
6
7	/**
8	* Date internal representation. This is a value object, which MUST be
9	* immutable.
10	*
11	* Keep in mind that this interface is only a date representation. The only real
12	* time value is the UNIX time/microtime couple, which represents a single
13	* moment of time, independant from timezone, DST, formats, and is expressed in
14	* a SI unit.
15	*
16	* An instance may not know the time/microtime it represents, for instance
17	* when it has been built by a parser.
18	*/
19	interface DateRepresentationInterface
20	{
21	/**
22	* Gets the unix time, if availanle.
23	*
24	* @return integer|null
25	*/
26	public function getUnixTime();
27
28	/**
29	* Gets the date's unix microtime, if available.
30	*
31	* @return integer|null
32	*/
33	public function getUnixMicroTime();
34
35	/**
36	* Gets time offset.
37	*
38	* @return TimeOffset
39	*/
40	public function getOffset();
41
42	/**
43	* Gets timezone.
44	*
45	* @return DateTimeZone
46	*/
47	public function getTimezone();
48
49	/**
50	* Gets a new date instance having the input unix time.
51	*
52	* @param integer|null $unixTime
53	*
54	* @return static
55	*/
56	public function withUnixTime($unixTime);
57
58	/**
59	* Gets a new date instance having the input unix microtime.
60	*
61	* @param integer|null $unixMicroTime
62	*
63	* @return static
64	*/
65	public function withUnixMicroTime($unixMicroTime);
66
67	/**
68	* Gets a new date instance having the input offset.
69	*
70	* @param TimeOffset $offset
71	*
72	* @return static
73	*/
74	public function withOffset(TimeOffset $offset);
75
76	/**
77	* Gets a new date instance having the input timezone.
78	*
79	* @param DateTimeZone $timezone
80	*
81	* @return static
82	*/
83	public function withTimezone(DateTimeZone $timezone);
84	}