File: microtime.xml

package info (click to toggle)
phpdoc 20050512-1
  • links: PTS
  • area: non-free
  • in suites: sarge
  • size: 36,592 kB
  • ctags: 1,501
  • sloc: xml: 376,768; php: 6,708; cpp: 500; makefile: 293; perl: 161; sh: 151; awk: 28
file content (109 lines) | stat: -rw-r--r-- 2,795 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.13 $ -->
<!-- splitted from ./en/functions/datetime.xml, last change in rev 1.2 -->
<refentry id="function.microtime">
 <refnamediv>
  <refname>microtime</refname>
  <refpurpose>Return current Unix timestamp with microseconds</refpurpose>
 </refnamediv>
 <refsect1>
  <title>Description</title>
  <methodsynopsis>
   <type>mixed</type><methodname>microtime</methodname>
   <methodparam choice="opt"><type>bool</type><parameter>get_as_float</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>microtime</function> returns the current Unix timestamp with
   microseconds. This function is only available on operating systems that
   support the gettimeofday() system call.
  </para>
  <para>
   When called without the optional argument, this function returns the string
   "msec sec" where sec is the current time measured in the number of
   seconds since the Unix Epoch (0:00:00 January 1, 1970 GMT), and
   msec is the microseconds part.
   Both portions of the string are returned in units of seconds.
  </para>
  <para>
   When <parameter>get_as_float</parameter> is given, and evaluates to
   &true;, <function>microtime</function> will return a float.
  </para>
  <note>
   <simpara>
    The <parameter>get_as_float</parameter> parameter was added as of
    PHP 5.0.0.
   </simpara>
  </note>
  <para>
   <example>
    <title>Timing script execution with <function>microtime</function></title>
    <programlisting role="php">
<![CDATA[
<?php
/**
 * Simple function to replicate PHP 5 behaviour
 */
function microtime_float()
{
    list($usec, $sec) = explode(" ", microtime());
    return ((float)$usec + (float)$sec);
}

$time_start = microtime_float();

// Sleep for a while
usleep(100);

$time_end = microtime_float();
$time = $time_end - $time_start;

echo "Did nothing in $time seconds\n";
?>
]]>
    </programlisting>
   </example>
   <example>
    <title>Timing script execution in PHP 5</title>
    <programlisting role="php">
<![CDATA[
<?php
$time_start = microtime(true);

// Sleep for a while
usleep(100);

$time_end = microtime(true);
$time = $time_end - $time_start;

echo "Did nothing in $time seconds\n";
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   See also <function>time</function>.
  </para>
 </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->