cvs: phpdoc /en/reference/classkit .cvsignore configure.xml constants.xml ini.xml reference.xml /en/reference/classkit/functions
classkit-method-add.xml classkit-method-redefine.xml classkit-method-remove.xml classkit-method-rename.xml

sean Sun Aug 22 13:05:41 2004 EDT Added files: /phpdoc/en/reference/classkit .cvsignore configure.xml constants.xml ini.xml reference.xml /phpdoc/en/reference/classkit/functions classkit-method-add.xml classkit-method-redefine.xml classkit-method-remove.xml classkit-method-rename.xml Log: added classkit docs

http://cvs.php.net/co.php/phpdoc/en/reference/classkit/.cvsignore?r=1.1&p=1 Index: phpdoc/en/reference/classkit/.cvsignore +++ phpdoc/en/reference/classkit/.cvsignore functions.xml http://cvs.php.net/co.php/phpdoc/en/reference/classkit/configure.xml?r=1.1&p=1 Index: phpdoc/en/reference/classkit/configure.xml +++ phpdoc/en/reference/classkit/configure.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <section id="classkit.installation"> &reftitle.install; <para> &pecl.info; <ulink url="&url.pecl.package;classkit">&url.pecl.package;classkit</ulink>. </para> <para> In order to use these functions you must install <literal>classkit</literal> from PECL, by issuing <literal>pear install classkit</literal> </para> </section> <!-- 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/classkit/constants.xml?r=1.1&p=1 Index: phpdoc/en/reference/classkit/constants.xml +++ phpdoc/en/reference/classkit/constants.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <section id="classkit.constants"> &reftitle.constants; &extension.constants; <para> <variablelist> <varlistentry> <term> <constant>CLASSKIT_ACC_PRIVATE</constant> (<type>int</type>) </term> <listitem> <simpara> Marks the method <literal>private</literal> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>CLASSKIT_ACC_PROTECTED</constant> (<type>int</type>) </term> <listitem> <simpara> Marks the method <literal>protected</literal> </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>CLASSKIT_ACC_PUBLIC</constant> (<type>int</type>) </term> <listitem> <simpara> Marks the method <literal>public</literal> </simpara> </listitem> </varlistentry> </variablelist> </para> </section> <!-- 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/classkit/ini.xml?r=1.1&p=1 Index: phpdoc/en/reference/classkit/ini.xml +++ phpdoc/en/reference/classkit/ini.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <section id="classkit.configuration"> &reftitle.runtime; &no.config; </section> <!-- 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/classkit/reference.xml?r=1.1&p=1 Index: phpdoc/en/reference/classkit/reference.xml +++ phpdoc/en/reference/classkit/reference.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <reference id="ref.classkit"> <title>Classkit Functions</title> <titleabbrev>Classkit</titleabbrev> <partintro> <section id="classkit.intro"> &reftitle.intro; <para> These functions allow the dynamic manipulation of PHP classes, at runtime. </para> </section> &reference.classkit.configure; &reference.classkit.ini; <section id="classkit.resources"> &reftitle.resources; &no.resource; </section> &reference.classkit.constants; </partintro> &reference.classkit.functions; </reference> <!-- 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/classkit/functions/classkit-method-add.xml?r=1.1&p=1 Index: phpdoc/en/reference/classkit/functions/classkit-method-add.xml +++ phpdoc/en/reference/classkit/functions/classkit-method-add.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.classkit-method-add"> <refnamediv> <refname>classkit_method_add</refname> <refpurpose>Dynamically adds a new method to a given class</refpurpose> </refnamediv> <refsect1> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>classkit_method_add</methodname> <methodparam><type>string</type><parameter>classname</parameter></methodparam> <methodparam><type>string</type><parameter>methodname</parameter></methodparam> <methodparam><type>string</type><parameter>args</parameter></methodparam> <methodparam><type>string</type><parameter>code</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> </methodsynopsis> <para> Returns &true; on success, &false; on failure. </para> &warn.experimental.func; </refsect1> <refsect1> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>classname</parameter></term> <listitem> <para> The class to which this method will be added </para> </listitem> </varlistentry> <varlistentry> <term><parameter>methodname</parameter></term> <listitem> <para> The name of the method to add </para> </listitem> </varlistentry> <varlistentry> <term><parameter>args</parameter></term> <listitem> <para> Comma-delimited list of arguments for the newly-created method </para> </listitem> </varlistentry> <varlistentry> <term><parameter>code</parameter></term> <listitem> <para> The code to be evaluated when <parameter>methodname</parameter> is called </para> </listitem> </varlistentry> <varlistentry> <term><parameter>flags</parameter></term> <listitem> <para> The type of method to create, can be <constant>CLASSKIT_ACC_PUBLIC</constant>, <constant>CLASSKIT_ACC_PROTECTED</constant> or <constant>CLASSKIT_ACC_PRIVATE</constant> </para> <note> <simpara> This parameter is only used as of PHP 5, because, prior to this, all methods were public. </simpara> </note> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> <!-- No changelog: it's only in PECL. --> <refsect1> &reftitle.examples; <para> <example> <title><function>classkit_method_add</function> example</title> <programlisting role="php"> <![CDATA[ <?php class Example { function foo() { echo "foo!\n"; } } // create an Example object $e = new Example(); // Add a new public method classkit_method_add( 'Example', 'add', '$num1, $num2', 'return $num1 + $num2;', CLASSKIT_ACC_PUBLIC ); // add 12 + 4 echo $e->add(12, 4); ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ 16 ]]> </screen> </example> </para> </refsect1> <refsect1> &reftitle.seealso; <para> <function>classkit_method_redefine</function>, <function>classkit_method_remove</function>, <function>classkit_method_rename</function>&listendand; <function>create_function</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 --> http://cvs.php.net/co.php/phpdoc/en/reference/classkit/functions/classkit-method-redefine.xml?r=1.1&p=1 Index: phpdoc/en/reference/classkit/functions/classkit-method-redefine.xml +++ phpdoc/en/reference/classkit/functions/classkit-method-redefine.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.classkit-method-redefine"> <refnamediv> <refname>classkit_method_redefine</refname> <refpurpose>Dynamically changes the code of the given method</refpurpose> </refnamediv> <refsect1> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>classkit_method_redefine</methodname> <methodparam><type>string</type><parameter>classname</parameter></methodparam> <methodparam><type>string</type><parameter>methodname</parameter></methodparam> <methodparam><type>string</type><parameter>args</parameter></methodparam> <methodparam><type>string</type><parameter>code</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> </methodsynopsis> <para> Returns &true; on success, &false; on failure. </para> &note.classkit.selfmanipulation; &warn.experimental.func; </refsect1> <refsect1> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>classname</parameter></term> <listitem> <para> The class in which to redefine the method </para> </listitem> </varlistentry> <varlistentry> <term><parameter>methodname</parameter></term> <listitem> <para> The name of the method to redefine </para> </listitem> </varlistentry> <varlistentry> <term><parameter>args</parameter></term> <listitem> <para> Comma-delimited list of arguments for the redefined method </para> </listitem> </varlistentry> <varlistentry> <term><parameter>code</parameter></term> <listitem> <para> The new code to be evaluated when <parameter>methodname</parameter> is called </para> </listitem> </varlistentry> <varlistentry> <term><parameter>flags</parameter></term> <listitem> <para> The redefined method can be <constant>CLASSKIT_ACC_PUBLIC</constant>, <constant>CLASSKIT_ACC_PROTECTED</constant> or <constant>CLASSKIT_ACC_PRIVATE</constant> </para> <note> <simpara> This parameter is only used as of PHP 5, because, prior to this, all methods were public. </simpara> </note> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> <!-- No changelog: it's only in PECL. --> <refsect1> &reftitle.examples; <para> <example> <title><function>classkit_method_redefine</function> example</title> <programlisting role="php"> <![CDATA[ <?php class Example { function foo() { return "foo!\n"; } } // create an Example object $e = new Example(); // output Example::foo() (before redefine) echo "Before: " . $e->foo(); // Redefine the 'foo' method classkit_method_redefine( 'Example', 'foo', '', 'return "bar!\n";', CLASSKIT_ACC_PUBLIC ); // output Example::foo() (after redefine) echo "After: " . $e->foo(); ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Before: foo! After: bar! ]]> </screen> </example> </para> </refsect1> <refsect1> &reftitle.seealso; <para> <function>classkit_method_add</function>, <function>classkit_method_remove</function>&listendand; <function>classkit_method_rename</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 --> http://cvs.php.net/co.php/phpdoc/en/reference/classkit/functions/classkit-method-remove.xml?r=1.1&p=1 Index: phpdoc/en/reference/classkit/functions/classkit-method-remove.xml +++ phpdoc/en/reference/classkit/functions/classkit-method-remove.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.classkit-method-remove"> <refnamediv> <refname>classkit_method_remove</refname> <refpurpose>Dynamically removes the given method</refpurpose> </refnamediv> <refsect1> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>classkit_method_remove</methodname> <methodparam><type>string</type><parameter>classname</parameter></methodparam> <methodparam><type>string</type><parameter>methodname</parameter></methodparam> </methodsynopsis> <para> Returns &true; on success, &false; on failure. </para> &note.classkit.selfmanipulation; &warn.experimental.func; </refsect1> <refsect1> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>classname</parameter></term> <listitem> <para> The class in which to remove the method </para> </listitem> </varlistentry> <varlistentry> <term><parameter>methodname</parameter></term> <listitem> <para> The name of the method to remove </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> <!-- No changelog: it's only in PECL. --> <refsect1> &reftitle.examples; <para> <example> <title><function>classkit_method_remove</function> example</title> <programlisting role="php"> <![CDATA[ <?php class Example { function foo() { return "foo!\n"; } function bar() { return "bar!\n"; } } // Remove the 'foo' method classkit_method_remove( 'Example', 'foo' ); echo implode(' ', get_class_methods('Example')); } ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ bar ]]> </screen> </example> </para> </refsect1> <refsect1> &reftitle.seealso; <para> <function>classkit_method_add</function>, <function>classkit_method_redefine</function>&listendand; <function>classkit_method_rename</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 --> http://cvs.php.net/co.php/phpdoc/en/reference/classkit/functions/classkit-method-rename.xml?r=1.1&p=1 Index: phpdoc/en/reference/classkit/functions/classkit-method-rename.xml +++ phpdoc/en/reference/classkit/functions/classkit-method-rename.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.classkit-method-rename"> <refnamediv> <refname>classkit_method_rename</refname> <refpurpose>Dynamically changes the name of the given method</refpurpose> </refnamediv> <refsect1> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>classkit_method_rename</methodname> <methodparam><type>string</type><parameter>classname</parameter></methodparam> <methodparam><type>string</type><parameter>methodname</parameter></methodparam> <methodparam><type>string</type><parameter>newname</parameter></methodparam> </methodsynopsis> <para> Returns &true; on success, &false; on failure. </para> &note.classkit.selfmanipulation; &warn.experimental.func; </refsect1> <refsect1> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>classname</parameter></term> <listitem> <para> The class in which to rename the method </para> </listitem> </varlistentry> <varlistentry> <term><parameter>methodname</parameter></term> <listitem> <para> The name of the method to rename </para> </listitem> </varlistentry> <varlistentry> <term><parameter>newname</parameter></term> <listitem> <para> The new name to give to the renamed method </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> <!-- No changelog: it's only in PECL. --> <refsect1> &reftitle.examples; <para> <example> <title><function>classkit_method_rename</function> example</title> <programlisting role="php"> <![CDATA[ <?php class Example { function foo() { return "foo!\n"; } } // Rename the 'foo' method to 'bar' classkit_method_rename( 'Example', 'foo', 'bar' ); // output renamed function echo e->bar(); ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ foo! ]]> </screen> </example> </para> </refsect1> <refsect1> &reftitle.seealso; <para> <function>classkit_method_add</function>, <function>classkit_method_remove</function>&listendand; <function>classkit_method_redefine</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 -->