svn: /phpdoc/en/trunk/language/oop5/ autoload.xml cloning.xml decon.xml magic.xml overloading.xml

From: Date: Thu, 12 Jan 2012 13:55:24 +0000
Subject: svn: /phpdoc/en/trunk/language/oop5/ autoload.xml cloning.xml decon.xml magic.xml overloading.xml
Groups: php.doc.cvs 
Request: Send a blank email to doc-cvs+get-9428@lists.php.net to get a copy of this message
vrana Thu, 12 Jan 2012 13:55:24 +0000 Revision: http://svn.php.net/viewvc?view=revision&revision=322132 Log: Method synopses and IDs for magic methods and function Changed paths: U phpdoc/en/trunk/language/oop5/autoload.xml U phpdoc/en/trunk/language/oop5/cloning.xml U phpdoc/en/trunk/language/oop5/decon.xml U phpdoc/en/trunk/language/oop5/magic.xml U phpdoc/en/trunk/language/oop5/overloading.xml Modified: phpdoc/en/trunk/language/oop5/autoload.xml =================================================================== --- phpdoc/en/trunk/language/oop5/autoload.xml 2012-01-12 12:40:04 UTC (rev 322131) +++ phpdoc/en/trunk/language/oop5/autoload.xml 2012-01-12 13:55:24 UTC (rev 322132) @@ -2,6 +2,10 @@ <!-- $Revision$ --> <sect1 xml:id="language.oop5.autoload" xmlns="http://docbook.org/ns/docbook"> <title>Autoloading Classes</title> + <methodsynopsis xml:id="function.autoload"> + <type>void</type><methodname>__autoload</methodname> + <methodparam><type>string</type><parameter>class</parameter></methodparam> + </methodsynopsis> <para> Many developers writing object-oriented applications create one PHP source file per-class definition. One of the biggest Modified: phpdoc/en/trunk/language/oop5/cloning.xml =================================================================== --- phpdoc/en/trunk/language/oop5/cloning.xml 2012-01-12 12:40:04 UTC (rev 322131) +++ phpdoc/en/trunk/language/oop5/cloning.xml 2012-01-12 13:55:24 UTC (rev 322132) @@ -36,6 +36,11 @@ will remain references. </para> + <methodsynopsis xml:id="object.clone"> + <type>void</type><methodname>__clone</methodname> + <void/> + </methodsynopsis> + <para> Once the cloning is complete, if a <link linkend="language.oop5.cloning">__clone()</link> method is defined, then the newly created object's <link linkend="language.oop5.cloning">__clone()</link> method will be called, to allow any Modified: phpdoc/en/trunk/language/oop5/decon.xml =================================================================== --- phpdoc/en/trunk/language/oop5/decon.xml 2012-01-12 12:40:04 UTC (rev 322131) +++ phpdoc/en/trunk/language/oop5/decon.xml 2012-01-12 13:55:24 UTC (rev 322132) @@ -5,7 +5,7 @@ <sect2 xml:id="language.oop5.decon.constructor"> <title>Constructor</title> - <methodsynopsis> + <methodsynopsis xml:id="object.construct"> <type>void</type><methodname>__construct</methodname> <methodparam choice="opt"><type>mixed</type><parameter>args</parameter></methodparam> <methodparam choice="opt"><parameter>...</parameter></methodparam> @@ -87,7 +87,7 @@ <sect2 xml:id="language.oop5.decon.destructor"> <title>Destructor</title> - <methodsynopsis> + <methodsynopsis xml:id="object.destruct"> <type>void</type><methodname>__destruct</methodname> <void /> </methodsynopsis> Modified: phpdoc/en/trunk/language/oop5/magic.xml =================================================================== --- phpdoc/en/trunk/language/oop5/magic.xml 2012-01-12 12:40:04 UTC (rev 322131) +++ phpdoc/en/trunk/language/oop5/magic.xml 2012-01-12 13:55:24 UTC (rev 322132) @@ -37,6 +37,16 @@ <link linkend="language.oop5.magic.sleep">__sleep()</link> and <link linkend="language.oop5.magic.sleep">__wakeup()</link> </title> + + <methodsynopsis xml:id="object.sleep"> + <modifier>public</modifier> <type>array</type><methodname>__sleep</methodname> + <void/> + </methodsynopsis> + <methodsynopsis xml:id="object.wakeup"> + <type>void</type><methodname>__wakeup</methodname> + <void/> + </methodsynopsis> + <para> <function>serialize</function> checks if your class has a function with the magic name <link linkend="language.oop5.magic.sleep">__sleep()</link>. If so, that function is @@ -115,6 +125,10 @@ <sect2 xml:id="language.oop5.magic.tostring"> <title><link linkend="language.oop5.magic.tostring">__toString()</link></title> + <methodsynopsis xml:id="object.tostring"> + <modifier>public</modifier> <type>string</type><methodname>__toString</methodname> + <void/> + </methodsynopsis> <para> The <link linkend="language.oop5.magic.tostring">__toString()</link> method allows a class to decide how it will react when it is treated like a string. For example, @@ -169,6 +183,10 @@ <sect2 xml:id="language.oop5.magic.invoke"> <title><link linkend="language.oop5.magic.invoke">__invoke()</link></title> + <methodsynopsis xml:id="object.invoke"> + <type>mixed</type><methodname>__invoke</methodname> + <methodparam choice="opt"><parameter>...</parameter></methodparam> + </methodsynopsis> <para> The <link linkend="language.oop5.magic.invoke">__invoke()</link> method is called when a script tries to call an object as a function. @@ -208,6 +226,10 @@ <sect2 xml:id="language.oop5.magic.set-state"> <title><link linkend="language.oop5.magic.set-state">__set_state()</link></title> + <methodsynopsis xml:id="object.set-state"> + <modifier>static</modifier> <type>object</type><methodname>__set_state</methodname> + <methodparam><type>array</type><parameter>properties</parameter></methodparam> + </methodsynopsis> <para> This <link linkend="language.oop5.static">static</link> method is called for classes exported by <function>var_export</function> since PHP 5.1.0. Modified: phpdoc/en/trunk/language/oop5/overloading.xml =================================================================== --- phpdoc/en/trunk/language/oop5/overloading.xml 2012-01-12 12:40:04 UTC (rev 322131) +++ phpdoc/en/trunk/language/oop5/overloading.xml 2012-01-12 13:55:24 UTC (rev 322132) @@ -78,21 +78,21 @@ <sect2 xml:id="language.oop5.overloading.members"> <title>Property overloading</title> - <methodsynopsis> - <type>void</type><methodname>__set</methodname> + <methodsynopsis xml:id="object.set"> + <modifier>public</modifier> <type>void</type><methodname>__set</methodname> <methodparam><type>string</type><parameter>name</parameter></methodparam> <methodparam><type>mixed</type><parameter>value</parameter></methodparam> </methodsynopsis> - <methodsynopsis> - <type>mixed</type><methodname>__get</methodname> + <methodsynopsis xml:id="object.get"> + <modifier>public</modifier> <type>mixed</type><methodname>__get</methodname> <methodparam><type>string</type><parameter>name</parameter></methodparam> </methodsynopsis> - <methodsynopsis> - <type>bool</type><methodname>__isset</methodname> + <methodsynopsis xml:id="object.isset"> + <modifier>public</modifier> <type>bool</type><methodname>__isset</methodname> <methodparam><type>string</type><parameter>name</parameter></methodparam> </methodsynopsis> - <methodsynopsis> - <type>void</type><methodname>__unset</methodname> + <methodsynopsis xml:id="object.unset"> + <modifier>public</modifier> <type>void</type><methodname>__unset</methodname> <methodparam><type>string</type><parameter>name</parameter></methodparam> </methodsynopsis> @@ -276,13 +276,13 @@ <sect2 xml:id="language.oop5.overloading.methods"> <title>Method overloading</title> - <methodsynopsis> - <type>mixed</type><methodname>__call</methodname> + <methodsynopsis xml:id="object.call"> + <modifier>public</modifier> <type>mixed</type><methodname>__call</methodname> <methodparam><type>string</type><parameter>name</parameter></methodparam> <methodparam><type>array</type><parameter>arguments</parameter></methodparam> </methodsynopsis> - <methodsynopsis> - <type>mixed</type><methodname>__callStatic</methodname> + <methodsynopsis xml:id="object.callstatic"> + <modifier>public static</modifier> <type>mixed</type><methodname>__callStatic</methodname> <methodparam><type>string</type><parameter>name</parameter></methodparam> <methodparam><type>array</type><parameter>arguments</parameter></methodparam> </methodsynopsis>

« previous php.doc.cvs (#9428) next »