Interesantes usos y alternativas de __toString() en PHP 5.x

Oriol — Wed, 01 Apr 2009 23:50:19 +0000

Desde la llegada de PHP 5.0 disponemos de varios métodos mágicos para nuestras clases PHP, entre ellos tenemos __toString() que nos permite codificar cómo queremos que se comporte una clase cuando una instancia de ella se convierte a un string.

Aunque a simple vista el método __toString() pueda parecer poco importante en PHP éste toma mucha relevancia si trabajamos con symfony o algún otro framework orientado a objetos donde la información de la base datos se encuentra mapeada en un modelo de objetos.

A pesar de que __toString() está disponible desde la versión 5.0.0 del PHP en mi opinión no empieza a ser realmente útil hasta la versión 5.2.0, algo que en el changelog del PHP reflejaron con un tímido:

Changed __toString() to be called wherever applicable. (Marcus)

Hasta entonces __toString() sólo se llamaba cuando se usaba echo() o print() lo que limitaba mucho su funcionalidad. Desde la versión 5.2.0 __toString() se llama siempre que tratemos a un objeto como a un string.

Por ejemplo dada la siguiente definición de clase:

class User extends BaseUser
{
public function __toString()
{
return $this->getName();
}
}

Hasta PHP 5.2.0 sólo podíamos invocar a __toString() con:

$user = new User();
echo $user;
print $user;

Desde la versión 5.2.0 podemos hacer varias cosas interesantes con __toString() sobretodo relacionadas con el manejo de arrays de objetos, algo muy frecuente en los frameworks que corren por ahí hoy en día.

Por ejemplo si obtenemos el típico array de objetos con symfony:

$users = UserPeer::doSelect(new Criteria());

Trabajando directamente con las funciones de PHP entre otras muchas cosas podemos:

Ordenar el array de objetos con un simple sort()
Eliminar objetos duplicados del array con un array_unique()
Generar una lista separada por comas para la presentación con un implode()
Buscar un objeto determinado dentro del array con array_search()

Alternativas a __toString()

Si no tenemos la suerte de trabajar con PHP 5.2.x, o si queremos poder trabajar con un método distinto de __toString() para determinadas operaciones con arrays de objetos, podemos usar un código parecido al que propongo a continuación:

class objectTools
{
protected static function getMethodValues($list, $method)
{
$items = array();
foreach ($list as $key => $obj)
$items[$key] = $obj->$method();
return $items;
}
protected static function getObjectList($items, $list)
{
$ret = array();
foreach ($items as $key => $item)
$ret[] = $list[$key];
return $ret;
}
public static function arraySortByMethod($list, $method, $sort='desc')
{
$items = self::getMethodValues($list, $method);
asort($items);
if ($sort=='desc')
return array_values(array_reverse(self::getObjectList($items, $list)));
return self::getObjectList($items, $list);
}
public static function arrayUniqueByMethod($list, $method)
{
$items = self::getMethodValues($list, $method);
return self::getObjectList(array_unique($items), $list);
}
public static function arrayImplodeByMethod($list, $method, $sep)
{
$items = self::getMethodValues($list, $method);
return implode($sep, $items);
}
public static function arraySearchByMethod($list, $method, $needle)
{
$items = self::getMethodValues($list, $method);
return array_search($needle, $items);
}
}

Lo anterior es más una propuesta de código que algo decente para ser distribuido. Simplemente se trata de trabajar con un array temporal para almacenar los valores del método solicitado, correr la función PHP y, si es necesario, volver a construir el array de objetos.

Algunos ejemplos de uso:

$ordenados = objectTools::arraySortByMethod($users, 'getName', 'asc');
$sin_duplicados = objectTools::arrayUniqueByMethod($users, 'getName');
$pos = objectTools::arraySearchByMethod($users, 'getName', 'oriol');
//y por último en una plantilla...
echo 'Usuarios: ' . objectTools::arrayImplodeByMethod($users, 'getName', ', ');

Fácilmente se pueden añadir tantos métodos de tratamiento de arrays como se necesiten... o mucho mejor hacer un método que simplemente reciba como variable la función PHP a ejecutar. En mi caso de momento sólo necesito estos en concreto y también así los puedo controlar individualmente.

Aunque estos métodos de objectTools nacieron como "parche" rápido dado que no tenía PHP 5.2.x para un proyecto symfony, ahora, una vez solventando el problema con los servidores, los sigo encontrando útiles en múltiples situaciones. Por supuesto se ha de tener presente el poco rendimiento de este código frente a realizar queries a medida usando el objeto Criteria, pero si ya tenemos un array de objetos en memoria sí que será más óptimo trabajar con él en lugar de lanzar varias queries contra la base de datos.

Entradas relacionadas:

PHPBSD.net » tostring

Interesantes usos y alternativas de __toString() en PHP 5.x

Alternativas a __toString()