Time API - Revision history

Devdocsbot: Protected "Time API": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

2022-07-06T04:40:53Z

Protected "Time API": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

← Older revision	Revision as of 04:40, 6 July 2022
(No difference)

Devdocsbot: Update migration status and path

2022-07-06T04:38:27Z

Update migration status and path

← Older revision		Revision as of 04:38, 6 July 2022
Line 1:		Line 1:
			{{Template:Migrated\|newDocId=/docs/apis/subsystems/time/}}
	==Overview==		==Overview==

Mudrd8mz: Text replacement - "" to ""

2021-07-14T20:24:23Z

Text replacement - "</code>" to "</syntaxhighlight>"

← Older revision		Revision as of 20:24, 14 July 2021
Line 22:		Line 22:
	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
	$tomorrow = new DateTime("1 day", core_date::get_server_timezone_object());		$tomorrow = new DateTime("1 day", core_date::get_server_timezone_object());
	</~~code~~>		</syntaxhighlight>

	Get a timestamp for storing in the database:		Get a timestamp for storing in the database:
	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
	$tomorrowint = $tomorrow->getTimestamp();		$tomorrowint = $tomorrow->getTimestamp();
	</~~code~~>		</syntaxhighlight>

	Get a timestamp for 3pm tomorrow in the current users timezone.		Get a timestamp for 3pm tomorrow in the current users timezone.
Line 37:		Line 37:

	$timestamp = $time->getTimestamp();		$timestamp = $time->getTimestamp();
	</~~code~~>		</syntaxhighlight>

	Remember! NEVER NEVER NEVER add or subtract timestamps for any reason - you will get it wrong (DST is a killer)!		Remember! NEVER NEVER NEVER add or subtract timestamps for any reason - you will get it wrong (DST is a killer)!
Line 89:		Line 89:
	$now = time();		$now = time();
	echo userdate($now);		echo userdate($now);
	</~~code~~>		</syntaxhighlight>

	To manually specify the display format, use one of the formatting strings defined in the <tt>core_langconfig</tt> component of the user's language. For example, to display just the date without the time, use:		To manually specify the display format, use one of the formatting strings defined in the <tt>core_langconfig</tt> component of the user's language. For example, to display just the date without the time, use:
Line 95:		Line 95:
	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
	echo userdate(time(), get_string('strftimedaydate', 'core_langconfig'));		echo userdate(time(), get_string('strftimedaydate', 'core_langconfig'));
	</~~code~~>		</syntaxhighlight>

	You can also use the <tt>DateTime</tt> class to obtain the timestamp:		You can also use the <tt>DateTime</tt> class to obtain the timestamp:
Line 103:		Line 103:
	$date->setTime(0, 0, 0);		$date->setTime(0, 0, 0);
	echo userdate($date->getTimestamp(), get_string('strftimedatefullshort', 'core_langconfig'));		echo userdate($date->getTimestamp(), get_string('strftimedatefullshort', 'core_langconfig'));
	</~~code~~>		</syntaxhighlight>

	===System Time API===		===System Time API===

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T13:07:11Z
Text replacement - "<code>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:07, 14 July 2021
				
Line 20:
Line 20:
Example: Get the current server time + 1 day. Example: Get the current server time + 1 day.



<code> <syntaxhighlight lang="php">
$tomorrow = new DateTime("1 day", core_date::get_server_timezone_object()); $tomorrow = new DateTime("1 day", core_date::get_server_timezone_object());
</code> </code>



Get a timestamp for storing in the database: Get a timestamp for storing in the database:
<code> <syntaxhighlight lang="php">
$tomorrowint = $tomorrow->getTimestamp(); $tomorrowint = $tomorrow->getTimestamp();
</code> </code>
Line 31:
Line 31:
Get a timestamp for 3pm tomorrow in the current users timezone. Get a timestamp for 3pm tomorrow in the current users timezone.



<code> <syntaxhighlight lang="php">
$time = new DateTime("now", core_date::get_user_timezone_object()); $time = new DateTime("now", core_date::get_user_timezone_object());
$time->add(new DateInterval("P1D")); $time->add(new DateInterval("P1D"));
Line 86:
Line 86:
Prints the current date and time in the user's timezone: Prints the current date and time in the user's timezone:



<code> <syntaxhighlight lang="php">
$now = time(); $now = time();
echo userdate($now); echo userdate($now);
Line 93:
Line 93:
To manually specify the display format, use one of the formatting strings defined in the <tt>core_langconfig</tt> component of the user's language. For example, to display just the date without the time, use: To manually specify the display format, use one of the formatting strings defined in the <tt>core_langconfig</tt> component of the user's language. For example, to display just the date without the time, use:



<code> <syntaxhighlight lang="php">
echo userdate(time(), get_string('strftimedaydate', 'core_langconfig')); echo userdate(time(), get_string('strftimedaydate', 'core_langconfig'));
</code> </code>
Line 99:
Line 99:
You can also use the <tt>DateTime</tt> class to obtain the timestamp: You can also use the <tt>DateTime</tt> class to obtain the timestamp:



<code> <syntaxhighlight lang="php">
$date = new DateTime("tomorrow", core_date::get_user_timezone_object()); $date = new DateTime("tomorrow", core_date::get_user_timezone_object());
$date->setTime(0, 0, 0); $date->setTime(0, 0, 0);



Mudrd8mz: /* Time API's for current user */
2020-08-24T13:00:41Z
Time API's for current user

				
				
				
				
				
				← Older revision
				Revision as of 13:00, 24 August 2020
				
Line 88:
Line 88:
<code> <code>
$now = time(); $now = time();
echo userdate($now, get_string('strftimedaydatetime', 'core_langconfig')); echo userdate($now);
</code> </code>






Mudrd8mz: /* Time API's for current user */ Fix and extend the examples
2020-08-24T12:58:50Z
Time API's for current user:  Fix and extend the examples

				
				
				
				
				
				← Older revision
				Revision as of 12:58, 24 August 2020
				
Line 83:
Line 83:



===Time API's for current user=== ===Time API's for current user===
Prints a formatted date in user time  
<pre> Prints the current date and time in the user's timezone:
// Get current day, month and year for current user.  
$date = new DateTime("now", core_date::get_user_timezone_object()); <code>
$now = time();
echo userdate($now, get_string('strftimedaydatetime', 'core_langconfig'));
</code>
 
To manually specify the display format, use one of the formatting strings defined in the <tt>core_langconfig</tt> component of the user's language. For example, to display just the date without the time, use:
 
<code>
echo userdate(time(), get_string('strftimedaydate', 'core_langconfig'));
</code>
 
You can also use the <tt>DateTime</tt> class to obtain the timestamp:
 
<code>
$date = new DateTime("tomorrow", core_date::get_user_timezone_object());
$date->setTime(0, 0, 0); $date->setTime(0, 0, 0);
// Print formatted date in user time. echo userdate($date->getTimestamp(), get_string('strftimedatefullshort', 'core_langconfig'));
echo userdate($date->getTimestamp(), "Current user time"); </code>
</pre> 



===System Time API=== ===System Time API===



Davidbalch: /* Examples */
2020-05-21T12:58:41Z
Examples

				
				
				
				
				
				← Older revision
				Revision as of 12:58, 21 May 2020
				
Line 76:
Line 76:



==Examples== ==Examples==
===Create DateTime with date/time from a unixtime (number of seconds)===

$date = new DateTime();
$date->setTimestamp(intval($unixtime);
echo userdate($date->getTimestamp());

===Time API's for current user=== ===Time API's for current user===
Prints a formatted date in user time Prints a formatted date in user time
Line 99:
Line 105:
echo $dayofweek; echo $dayofweek;
</pre> </pre>




==See also== ==See also==



Davidbalch: /* DST */
2020-05-21T11:52:32Z
DST

				
				
				
				
				
				← Older revision
				Revision as of 11:52, 21 May 2020
				
Line 73:
Line 73:
Timezone depends on [[:en:Location]] of the user and can be forced upon by administrator. Timezone depends on [[:en:Location]] of the user and can be forced upon by administrator.
===DST=== ===DST===
DST is abbreviation of '''Daylight Saving Time''' (also known as '''Day light saving''' and "Summer Time"). Many countries, and sometimes just certain regions of countries, adopt daylight saving time during part of the year. Moodle automatically calculates DST for current user, depending on user location. DST is abbreviation of '''Daylight Saving Time''' (also known as "Day light saving" and "Summer Time"). Many countries, and sometimes just certain regions of countries, adopt daylight saving time during part of the year. Moodle automatically calculates DST for current user, depending on user location.



==Examples== ==Examples==





Davidbalch: /* DST */
2020-05-21T11:52:16Z
DST

				
				
				
				
				
				← Older revision
				Revision as of 11:52, 21 May 2020
				
Line 73:
Line 73:
Timezone depends on [[:en:Location]] of the user and can be forced upon by administrator. Timezone depends on [[:en:Location]] of the user and can be forced upon by administrator.
===DST=== ===DST===
DST is abbreviation of '''Day light saving'''. Many countries, and sometimes just certain regions of countries, adopt daylight saving time (also known as "Summer Time") during part of the year. Moodle automatically calculates DST for current user, depending on user location. DST is abbreviation of '''Daylight Saving Time''' (also known as '''Day light saving''' and "Summer Time"). Many countries, and sometimes just certain regions of countries, adopt daylight saving time during part of the year. Moodle automatically calculates DST for current user, depending on user location.
 
==Examples== ==Examples==
===Time API's for current user=== ===Time API's for current user===



Maherne at 14:12, 4 April 2019
2019-04-04T14:12:42Z


				
				
				
				
				
				← Older revision
				Revision as of 14:12, 4 April 2019
				
Line 44:
Line 44:
# Time API's for current user # Time API's for current user
#* '''make_timestamp''' - Given date-time, it produces a GMT timestamp for current user. #* '''make_timestamp''' - Given date-time, it produces a GMT timestamp for current user.
#* '''userdate''' - Gets formatted string that represents a date in user time #* '''userdate''' - Gets formatted string that represents a date in user time (note that the format required by this function is the [https://www.php.net/manual/en/function.strftime.php strftime()] format, not the more common format used by date())
#* '''usertime''' - Given a GMT timestamp (seconds since epoch), offsets it by the timezone.  eg 3pm in India is 3pm GMT - 5.5 * 3600 seconds #* '''usertime''' - Given a GMT timestamp (seconds since epoch), offsets it by the timezone.  eg 3pm in India is 3pm GMT - 5.5 * 3600 seconds
#* '''usergetdate''' - Given a timestamp in GMT, returns an array that represents the date-time in user time #* '''usergetdate''' - Given a timestamp in GMT, returns an array that represents the date-time in user time

← Older revision		Revision as of 13:07, 14 July 2021
Line 20:		Line 20:
	Example: Get the current server time + 1 day.		Example: Get the current server time + 1 day.

	<~~code~~>		<syntaxhighlight lang="php">
	$tomorrow = new DateTime("1 day", core_date::get_server_timezone_object());		$tomorrow = new DateTime("1 day", core_date::get_server_timezone_object());
	</code>		</code>

	Get a timestamp for storing in the database:		Get a timestamp for storing in the database:
	<~~code~~>		<syntaxhighlight lang="php">
	$tomorrowint = $tomorrow->getTimestamp();		$tomorrowint = $tomorrow->getTimestamp();
	</code>		</code>
Line 31:		Line 31:
	Get a timestamp for 3pm tomorrow in the current users timezone.		Get a timestamp for 3pm tomorrow in the current users timezone.

	<~~code~~>		<syntaxhighlight lang="php">
	$time = new DateTime("now", core_date::get_user_timezone_object());		$time = new DateTime("now", core_date::get_user_timezone_object());
	$time->add(new DateInterval("P1D"));		$time->add(new DateInterval("P1D"));
Line 86:		Line 86:
	Prints the current date and time in the user's timezone:		Prints the current date and time in the user's timezone:

	<~~code~~>		<syntaxhighlight lang="php">
	$now = time();		$now = time();
	echo userdate($now);		echo userdate($now);
Line 93:		Line 93:
	To manually specify the display format, use one of the formatting strings defined in the <tt>core_langconfig</tt> component of the user's language. For example, to display just the date without the time, use:		To manually specify the display format, use one of the formatting strings defined in the <tt>core_langconfig</tt> component of the user's language. For example, to display just the date without the time, use:

	<~~code~~>		<syntaxhighlight lang="php">
	echo userdate(time(), get_string('strftimedaydate', 'core_langconfig'));		echo userdate(time(), get_string('strftimedaydate', 'core_langconfig'));
	</code>		</code>
Line 99:		Line 99:
	You can also use the <tt>DateTime</tt> class to obtain the timestamp:		You can also use the <tt>DateTime</tt> class to obtain the timestamp:

	<~~code~~>		<syntaxhighlight lang="php">
	$date = new DateTime("tomorrow", core_date::get_user_timezone_object());		$date = new DateTime("tomorrow", core_date::get_user_timezone_object());
	$date->setTime(0, 0, 0);		$date->setTime(0, 0, 0);

← Older revision		Revision as of 13:00, 24 August 2020
Line 88:		Line 88:
	<code>		<code>
	$now = time();		$now = time();
	echo userdate($now~~, get_string('strftimedaydatetime', 'core_langconfig')~~);		echo userdate($now);
	</code>		</code>

← Older revision		Revision as of 12:58, 24 August 2020
Line 83:		Line 83:

	===Time API's for current user===		===Time API's for current user===
	Prints ~~a formatted~~ date in user time
	<~~pre~~>		Prints the current date and time in the user's timezone:
	/~~/ Get current day, month and year for current~~ user.
	$date = new DateTime("~~now~~", core_date::get_user_timezone_object());		<code>
			$now = time();
			echo userdate($now, get_string('strftimedaydatetime', 'core_langconfig'));
			</code>

			To manually specify the display format, use one of the formatting strings defined in the <tt>core_langconfig</tt> component of the user's language. For example, to display just the date without the time, use:

			<code>
			echo userdate(time(), get_string('strftimedaydate', 'core_langconfig'));
			</code>

			You can also use the <tt>DateTime</tt> class to obtain the timestamp:

			<code>
			$date = new DateTime("tomorrow", core_date::get_user_timezone_object());
	$date->setTime(0, 0, 0);		$date->setTime(0, 0, 0);
	~~// Print formatted date in user time.~~		echo userdate($date->getTimestamp(), get_string('strftimedatefullshort', 'core_langconfig'));
	echo userdate($date->getTimestamp(), ~~"Current user time"~~);		</code>
	</~~pre~~>

	===System Time API===		===System Time API===

← Older revision		Revision as of 12:58, 21 May 2020
Line 76:		Line 76:

	==Examples==		==Examples==
			===Create DateTime with date/time from a unixtime (number of seconds)===

			$date = new DateTime();
			$date->setTimestamp(intval($unixtime);
			echo userdate($date->getTimestamp());

	===Time API's for current user===		===Time API's for current user===
	Prints a formatted date in user time		Prints a formatted date in user time
Line 99:		Line 105:
	echo $dayofweek;		echo $dayofweek;
	</pre>		</pre>


	==See also==		==See also==

← Older revision		Revision as of 11:52, 21 May 2020
Line 73:		Line 73:
	Timezone depends on [[:en:Location]] of the user and can be forced upon by administrator.		Timezone depends on [[:en:Location]] of the user and can be forced upon by administrator.
	===DST===		===DST===
	DST is abbreviation of '''Daylight Saving Time''' (also known as ~~'''~~Day light saving~~'''~~ and "Summer Time"). Many countries, and sometimes just certain regions of countries, adopt daylight saving time during part of the year. Moodle automatically calculates DST for current user, depending on user location.		DST is abbreviation of '''Daylight Saving Time''' (also known as "Day light saving" and "Summer Time"). Many countries, and sometimes just certain regions of countries, adopt daylight saving time during part of the year. Moodle automatically calculates DST for current user, depending on user location.

	==Examples==		==Examples==

← Older revision		Revision as of 14:12, 4 April 2019
Line 44:		Line 44:
	# Time API's for current user		# Time API's for current user
	#* '''make_timestamp''' - Given date-time, it produces a GMT timestamp for current user.		#* '''make_timestamp''' - Given date-time, it produces a GMT timestamp for current user.
	#* '''userdate''' - Gets formatted string that represents a date in user time		#* '''userdate''' - Gets formatted string that represents a date in user time (note that the format required by this function is the [https://www.php.net/manual/en/function.strftime.php strftime()] format, not the more common format used by date())
	#* '''usertime''' - Given a GMT timestamp (seconds since epoch), offsets it by the timezone. eg 3pm in India is 3pm GMT - 5.5 * 3600 seconds		#* '''usertime''' - Given a GMT timestamp (seconds since epoch), offsets it by the timezone. eg 3pm in India is 3pm GMT - 5.5 * 3600 seconds
	#* '''usergetdate''' - Given a timestamp in GMT, returns an array that represents the date-time in user time		#* '''usergetdate''' - Given a timestamp in GMT, returns an array that represents the date-time in user time