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

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:

Prerequisitos: Comprensi贸n b谩sica de los diferentes tipos: Aunque PHP es un lenguaje de programaci贸n relajado en lo referente a los tipos de variables/valores, es importante entender b谩sicamente los diferentes tipos, ya que son importantes.

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.

Tabla R-1. Explicaci贸n de la definici贸n de una funci贸n

ParteDescripci贸n
strlen El nombre de la funci贸n.
(PHP 3, PHP 4 >= 4.0.0) strlen() est谩 disponible tanto en PHP 3 como en PHP 4
int Tipo de valor devuelto por esta funci贸n, en este caso un entero (La longitud de una cadena es medida en numeros)
( string str ) El primer (y en este caso el 煤nico) par谩metro/argumento de la funci贸n strlen() se llama str y es 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.