mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 10:28:54 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
117 lines
3.5 KiB
XML
117 lines
3.5 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.token-get-all" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>token_get_all</refname>
|
|
<refpurpose>Split given source into PHP tokens</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>token_get_all</methodname>
|
|
<methodparam><type>string</type><parameter>source</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>token_get_all</function> parses the given <parameter>source</parameter>
|
|
string into PHP language tokens using the Zend engine's lexical scanner.
|
|
</para>
|
|
<para>
|
|
For a list of parser tokens, see <xref linkend="tokens"/>, or use
|
|
<function>token_name</function> to translate a token value into its string
|
|
representation.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>source</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The PHP source to parse.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
An array of token identifiers. Each individual token identifier is either
|
|
a single character (i.e.: <literal>;</literal>, <literal>.</literal>,
|
|
<literal>></literal>, <literal>!</literal>, etc...),
|
|
or a three element array containing the token index in element 0, the string
|
|
content of the original token in element 1 and the line number in element 2.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>token_get_all</function> examples</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$tokens = token_get_all('<?php echo; ?>'); /* => array(
|
|
array(T_OPEN_TAG, '<?php'),
|
|
array(T_ECHO, 'echo'),
|
|
';',
|
|
array(T_CLOSE_TAG, '?>') ); */
|
|
|
|
/* Note in the following example that the string is parsed as T_INLINE_HTML
|
|
rather than the otherwise expected T_COMMENT (T_ML_COMMENT in PHP <5).
|
|
This is because no open/close tags were used in the "code" provided.
|
|
This would be equivalent to putting a comment outside of <?php ?> tags in a normal file. */
|
|
$tokens = token_get_all('/* comment */'); // => array(array(T_INLINE_HTML, '/* comment */'));
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<para>
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>5.2.2</entry>
|
|
<entry>Line numbers are returned in element 2
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</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
|
|
-->
|