Files
Leonardo Lara Rodrigues 0d70ce9606 sync with en rev
2025-10-31 10:29:48 -03:00

111 lines
3.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 3a8c3e77df070a046c9d5b56b68926ca2d7e5ee3 Maintainer: leonardolara Status: ready --><!-- CREDITS: fabioluciano, leonardolara -->
<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>Retorna o deslocamento do fuso horário em relação ao GMT</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>
Esta função retorna o deslocamento em relação ao GMT para a data/horário especificada
no parâmetro <parameter>datetime</parameter>. O deslocamento GMT é calculado
com informação do fuso horário contido no objeto DateTimeZone utilizado.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&date.datetimezone.description;
<varlistentry>
<term><parameter>datetime</parameter></term>
<listitem>
<para>
DateTime que contém a data/horário a partir da qual será computado o deslocamento.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retorna o deslocamento do fuso horário em segundos.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemplos do método <function>DateTimeZone::getOffset</function></title>
<programlisting role="php">
<![CDATA[
<?php
// Cria dois objetos de fuso horário, um para Taipei (Taiwan) e um para
// Tokyo (Japão)
$dateTimeZoneTaipei = new DateTimeZone("Asia/Taipei");
$dateTimeZoneJapan = new DateTimeZone("Asia/Tokyo");
// Cria dois objetos DateTime que irão conter o mesmo timestamp Unix, mas
// têm fusos horários diferentes anexados a eles.
$dateTimeTaipei = new DateTime("now", $dateTimeZoneTaipei);
$dateTimeJapan = new DateTime("now", $dateTimeZoneJapan);
// Calcula o deslocamento GMT para a data/horário contida no objeto $dateTimeTaipei,
// mas usando as regras de fuso horário como definidas para Tokyo
// ($dateTimeZoneJapan).
$timeOffset = $dateTimeZoneJapan->getOffset($dateTimeTaipei);
// Deve mostrar int(32400) (para datas após Sat Sep 8 01:00:00 1951 JST).
var_dump($timeOffset);
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
int(32400)
]]>
</screen>
</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
-->