Added more information and made the examples easier to understand

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@169826 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Aidan Lister 2004-10-03 05:07:04 +00:00
parent fea8f64e69
commit 074cc6526d

View file

@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<sect1 id="language.oop5.typehinting">
<title>Type Hinting</title>
<para>
PHP 5 introduces Type Hinting. Methods are now able to force parameters
PHP 5 introduces Type Hinting. Functions are now able to force parameters
to be objects by specifying the name of the class in the function prototype.
</para>
@ -12,6 +12,7 @@
<programlisting role="php">
<![CDATA[
<?php
// An example class
class MyClass
{
/**
@ -24,29 +25,70 @@ class MyClass
}
}
// Another example class
class OtherClass {
public $var = 'Hello World';
}
?>
]]>
</programlisting>
<para>
Failing to satisfy the type hint results in a fatal error.
</para>
<programlisting role="php">
<![CDATA[
<?php
// An instance of each class
$myclass = new MyClass;
$otherclass = new OtherClass;
// These are fatal errors
// Argument 1 must be an object of class OtherClass
// Fatal Error: Argument 1 must be an object of class OtherClass
$myclass->test('hello');
// Argument 1 must be an instance of OtherClass
// Fatal Error: Argument 1 must be an instance of OtherClass
$foo = new stdClass;
$myclass->test($foo);
// Argument 1 must not be null
// Fatal Error: Argument 1 must not be null
$myclass->test(null);
// This is fine
$foo = new OtherClass;
// Prints Hello World
$myclass->test($foo);
?>
// Works: Prints Hello World
$myclass->test($otherclass);
?>
]]>
</programlisting>
<para>
Type hinting also works with functions:
</para>
<programlisting role="php">
<![CDATA[
<?php
// An example class
class MyClass {
public $var = 'Hello World';
}
/**
* A test function
*
* First parameter must be an object of type MyClass
*/
function MyFunction (MyClass $foo) {
echo $foo->var;
}
// Works
$myclass = new MyClass;
MyFunction($myclass);
?>
]]>
</programlisting>
</example>
<para>
Type Hints can only be of the <type>object</type> type. Traditional
type hinting with <type>int</type> and <type>string</type> are not
supported.
</para>
</sect1>
<!-- Keep this comment at the end of the file