cvs: peardoc /en/package/php/php-compatinfo/php-compatinfo getclasses.xml getconditions.xml getconstants.xml getextensions.xml getfunctions.xml
getignoredconstants.xml getignoredextensions.xml getignoredfiles.xml getignoredfunctions.xml gettokens.xml getversion.xml

From: Date: Wed, 24 Dec 2008 09:14:12 +0000
Subject: cvs: peardoc /en/package/php/php-compatinfo/php-compatinfo getclasses.xml getconditions.xml getconstants.xml getextensions.xml getfunctions.xml
getignoredconstants.xml getignoredextensions.xml getignoredfiles.xml getignoredfunctions.xml gettokens.xml getversion.xml
Groups: php.pear.doc 
Request: Send a blank email to pear-doc+get-11338@lists.php.net to get a copy of this message
farell Wed Dec 24 09:14:12 2008 UTC Added files: /peardoc/en/package/php/php-compatinfo/php-compatinfo getclasses.xml getconditions.xml getconstants.xml getextensions.xml getfunctions.xml getignoredconstants.xml getignoredextensions.xml getignoredfiles.xml getignoredfunctions.xml gettokens.xml getversion.xml Log: add new getters introduced with version 1.9.0 beta1 and beta 2

http://cvs.php.net/viewvc.cgi/peardoc/en/package/php/php-compatinfo/php-compatinfo/getclasses.xml?view=markup&rev=1.1 Index: peardoc/en/package/php/php-compatinfo/php-compatinfo/getclasses.xml +++ peardoc/en/package/php/php-compatinfo/php-compatinfo/getclasses.xml <?xml version="1.0" encoding="utf-8"?> <refentry xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="package.php.php-compatinfo.php-compatinfo.getclasses"> <refnamediv> <refname> <function>PHP_CompatInfo::getClasses</function> </refname> <refpurpose>Returns the latest parse data source classes declared</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo>require_once &apos;PHP/CompatInfo.php&apos;;</funcsynopsisinfo> <funcprototype> <funcdef> mixed <function>PHP_CompatInfo::getClasses</function> </funcdef> <paramdef choice="opt">mixed <parameter> $file</parameter> <initializer>false</initializer> </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getclasses.desc"> &title.desc; <para> Returns the latest parse data source classes declared (internal or end-user defined) </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getclasses.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.mixed; <parameter>$file</parameter> </term> <listitem> <para>(optional) A specific filename or not (&false;)</para> </listitem> </varlistentry> </variablelist> </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getclasses.returns"> &title.returns; <para> <emphasis>returns</emphasis> Null on error or if there were no previous data parsing </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getclasses.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getclasses.since"> &title.since; <para> <emphasis>since</emphasis> version 1.9.0b1 (2008-11-30) </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getclasses.note"> &title.note; &note.notstatic; </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getclasses.example"> &title.example; <para> See <link linkend="package.php.php-compatinfo.php-compatinfo.getversion"> PHP_CompatInfo::getVersion() </link> example. </para> </refsection> </refentry> http://cvs.php.net/viewvc.cgi/peardoc/en/package/php/php-compatinfo/php-compatinfo/getconditions.xml?view=markup&rev=1.1 Index: peardoc/en/package/php/php-compatinfo/php-compatinfo/getconditions.xml +++ peardoc/en/package/php/php-compatinfo/php-compatinfo/getconditions.xml <?xml version="1.0" encoding="utf-8"?> <refentry xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="package.php.php-compatinfo.php-compatinfo.getconditions"> <refnamediv> <refname> <function>PHP_CompatInfo::getConditions</function> </refname> <refpurpose>Returns the latest parse data source conditions</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo>require_once &apos;PHP/CompatInfo.php&apos;;</funcsynopsisinfo> <funcprototype> <funcdef> mixed <function>PHP_CompatInfo::getConditions</function> </funcdef> <paramdef choice="opt">mixed <parameter> $file</parameter> <initializer>false</initializer> </paramdef> <paramdef choice="opt">bool <parameter> $levelOnly</parameter> <initializer>false</initializer> </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getconditions.desc"> &title.desc; <para> Returns the latest parse data source conditions, with or without contextual data </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getconditions.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.mixed; <parameter>$file</parameter> </term> <listitem> <para>(optional) A specific filename or not (&false;)</para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.bool; <parameter>$levelOnly</parameter> </term> <listitem> <para>(optional) Level with or without contextual data</para> </listitem> </varlistentry> </variablelist> </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getconditions.returns"> &title.returns; <para> <emphasis>returns</emphasis> Null on error or if there were no previous data parsing </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getconditions.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getconditions.since"> &title.since; <para> <emphasis>since</emphasis> version 1.9.0b1 (2008-11-30) </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getconditions.note"> &title.note; &note.notstatic; </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getconditions.example"> &title.example; <para> See <link linkend="package.php.php-compatinfo.php-compatinfo.getversion"> PHP_CompatInfo::getVersion() </link> example. </para> </refsection> </refentry> http://cvs.php.net/viewvc.cgi/peardoc/en/package/php/php-compatinfo/php-compatinfo/getconstants.xml?view=markup&rev=1.1 Index: peardoc/en/package/php/php-compatinfo/php-compatinfo/getconstants.xml +++ peardoc/en/package/php/php-compatinfo/php-compatinfo/getconstants.xml <?xml version="1.0" encoding="utf-8"?> <refentry xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="package.php.php-compatinfo.php-compatinfo.getconstants"> <refnamediv> <refname> <function>PHP_CompatInfo::getConstants</function> </refname> <refpurpose>Returns the latest parse data source constants declared</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo>require_once &apos;PHP/CompatInfo.php&apos;;</funcsynopsisinfo> <funcprototype> <funcdef> mixed <function>PHP_CompatInfo::getConstants</function> </funcdef> <paramdef choice="opt">mixed <parameter> $file</parameter> <initializer>false</initializer> </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getconstants.desc"> &title.desc; <para> Returns the latest parse data source constants declared (internal or end-user defined) </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getconstants.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.mixed; <parameter>$file</parameter> </term> <listitem> <para>(optional) A specific filename or not (&false;)</para> </listitem> </varlistentry> </variablelist> </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getconstants.returns"> &title.returns; <para> <emphasis>returns</emphasis> Null on error or if there were no previous data parsing </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getconstants.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getconstants.since"> &title.since; <para> <emphasis>since</emphasis> version 1.9.0b1 (2008-11-30) </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getconstants.note"> &title.note; &note.notstatic; </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getconstants.example"> &title.example; <para> See <link linkend="package.php.php-compatinfo.php-compatinfo.getversion"> PHP_CompatInfo::getVersion() </link> example. </para> </refsection> </refentry> http://cvs.php.net/viewvc.cgi/peardoc/en/package/php/php-compatinfo/php-compatinfo/getextensions.xml?view=markup&rev=1.1 Index: peardoc/en/package/php/php-compatinfo/php-compatinfo/getextensions.xml +++ peardoc/en/package/php/php-compatinfo/php-compatinfo/getextensions.xml <?xml version="1.0" encoding="utf-8"?> <refentry xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="package.php.php-compatinfo.php-compatinfo.getextensions"> <refnamediv> <refname> <function>PHP_CompatInfo::getExtensions</function> </refname> <refpurpose>Returns the latest parse data source extensions used</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo>require_once &apos;PHP/CompatInfo.php&apos;;</funcsynopsisinfo> <funcprototype> <funcdef> mixed <function>PHP_CompatInfo::getExtensions</function> </funcdef> <paramdef choice="opt">mixed <parameter> $file</parameter> <initializer>false</initializer> </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getextensions.desc"> &title.desc; <para> Returns the latest parse data source extensions used </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getextensions.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.mixed; <parameter>$file</parameter> </term> <listitem> <para>(optional) A specific filename or not (&false;)</para> </listitem> </varlistentry> </variablelist> </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getextensions.returns"> &title.returns; <para> <emphasis>returns</emphasis> Null on error or if there were no previous data parsing </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getextensions.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getextensions.since"> &title.since; <para> <emphasis>since</emphasis> version 1.9.0b1 (2008-11-30) </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getextensions.note"> &title.note; &note.notstatic; </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getextensions.example"> &title.example; <para> See <link linkend="package.php.php-compatinfo.php-compatinfo.getversion"> PHP_CompatInfo::getVersion() </link> example. </para> </refsection> </refentry> http://cvs.php.net/viewvc.cgi/peardoc/en/package/php/php-compatinfo/php-compatinfo/getfunctions.xml?view=markup&rev=1.1 Index: peardoc/en/package/php/php-compatinfo/php-compatinfo/getfunctions.xml +++ peardoc/en/package/php/php-compatinfo/php-compatinfo/getfunctions.xml <?xml version="1.0" encoding="utf-8"?> <refentry xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="package.php.php-compatinfo.php-compatinfo.getfunctions"> <refnamediv> <refname> <function>PHP_CompatInfo::getFunctions</function> </refname> <refpurpose>Returns the latest parse data source functions declared</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo>require_once &apos;PHP/CompatInfo.php&apos;;</funcsynopsisinfo> <funcprototype> <funcdef> mixed <function>PHP_CompatInfo::getFunctions</function> </funcdef> <paramdef choice="opt">mixed <parameter> $file</parameter> <initializer>false</initializer> </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getfunctions.desc"> &title.desc; <para> Returns the latest parse data source functions declared (internal or end-user defined) </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getfunctions.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.mixed; <parameter>$file</parameter> </term> <listitem> <para>(optional) A specific filename or not (&false;)</para> </listitem> </varlistentry> </variablelist> </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getfunctions.returns"> &title.returns; <para> <emphasis>returns</emphasis> Null on error or if there were no previous data parsing </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getfunctions.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getfunctions.since"> &title.since; <para> <emphasis>since</emphasis> version 1.9.0b1 (2008-11-30) </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getfunctions.note"> &title.note; &note.notstatic; </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getfunctions.example"> &title.example; <para> See <link linkend="package.php.php-compatinfo.php-compatinfo.getversion"> PHP_CompatInfo::getVersion() </link> example. </para> </refsection> </refentry> http://cvs.php.net/viewvc.cgi/peardoc/en/package/php/php-compatinfo/php-compatinfo/getignoredconstants.xml?view=markup&rev=1.1 Index: peardoc/en/package/php/php-compatinfo/php-compatinfo/getignoredconstants.xml +++ peardoc/en/package/php/php-compatinfo/php-compatinfo/getignoredconstants.xml <?xml version="1.0" encoding="utf-8"?> <refentry xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="package.php.php-compatinfo.php-compatinfo.getignoredconstants"> <refnamediv> <refname> <function>PHP_CompatInfo::getIgnoredConstants</function> </refname> <refpurpose>Returns the latest parse data source ignored constants</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo>require_once &apos;PHP/CompatInfo.php&apos;;</funcsynopsisinfo> <funcprototype> <funcdef> mixed <function>PHP_CompatInfo::getIgnoredConstants</function> </funcdef> <paramdef choice="opt">mixed <parameter> $file</parameter> <initializer>false</initializer> </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getignoredconstants.desc"> &title.desc; <para> Returns the latest parse data source ignored constants list </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getignoredconstants.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.mixed; <parameter>$file</parameter> </term> <listitem> <para>(optional) A specific filename or not (&false;)</para> </listitem> </varlistentry> </variablelist> </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getignoredconstants.returns"> &title.returns; <para> <emphasis>returns</emphasis> Null on error or if there were no previous data parsing </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getignoredconstants.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getignoredconstants.since"> &title.since; <para> <emphasis>since</emphasis> version 1.9.0b2 (2008-12-19) </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getignoredconstants.note"> &title.note; &note.notstatic; </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getignoredconstants.example"> &title.example; <para> See <link linkend="package.php.php-compatinfo.php-compatinfo.getignoredfunctions"> PHP_CompatInfo::getIgnoredFunctions() </link> example. </para> </refsection> </refentry> http://cvs.php.net/viewvc.cgi/peardoc/en/package/php/php-compatinfo/php-compatinfo/getignoredextensions.xml?view=markup&rev=1.1 Index: peardoc/en/package/php/php-compatinfo/php-compatinfo/getignoredextensions.xml +++ peardoc/en/package/php/php-compatinfo/php-compatinfo/getignoredextensions.xml <?xml version="1.0" encoding="utf-8"?> <refentry xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="package.php.php-compatinfo.php-compatinfo.getignoredextensions"> <refnamediv> <refname> <function>PHP_CompatInfo::getIgnoredExtensions</function> </refname> <refpurpose>Returns the latest parse data source ignored extensions</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo>require_once &apos;PHP/CompatInfo.php&apos;;</funcsynopsisinfo> <funcprototype> <funcdef> mixed <function>PHP_CompatInfo::getIgnoredExtensions</function> </funcdef> <paramdef choice="opt">mixed <parameter> $file</parameter> <initializer>false</initializer> </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getignoredextensions.desc"> &title.desc; <para> Returns the latest parse data source ignored extensions list </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getignoredextensions.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.mixed; <parameter>$file</parameter> </term> <listitem> <para>(optional) A specific filename or not (&false;)</para> </listitem> </varlistentry> </variablelist> </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getignoredextensions.returns"> &title.returns; <para> <emphasis>returns</emphasis> Null on error or if there were no previous data parsing </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getignoredextensions.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getignoredextensions.since"> &title.since; <para> <emphasis>since</emphasis> version 1.9.0b2 (2008-12-19) </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getignoredextensions.note"> &title.note; &note.notstatic; </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getignoredextensions.example"> &title.example; <para> See <link linkend="package.php.php-compatinfo.php-compatinfo.getignoredfunctions"> PHP_CompatInfo::getIgnoredFunctions() </link> example. </para> </refsection> </refentry> http://cvs.php.net/viewvc.cgi/peardoc/en/package/php/php-compatinfo/php-compatinfo/getignoredfiles.xml?view=markup&rev=1.1 Index: peardoc/en/package/php/php-compatinfo/php-compatinfo/getignoredfiles.xml +++ peardoc/en/package/php/php-compatinfo/php-compatinfo/getignoredfiles.xml <?xml version="1.0" encoding="utf-8"?> <refentry xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="package.php.php-compatinfo.php-compatinfo.getignoredfiles"> <refnamediv> <refname> <function>PHP_CompatInfo::getIgnoredFiles</function> </refname> <refpurpose>Returns list of files ignored</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo>require_once &apos;PHP/CompatInfo.php&apos;;</funcsynopsisinfo> <funcprototype> <funcdef> array <function>PHP_CompatInfo::getIgnoredFiles</function> </funcdef> <paramdef /> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getignoredfiles.desc"> &title.desc; <para> Returns list of files ignored while parsing directories </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getignoredfiles.returns"> &title.returns; <para> <emphasis>returns</emphasis> or false on error </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getignoredfiles.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getignoredfiles.since"> &title.since; <para> <emphasis>since</emphasis> version 1.9.0b2 (2008-12-19) </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getignoredfiles.note"> &title.note; &note.notstatic; </refsection> </refentry> http://cvs.php.net/viewvc.cgi/peardoc/en/package/php/php-compatinfo/php-compatinfo/getignoredfunctions.xml?view=markup&rev=1.1 Index: peardoc/en/package/php/php-compatinfo/php-compatinfo/getignoredfunctions.xml +++ peardoc/en/package/php/php-compatinfo/php-compatinfo/getignoredfunctions.xml <?xml version="1.0" encoding="utf-8"?> <refentry xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="package.php.php-compatinfo.php-compatinfo.getignoredfunctions"> <refnamediv> <refname> <function>PHP_CompatInfo::getIgnoredFunctions</function> </refname> <refpurpose>Returns the latest parse data source ignored functions</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo>require_once &apos;PHP/CompatInfo.php&apos;;</funcsynopsisinfo> <funcprototype> <funcdef> mixed <function>PHP_CompatInfo::getIgnoredFunctions</function> </funcdef> <paramdef choice="opt">mixed <parameter> $file</parameter> <initializer>false</initializer> </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getignoredfunctions.desc"> &title.desc; <para> Returns the latest parse data source ignored functions list </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getignoredfunctions.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.mixed; <parameter>$file</parameter> </term> <listitem> <para>(optional) A specific filename or not (&false;)</para> </listitem> </varlistentry> </variablelist> </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getignoredfunctions.returns"> &title.returns; <para> <emphasis>returns</emphasis> Null on error or if there were no previous data parsing </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getignoredfunctions.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getignoredfunctions.since"> &title.since; <para> <emphasis>since</emphasis> version 1.9.0b2 (2008-12-19) </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getignoredfunctions.note"> &title.note; &note.notstatic; </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getignoredfunctions.example"> &title.example; <para> Suppose we have to parse source code like this file, named &quot;conditional.php&quot; : <programlisting role="php"> <![CDATA[ <?php // PHP 4.0.0 : __FILE__ // PHP 4.0.6 : DIRECTORY_SEPARATOR // PHP 4.0.7 : version compare // PHP 4.3.0 : ob_get_clean // PHP 4.3.0 : debug_backtrace // PHP 4.3.10 and 5.0.2 : PHP_EOL // PHP 5.0.0 : simplexml_load_file // PHP 5.1.1 : DATE_W3C if (!defined('DIRECTORY_SEPARATOR')) { define('DIRECTORY_SEPARATOR', strtoupper(substr(PHP_OS, 0, 3) == 'WIN') ? '\\' : '/' ); } if (function_exists('debug_backtrace')) { $backtrace = debug_backtrace(); } else { $backtrace = false; } if (function_exists('simplexml_load_file')) { $xml = simplexml_load_file('C:\php\pear\PHP_CompatInfo\scripts\version.xml'); } if (version_compare(phpversion(), '5.0.0', '<')) { include_once 'PHP/Compat.php'; PHP_Compat::loadFunction('ob_get_clean'); PHP_Compat::loadConstant('PHP_EOL'); } echo "Hello World" . PHP_EOL; $ds = DIRECTORY_SEPARATOR; $fn = dirname(__FILE__) . $ds . basename(__FILE__); echo "You have run file : $fn at " . date(DATE_W3C) . PHP_EOL; ?> ]]> </programlisting> And this other one, named &quot;ignore_functions_match.php&quot; <programlisting role="php"> <![CDATA[ <?php function toFile($filename, $data) { if (function_exists('file_put_contents')) { file_put_contents($filename, $data); } else { $file = fopen($filename, 'wb'); fwrite($file, $data); fclose($file); } } if (function_exists('debug_backtrace')) { $backtrace = debug_backtrace(); } else { $backtrace = false; } debug_print_backtrace(); ?> ]]> </programlisting> </para> <para> Script to parse data source, will look like to: <programlisting role="php"> <![CDATA[ <?php require_once 'PHP/CompatInfo.php'; $pci = new PHP_CompatInfo('null'); $dir = dirname(__FILE__) . DIRECTORY_SEPARATOR; $input = array($dir . 'conditional.php', $dir . 'ignore_functions_match.php'); $options = array('ignore_functions_match' => array('preg_match', array('/^debug/')), 'ignore_constants' => array('DIRECTORY_SEPARATOR') ); $pci->parseData($input, $options); $functions = $pci->getIgnoredFunctions(); echo 'ALL Ignored Functions = '. implode(',', $functions) . PHP_EOL; $functions = $pci->getIgnoredFunctions($input[0]); echo basename($input[0]) . ' ignored functions = '. implode(',', $functions) . PHP_EOL; $extensions = $pci->getIgnoredExtensions(); echo 'ALL Ignored Extensions = '. implode(',', $extensions) . PHP_EOL; $constants = $pci->getIgnoredConstants(); echo 'ALL Ignored Constants = '. implode(',', $constants) . PHP_EOL; ?> ]]> </programlisting> We have just used the NULL renderer because we want to organize output results, as below: </para> <para> <screen> ALL Ignored Functions = debug_backtrace,debug_print_backtrace conditional.php ignored functions = debug_backtrace ALL Ignored Extensions = ALL Ignored Constants = DIRECTORY_SEPARATOR </screen> </para> </refsection> </refentry> http://cvs.php.net/viewvc.cgi/peardoc/en/package/php/php-compatinfo/php-compatinfo/gettokens.xml?view=markup&rev=1.1 Index: peardoc/en/package/php/php-compatinfo/php-compatinfo/gettokens.xml +++ peardoc/en/package/php/php-compatinfo/php-compatinfo/gettokens.xml <?xml version="1.0" encoding="utf-8"?> <refentry xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="package.php.php-compatinfo.php-compatinfo.gettokens"> <refnamediv> <refname> <function>PHP_CompatInfo::getTokens</function> </refname> <refpurpose>Returns the latest parse data source tokens declared</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo>require_once &apos;PHP/CompatInfo.php&apos;;</funcsynopsisinfo> <funcprototype> <funcdef> mixed <function>PHP_CompatInfo::getTokens</function> </funcdef> <paramdef choice="opt">mixed <parameter> $file</parameter> <initializer>false</initializer> </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.gettokens.desc"> &title.desc; <para> Returns the latest parse data source PHP5+ tokens declared </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.gettokens.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.mixed; <parameter>$file</parameter> </term> <listitem> <para>(optional) A specific filename or not (&false;)</para> </listitem> </varlistentry> </variablelist> </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.gettokens.returns"> &title.returns; <para> <emphasis>returns</emphasis> Null on error or if there were no previous data parsing </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.gettokens.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.gettokens.since"> &title.since; <para> <emphasis>since</emphasis> version 1.9.0b1 (2008-11-30) </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.gettokens.note"> &title.note; &note.notstatic; </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.gettokens.example"> &title.example; <para> See <link linkend="package.php.php-compatinfo.php-compatinfo.getversion"> PHP_CompatInfo::getVersion() </link> example. </para> </refsection> </refentry> http://cvs.php.net/viewvc.cgi/peardoc/en/package/php/php-compatinfo/php-compatinfo/getversion.xml?view=markup&rev=1.1 Index: peardoc/en/package/php/php-compatinfo/php-compatinfo/getversion.xml +++ peardoc/en/package/php/php-compatinfo/php-compatinfo/getversion.xml <?xml version="1.0" encoding="utf-8"?> <refentry xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="package.php.php-compatinfo.php-compatinfo.getversion"> <refnamediv> <refname> <function>PHP_CompatInfo::getVersion</function> </refname> <refpurpose>Returns the latest parse data source version</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo>require_once &apos;PHP/CompatInfo.php&apos;;</funcsynopsisinfo> <funcprototype> <funcdef> mixed <function>PHP_CompatInfo::getVersion</function> </funcdef> <paramdef choice="opt">mixed <parameter> $file</parameter> <initializer>false</initializer> </paramdef> <paramdef choice="opt">bool <parameter> $max</parameter> <initializer>false</initializer></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getversion.desc"> &title.desc; <para> Returns the latest parse data source version, minimum and/or maximum </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getversion.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.mixed; <parameter>$file</parameter> </term> <listitem> <para>(optional) A specific filename or not (&false;)</para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.bool; <parameter>$max</parameter> </term> <listitem> <para>(optional) Level with or without contextual data</para> </listitem> </varlistentry> </variablelist> </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getversion.returns"> &title.returns; <para> <emphasis>returns</emphasis> Null on error or if there were no previous data parsing </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getversion.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getversion.since"> &title.since; <para> <emphasis>since</emphasis> version 1.9.0b1 (2008-11-30) </para> </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getversion.note"> &title.note; &note.notstatic; </refsection> <refsection xml:id="package.php.php-compatinfo.php-compatinfo.getversion.example"> &title.example; <para> Suppose we have to parse source code like this file, named &quot;conditional.php&quot; : <programlisting role="php"> <![CDATA[ <?php // PHP 4.0.0 : __FILE__ // PHP 4.0.6 : DIRECTORY_SEPARATOR // PHP 4.0.7 : version compare // PHP 4.3.0 : ob_get_clean // PHP 4.3.0 : debug_backtrace // PHP 4.3.10 and 5.0.2 : PHP_EOL // PHP 5.0.0 : simplexml_load_file // PHP 5.1.1 : DATE_W3C if (!defined('DIRECTORY_SEPARATOR')) { define('DIRECTORY_SEPARATOR', strtoupper(substr(PHP_OS, 0, 3) == 'WIN') ? '\\' : '/' ); } if (function_exists('debug_backtrace')) { $backtrace = debug_backtrace(); } else { $backtrace = false; } if (function_exists('simplexml_load_file')) { $xml = simplexml_load_file('C:\php\pear\PHP_CompatInfo\scripts\version.xml'); } if (version_compare(phpversion(), '5.0.0', '<')) { include_once 'PHP/Compat.php'; PHP_Compat::loadFunction('ob_get_clean'); PHP_Compat::loadConstant('PHP_EOL'); } echo "Hello World" . PHP_EOL; $ds = DIRECTORY_SEPARATOR; $fn = dirname(__FILE__) . $ds . basename(__FILE__); echo "You have run file : $fn at " . date(DATE_W3C) . PHP_EOL; ?> ]]> </programlisting> And this second file, named &quot;upload_error.php&quot; : <programlisting role="php"> <![CDATA[ <?php $uploadErrors = array( UPLOAD_ERR_INI_SIZE => "The uploaded file exceeds the upload_max_filesize directive in php.ini.", UPLOAD_ERR_FORM_SIZE => "The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form.", UPLOAD_ERR_PARTIAL => "The uploaded file was only partially uploaded.", UPLOAD_ERR_NO_FILE => "No file was uploaded.", UPLOAD_ERR_NO_TMP_DIR => "Missing a temporary folder.", UPLOAD_ERR_CANT_WRITE => "Failed to write file to disk.", UPLOAD_ERR_EXTENSION => "File upload stopped by extension.", ); $errorCode = $_FILES["myUpload"]["error"]; if ($errorCode !== UPLOAD_ERR_OK) { if (isset($uploadErrors[$errorCode])) { throw new Exception($uploadErrors[$errorCode]); } else { throw new Exception("Unknown error uploading file."); } } ?> ]]> </programlisting> </para> <para> Script to parse data source, will look like to: <programlisting role="php"> <![CDATA[ <?php require_once 'PHP/CompatInfo.php'; $pci = new PHP_CompatInfo('null'); $dir = dirname(__FILE__) . DIRECTORY_SEPARATOR; $input = array($dir . 'conditional.php', $dir . 'upload_error.php'); $options = array('ignore_functions' => array('simplexml_load_file'), 'ignore_constants' => array('DATE_W3C') ); $pci->parseData($input, $options); $version = $pci->getVersion(); echo 'GLOBAL version = '. $version . PHP_EOL; $version = $pci->getVersion($input[0]); echo basename($input[0]) . ' version = '. $version . PHP_EOL; $classes = $pci->getClasses(); echo 'ALL Classes = '. implode(',', $classes) . PHP_EOL; $functions = $pci->getFunctions(); echo 'ALL Functions = '. implode(',', $functions) . PHP_EOL; $extensions = $pci->getExtensions(); echo 'ALL Extensions required = '. implode(',', $extensions) . PHP_EOL; $constants = $pci->getConstants(); echo 'ALL Constants required = '. implode(',', $constants) . PHP_EOL; $tokens = $pci->getTokens(); echo 'ALL Tokens required = '. implode(',', $tokens) . PHP_EOL; $conditions = $pci->getConditions(false, true); echo 'ALL Code Conditions = '. $conditions . PHP_EOL; $conditions = $pci->getConditions($input[1], true); echo basename($input[1]) . ' conditions = '. $conditions . PHP_EOL; ?> ]]> </programlisting> We have just used the NULL renderer because we want to organize output results, as below: </para> <para> <screen> GLOBAL version = 5.2.0 conditional.php version = 4.3.10 ALL Classes = Exception ALL Functions = basename,date,debug_backtrace,define,defined,dirname,function_exists, phpversion,simplexml_load_file,strtoupper,substr,version_compare ALL Extensions required = date ALL Constants required = DATE_W3C,DIRECTORY_SEPARATOR,FALSE,PHP_EOL,PHP_OS, UPLOAD_ERR_CANT_WRITE,UPLOAD_ERR_EXTENSION,UPLOAD_ERR_FORM_SIZE,UPLOAD_ERR_INI_SIZE, UPLOAD_ERR_NO_FILE,UPLOAD_ERR_NO_TMP_DIR,UPLOAD_ERR_OK,UPLOAD_ERR_PARTIAL,__FILE__ ALL Tokens required = throw ALL Code Conditions = 5 upload_error.php conditions = 0 </screen> </para> </refsection> </refentry>
« previous php.pear.doc (#11338) next »