Patrón Simple Factory en PHP5

Factory Method o Simple Factory

  
"Clase con la responsabilidad de crear objetos de otras clases. No delega en subclases y sus métodos pueden ser estáticos. Puede evolucionar en un Abstract Factory." [1]


Clasificación del patrón

Creacional.

Intención o problema que soluciona


Centraliza en una clase constructora la creación de objetos de un subtipo de un tipo determinado, ocultando al cliente la casuística para elegir el subtipo que crear.

Motivación

Muchos de ustedes pensaran: ¿Por qué complicarme tanto la vida utilizando un patrón de diseño, en lugar de instanciarla directamente $obj = new MiClase () ?

Hay un escenario principal en el que puede resultar útil.

Flexibilidad en tiempo de ejecución: A veces es imposible elegir de antemano cuál objeto específico debe ser instanciado, ya que la elección de los objetos a utilizar puede depender de algo en el entorno de ejecución.

Aplicabilidad

  1. Una clase no puede prever la clase de objetos que debe crear.
  2. Centralizar la creación de objetos.
  3. Proveer una interfaz para el cliente, permitiendo crear una familia de objetos sin especificar su clase.
Estructura



Implementación

La clase UserFactory tiene un método estático create, el cual recibe como parámetro un argumento y según el valor de este decide que clase instanciar (usualmente una subclase).

Código de Ejemplo en PHP5

Existen diferentes tipos y variantes de fábricas. En este artículo explicaré el Simple Factory.

  1. interface FactoryInterface {  
  2. static public function Create($name);  
  3. }  

  1. abstract class User {  
  2.   
  3.     protected $name = NULL;  
  4.       
  5.     public function __construct($name)  
  6.     {  
  7.         $this->name = $name;  
  8.     }  
  9.   
  10.     public function getName()  
  11.     {  
  12.         return $this->name;  
  13.     }  
  14.   
  15.     public function hasReadPermission()  
  16.     {  
  17.         return true;  
  18.     }  
  19.   
  20.     public function hasModifyPermission()  
  21.     {  
  22.         return false;  
  23.     }  
  24.   
  25.     public function hasDeletePermission()  
  26.     {  
  27.         return false;  
  28.     }  
  29.   
  30.     public function wantsFlashInterface()  
  31.     {  
  32.         return true;  
  33.     }  
  34. }  

  1. class GuestUser extends User { }  

  1. class CustomerUser extends User {  
  2.    function hasModifyPermission()  
  3.     {  
  4.         return true;  
  5.     }  
  6. }  

  1. class AdminUser extends User {  
  2.   
  3.     public function hasModifyPermission()  
  4.     {  
  5.         return true;  
  6.     }  
  7.   
  8.     public function hasDeletePermission()  
  9.     {  
  10.         return true;  
  11.     }  
  12.   
  13.     public function wantsFlashInterface()  
  14.     {  
  15.         return false;  
  16.     }  
  17. }  

  1. class UserFactory  implements FactoryInterface  {  
  2.       
  3.     private static $users = array('Arley'=>'admin''Michel'=>'guest',  
  4.                                   'Derick'=>'customer');  
  5.   
  6.    /** 
  7.     * Función de creación de usuarios. Recibe el tipo 
  8.     * de usario a crear y retorna una instancia valida 
  9.     * 
  10.     * @access public static 
  11.     * @param  string $name 
  12.     * @return object 
  13.     */  
  14.     static public function Create($name)  
  15.     {  
  16.         if (!isset(self::$users[$name])) {  
  17.            throw new Exception('El nombre de usuario '.$name.' es desconocido');  
  18.         }  
  19.         switch (self::$users[$name]) {  
  20.             case 'guest'return new GuestUser($name);  
  21.             case 'customer'return new CustomerUser($name);  
  22.             case 'admin'return new AdminUser($name);  
  23.             default:  
  24.             throw new Exception('Tipo de usario desconocido');  
  25.         }  
  26.     }  
  27. }  

  1. function boolToStr($b)  
  2. {  
  3.     if ($b == true) {  
  4.         return "Si\n";  
  5.     } else {  
  6.         return "No\n";  
  7.     }  
  8. }  
  9.   
  10. function displayPermissions(User $obj)  
  11. {  
  12.     print $obj->getName() . ' permiso:</br>';  
  13.     print 'Lectura: ' . boolToStr($obj->hasReadPermission()).'</br>';  
  14.     print 'Modificar: ' . boolToStr($obj->hasModifyPermission()).'</br>';  
  15.     print 'Escritra: ' . boolToStr($obj->hasDeletePermission()).'</br>';  
  16. }  
  17.   
  18. function displayRequirements(User $obj)  
  19. {  
  20.     if ($obj->wantsFlashInterface()) {  
  21.         print $obj->getName() . ' requiere Flash </br></br>';  
  22.     }  
  23. }  
  24.   
  25. $logins = array('Arley''Michel''Derick');  
  26.   
  27. foreach($logins as $login)  
  28. {  
  29.     displayPermissions(UserFactory::Create($login));  
  30.     print '</br>';  
  31.     displayRequirements(UserFactory::Create($login));  
  32. }  

Otros artículos sobre Patrones
  1. Patron Singleton en PHP
  2. Patrón de diseño Decorator en PHP
  3. Patrón Simple Factory en PHP
  4. Patrón Registry en PHP
  5. Patrón clásico de diseño web Modelo Vista Controlador (MVC) en PHP

Referencias bibliográficas
[1] León Welicki, «Patrones de Fabricación: Fábricas de Objetos». Consultado el 11 de septiembre de 2009.




Patrón de diseño Decorator en PHP5

Patrón de diseño Decorator en PHP5 

Patrón Decorator responde a la necesidad de agregar funcionalidad a un objeto por medio de la asociación de clases. Es un objeto con el que se puede ejecutar funcionalidades de varias clases a la vez.

"Esto nos permite no tener que crear sucesivas clases que hereden de la primera incorporando la nueva funcionalidad, sino otras que la implementan y se asocian a la primera." [1]



Clasificación del patrón

Estructural.

Intención o problema que soluciona


"Supongamos que tenemos una clase existente Ventana y queremos añadirle funcionalidad para que muestre un borde alrededor. Podemos crear una subclase VentanaConBorde que herede de Ventana. Hasta aquí todo bien, pero supongamos que surge la necesidad de crear una ventana que muestre un pequeño botón de ayuda con un signo de interrogación (?) en su parte superior." [1]

Entonces tenemos las siguientes opciones:

1. Crear otra subclase de Ventana: VentanaConBotónDeAyuda.

Problema: No cubre la necesidad de tener ventanas con bordes y botón de ayuda a la vez.

2. Crear una subclase de VentanaConBorde: VentanaConBordeYBotonDeAyuda.

Problema: No tenemos una ventana con botón de ayuda y sin borde.
3. Crear clases para todas las combinaciones posibles de funcionalidades.


Problema: Con este ejemplo tendríamos cuatro clases: Ventana, VentanaConBorde, VentanaConBotonDeAyuda y VentanaConBordeYBotonDeAyuda; con tres funcionalidades tendríamos ocho clases y con cuatro, ¡dieciséis!.

Aplicabilidad
  1. Añadir objetos individuales de forma dinámica y transparente.
  2. Responsabilidades de un objeto pueden ser retiradas.
  3. Cuando la extensión mediante la herencia no es viable.
  4. Hay una necesidad de extender la funcionalidad de una clase, pero no hay razones para extenderlo a través de la herencia.
  5. Hay la necesidad de extender dinámicamente la funcionalidad de un objeto y quizás quitar la funcionalidad extendida. [1]


Código de Ejemplo en PHP5

  1. <?php  
  2. interface iCoffee {  
  3.   public function getBaseCost();  
  4. }  
  5.          
  6. class Coffee implements iCoffee {  
  7.   protected $_baseCost = 0;  
  8.   public function getBaseCost()  
  9.   {  
  10.     return $this->_baseCost;  
  11.   }  
  12. }  
  13.   
  14. class BlackCoffee extends Coffee {  
  15.   public function __construct()  
  16.   {  
  17.     $this->_baseCost = 5;  
  18.   }  
  19. }  
  20.   
  21. abstract class CoffeeDecorator implements iCoffee {  
  22.   protected $_coffee;  
  23.   public function __construct(iCoffee $Coffee)  
  24.   {  
  25.      $this->_coffee = $Coffee;  
  26.   }  
  27. }  
  28.   
  29. class WithCream extends CoffeeDecorator {  
  30.   public function getBaseCost()  
  31.   {  
  32.     return $this->_coffee->getBaseCost() + 1.5;  
  33.   }  
  34. }  
  35.   
  36. class WithMilk extends CoffeeDecorator {  
  37.   public function getBaseCost()  
  38.   {  
  39.      return $this->_coffee->getBaseCost() + 4;  
  40.   }  
  41. }  
  42.   
  43. class WithChocolate extends CoffeeDecorator {  
  44.   public function getBaseCost()  
  45.   {  
  46.     return $this->_coffee->getBaseCost() + 5;  
  47.   }  
  48. }  
  49.   
  50. $coffee = new WithChocolate(new WithMilk(new WithCream(new BlackCoffee())));  
  51. echo 'El precio del cafe es: $' . $coffee->getBaseCost();  

Otros artículos sobre Patrones
  1. Patron Singleton en PHP
  2. Patrón de diseño Decorator en PHP
  3. Patrón Simple Factory en PHP
  4. Patrón Registry en PHP
  5. Patrón clásico de diseño web Modelo Vista Controlador (MVC) en PHP

Referencias bibliográficas

[1] Colaboradores de Wikipedia. Decorator (patrón de diseño) [en línea]. Wikipedia, La enciclopedia libre, 2009 [fecha de consulta: 9 de septiembre del 2009]. Disponible en <http://es.wikipedia.org/w/index.php?title=Decorator_(patr%C3%B3n_de_dise%C3%B1o)&oldid=27813809>.

Patrón Singleton en PHP5

Patrón Singleton en PHP5






El patrón de diseño"Singleton" está diseñado para restringir la creación de objetos pertenecientes a una clase, forzando a que solo se pueda crear una única instancia, de ahí su nombre Singleton (instancia única).






Un ejemplo de uso de este patrón: supongamos que tenemos una clase "Database" y instanciamos dicha clase, la cual nos devuelve un objeto llamado "$conn", una vez creada la conexión con la base de datos esta simple instancia será fácilmente accesible a muchos otros objetos, restringiéndose así a la creación de una única instancia la cual será reutilizada una y otra vez.

¿Pero como funciona el patrón de diseño Singleton?

El patrón Singleton provee una única instancia global debido a que: si se solicita una instancia de la clase:


a) La propia clase es la responsable de crear la única instancia, la cual debe garantizar que no se pueda crear ninguna otra (interceptando todas las peticiones para crear nuevos objetos) y proporcionando un solo punto de acceso a ella.

b) Si no se ha creado anteriormente (o sea, es la primera vez que se usa esta clase) se crea la instancia.

c) Si existe ya anteriormente una instancia (es la segunda o más veces que se usa), se retorna la existente todas las veces que se solicite.

d) El constructor de la clase debe declararse como privado para que la clase no pueda ser instanciada directamente.

e) Adicionalmente en PHP5 no se permite que la clase sea clonada con el método __clone().

De esta forma forzamos a que no se puedan crear objetos de forma directa por la vía del operador "new" ejemplo:

$objeto = new Ejemplo();
//Fatal error:Call to private Ejemplo::__construct() from invalid context

Bueno llegados a este punto se pudieran preguntar

¿Entonces como creo la instancia a la clase si el constructor está declarado como privado?

Directamente a través de un método declarado como público y estático, que será el encargado de crear la instancia de la clase. Ver a continuación:

public static function getInstance() {
if (!isset(self::$instance)) {
$c = __CLASS__;
self::$instance = new $c;
}
return self::$instance;
}

Cuando declararamos atributos de clases o métodos como estáticos, los hacemos accesibles desde afuera del contexto del objeto. Utilizamos entonces el operador de resolución :: que permite el acceso a los atributos y métodos estáticos, veamos un ejemplo:

$var = NombreClase::Metodo();

Funcionamiento del método getInstance()

Primeramente accedemos al método:

$inst1 = Ejemplo::getInstance();


Como podemos ver este método verifica el estado del atributo private static $instance;  si está o no definido, para así tomar la decisión de crear la instancia o retornarla directamente en caso de que ya esté creada.

Entonces existen 2 posibles casos:

Caso 1: Si no esta definido el atributo $instance se crea por primera vez la instancia, se almacena en el la referencia y se retorna.


Caso 2: De estar definido el atributo se retorna la instancia almacenada en el directamente.

Implementacion oficial del Patrón Singleton en PHP5:

Esta es la implementación oficial en PHP5 de este patrón les dejo el vinculo http://www.php.net/manual/en/language.oop5.patterns.php , lo único que he cambiado por motivos didácticos y de claridad es el nombre del método singleton() por el de getInstance().

  
class Ejemplo
{
/**
*  Contenedor de la Instancia de la Clase
*
*  @access private static
*/
private static $instance;

/**
*  Constructor
*
*  Previene la creación de objetos via $obj = new Ejemplo();
*
*  @access private
*/
private function __construct() { }

/**
* El método getInstance
*
* Crea una instancia de la clase Ejemplo
*
* @access public static
* @return object de la clase Ejemplo
*/
public static function getInstance()
{

if (!isset(self::$instance)) {
$c = __CLASS__;
self::$instance = new $c;

}

return self::$instance;
}
/**
* El método __clone()
*
* Previene que la clase sea clonada
*
* @access public
*/
public function __clone()
{
trigger_error('Clone no se permite.', E_USER_ERROR);

}
}

/**
* Ejemplo de uso
*
* Accedo directamente al método getInstance()
* para que me devuelva una instancia de la clase Ejemplo,
* como dicha instancia no existe este método, la crea.
*
* Nota: si hacemos var_dump sobre un variable esta función
* mostrará información estructurada que incluye tipos y valores.
* En el caso de las variables que contienen objetos esta funcion
* devolvería tipo de la variable, en este caso
* object, entre paréntesis (nombre de la clase) y
* un número único #id que representa al objeto creado.
* Podemos ver que dicho número #id es el mismo para estas
* dos primeros casos.
*/
$inst1 = Ejemplo::getInstance();


var_dump($inst1);
/** * En el segundo caso, como existe ya la instancia, * el método getInstance() lo comprueba y no la crea, * sino que la retorna directamente. */ $inst2 = Ejemplo::getInstance();
var_dump($inst2);
/** * Si intento crear una instancia directamente utilizando * el operador new. * * Fatal error: Call to private Ejemplo::__construct() * from invalid context */ $inst3 = new Ejemplo();
¿Ventajas y usos?

Suponiendo que utilizamos el Singleton en una Base de Datos, esto posibilita que:

1.) Que nuestra aplicación web ahorre recursos del servidor.
2.) Tenemos bien controlado la creación de objetos, al no permitir que nuestra aplicación tenga innumerable y descontroladas conexiones innecesarias abiertas a una misma base de datos.
Bibliografía
  1. Enrique Place, (7 de noviembre del 2006). «Patrón de Diseño "Singleton"». Consultado el 25 de agosto de 2009.
  2. Colaboradores de Wikipedia. Patrón de diseño [en línea]. Wikipedia, La enciclopedia libre, 2009 [fecha de consulta: 17 de septiembre del 2009]. Disponible en <http://es.wikipedia.org/w/index.php?title=Patr%C3%B3n_de_dise%C3%B1o&oldid=29814016>. 
  3. Colaboradores de Wikipedia. Singleton [en línea]. Wikipedia, La enciclopedia libre, 2009 [fecha de consulta: 1 de septiembre del 2009]. Disponible en <http://es.wikipedia.org/w/index.php?title=Singleton&oldid=29359982>.