cvs: phpdoc /en/reference/tokenizer/functions token-get-all.xml token-name.xml

From: Date: Sun, 02 Jan 2005 12:20:10 +0000
Subject: cvs: phpdoc /en/reference/tokenizer/functions token-get-all.xml token-name.xml
Groups: php.doc 
Request: Send a blank email to phpdoc+get-969365758@lists.php.net to get a copy of this message
didou Sun Jan 2 07:20:10 2005 EDT Modified files: /phpdoc/en/reference/tokenizer/functions token-get-all.xml token-name.xml Log: switch ref.token to the new structure

http://cvs.php.net/diff.php/phpdoc/en/reference/tokenizer/functions/token-get-all.xml?r1=1.7&r2=1.8&ty=u Index: phpdoc/en/reference/tokenizer/functions/token-get-all.xml diff -u phpdoc/en/reference/tokenizer/functions/token-get-all.xml:1.7 phpdoc/en/reference/tokenizer/functions/token-get-all.xml:1.8 --- phpdoc/en/reference/tokenizer/functions/token-get-all.xml:1.7 Wed Jan 7 18:15:48 2004 +++ phpdoc/en/reference/tokenizer/functions/token-get-all.xml Sun Jan 2 07:20:10 2005 @@ -1,53 +1,78 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> - <refentry id="function.token-get-all"> - <refnamediv> - <refname>token_get_all</refname> - <refpurpose>Split given source into PHP tokens</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>token_get_all</methodname> - <methodparam><type>string</type><parameter>source</parameter></methodparam> - </methodsynopsis> - <simpara> - <function>token_get_all</function> parses the given <parameter>source</parameter> - string into PHP language tokens using the Zend engine&apos;s lexical scanner. - The function returns an array of token identifiers. Each individual token - identifier is either a single character (i.e.: <constant>;</constant>, - <constant>.</constant>, <constant>&gt;</constant>, <constant>!</constant>, etc...), - or a two element array containing the token index in element 0, and the string - content of the original token in element 1. - </simpara> - <simpara> - 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. - </simpara> - <example> - <title><function>token_get_all</function> examples</title> - <programlisting role="php"> +<!-- $Revision: 1.8 $ --> +<refentry id="function.token-get-all"> + <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&apos;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>&gt;</literal>, <literal>!</literal>, etc...), + or a two element array containing the token index in element 0, and the string + content of the original token in element 1. + </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'); // => array(array(T_OPEN_TAG, '<?')); - $tokens = token_get_all('<?php echo; ?>'); /* => array( - array(T_OPEN_TAG, '<?php'), - array(T_ECHO, 'echo'), - ';', - array(T_CLOSE_TAG, '?>') ); */ +$tokens = token_get_all('<?php'); // => array(array(T_OPEN_TAG, '<?')); +$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 */')); +$tokens = token_get_all('/* comment */'); // => array(array(T_INLINE_HTML, '/* comment */')); ?> ]]> - </programlisting> - </example> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/tokenizer/functions/token-name.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/tokenizer/functions/token-name.xml diff -u phpdoc/en/reference/tokenizer/functions/token-name.xml:1.6 phpdoc/en/reference/tokenizer/functions/token-name.xml:1.7 --- phpdoc/en/reference/tokenizer/functions/token-name.xml:1.6 Fri May 21 06:19:06 2004 +++ phpdoc/en/reference/tokenizer/functions/token-name.xml Sun Jan 2 07:20:10 2005 @@ -1,40 +1,71 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> - <refentry id="function.token-name"> - <refnamediv> - <refname>token_name</refname> - <refpurpose>Get the symbolic name of a given PHP token</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>token_name</methodname> - <methodparam><type>int</type><parameter>token</parameter></methodparam> - </methodsynopsis> - <para> - <function>token_name</function> returns the symbolic name for a PHP - <parameter>token</parameter> value. The symbolic name - returned matches the name of the matching token constant. - </para> - <example> - <title><function>token_name</function> example</title> - <programlisting role="php"> +<!-- $Revision: 1.7 $ --> +<refentry id="function.token-name"> + <refnamediv> + <refname>token_name</refname> + <refpurpose>Get the symbolic name of a given PHP token</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>string</type><methodname>token_name</methodname> + <methodparam><type>int</type><parameter>token</parameter></methodparam> + </methodsynopsis> + <para> + <function>token_name</function> gets the symbolic name for a PHP + <parameter>token</parameter> value. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>token</parameter></term> + <listitem> + <para> + The token value. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The symbolic name of the given <parameter>token</parameter>. The returned + name returned matches the name of the matching token constant. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>token_name</function> example</title> + <programlisting role="php"> <![CDATA[ <?php - // 260 is the token value for the T_REQUIRE token - echo token_name(260); // -> "T_REQUIRE" +// 260 is the token value for the T_REQUIRE token +echo token_name(260); // -> "T_REQUIRE" - // a token constant maps to its own name - echo token_name(T_FUNCTION); // -> "T_FUNCTION" +// a token constant maps to its own name +echo token_name(T_FUNCTION); // -> "T_FUNCTION" ?> ]]> - </programlisting> - </example> - <para> - See also <link linkend="tokens">List of Parser Tokens</link>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><link linkend="tokens">List of Parser Tokens</link></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables:
« previous php.doc (#969365758) next »