settime.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="datetime.settime" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>DateTime::setTime</refname>
  <refname>date_time_set</refname>
  <refpurpose>Sets the time</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>&style.oop;</para>
  <methodsynopsis role="oop">
   <modifier>public</modifier> <type>DateTime</type><methodname>DateTime::setTime</methodname>
   <methodparam><type>int</type><parameter>hour</parameter></methodparam>
   <methodparam><type>int</type><parameter>minute</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>second</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>&style.procedural;</para>
  <methodsynopsis role="procedural">
   <type>DateTime</type><methodname>date_time_set</methodname>
   <methodparam><type>DateTime</type><parameter>object</parameter></methodparam>
   <methodparam><type>int</type><parameter>hour</parameter></methodparam>
   <methodparam><type>int</type><parameter>minute</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>second</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   Resets the current time of the DateTime object to a different time.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   &date.datetime.description.modified;
   <varlistentry>
    <term><parameter>hour</parameter></term>
    <listitem>
     <para>
      Hour of the time.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>minute</parameter></term>
    <listitem>
     <para>
      Minute of the time.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>second</parameter></term>
    <listitem>
     <para>
      Second of the time.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &date.datetime.return.modifiedobjectorfalseforfailure;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &date.datetime.retval.changelog;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><function>DateTime::setTime</function> example</title>
   <para>&style.oop;</para>
   <programlisting role="php">
<![CDATA[
<?php
$date = new DateTime('2001-01-01');

$date->setTime(14, 55);
echo $date->format('Y-m-d H:i:s') . "\n";

$date->setTime(14, 55, 24);
echo $date->format('Y-m-d H:i:s') . "\n";
?>
]]>
   </programlisting>
   <para>&style.procedural;</para>
   <programlisting role="php">
<![CDATA[
<?php
$date = date_create('2001-01-01');

date_time_set($date, 14, 55);
echo date_format($date, 'Y-m-d H:i:s') . "\n";

date_time_set($date, 14, 55, 24);
echo date_format($date, 'Y-m-d H:i:s') . "\n";
?>
]]>
   </programlisting>
   &examples.outputs.similar;
   <screen>
<![CDATA[
2001-01-01 14:55:00
2001-01-01 14:55:24
]]>
   </screen>
  </example>
  <example>
   <title>Values exceeding ranges are added to their parent values</title>
   <programlisting role="php">
<![CDATA[
<?php
$date = new DateTime('2001-01-01');

$date->setTime(14, 55, 24);
echo $date->format('Y-m-d H:i:s') . "\n";

$date->setTime(14, 55, 65);
echo $date->format('Y-m-d H:i:s') . "\n";

$date->setTime(14, 65, 24);
echo $date->format('Y-m-d H:i:s') . "\n";

$date->setTime(25, 55, 24);
echo $date->format('Y-m-d H:i:s') . "\n";
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
2001-01-01 14:55:24
2001-01-01 14:56:05
2001-01-01 15:05:24
2001-01-02 01:55:24
]]>
   </screen>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><function>DateTime::setDate</function></member>
   <member><function>DateTime::setISODate</function></member>
  </simplelist>
 </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:"~/.phpdoc/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
-->