insteadof

La palabra clave insteadof de PHP

insteadof es una palabra clave de PHP que se usa dentro de un bloque use para resolver un conflicto de métodos entre dos o más traits. Cuando una clase usa varios traits que definen un método con el mismo nombre, PHP no puede decidir cuál prevalece y lanza un error fatal. insteadof le indica a PHP qué método del trait conservar y cuál descartar.

Esta página explica el conflicto que resuelve, su sintaxis exacta, cómo se combina con la palabra clave as para mantener el método "perdedor", y los aspectos importantes a tener en cuenta.

El problema que insteadof resuelve

Un trait es un bloque reutilizable de métodos que se copia en una clase en tiempo de compilación. Si dos traits definen un método con el mismo nombre y una clase usa ambos, PHP no tiene forma de elegir uno. El resultado es un error fatal de colisión:

<?php

trait FileLogger {
  function log() { echo "Writing to a file."; }
}
trait DatabaseLogger {
  function log() { echo "Writing to the database."; }
}

class Service {
  use FileLogger, DatabaseLogger; // No conflict resolution
}

// PHP Fatal error: Trait method DatabaseLogger::log has not been
// applied as Service::log, because of collision with FileLogger::log

La clase nunca llega a crearse — este es un error en tiempo de compilación, no en tiempo de ejecución. insteadof es la forma de decirle a PHP qué método aplicar.

Sintaxis

insteadof se escribe dentro del bloque de llaves de una instrucción use:

use TraitWeKeep, TraitWeDrop {
    TraitWeKeep::methodName insteadof TraitWeDrop;
}

Léase como: "usa el methodName de TraitWeKeep en lugar del de TraitWeDrop." Al trait nombrado después de insteadof se le elimina su versión de ese método de la clase.

<?php

trait FileLogger {
  function log() { echo "Writing to a file."; }
}
trait DatabaseLogger {
  function log() { echo "Writing to the database."; }
}

class Service {
  use FileLogger, DatabaseLogger {
    FileLogger::log insteadof DatabaseLogger;
  }
}

$service = new Service();
$service->log();
// Output: Writing to a file.

Resolución con más de un trait

Si tres o más traits colisionan, lista todos los traits que quieras excluir después de insteadof, separados por comas:

<?php

trait Json    { function format() { echo "JSON output"; } }
trait Xml      { function format() { echo "XML output"; } }
trait Csv      { function format() { echo "CSV output"; } }

class Report {
  use Json, Xml, Csv {
    Json::format insteadof Xml, Csv;
  }
}

$report = new Report();
$report->format();
// Output: JSON output

Conservar el otro método con as

insteadof descarta un método, pero a menudo no quieres perderlo, simplemente lo quieres con un nombre diferente para que ambos estén disponibles. Eso es lo que hace la palabra clave as: crea un alias del método excluido con un nuevo nombre para que sobreviva a la resolución del conflicto.

<?php

trait FileLogger {
  function log($msg) { return "[file] $msg"; }
}
trait DatabaseLogger {
  function log($msg) { return "[db] $msg"; }
}

class Service {
  use FileLogger, DatabaseLogger {
    FileLogger::log insteadof DatabaseLogger;  // FileLogger::log becomes log()
    DatabaseLogger::log as logToDb;            // DatabaseLogger::log survives as logToDb()
  }
}

$service = new Service();
echo $service->log("started"), "\n";      // [file] started
echo $service->logToDb("started"), "\n";  // [db] started

insteadof y as se usan casi siempre juntos: insteadof elige al ganador, as rescata al perdedor con un alias. La palabra clave as también puede cambiar la visibilidad de un método (por ejemplo, FileLogger::log as protected;).

Aspectos a tener en cuenta

• insteadof solo resuelve colisiones de nombres. Si los dos métodos no comparten nombre, no hay conflicto y insteadof es innecesario.
• Debes referenciar un método que realmente exista en el trait indicado, usando la sintaxis Trait::method. Un error tipográfico produce un error fatal.
• No combina comportamientos. El método excluido simplemente no se aplica; insteadof nunca llama a ambos métodos.
• Un método de una clase hija sigue teniendo prioridad sobre un trait. El orden de resolución de métodos es: los métodos definidos en la propia clase sobreescriben a los del trait, y los métodos del trait sobreescriben a los heredados (de la clase padre).

Cuándo usarlo

Recurre a insteadof cuando compongas una clase a partir de múltiples traits y dos de ellos resulten exponer el mismo nombre de método — algo común al mezclar traits de terceros que no controlas. Combinado con as, te permite componer comportamientos de traits independientes sin renombrar su código fuente, manteniendo tus clases modulares y libres de conflictos.

Práctica