How to read a function definition (prototype)
Each function in the manual is documented for quick reference. Knowing how to read and understand the text will make learning PHP much easier. Rather than relying on examples or cut/paste, everyone should know how to read function definitions (prototypes). Let's begin:
Note: Prerequisite: Basic understanding of types
Although PHP is a loosely typed language, it's important to have a basic understanding of types as they have important meaning.
Function definitions tell us what type of value is returned. Let's use the definition for strlen() as our first example:
strlen (PHP 4, PHP 5) strlen -- Get string length Description strlen ( string $string ) : int Returns the length of given string.
Part | Description |
---|---|
strlen | The function name. |
(PHP 4, PHP 5) | strlen() has been around in all versions of PHP 4 and PHP 5 |
( string $string ) |
The first (and in this case the only) parameter/argument for this
function is named string , and it's a
string.
|
int | Type of value this function returns, which is an integer (i.e. the length of a string is measured in numbers). |
We could rewrite the above function definition in a generic way:
function name ( parameter type parameter name ) : returned type
Many functions take on multiple parameters, such as in_array(). Its prototype is as follows:
in_array ( mixed $needle, array $haystack [, bool $strict = FALSE ] ) : bool
What does this mean? in_array() returns a
boolean value, TRUE
on
success (if the needle
was found in the
haystack
) or FALSE
on failure (if the
needle
was not found in the
haystack
). The first parameter is named
needle
and it can be of many different
types, so we call it
"mixed". This mixed needle
(what we're looking for) can be either a scalar value (string, integer,
or float), or an
array.
haystack
(the array we're searching in) is the
second parameter. The third optional parameter is
named strict
. All optional parameters are seen
in [ brackets ]. The manual
states that the strict
parameter defaults to
boolean FALSE
. See the manual page on each function for details on
how they work.
In addition the & (ampersand) symbol prepended to a function parameter allows the parameter to be passed by reference, as seen below:
preg_match ( string $pattern , string $subject [, array &$matches [, int $flags = 0 [, int $offset = 0 ]]] ) : int
In this example, we can see the third optional parameter &$matches
will be
passed as reference.
There are also functions with more complex PHP version information. Take html_entity_decode() as an example:
(PHP 4 >= 4.3.0, PHP 5)
This means that this function has only been available in a released version since PHP 4.3.0.
Vertaling niet beschikbaar
De PHP-handleiding is nog niet in het Nederlands vertaald, dus het scherm is in het Engels. Als u wilt, kunt u het ook in het Frans of in het Duits raadplegen.
Als je de moed voelt, kun je je vertaling aanbieden ;-)
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 30/01/2003 gemaakt, de laatste keer de 26/10/2018 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/php-rf-about.prototypes.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.