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

<!-- $Revision$ -->

<!-- EN-Revision: 3a8c3e77df070a046c9d5b56b68926ca2d7e5ee3 Maintainer: PhilDaiguille Status: ready -->

<!-- Reviewed: no Maintainer: Marqitos -->

<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 el desplazamiento GMT de una zona horaria</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 función retorna el desplazamiento GMT para la fecha/hora especificada

en el parámetro <parameter>datetime</parameter>. El

desplazamiento GMT se calcula a partir de las informaciones de zona horaria

contenidas en el 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 contiene la fecha/hora desde la cual se debe calcular el desplazamiento.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Retorna el desplazamiento horario, expresado en segundos, en caso de éxito.

</para>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Ejemplo con <function>DateTimeZone::getOffset</function></title>

<programlisting role="php">

<![CDATA[

<?php

// Crea dos objetos zona horaria, uno para Taipei (Taiwán) y uno para

// Tokio (Japón)

$dateTimeZoneTaipei = new DateTimeZone("Asia/Taipei");

$dateTimeZoneJapan = new DateTimeZone("Asia/Tokyo");

// Crea dos objetos DateTime que contienen el mismo timestamp Unix,

// pero están situados en dos zonas horarias diferentes.

$dateTimeTaipei = new DateTime("now", $dateTimeZoneTaipei);

$dateTimeJapan = new DateTime("now", $dateTimeZoneJapan);

// Calcula el desplazamiento horario GMT para el objeto $dateTimeTaipei

// pero utilizando la zona horaria de Tokio

// ($dateTimeZoneJapan).

$timeOffset = $dateTimeZoneJapan->getOffset($dateTimeTaipei);

// Debería mostrar int(32400) (para las fechas posteriores al 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

-->