Como interpretar la definición de una función (prototipo)

Cada función está documentada para una obtener una referencia rápida, si sabemos como interpretar y entender el manual podremos usar PHP de una manera más sencilla. En vez de confiar en ejemplos ó cortar y pegar, podeis aprender como interpretar las definiciones de funciones. Empecemos:

Las definiciones de funciones nos dicen que tipo de valores es retornado. Usemos la definición de la función strlen() en nuestro primer ejemplo:

strlen (PHP 3, PHP 4 >= 4.0.0) strlen -- Obtiene la longitud de una cadena. Descripción int strlen ( string str ) Retorna la longitud de una cadena.

Podriamos escribir la definicion de esta función de un modo genérico:

Tipo de valor retornado - nombre de función (tipo de parametro - nombre del parametro)

Muchas funciones tiene multiples parametros, por ejemplo in_array(). Su definición seria:

bool in_array ( mixed needle, array haystack [, bool strict])

Esto significa lo siguiente, in_array() retorna un valor boolean, TRUE si termina con exito (el parametro needle fue encontrado en la matriz haystack) ó FALSE si falla (el parametro needle no fue encontrado en la matriz haystack). El primer parametro se llama needle y puede tener valores de diferente tipo, asi que lo llamamos de tipo "mixed". Este parametro needle (lo que estamos buscando) puede ser un valor escalar (cadena (string), entero (integer) o flotante(float)), ó una matriz. haystack, (la matriz en la que estamos buscando) es el segundo parámetro. El tercer parametro opcional se llama strict. Todos los parámetros opcionales se encuentran entre [ corchetes ]. El manual define que el parametro strict por defecto retorna FALSE. Consultar el manual para obtener detalles de como las diferentes funciones funcionan.