cvs: phpdoc /en language-snippets.ent /en/reference/runkit/functions runkit-lint-file.xml runkit-lint.xml runkit-superglobals.xml

pollita Mon May 2 15:32:59 2005 EDT Added files: /phpdoc/en/reference/runkit/functions runkit-lint.xml runkit-lint-file.xml runkit-superglobals.xml Modified files: /phpdoc/en language-snippets.ent Log: Add note about sandbox support in runkit and document runkit_lint(), runkit_lint_file(), and runkit_superglobals() http://cvs.php.net/diff.php/phpdoc/en/language-snippets.ent?r1=1.148&r2=1.149&ty=u Index: phpdoc/en/language-snippets.ent diff -u phpdoc/en/language-snippets.ent:1.148 phpdoc/en/language-snippets.ent:1.149 --- phpdoc/en/language-snippets.ent:1.148 Sun May 1 13:33:08 2005 +++ phpdoc/en/language-snippets.ent Mon May 2 15:32:58 2005 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.148 $ --> +<!-- $Revision: 1.149 $ --> <!-- Keep 'em sorted --> @@ -579,3 +579,9 @@ be used to manipulate the currently running (or chained) method.</simpara> </note>'> +<!ENTITY note.runkit.sandbox '<note><simpara>Sandbox support (required for +<function>runkit_lint</function>, <function>runkit_line_file</function>, +and the Runkit_Sandbox class) is only available with PHP 5.1 or specially +patched versions of PHP 5.0 and requires that thread safety be enabled. +See the README file included in the runkit package for more information. +</simpara></note>'> http://cvs.php.net/co.php/phpdoc/en/reference/runkit/functions/runkit-lint.xml?r=1.1&p=1 Index: phpdoc/en/reference/runkit/functions/runkit-lint.xml +++ phpdoc/en/reference/runkit/functions/runkit-lint.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.runkit-lint"> <refnamediv> <refname>runkit_lint</refname> <refpurpose> Check the PHP syntax of the specified php code </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>runkit_lint</methodname> <methodparam><type>string</type><parameter>code</parameter></methodparam> </methodsynopsis> <para> The <function>runkit_lint</function> function performs a syntax (lint) check on the specified php code testing for scripting errors. This is similar to using php -l from the commandline except <function>runkit_lint</function> accepts actual code rather than a filename. </para> &note.runkit.sandbox; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>code</parameter></term> <listitem> <para> PHP Code to be lint checked </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function>runkit_lint_file</function></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:"../../../../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 --> http://cvs.php.net/co.php/phpdoc/en/reference/runkit/functions/runkit-lint-file.xml?r=1.1&p=1 Index: phpdoc/en/reference/runkit/functions/runkit-lint-file.xml +++ phpdoc/en/reference/runkit/functions/runkit-lint-file.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.runkit-lint-file"> <refnamediv> <refname>runkit_lint_file</refname> <refpurpose> Check the PHP syntax of the specified file </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>runkit_lint_file</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> </methodsynopsis> <para> The <function>runkit_lint_file</function> function performs a syntax (lint) check on the specified filename testing for scripting errors. This is similar to using php -l from the commandline. </para> &note.runkit.sandbox; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>filename</parameter></term> <listitem> <para> File containing PHP Code to be lint checked </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function>runkit_lint</function></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:"../../../../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 --> http://cvs.php.net/co.php/phpdoc/en/reference/runkit/functions/runkit-superglobals.xml?r=1.1&p=1 Index: phpdoc/en/reference/runkit/functions/runkit-superglobals.xml +++ phpdoc/en/reference/runkit/functions/runkit-superglobals.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.runkit-superglobals"> <refnamediv> <refname>runkit_superglobals</refname> <refpurpose> Return numericly indexed array of registered superglobals </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>array</type><methodname>runkit_superglobals</methodname> <void/> </methodsynopsis> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns a numericly indexed array of the currently registered superglobals. i.e. _GET, _POST, _REQUEST, _COOKIE, _SESSION, _SERVER, _ENV, _FILES </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><link linkend="language.variables.scope">Variable Scope</link></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:"../../../../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 -->