[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/array/_functions/array-key-first.xml_functions/a
From:       Christoph_Michael_Becker <cmb () php ! net>
Date:       2018-07-17 11:41:17
Message-ID: svn-cmb-1531827677-345342-1850066665 () svn ! php ! net
[Download RAW message or body]

cmb                                      Tue, 17 Jul 2018 11:41:17 +0000

Revision: http://svn.php.net/viewvc?view=revision&revision=345342

Log:
Document array_key_first() and array_key_last()

Cf. <https://wiki.php.net/rfc/array_key_first_last>.

Changed paths:
    A   phpdoc/en/trunk/reference/array/functions/array-key-first.xml
    A   phpdoc/en/trunk/reference/array/functions/array-key-last.xml
    U   phpdoc/en/trunk/reference/array/functions/end.xml
    U   phpdoc/en/trunk/reference/array/functions/reset.xml
    U   phpdoc/en/trunk/reference/array/versions.xml

Added: phpdoc/en/trunk/reference/array/functions/array-key-first.xml
===================================================================
--- phpdoc/en/trunk/reference/array/functions/array-key-first.xml	                    \
                (rev 0)
+++ phpdoc/en/trunk/reference/array/functions/array-key-first.xml	2018-07-17 11:41:17 \
UTC (rev 345342) @@ -0,0 +1,73 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="function.array-key-first" xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv>
+  <refname>array_key_first</refname>
+  <refpurpose>Gets the first key of an array</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>mixed</type><methodname>array_key_first</methodname>
+   <methodparam><type>array</type><parameter>array</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Get the first key of the given <parameter>array</parameter> without affecting
+   the internal array pointer.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>array</parameter></term>
+    <listitem>
+     <para>
+      An array.
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns the first key of <parameter>array</parameter> if the array is not empty;
+   &null; otherwise.
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <simplelist>
+   <member><function>array_key_last</function></member>
+   <member><function>reset</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
+-->


Property changes on: phpdoc/en/trunk/reference/array/functions/array-key-first.xml
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: svn:keywords
## -0,0 +1 ##
+Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy \
HeadURL URL \ No newline at end of property
Added: phpdoc/en/trunk/reference/array/functions/array-key-last.xml
===================================================================
--- phpdoc/en/trunk/reference/array/functions/array-key-last.xml	                     \
                (rev 0)
+++ phpdoc/en/trunk/reference/array/functions/array-key-last.xml	2018-07-17 11:41:17 \
UTC (rev 345342) @@ -0,0 +1,73 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="function.array-key-last" xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv>
+  <refname>array_key_last</refname>
+  <refpurpose>Gets the last key of an array</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>mixed</type><methodname>array_key_last</methodname>
+   <methodparam><type>array</type><parameter>array</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Get the last key of the given <parameter>array</parameter> without affecting
+   the internal array pointer.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>array</parameter></term>
+    <listitem>
+     <para>
+      An array.
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns the last key of <parameter>array</parameter> if the array is not empty;
+   &null; otherwise.
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <simplelist>
+   <member><function>array_key_first</function></member>
+   <member><function>end</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
+-->


Property changes on: phpdoc/en/trunk/reference/array/functions/array-key-last.xml
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: svn:keywords
## -0,0 +1 ##
+Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy \
HeadURL URL \ No newline at end of property
Modified: phpdoc/en/trunk/reference/array/functions/end.xml
===================================================================
--- phpdoc/en/trunk/reference/array/functions/end.xml	2018-07-17 11:17:06 UTC (rev \
                345341)
+++ phpdoc/en/trunk/reference/array/functions/end.xml	2018-07-17 11:41:17 UTC (rev \
345342) @@ -67,6 +67,7 @@
     <member><function>prev</function></member>
     <member><function>reset</function></member>
     <member><function>next</function></member>
+    <member><function>array_key_last</function></member>
    </simplelist>
   </para>
  </refsect1>

Modified: phpdoc/en/trunk/reference/array/functions/reset.xml
===================================================================
--- phpdoc/en/trunk/reference/array/functions/reset.xml	2018-07-17 11:17:06 UTC (rev \
                345341)
+++ phpdoc/en/trunk/reference/array/functions/reset.xml	2018-07-17 11:41:17 UTC (rev \
345342) @@ -91,6 +91,7 @@
     <member><function>end</function></member>
     <member><function>next</function></member>
     <member><function>prev</function></member>
+    <member><function>array_key_first</function></member>
    </simplelist>
   </para>
  </refsect1>

Modified: phpdoc/en/trunk/reference/array/versions.xml
===================================================================
--- phpdoc/en/trunk/reference/array/versions.xml	2018-07-17 11:17:06 UTC (rev 345341)
+++ phpdoc/en/trunk/reference/array/versions.xml	2018-07-17 11:41:17 UTC (rev 345342)
@@ -25,6 +25,8 @@
  <function name='array_intersect_uassoc' from='PHP 5, PHP 7'/>
  <function name='array_intersect_ukey' from='PHP 5 &gt;= 5.1.0, PHP 7'/>
  <function name='array_key_exists' from='PHP 4 &gt;= 4.0.7, PHP 5, PHP 7'/>
+ <function name='array_key_first' from='PHP 7 &gt;= 7.3.0'/>
+ <function name='array_key_last' from='PHP 7 &gt;= 7.3.0'/>
  <function name='array_keys' from='PHP 4, PHP 5, PHP 7'/>
  <function name='array_map' from='PHP 4 &gt;= 4.0.6, PHP 5, PHP 7'/>
  <function name='array_merge' 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