[prev in list] [next in list] [prev in thread] [next in thread]
List: php-doc-cvs
Subject: [DOC-CVS] =?utf-8?q?svn:_/phpdoc/en/trunk/reference/datetime/_dateperiod/getdateinterval.xml_dateper
From: Peter_Cowburn <salathe () php ! net>
Date: 2016-05-17 20:41:56
Message-ID: svn-salathe-1463517716-339177-1308065304 () svn ! php ! net
[Download RAW message or body]
salathe Tue, 17 May 2016 20:41:56 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=339177
Log:
Document DatePeriod getStartDate(), getEndDate(), getDateInterval() methods
Changed paths:
A phpdoc/en/trunk/reference/datetime/dateperiod/getdateinterval.xml
A phpdoc/en/trunk/reference/datetime/dateperiod/getenddate.xml
A phpdoc/en/trunk/reference/datetime/dateperiod/getstartdate.xml
U phpdoc/en/trunk/reference/datetime/dateperiod.xml
U phpdoc/en/trunk/reference/datetime/versions.xml
["svn-diffs-339177.txt" (text/x-diff)]
Added: phpdoc/en/trunk/reference/datetime/dateperiod/getdateinterval.xml
===================================================================
--- phpdoc/en/trunk/reference/datetime/dateperiod/getdateinterval.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/datetime/dateperiod/getdateinterval.xml 2016-05-17 \
20:41:56 UTC (rev 339177) @@ -0,0 +1,88 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="dateperiod.getdateinterval" xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv>
+ <refname>DatePeriod::getDateInterval</refname>
+ <refpurpose>
+ Gets the interval
+ </refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <para>&style.oop;</para>
+ <methodsynopsis role="oop">
+ <modifier>public</modifier> \
<type>DateInterval</type><methodname>DatePeriod::getDateInterval</methodname> + \
<void /> + </methodsynopsis>
+ <para>
+ Gets a <classname>DateInterval</classname> <type>object</type>
+ representing the interval used for the period.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns a <classname>DateInterval</classname> <type>object</type>
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <example>
+ <title><methodname>DatePeriod::getDateInterval</methodname> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+$period = new DatePeriod('R7/2016-05-16T00:00:00Z/P1D');
+$interval = $period->getDateInterval();
+echo $interval->format('%d day');
+?>
+]]>
+ </programlisting>
+ &example.outputs;
+ <screen>
+<![CDATA[
+1 day
+]]>
+ </screen>
+ </example>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><methodname>DatePeriod::getStartDate</methodname></member>
+ <member><methodname>DatePeriod::getEndDate</methodname></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
+-->
Property changes on: \
phpdoc/en/trunk/reference/datetime/dateperiod/getdateinterval.xml \
___________________________________________________________________
Added: svn:eol-style
+ native
Added: svn:keywords
+ Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy \
HeadURL URL
Added: phpdoc/en/trunk/reference/datetime/dateperiod/getenddate.xml
===================================================================
--- phpdoc/en/trunk/reference/datetime/dateperiod/getenddate.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/datetime/dateperiod/getenddate.xml 2016-05-17 20:41:56 \
UTC (rev 339177) @@ -0,0 +1,126 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="dateperiod.getenddate" xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv>
+ <refname>DatePeriod::getEndDate</refname>
+ <refpurpose>
+ Gets the end date
+ </refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <para>&style.oop;</para>
+ <methodsynopsis role="oop">
+ <modifier>public</modifier> \
<type>DateTimeInterface</type><methodname>DatePeriod::getEndDate</methodname> + \
<void /> + </methodsynopsis>
+ <para>
+ Gets the end date of the period.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns &null; if the <classname>DatePeriod</classname> does
+ not have an end date. For example, when initialized with the
+ <parameter>recurrences</parameter> parameter, or the
+ <parameter>isostr</parameter> parameter without an
+ end date.
+ </para>
+ <para>
+ Returns a <classname>DateTimeImmutable</classname> <type>object</type>
+ when the <classname>DatePeriod</classname> is initialized with a
+ <classname>DateTimeImmutable</classname> <type>object</type>
+ as the <parameter>start</parameter> parameter.
+ </para>
+ <para>
+ Returns a <classname>DateTime</classname> <type>object</type>
+ otherwise.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <example>
+ <title><methodname>DatePeriod::getEndDate</methodname> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+$period = new DatePeriod(
+ new DateTime('2016-05-16T00:00:00Z'),
+ new DateInterval('P1D'),
+ new DateTime('2016-05-20T00:00:00Z')
+);
+$start = $period->getEndDate();
+echo $start->format(DateTime::ISO8601);
+?>
+]]>
+ </programlisting>
+ &examples.outputs;
+ <screen>
+<![CDATA[
+2016-05-20T00:00:00+0000
+]]>
+ </screen>
+ </example>
+ <example>
+ <title><methodname>DatePeriod::getEndDate</methodname> without an end \
date</title> + <programlisting role="php">
+<![CDATA[
+<?php
+$period = new DatePeriod(
+ new DateTime('2016-05-16T00:00:00Z'),
+ new DateInterval('P1D'),
+ 7
+);
+var_dump($period->getEndDate());
+?>
+]]>
+ </programlisting>
+ &example.outputs;
+ <screen>
+<![CDATA[
+NULL
+]]>
+ </screen>
+ </example>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><methodname>DatePeriod::getStartDate</methodname></member>
+ <member><methodname>DatePeriod::getDateInterval</methodname></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
+-->
Property changes on: phpdoc/en/trunk/reference/datetime/dateperiod/getenddate.xml
___________________________________________________________________
Added: svn:keywords
+ Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy \
HeadURL URL
Added: svn:eol-style
+ native
Added: phpdoc/en/trunk/reference/datetime/dateperiod/getstartdate.xml
===================================================================
--- phpdoc/en/trunk/reference/datetime/dateperiod/getstartdate.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/datetime/dateperiod/getstartdate.xml 2016-05-17 \
20:41:56 UTC (rev 339177) @@ -0,0 +1,94 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="dateperiod.getstartdate" xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv>
+ <refname>DatePeriod::getStartDate</refname>
+ <refpurpose>
+ Gets the start date
+ </refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <para>&style.oop;</para>
+ <methodsynopsis role="oop">
+ <modifier>public</modifier> \
<type>DateTimeInterface</type><methodname>DatePeriod::getStartDate</methodname> + \
<void /> + </methodsynopsis>
+ <para>
+ Gets the start date of the period.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns a <classname>DateTimeImmutable</classname> <type>object</type>
+ when the <classname>DatePeriod</classname> is initialized with a
+ <classname>DateTimeImmutable</classname> <type>object</type>
+ as the <parameter>start</parameter> parameter.
+ </para>
+ <para>
+ Returns a <classname>DateTime</classname> <type>object</type>
+ otherwise.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <example>
+ <title><methodname>DatePeriod::getStartDate</methodname> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+$period = new DatePeriod('R7/2016-05-16T00:00:00Z/P1D');
+$start = $period->getStartDate();
+echo $start->format(DateTime::ISO8601);
+?>
+]]>
+ </programlisting>
+ &example.outputs;
+ <screen>
+<![CDATA[
+2016-05-16T00:00:00+0000
+]]>
+ </screen>
+ </example>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><methodname>DatePeriod::getEndDate</methodname></member>
+ <member><methodname>DatePeriod::getDateInterval</methodname></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
+-->
Property changes on: phpdoc/en/trunk/reference/datetime/dateperiod/getstartdate.xml
___________________________________________________________________
Added: svn:keywords
+ Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy \
HeadURL URL
Added: svn:eol-style
+ native
Modified: phpdoc/en/trunk/reference/datetime/dateperiod.xml
===================================================================
--- phpdoc/en/trunk/reference/datetime/dateperiod.xml 2016-05-17 15:55:30 UTC (rev \
339176)
+++ phpdoc/en/trunk/reference/datetime/dateperiod.xml 2016-05-17 20:41:56 UTC (rev \
339177) @@ -55,10 +55,10 @@
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) \
xpointer(id('class.dateperiod')/db:refentry/db:refsect1[@role='description']/descendant::db:destructorsynopsis[not(@role='procedural')])">
<xi:fallback />
</xi:include>
+ -->
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) \
xpointer(id('class.dateperiod')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
<xi:fallback />
</xi:include>
- -->
</classsynopsis>
<!-- }}} -->
Modified: phpdoc/en/trunk/reference/datetime/versions.xml
===================================================================
--- phpdoc/en/trunk/reference/datetime/versions.xml 2016-05-17 15:55:30 UTC (rev \
339176)
+++ phpdoc/en/trunk/reference/datetime/versions.xml 2016-05-17 20:41:56 UTC (rev \
339177) @@ -62,6 +62,9 @@
<function name="dateperiod::__construct" from="PHP 5 >= 5.3.0, PHP 7"/>
<function name="dateperiod::__wakeup" from="PHP 5 >= 5.5.0, PHP 7"/>
<function name="dateperiod::__set_state" from="PHP 5 >= 5.5.0, PHP 7"/>
+ <function name="dateperiod::getstartdate" from="PHP 5 >= 5.6.5, PHP 7"/>
+ <function name="dateperiod::getenddate" from="PHP 5 >= 5.6.5, PHP 7"/>
+ <function name="dateperiod::getdateinterval" from="PHP 5 >= 5.6.5, PHP 7"/>
<!-- Functions -->
<function name="checkdate" from="PHP 4, PHP 5, PHP 7"/>
--
PHP Documentation Commits Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic