Files
doc-fr/reference/datetime/datetimezone/getoffset.xml
2023-02-25 14:33:38 -05:00

110 lines
3.4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e057f1f552548a68030830e96ae1bdf313b1794e Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="datetimezone.getoffset" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateTimeZone::getOffset</refname>
<refname>timezone_offset_get</refname>
<refpurpose>Retourne le décalage GMT d'un fuseau horaire</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="DateTimeZone">
<modifier>public</modifier> <type>int</type><methodname>DateTimeZone::getOffset</methodname>
<methodparam><type>DateTimeInterface</type><parameter>datetime</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis>
<type>int</type><methodname>timezone_offset_get</methodname>
<methodparam><type>DateTimeZone</type><parameter>object</parameter></methodparam>
<methodparam><type>DateTimeInterface</type><parameter>datetime</parameter></methodparam>
</methodsynopsis>
<para>
<function>timezone_offset_get</function> retourne le décalage horaire par
rapport au GMT pour le paramètre <parameter>datetime</parameter>. Le
décalage GMT est calculé à partir des informations de fuseau horaire
contenu dans l'objet <classname>DateTime</classname>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&date.datetimezone.description;
<varlistentry>
<term><parameter>datetime</parameter></term>
<listitem>
<para>
Objet <classname>DateTime</classname> qui contient la date
dont il faut calculer le décalage.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne le décalage horaire, exprimé en secondes, en cas de succès.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemple avec <function>DateTimeZone::getOffset</function></title>
<programlisting role="php">
<![CDATA[
<?php
// Crée deux objets fuseau horaire, un pour Taipei (Taiwan) et un pour
// Tokyo (Japon)
$dateTimeZoneTaipei = new DateTimeZone("Asia/Taipei");
$dateTimeZoneJapan = new DateTimeZone("Asia/Tokyo");
// Crée deux objets DateTime qui contiennent le même timestamp Unix,
// mais sont situés dans deux fuseaux horaires différents.
$dateTimeTaipei = new DateTime("now", $dateTimeZoneTaipei);
$dateTimeJapan = new DateTime("now", $dateTimeZoneJapan);
// Calcule le décalage horaire GMT pour l'objet $dateTimeTaipei
// mais en utilisant le fuseau horaire de Tokyo
// ($dateTimeZoneJapan).
$timeOffset = $dateTimeZoneJapan->getOffset($dateTimeTaipei);
// Devrait afficher int(32400) (pour les dates après le Sat Sep 8 01:00:00 1951 JST).
var_dump($timeOffset);
?>
]]>
</programlisting>
</example>
</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:"~/.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
-->