mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 22:08:55 +00:00
27960e632c
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@146503 c90b9560-bf6c-de11-be94-00142212c4b1
127 lines
3.6 KiB
XML
127 lines
3.6 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.4 $ -->
|
|
<!-- splitted from ./en/functions/strings.xml, last change in rev 1.2 -->
|
|
<refentry id="function.strtok">
|
|
<refnamediv>
|
|
<refname>strtok</refname>
|
|
<refpurpose>Tokenize string</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>strtok</methodname>
|
|
<methodparam><type>string</type><parameter>arg1</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>arg2</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>strtok</function> splits a string (<parameter>arg1</parameter>)
|
|
into smaller strings (tokens), with each token being delimited by any
|
|
character from <parameter>arg2</parameter>.
|
|
That is, if you have a string like "This is an example string" you
|
|
could tokenize this string into its individual words by using the
|
|
space character as the token.
|
|
<example>
|
|
<title><function>strtok</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$string = "This is\tan example\nstring";
|
|
/* Use tab and newline as tokenizing characters as well */
|
|
$tok = strtok($string, " \n\t");
|
|
while ($tok) {
|
|
echo "Word=$tok<br />";
|
|
$tok = strtok(" \n\t");
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
Note that only the first call to strtok uses the string argument.
|
|
Every subsequent call to strtok only needs the token to use, as
|
|
it keeps track of where it is in the current string. To start
|
|
over, or to tokenize a new string you simply call strtok with the
|
|
string argument again to initialize it. Note that you may put
|
|
multiple tokens in the token parameter. The string will be
|
|
tokenized when any one of the characters in the argument are
|
|
found.
|
|
</para>
|
|
<para>
|
|
The behavior when an empty part was found changed with PHP 4.1.0. The old
|
|
behavior returned an empty string, while the new, correct, behavior
|
|
simply skips the part of the string:
|
|
<example>
|
|
<title>Old <function>strtok</function> behavior</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$first_token = strtok('/something', '/');
|
|
$second_token = strtok('/');
|
|
var_dump($first_token, $second_token);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
<para>
|
|
Output:
|
|
</para>
|
|
<screen>
|
|
<![CDATA[
|
|
string(0) ""
|
|
string(9) "something"
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
<example>
|
|
<title>New <function>strtok</function> behavior</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$first_token = strtok('/something', '/');
|
|
$second_token = strtok('/');
|
|
var_dump($first_token, $second_token);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
<para>
|
|
Output:
|
|
</para>
|
|
<screen>
|
|
<![CDATA[
|
|
string(9) "something"
|
|
bool(false)
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
Also be careful that your tokens may be equal to "0". This
|
|
evaluates to &false; in conditional expressions.
|
|
</para>
|
|
<para>
|
|
See also <function>split</function> and
|
|
<function>explode</function>.
|
|
</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:"../../../../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
|
|
-->
|