Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/Datetime/DateFormatterInterface.php

	Code Coverage
	Classes and Traits		Functions and Methods				Lines
Total	100.00% covered (success)	0 / 0	100.00% covered (success)	100.00%	0 / 0	CRAP	100.00% covered (success)	100.00%	0 / 0

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Core\Datetime\DateFormatterInterface.
6	*/
7
8	namespace Drupal\Core\Datetime;
9
10	/**
11	* Provides an interface defining a date formatter.
12	*/
13	interface DateFormatterInterface {
14
15	/**
16	* Formats a date, using a date type or a custom date format string.
17	*
18	* @param int $timestamp
19	* A UNIX timestamp to format.
20	* @param string $type
21	* (optional) The format to use, one of:
22	* - One of the built-in formats: 'short', 'medium',
23	* 'long', 'html_datetime', 'html_date', 'html_time',
24	* 'html_yearless_date', 'html_week', 'html_month', 'html_year'.
25	* - The name of a date type defined by a date format config entity.
26	* - The machine name of an administrator-defined date format.
27	* - 'custom', to use $format.
28	* Defaults to 'medium'.
29	* @param string $format
30	* (optional) If $type is 'custom', a PHP date format string suitable for
31	* input to date(). Use a backslash to escape ordinary text, so it does not
32	* get interpreted as date format characters.
33	* @param string\|null $timezone
34	* (optional) Time zone identifier, as described at
35	* http://php.net/manual/timezones.php Defaults to the time zone used to
36	* display the page.
37	* @param string\|null $langcode
38	* (optional) Language code to translate to. NULL (default) means to use
39	* the user interface language for the page.
40	*
41	* @return string
42	* A translated date string in the requested format. Since the format may
43	* contain user input, this value should be escaped when output.
44	*/
45	public function format($timestamp, $type = 'medium', $format = '', $timezone = NULL, $langcode = NULL);
46
47	/**
48	* Formats a time interval with the requested granularity.
49	*
50	* Note that for intervals over 30 days, the output is approximate: a "month"
51	* is always exactly 30 days, and a "year" is always 365 days. It is not
52	* possible to make a more exact representation, given that there is only one
53	* input in seconds. If you are formatting an interval between two specific
54	* timestamps, use \Drupal\Core\Datetime\DateFormatter::formatDiff() instead.
55	*
56	* @param int $interval
57	* The length of the interval in seconds.
58	* @param int $granularity
59	* (optional) How many different units to display in the string (2 by
60	* default).
61	* @param string\|null $langcode
62	* (optional) langcode: The language code for the language used to format
63	* the date. Defaults to NULL, which results in the user interface language
64	* for the page being used.
65	*
66	* @return string
67	* A translated string representation of the interval.
68	*
69	* @see \Drupal\Core\Datetime\DateFormatterInterface::formatDiff()
70	*/
71	public function formatInterval($interval, $granularity = 2, $langcode = NULL);
72
73	/**
74	* Provides values for all date formatting characters for a given timestamp.
75	*
76	* @param string\|null $langcode
77	* (optional) Language code of the date format, if different from the site
78	* default language.
79	* @param int\|null $timestamp
80	* (optional) The Unix timestamp to format, defaults to current time.
81	* @param string\|null $timezone
82	* (optional) The timezone to use, if different from the site's default
83	* timezone.
84	*
85	* @return array
86	* An array of formatted date values, indexed by the date format character.
87	*
88	* @see date()
89	*/
90	public function getSampleDateFormats($langcode = NULL, $timestamp = NULL, $timezone = NULL);
91
92	/**
93	* Formats the time difference from the current request time to a timestamp.
94	*
95	* @param $timestamp
96	* A UNIX timestamp to compare against the current request time.
97	* @param array $options
98	* (optional) An associative array with additional options. The following
99	* keys can be used:
100	* - granularity: An integer value that signals how many different units to
101	* display in the string. Defaults to 2.
102	* - langcode: The language code for the language used to format the date.
103	* Defaults to NULL, which results in the user interface language for the
104	* page being used.
105	* - strict: A Boolean value indicating whether or not the timestamp can be
106	* before the current request time. If TRUE (default) and $timestamp is
107	* before the current request time, the result string will be "0 seconds".
108	* If FALSE and $timestamp is before the current request time, the result
109	* string will be the formatted time difference.
110	*
111	* @return string
112	* A translated string representation of the difference between the given
113	* timestamp and the current request time. This interval is always positive.
114	*
115	* @see \Drupal\Core\Datetime\DateFormatterInterface::formatDiff()
116	* @see \Drupal\Core\Datetime\DateFormatterInterface::formatTimeDiffSince()
117	*/
118	public function formatTimeDiffUntil($timestamp, $options = array());
119
120	/**
121	* Formats the time difference from a timestamp to the current request time.
122	*
123	* @param $timestamp
124	* A UNIX timestamp to compare against the current request time.
125	* @param array $options
126	* (optional) An associative array with additional options. The following
127	* keys can be used:
128	* - granularity: An integer value that signals how many different units to
129	* display in the string. Defaults to 2.
130	* - langcode: The language code for the language used to format the date.
131	* Defaults to NULL, which results in the user interface language for the
132	* page being used.
133	* - strict: A Boolean value indicating whether or not the timestamp can be
134	* after the current request time. If TRUE (default) and $timestamp is
135	* after the current request time, the result string will be "0 seconds".
136	* If FALSE and $timestamp is after the current request time, the result
137	* string will be the formatted time difference.
138	*
139	* @return string
140	* A translated string representation of the difference between the given
141	* timestamp and the current request time. This interval is always positive.
142	*
143	* @see \Drupal\Core\Datetime\DateFormatterInterface::formatDiff()
144	* @see \Drupal\Core\Datetime\DateFormatterInterface::formatTimeDiffUntil()
145	*/
146	public function formatTimeDiffSince($timestamp, $options = array());
147
148	/**
149	* Formats a time interval between two timestamps.
150	*
151	* @param int $from
152	* A UNIX timestamp, defining the from date and time.
153	* @param int $to
154	* A UNIX timestamp, defining the to date and time.
155	* @param array $options
156	* (optional) An associative array with additional options. The following
157	* keys can be used:
158	* - granularity: An integer value that signals how many different units to
159	* display in the string. Defaults to 2.
160	* - langcode: The language code for the language used to format the date.
161	* Defaults to NULL, which results in the user interface language for the
162	* page being used.
163	* - strict: A Boolean value indicating whether or not the $from timestamp
164	* can be after the $to timestamp. If TRUE (default) and $from is after
165	* $to, the result string will be "0 seconds". If FALSE and $from is
166	* after $to, the result string will be the formatted time difference.
167	*
168	* @return string
169	* A translated string representation of the interval. This interval is
170	* always positive.
171	*
172	* @see \Drupal\Core\Datetime\DateFormatterInterface::formatInterval()
173	* @see \Drupal\Core\Datetime\DateFormatterInterface::formatTimeDiffSince()
174	* @see \Drupal\Core\Datetime\DateFormatterInterface::formatTimeDiffUntil()
175	*/
176	public function formatDiff($from, $to, $options = array());
177
178	}