mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 14:58:55 +00:00
b71e8b802f
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@290998 c90b9560-bf6c-de11-be94-00142212c4b1
135 lines
3.1 KiB
XML
135 lines
3.1 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="splfileobject.key" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>SplFileObject::key</refname>
|
|
<refpurpose>Get line number</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>int</type><methodname>SplFileObject::key</methodname>
|
|
<void />
|
|
</methodsynopsis>
|
|
<para>
|
|
Gets the current line number.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
This number may not reflect the actual line number in the file
|
|
if <methodname>SplFileObject::setMaxLineLen</methodname> is used to
|
|
read fixed lengths of the file.
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
&no.function.parameters;
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the current line number.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><methodname>SplFileObject::key</methodname> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$file = new SplFileObject("lipsum.txt");
|
|
foreach ($file as $line) {
|
|
echo $file->key() . ". " . $line;
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
0. Lorem ipsum dolor sit amet, consectetur adipiscing elit.
|
|
1. Duis nec sapien felis, ac sodales nisl.
|
|
2. Lorem ipsum dolor sit amet, consectetur adipiscing elit.
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title><methodname>SplFileObject::key</methodname> example with <methodname>SplFileObject::setMaxLineLen</methodname></title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$file = new SplFileObject("lipsum.txt");
|
|
$file->setMaxLineLen(20);
|
|
foreach ($file as $line) {
|
|
echo $file->key() . ". " . $line . "\n";
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
0. Lorem ipsum dolor s
|
|
1. it amet, consectetu
|
|
2. r adipiscing elit.
|
|
3.
|
|
|
|
4. Duis nec sapien fel
|
|
5. is, ac sodales nisl
|
|
6. .
|
|
|
|
7. Lorem ipsum dolor s
|
|
8. it amet, consectetu
|
|
9. r adipiscing elit.
|
|
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><methodname>SplFileObject::current</methodname></member>
|
|
<member><methodname>SplFileObject::seek</methodname></member>
|
|
<member><methodname>SplFileObject::next</methodname></member>
|
|
<member><methodname>SplFileObject::rewind</methodname></member>
|
|
<member><methodname>SplFileObject::valid</methodname></member>
|
|
</simplelist>
|
|
</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
|
|
-->
|