Funciones en PHP

Para definir funciones disponemos de la instrucción function

Después de esta palabra reservada se coloca el nombre de la función seguido de una lista de argumentos delimitados por paréntesis y separados por comas

function nombre( param1, param2,..., paramn ) {
    instrucciones en PHP;
}

Argumentos

El paso de argumentos es opcional y en algunos casos puede haber funciones que carezcan de ellos

Por ejemplo la función phpinfo no tiene argumentos

Esta función nos muestra información referente al módulo PHP que estamos usando y siempre devuelve el valor entero 1

Tipo de los argumentos

A partir de PHP 7 se puede declarar de forma opcional el tipo de los argumentos pasados a la función

Admite los tipos string, int, float, array, callable y clases

function sumar( int $a, int $b ) {
    echo($a + $b); #nos mostrará el resultado de la suma
}

sumar(5, 'a'); #el segundo argumento debía ser de tipo int, se mostrará un mensaje de error

Si el usuario de la función los introduce mal o utiliza otro tipo de dato, PHP devolverá un mensaje de error indicándolo

Argumentos con valor por defecto

En ocasiones necesitamos que un argumento tenga un valor, para evitar un error, aunque el usuario de la función no lo introduzca

Hay que tener en cuenta, que los argumentos con valor por defecto pasan a ser opcionales y que todos los argumentos a la izquierda del primer valor por defecto, son obligatorios

#el segundo argumento tiene el valor 1 por defecto, para evitar la división por 0
function dividir( int $a, int $b = 1 ) {
    echo($a / $b); #nos mostrará el resultado de la división
}

dividir(10, 2); #se ha usado la función de la forma normal
dividir(5); #se ha prescindido el segundo argumento, $b tendrá el valor 1, que era su valor por defecto

Argumentos por valor o por referencia

Cuando pasamos un valor a una función, aunque lo modifiquemos, al salir de la función conservará su valor original

Esta es la situación por defecto y se denomina que es un argumento por valor

Ya que se utiliza una copia en memoria de la variable y cuando se sale de la función, esa copia de la variable se destruye

En el caso de que quisiéramos que los cambios realizados en el valor de la variable se conservarán después de salir de la función, deberemos usar el símbolo & delante del nombre de la variable

A esta situación se denomina que es un argumento por referencia

Ya que se utiliza una referencia a la variable en memoria, trabajando directamente sobre la variable y cuando se sale de la función, todos los cambios permanecen

#el argumento $a es pasado por valor
function incremento( int $a = 0 ) {
    $a++;
}

#el argumento $a es pasado por referencia
function incremento_r( int &$a = 0 ) {
    $a++;
}

$a = 5;
incremento($a);
echo($a); #mostrará el valor 5, ya que $a se pasó por valor, no ha cambiado
incremento_r($a);
echo($a); #mostrará el valor 6, ya que $a se pasó por referencia, sí ha cambiado

Hasta PHP 5.0.5 era posible indicar que una función era por referencia usando el símbolo & delante del nombre de la función

Sin embargo, a partir de PHP 5.3.0 pasaría a indicar con un mensaje call-time pass-by-reference que su uso estaba obsoleto

A partir de PHP 5.4.0 fue totalmente eliminado y actualmente produce un error fatal

function foo( &$var) {
    $var++;
}

#no se ha utilizado el &
function bar() {
    $a = 5;

    return $a;
}

#Producirá un error fatal a partir de PHP 5.0.5, un aviso a partir de PHP 5.1.1, y un aviso a partir de PHP 7.0.0
foo( bar() );

foo( $a = 5 ); #es una expresión, no una variable, está permitido
foo(5); #Produce un error fatal, era una constante

class Foobar {}

foo( new Foobar() ); #A partir de PHP 7.0.7 produce un aviso, solo las variables deben pasarse por referencia

Es decir, sólo puede utilizarse el símbolo & al pasar argumentos, nunca en el nombre de la función

Sólo podemos pasar por referencia:

• Variables
• Referencias devueltas desde funciones

La sentencia return

La sentencia return es la que permite devolver el resultado de una función

A partir de PHP 7 se puede declarar de forma opcional el tipo devuelto por la función

Admite los tipos string, int, float, array, callable y clases

Para declarar el tipo se escribirá el símbolo : después de los paréntesis que siguen a los argumentos y antes de la llave de inicio {

function sumar( int $a, int $b ) : int {
    return $a + $b; #nos devolverá el resultado de la suma
}

echo sumar(5, 6); #mostrará 11

Funciones predefinidas por el lenguaje

Funciones de visualización

Echo

La función echo sirve para enviar la salida de sus argumentos al navegador

Lo hemos usado continuamente en ejemplos previos

Tiene el formato:

echo( string $arg1 [, string $... ] ) : void;

Tiene las siguientes particularidades:

• Podemos prescindir de los paréntesis en su uso, ya que son opcionales

• Convierte toda la información a string antes de enviarla al navegador

• Si utilizamos varios echo seguidos, nos encontraremos que el resultado lo concatena en la misma línea

  Para solucionarlo deberemos utilizar la etiqueta HTML <br/> para que salte de línea

• Si utilizamos varios echo seguidos, nos encontraremos que el resultado no añade un espacio al final y por tanto, el contenido podría mostrar textos incomprensibles, al carecer de ese espacio

  Para solucionarlo deberemos añadir un espacio al final del primer echo o al principio del siguiente echo

echo("Este es el ejemplo de echo"); #con paréntesis
echo "prueba"; #sin paréntesis
echo 1;
#mostrará en el navegador 'Esto es un ejemplo de echoprueba1'

#el resultado no se entendía bien, tratamos de solucionarlo
echo "Este es el ejemplo de echo<br/>"; #se ha añadido <br/> al final, para saltar de línea
echo "prueba "; #se ha añadido un espacio al final, para que se entienda mejor al leerlo
echo 1;
/* mostrará en el navegador
'Esto es un ejemplo de echo
prueba 1'
*/

printf

La función printf sirve para enviar la salida de sus argumentos al navegador con un formato

Tiene el formato:

printf( string $format [, mixed $args [, mixed $... ]] ) : int;

Para formatear un texto deberemos introducir los siguientes caracteres de formato precedidos por el símbolo %:

int $n =  43951789;
int $u = -43951789;
string $c = 65; // ASCII 65 es 'A'

printf("80%% de los corredores"); # % para literales, muestra '80% de los corredores'
printf("%b", $n); # b para número binario, muestra '10100111101010011010101101'
printf("%c", $c); # c para valor ASCII del número, muestra 'A'
printf("%d", $n); # d para número entero, muestra '43951789'
printf("%+d", $n); # +d para número entero positivo con signo, muestra '+43951789'
printf("%+d", $u); # +d para número entero negativo con signo, muestra '-43951789'
printf("%e", $n); # e para notación científica del número entero, muestra '4.39518e+7'
printf("%E", $n); # E para notación científica del número entero, muestra '4.39518E+7'
printf("%f", $n); # f para número decimal (considerando la configuración regional), muestra '43951789.000000'
printf("%F", $n); # F para número decimal (sin considerar la configuración regional), muestra '43951789.000000'
printf("%g", $n); # g igual que e y f
printf("%G", $n); # G igual que E y f
printf("%o", $n); # o para número octal, muestra '247523255'
printf("%s", $n); # s como una cadena, muestra '43951789'
printf("%E", $n); # E para notación científica del número entero, muestra '4.39518E+7'
printf("%u", $n); # u para número entero positivo sin signo, muestra '43951789'
printf("%u", $n); # u para número entero negativo sin signo, muestra '4251015507'
printf("%x", $u); # x para número hexadecimal, muestra '29ea6ad'
printf("%X", $n); # X para número hexadecimal en mayúsculas, muestra '29EA6AD'

sprintf

La función sprintf sirve para asignar a sus argumentos, de forma formateada, la variable de retorno

Tiene el mismo formato que printf y admite los mismos formatos

print_r

La función print_r sirve para enviar la salida de sus argumentos al navegador, mostrando información entendible por las personas sobre los argumentos

Es útil para poder depurar nuestro código

Tiene el siguiente formato:

print_r ( mixed $expression [, bool $return = FALSE ] ) : mixed;

Podemos usarlo para ver el contenido completo de un array

$a = array(
              'a' => 'manzana',
              'b' => 'banana',
              'c' => array('x', 'y', 'z')
);
print_r($a);

/* Mostrará

Array
(
    [a] => manzana
    [b] => banana
    [c] => Array
        (
            [0] => x
            [1] => y
            [2] => z
        )
)
*/

Funciones para cadenas

Vamos a ver algunas de las funciones para cadenas de uso más cotidiano

Si necesitas más, la lista completa la puedes encontrar en el manual de PHP

Mayúsculas y minúsculas

La función strtoupper devuelve una copia de la cadena en mayúsculas

La función strtolower devuelve una copia de la cadena en minúsculas

$str = "Me gusta programar en PHP";
echo strtoupper($str); #muestra 'ME GUSTA PROGRAMAR EN PHP'
echo strtolower($str); #muestra 'me gusta programar en php'

Extraer cadena

La función substr sirve para extraer una subcadena de la cadena que le pasamos como argumento

Tiene el siguiente formato:

substr( string $string, int $start [, int $length ] ) : string;

Dónde $start es la posición de inicio de la subcadena y $length la longitud que tendrá la subcadena

Puede ser útil cuando necesitamos extraer una palabra de un texto y conocemos previamente su posición y su longitud

$str = "En un lugar de la Mancha de cuyo nombre no quiero acordarme";
echo substr( $str, 18, 6); #muestra 'Mancha'

Hay que tener en cuenta que la posición $start debe empezar en 0

Longitud de la cadena

La función strlen sirve para contar la longitud de la cadena

Tiene el siguiente formato:

strlen( string $string ) : int;

Retomando la cadena del ejemplo anterior

$str = "En un lugar de la Mancha de cuyo nombre no quiero acordarme";
echo strlen($str); #muestra 58

Posición de un carácter en la cadena

La función strpos sirve para encontrar la posición de un carácter concreto en la cadena

Tiene el siguiente formato:

strpos( string $haystack, mixed $needle [, int $offset = 0 ] ) : mixed;

Dónde encontramos la aguja ($needle, es el carácter a buscar) en el pajar ($haystack, es la cadena en la que buscamos) y $offset, que es opcional, es el número inicial en el que se empieza a buscar

$mail = "pedro@proveedor.net";
echo strpos($mail, '@'); #muestra 5

Hay que tener en cuenta que la posición inicial empieza en cero

A no ser que especifiquemos el valor de $offset

Encontrar un texto

La función strstr sirve para encontrar la primera aparición de una cadena

Tiene el siguiente formato:

strstr( string $haystack, mixed $needle [, bool $before_needle = FALSE ] ) : string;

Es muy similar a substr, pero nos ahorra el tener que usar strpos de forma intermedia

$mail = "pedro@proveedor.net";
echo substr( $mail, strpos($mail, '@') ); #muestra 'proveedor.net'
echo strstr( $mail, '@' ); #muestra 'proveedor.net', por lo que son equivalentes, nos ahorra algo de código

Funciones para matrices

Vamos a ver algunas de las funciones para matrices de uso más cotidiano

Si necesitas más, la lista completa la puedes encontrar en el manual de PHP

Contar el número de elementos

La función count sirve para contar el número total de elementos

Tiene el siguiente formato:

count( mixed $array_or_countable [, int $mode = COUNT_NORMAL ] ) : int;

De forma opcional podemos utilizar el argumento $mode que por defecto utiliza el valor COUNT_NORMAL (cuenta los elementos secuencialmente) y para arrays multidimensionales COUNT_RECURSIVE (cuenta los elementos de forma recursiva, es decir, recorre todos los arrays multidimensionales y suma el total de elementos)

$a = array(
              'a' => 'manzana',
              'b' => 'banana',
              'c' => array('x', 'y', 'z')
);

echo count($a); #muestra 3, ya que usa COUNT_NORMAL por defecto
echo count($a, COUNT_RECURSIVE); #muestra 8, ya que usa COUNT_RECURSIVE para contar de forma recursiva
echo count($a, 1); #muestra 8, ya que 1 es un valor equivalente a COUNT_RECURSIVE

Buscar un valor en la matriz

Comprobar si un valor existe

La función in_array sirve para comprobar si un valor existe dentro de una matriz

Tiene el siguiente formato:

in_array( mixed $needle , array $haystack [, bool $strict = FALSE ] ) : bool;

Dónde encontramos la aguja ($needle, es el carácter a buscar) en el pajar ($haystack, es la cadena en la que buscamos) y $strict, que es opcional, si es TRUE comprobará los tipos de $needle en $haystack

Si $needle es un string, la comparación se realiza considerando las mayúsculas ó minúsculas

$os = array("Mac", "NT", "Irix", "Linux");

#mostrará esta opción
if (in_array("Irix", $os) ) { 
    echo "Existe Irix\n";
}
#pero no mostrará esta opción porque distingue entre mayúsculas y minúsculas
if (in_array("mac", $os) ) { 
    echo "Existe mac\n";
}

$a = array('1.10', 12.4, 1.13);

#mostrará esta opción por tener activa la comprobación estricta
if (in_array(1.13, $a, true) ) {
    echo "Se encontró 1.13\n";
}
#no mostrará esta opción porque al tener activa la comprobación estricta comprueba los tipos
if (in_array('12.4', $a, true) ) { 
    echo "Se encontró '12.4'\n";
}

$a = array(array('p', 'h'), array('p', 'r'), 'o');

#mostrará esta opción porque permite buscar un array dentro de otro array, el cual considera como un string
if (in_array(array('p', 'h'), $a) ) {
    echo "Se encontró 'ph'\n";
}
#no mostrará esta opción porque el array no pudo ser encontrado
if (in_array(array('f', 'i'), $a) ) {
    echo "Se encontró 'fi'\n";
}
#mostrará esta opción porque el carácter pudo ser encontrado
if (in_array('o', $a) ) {
    echo "Se encontró 'o'\n";
}

Encontrar el primer valor

La función array_search sirve para encontrar el primer valor, si existe, dentro de una matriz

Tiene el siguiente formato:

array_search( mixed $needle , array $haystack [, bool $strict = false ] ) : mixed;

Dónde encontramos la aguja ($needle, es el carácter a buscar) en el pajar ($haystack, es la cadena en la que buscamos) y $strict, que es opcional, si es TRUE comprobará los tipos de $needle en $haystack

Si $needle es un string, la comparación se realiza considerando las mayúsculas ó minúsculas

Hay que tener cuidado con los valores devueltos por esta función porque puede devolver el valor booleano FALSE, pero también puede devolver un valor no booleano que se evalúa como FALSE

En versiones anteriores a PHP 4.2.0 devolvía NULL en caso de fallo, en lugar de FALSE

A partir de PHP 5.3.0 devuelve NULL si se le pasan parámetros inválidos

$array = array(0 => 'azul', 1 => 'rojo', 2 => 'verde', 3 => 'amarillo');

$clave = array_search('verde', $array);
echo($clave); #mostrará 2
$clave = array_search('rojo', $array);
echo($clave); #mostrará 1

Formatos de fecha

PHP no dispone de un tipo para fechas

Para trabajar con fechas utilizar strings formateados con marcas de tiempo al estilo de UNIX

Estas marcas de tiempo son un valor de entero medido en segundos que empiezan a contar a partir del 1 de Enero de 1970

Marcas de tiempo

Para obtener la marca de tiempo actual podemos usar la función time que tiene el siguiente formato:

time( void ) : int;

El valor obtenido es fácil de manipular, ya que podemos sumarle múltiplos:

• de 3600 para añadirle horas
• de 86400 para añadirle días
• de 604800 para añadirle semanas

Cadena con formato

También podemos usar una cadena de formato para trabajar con fechas usando la función date que tiene el siguiente formato:

date( string $format [, int $timestamp = time() ] ) : string;

Donde $format es el cadena con el formato que queremos usar, $timestamp, que es opcional y por defecto se toma la función time, es una marca de tiempo UNIX

Para formatear una fecha deberemos introducir los siguientes caracteres de formato:

$fecha = date("d-m-Y"); #fecha en formato de España
echo $fecha; #mostrará la fecha de hoy con el formato 'dd-mm-YYYY' de España

Obtener una fecha desde una cadena

Usando un delimitador

A partir de una cadena podemos recoger una fecha usando la función explode que tiene el siguiente formato:

explode( string $delimiter , string $string [, int $limit = PHP_INT_MAX ] ) : array;

Donde $delimiter es el carácter usado para delimitar los valores, $string la cadena que contiene la fecha que queremos manipular y $limit un valor opcional cuyo valor por defecto es 1, que indica el máximo de valores devueltos

Si $limit es negativo se devolverán todos los valores eliminando el valor de $limit a partir del final

Y si es 0 se tratará como 1

Y después usaremos la función mktime para crear la marca de tiempo de tipo UNIX, que tiene el siguiente formato:

mktime([ int $hour = date("H") [, int $minute = date("i") [, int $second = date("s") [, int $month = date("n") [, int $day = date("j") [, int $year = date("Y") [, int $is_dst = -1 ]]]]]]] ) : int;

Donde $hour es la hora, $minute son los minutos, $second, los segundos, $month es el mes, $day es el día, $year es el año y $is_dst es el horario de verano o no (-1 si no lo es)

Todos los parámetros son opcionales, en caso de no introducir ninguno, se tomará el resultado de la función time

A partir de 5.1, cuando se hace la llamada sin argumentos, lanza un aviso de tipo E_STRICT: use la función time() en su lugar

$fecha = "03-05-1978"; #fecha en formato de España

$partes = explode('-', $fecha); #extraemos las partes de la fecha usando el separador '-'
$dia = $partes[0]; #guardamos el día de la fecha
$mes = $partes[1]; #guardamos el mes de la fecha
$ano = $partes[2]; #guardamos el año de la fecha

$timestamp = mktime(12, 0, 0, $mes, $dia, $ano); #guardamos la fecha en formato UNIX

Convirtiendo una cadena a formato de fecha

A partir de una cadena podemos recoger una fecha usando la función strtotime que tiene el siguiente formato:

strtotime( string $time [, int $now = time() ] ) : int;

Donde $time es la cadena de la que queremos obtener la fecha, $now, que es opcional y por defecto se toma la función time, es una marca de tiempo UNIX

A partir de PHP 5.0.0 los microsegundos comenzaron a estar permitidos, pero eran ignorados

En PHP 5 hasta 5.0.2, now y otros momentos relativos son computados erróneamente como la medianoche de hoy

Esto difiere entre versiones donde es computado como el momento actual

A partir de PHP 5.1.0 muestra el error E_STRICT y E_NOTICE cuando ocurren errores con zonas horarias

Y devuelve FALSE si falla, en vez de -1

En PHP 5 hasta 5.2.7, las peticiones de una incidencia de un día de la semana dado en un mes donde ese día de la semana era el primer día del mes, añadía incorrectamente una semana a la marca de tiempo devuelta

Esto fue corregido en 5.2.7 y se mantiene en versiones posteriores

Antes de PHP 5.3.0, 24:00 no era un formato válido y devolvía FALSE

Los formatos de tiempo relativos que se suministraban al parámetro $time como this week, previous week, last week, y next week se interpretaban como un período de 7 días en relación con la fecha y hora actual, en lugar de un período de la semana de Monday a Sunday

$fecha = "03-05-1978"; #fecha en formato de España

$timestamp = strtotime($fecha); #guardamos la fecha en formato UNIX