Orientacion a Objetos
Modificadores de acceso y abstract, final, static (POO 04)
por ObjetivoPHP el Sep.26, 2009, bajo Orientacion a Objetos
Los modificadores de acceso nos dan la posibilidad de poder establecer la visibilidad de los atributos y métodos de una clase, o de una manera mas sencilla es un forma de establecer los permisos que tendran otros objetos para acceder a los métodos y atributos de la clase.
Modificador public
Es el modificador de acceso por defecto es decir si no ponemos nada en el atributo o metodo este tomara el modificador public o sea que el método o atributo sera publico.
- public aplicado a un atributo o método: significa que es accesible por cualquier clase que los invoque desde una referencia a un objeto de la clase contenedora. Resumiendo se accede desde cualquier objeto haciendo referencia al objeto propietario.
- public no se puede aplicar a clases como por ejemplo en JAVA.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | class modificadores { public $mensajeUno; private $mensajeDos; public function getMensajeUno() { echo $this->mensajeUno; } public function getMensajeDos() { echo $this->mensajeDos; } } $modificador = new modificadores(); $modificador ->mensajeUno = 'Probando Modificadores'; $modificador ->getMensajeUno(); ?> |
En este caso como el atributo $mensajeUno es publico se puede acceder desde fuera de la clase, con tener una instancia en este caso $modificador lo podemos cambiar y tambien desplegar aunque en este caso usamos el metodo publico getMensajeUno.
Modificador private
Se puede aplicar tanto a atributos como métodos y es el nivel mas restrictivo de todos. Solo permite acceder desde el propio objeto, nunca desde fuera. Si nosotros intentáramos configurar el atributo mensajeDos como el Uno nos daría un error, para poder cambiar el texto tenemos que crear un método publico que realice la tarea.
Un ejemplo del método necesario seria:
1 2 3 4 | public function setMensajeDos($texto) { $this->mensajeDos = $texto; } |
Ejemplo de como accederiamos es el siguiente:
$modificador = new modificadores(); $modificador ->mensajeDos = 'Probando Modificadores'; // Error $modificador ->setMensajeDos('Asi se debe realizar'); // Correcto $modificador ->getMensajeDos();
Modificador protected
Es un nivel intermedio de accesibilidad. Si lo aplicamos a un atributo o método este sera accesible desde la propia clase y desde las clases que heredan de esta. Fuera de estas clases se comportan como si fueran atributos o metodos privados.
abstract
PHP 5 introduce las clases y métodos abstractos. Cuando una clase es abstracta no se permite crear una instancia de la misma. Si una clase contiene un metodo abstracto la misma debera ser declarada como abstracta. Los métodos definidos como abstractos no se implementan en dicha clase simplemente se declara la firma del mismo.
Cuando heredamos de una clase abstracta, todos los métodos definidos como abstractos en la clase padre, deben ser definidos en la clase hijo, teniendo en cuenta que la visibilidad de los mismos no puede ser menor a la definida en el metodo declarado como abstracto es decir no se puede restringir la visibilidad. A modo de ejemplo si un metodo es declarado como protected en la clase abstracta, cuando implementamos el mismo en la clase hija el mismo debera ser protected o public pero nunca podra ser private pues estariamos restringiendo la visibilidad.
Resumiendo:
- Aplicado a un metodo significa que no se implementa en la clase actual.
- Aplicado a una clase significa que no se puede instanciar.
final
- Aplicado a un atributo significa que es invariante (constante).
- Aplicado a un metodo significa que no se puede sobreescribir. Es decir la clase que hereda no puede volver a implementar el metodo.
- Aplicado a una clase significa que no se puede heredar.
static
La declaración de atributos de clase o métodos como estático los hace accesibles sin necesitar un instancia de la clase. No se puede tener acceso a una propiedad declarada como estática con una variable que es una instancia del objeto (aunque un método estático pueda) y no puede ser redefinido en una clase que herede de esta.
La declaracion de static tiene que estar despues de la declaracion de visibiliadad, para la compatibilidad con PHP 4, si no se declara la visibilidad del atributo o metodo definido como static, entonces PHP los tratara como si fuesen public (publicos).
Como los métodos estáticos son accesibles sin una instancia del objeto,lapseudovariable $this no está disponible dentro del método declarado como estático, para esto se debera usar self::.
Las propiedades estáticas no pueden ser accesadas a través del objeto usando el operador de flecha ->.
La llamada a métodos no estáticos desde un metodo estatico genera una advertencia de nivel E_STRICT.
Una variable estatica solo se puede inicializar usando un literal o una constante, no se permite que sea con expresiones . Usted puede inicializar una propiedad estatica a un entero(integer) o a un arreglo (array) como cualquier otra variable, pero no se puede inicializar a una variable, un retorno de una funcion o un objeto.
Si una variable se etiqueta como static, solo existira un ejemplar para todos los objetos de la clase.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 | <?php class estatica { static $variable = 3; public function getVariable() { echo "<br />Static: " . self::$variable; } public function setVariable($valor) { self::$variable = $valor; } } // Creamos 2 instancias para ver que el valor es para // todas las instancias. $modificador1 = new estatica(); $modificador2 = new estatica(); // Formas de acceder al valor echo "Ver Directamente:" . estatica::$variable; $modificador1 ->getVariable(); // Cambiamos el valor con el modificador1 // y mostramos el valor del 2. $modificador1 ->setVariable(5); $modificador2 ->getVariable(); /* SALIDA POR PANTALLA Ver Directamente:3 Static: 3 # con modificador1 Static: 5 # con modificador2 */ ?> |
Fuente:
Constructores, Destructores y auto-carga de Clases (POO 03)
por ObjetivoPHP el Ago.15, 2009, bajo Orientacion a Objetos
Constructor
Es un método especial de una clase , que es llamado siempre que se inicializa un objeto. Es decir cuando instanciamos una clase se ejecuta ese método automáticamente, se utiliza para cualquier inicialización que el objeto pueda necesitar antes de ser usado.
La sintaxis básica es: void __construct ( [mixed args [, ...]] ), dado que esta forma solo esta soportada a partir de PHP5, también se puede declarar un constructor usando el mismo nombre que la clase a la cual pertenece (Para otorgar compatibilidad con PHP4), es decir si al instanciar no encuentra el método __construct(), PHP buscara un método que se llame igual que la clase.
Si una clase que hereda (sub-clase o clase hija), tiene definido su propio constructor, entonces al crear el objeto de esta, solo se ejecutara el constructor propio de la clase hija y no el de la clase superior o padre. Si necesitamos que la clase padre ejecute su constructor entonces debemos realizar una llamada explicita al método padre de la siguiente manera parent::__construct().
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 | <?php class BaseClase { function __construct() { print "Constructor de Clase Base<br />\n"; } } class SubClase extends BaseClase { function __construct() { parent::__construct(); // llamamos al constructor de la clase padre. print "Constructor en clase Hija<br />\n"; } } $obj = new BaseClase(); // salida : Constructor de Clase Base $obj = new SubClase(); // salida: Constructor de Clase Base // Constructor en clase Hija ?> |
Destructor
PHP 5 introduce un concepto de destructor similar a aquellos de otros lenguajes de programación orientada a objetos, tal como C++. El método destructor será llamado tan pronto como todas las referencias a un objeto en particular sean removidas o cuando el objeto sea explícitamente destruido. En definitiva es otro método especial de una clase que se ejecuta antes de que un objeto de esa clase sea eliminado físicamente de la memoria. El destructor se utiliza para realizar las acciones finales, como borrar viejos archivos o liberar recursos.
Como sucede en los constructores, los destructores de la clase padre no serán llamados explícitamente por el compilador. Para ejecutar un destructor padre, se debe tener una llamada explícita a parent::__destruct() en el cuerpo del destructor.
El destructor es llamado durante la finalización del script, de tal manera que los headers ya han sido enviados.
Si se intenta arrojar una excepción desde un destructor produce un error fatal.
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 | <?php class MyDestructableClass { function __construct() { print "In constructor\n"; $this->name = "MyDestructableClass"; } function __destruct() { print "Destroying " . $this->name . "\n"; } } $obj = new MyDestructableClass(); ?> |
Auto-Carga de Clases
Muchos desarrolladores que escriben aplicaciones con programación orientada a objetos crean un archivo fuente PHP por cada definición de clase. Una de las molestias más grandes es tener que escribir una larga lista de includes necesarios al principio de cada script (uno para cada clase).
En PHP 5, esto ya no es necesario. Puede definir una función __autoload la cual es llamada automáticamente en caso de que intente usar una clase que no ha sido definida aún. Al llamar esta función la ejecución del script da una última oportunidad de cargar la clase antes de que PHP falle con un error.
Las excepciones arrojadas en la función __autoload no pueden ser capturadas en el bloque catch y resultan en el despliegue de un error fatal.
52 53 54 55 56 57 58 59 60 | <?php function __autoload($nombreDeClase) { require_once $nombreDeClase . '.php'; } $obj = new MyClass1(); $obj2 = new MyClass2(); ?> |
La pequeña rutina intenta levantar la clase MyClass1, al fallar y tener el método mágico __autoload, pasa el nombre de la clase a dicha función quien realiza el include para poder lograr la instancia.
Otros Conceptos de POO (POO 02)
por ObjetivoPHP el Ago.14, 2009, bajo Orientacion a Objetos
Sobrecarga de Metodos
La interpretacion de PHP para la sobrecarga de métodos, es diferente a la mayoria de los lenguajes orientados a objetos. La sobrecarga tradicional proporciona la capacidad de tener multiples métodos con el mismo nombre, pero con diferente número y/o tipo de parámetros (a esto se le llama firma del metodo), dependiendo de ellos se ejecutará una función u otra.
En JAVA la sobrecarga seria así:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | class Pruebas { public void Pruebas() { System.out.println("Hola Pruebas"); } public void Pruebas(String name) { System.out.println("Hola " + name); } public void Pruebas(String firstName, String lastName) { System.out.println("Hola " + firstName + " " + lastName); } } |
En este caso declaramos 3 constructores (Metodos que inicializan el objeto pruebas), que reciben diferente cantidad de parametros. De esta forma segun el numero de parametros que pasemos se ejecuta uno u otro metodo.
Como logramos esto en PHP, si no soporta la sobrecarga de metodos en esa forma. Para ello se recurre a un metodo magico que es el método __call().
Metodo __call()
Se trata de un método “mágico” que permite capturar la invocación de métodos no existentes. Esté método puede ser redefinido para cubrir las necesidades del proyecto o como en este caso, proporcionar sobrecarga a nuestros scripts. Aprovechando está funcionalidad podemos controlar la función a la que estamos llamando y redirigir a la función concreta a la que hacemos referencia.
1 2 3 4 5 | mixed __call ( string $nombre, array $argumentos ); /** La función _call() recibe dos parámetros: * $nombre -> El nombre del método * $argumentos -> Los argumentos pasados a la función. */ |
Una forma de implementarlo con este metodo es la siguiente…
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 | <?php class SobreCarga { public function __call($metodo, $parametros) { if (method_exists($this, $metodo.sizeof($parametros))) return call_user_func_array(array($this, $metodo.sizeof($parametros)), $parametros); // Si la Funcion no Existe throw new Exception('Metodo Desconocido: '.get_class($this).'::'.$metodo); } function Param2($a, $b) { echo "<br />Param2($a,$b)\n"; } function Param3($a, $b, $c) { echo "<br />Param3($a,$b,$c)\n"; } } $o = new SobreCarga(); $o->Param(4,5); $o->Param(4,5,6); $o->ParamX(4,5,6,7); ?> // La salida de este script seria: Param2(4,5) Param3(4,5,6) Fatal error: Uncaught exception 'Exception' with message 'Metodo Desconocido: SobreCarga::ParamX' in C:\AppServ\www\clasesPHP\sobrecarga.php:7 Stack trace: #0 [internal function]: SobreCarga->__call('ParamX', Array) #1 C:\AppServ\www\clasesPHP\sobrecarga.php(22): SobreCarga->ParamX(4, 5, 6, 7) #2 {main} thrown in C:\AppServ\www\clasesPHP\sobrecarga.php on line 7 |
la funcion method_exists() comprueba que el metodo de clase existe y requiere 2 parametros un objeto donde se buscara el método y el nombre del método a buscar. La misma retorna un booleano, true si existe el metodo en la clase o false en caso contrario.
bool method_exists ( object object, nombreDeMetodo )
Es lo que hace la consulta de la linea 7. En caso de ser verdadera es decir existe el método utiliza la funcion call_user_func_array () que lo que realiza es Llamar una función definida por el usuario dada por funcion, con los parámetros establecidos.
mixed call_user_func_array ( callback funcion, array matriz_parametros );
callback funcion contiene una estructura de array donde debera constar el objeto y el metodo a llamar por ejemplo array(’MiClase’, ‘miMetodoDeRetorno’). Por lo cual la llamada de tipo array($this, $metodo.sizeof($parametros)) le indica que retorne de esta misma clase($this) el metodo que se llama $metodo.sizeof($parametros) donde sizeof es el numero de parametros pasados.
Como se puede ver no existe en PHP la sobrecarga tradicional, pero se puede llegar a simular con un poco de trabajo.
Fuente: Anieto, php.net
Sobre-Escritura de Métodos
Es un mecanismo por el cual una clase que hereda puede redefinir los métodos que está heredando. Es decir que podemos crear un método con el mismo nombre que el método de la clase padre. Ahora cuando creamos un objeto de la subclase, el método que se llamará es el de dicha subclase.
Lo más conveniente es sobreescribir métodos para completar el algoritmo del método de la clase padre. No es bueno sobreescribir un método y cambiar completamente su comportamiento.
Un ejemplo sencillo.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 | <?php class Saludo { public function saludar() { echo '<br />Hola'; } public function despedida() { echo '<br />Chau'; } } class BuenosDias extends Saludo { public function saludar() { echo '<br />Buenos Dias'; } } $instancia = new BuenosDias(); $instancia->saludar(); $instancia->despedida(); // El resultado seria: Buenos Dias Chau ?> |
En el resultado se ve claro que ejecuta el metodo de la clase hija.
la palabra extends indica que hereda los metodos y propiedades de la clase padre Saludo.
Programación Orientada a Objetos (POO 01)
por ObjetivoPHP el Ago.14, 2009, bajo Orientacion a Objetos
Primero aclarar que la Programación Orientada a Objetos (POO), no es un lenguaje de programación sino que es un paradigma. Un paradigma según la WIKI, representa un enfoque particular o filosofía para la construcción del software. La POO se puede aplicar a casi todos los lenguajes modernos.
Podemos distinguir entre lenguajes Puros e híbridos. Puros cuando se ajusta 100% a los principios que la técnica propone y contempla la posibilidad de trabajar exclusivamente con clases. Híbrido, cuando el lenguaje que generalmente existía antes de la aparición de la POO, incorpora características para trabajar con clases.
Conceptos Básicos
Los principales conceptos que se vinculan con la POO son Clase, Objeto, Método, Instancia, Evento, Mensaje, Propiedad o Atributo, Estado Interno.
Clases: son declaraciones o abstracciones de objetos, lo que significa, que una clase es la definición de un objeto. Cuando se programa un objeto y se definen sus características y funcionalidades, realmente se programa una clase.
Las clases contienen datos (variables, propiedades miembro o atributos) junto con las operaciones de manipulación de esos datos (funciones o Métodos).
Ejemplo de clase en PHP:
class Nombre { // Variables miembro (habitualmente privadas) private miembro_1; //lista de miembros public miembro_2; protected miembro_3; // Funciones o métodos (habitualmente públicas) public function miembro_1( ); public function miembro_2 ( ); }
Objetos: se define como la unidad que en tiempo de ejecución realiza las tareas de un programa. También a un nivel más básico se define como la instancia de una clase. Estos objetos interactúan unos con otros, en contraposición a la visión tradicional en la cual un programa es una colección de subrutinas (funciones o procedimientos), o simplemente una lista de instrucciones para el computador. Cada objeto es capaz de recibir mensajes, procesar datos y enviar mensajes a otros objetos de manera similar a un servicio. En el mundo de la programación orientada a objetos (POO), un objeto es el resultado de la instanciación de una clase. Una clase es el anteproyecto que ofrece la funcionalidad en ella definida, pero ésta queda implementada sólo al crear una instancia de la clase, en la forma de un objeto.
Método: es una subrutina asociada exclusivamente a una clase. Un método consiste generalmente de una serie de sentencias para llevar a cabo una acción, un juego de parámetros de entrada que regularán dicha acción y, posiblemente, un valor de salida (o valor de retorno) de algún tipo. Existen 2 tipos de métodos los de instancia, que están relacionados con un objeto en particular y los estáticos o de clase (o compartidos) están asociados a una clase en particular.
En ciertos lenguajes de programación se requiere de un metodo especial que son los constructores siendo estos métodos de instancia especiales llamados automáticamente cuando se crea una instancia de alguna clase.
Instancia: se produce con la creación de un objeto perteneciente a una clase (instanciar una clase), que hereda entonces sus atributos, propiedades y métodos para ser usados dentro de un programa, ya sea como contenedores de datos o como partes funcionales del programa al contener en su interior funcionalidades de tratamiento de datos y procesamiento de la información que ha sido programada con anterioridad en la clase a la que pertenece. Ejemplo de instancia en php:
$instancia = new Nombre(); // instanciamos la clase del ejemplo anterior. $instancia->miembro_1(); // accedemos a un método.
Evento: un suceso en el sistema (tal como una interacción del usuario con la máquina, o un mensaje enviado por un objeto). El sistema maneja el evento enviando el mensaje adecuado al objeto pertinente. También se puede definir como evento, a la reacción que puede desencadenar un objeto, es decir la acción que genera.
Mensaje: una comunicación dirigida a un objeto, que le ordena que ejecute uno de sus métodos con ciertos parámetros asociados al evento que lo generó.
Propiedad o atributo: contenedor de un tipo de datos asociados a un objeto (o a una clase de objetos), que hace los datos visibles desde fuera del objeto y esto se define como sus características predeterminadas, y cuyo valor puede ser alterado por la ejecución de algún método.
Estado interno: es una variable que se declara privada, que puede ser únicamente accedida y alterada por un método del objeto, y que se utiliza para indicar distintas situaciones posibles para el objeto (o clase de objetos). No es visible al programador que maneja una instancia de la clase.
Características
Las principales características son Abstracción, Encapsulamiento, Principio de Ocultación, Polimorfismo, Herencia.
Abstracción: es poner el enfasis en el ¿Que se Hace? mas que en el ¿como lo hace?. Es decir consiste en captar las características esenciales de un objeto, así como su comportamiento.
Es el mecanismo de diseño en la POO. Nos permite extraer de un conjunto de entidades datos y comportamientos comunes para almacenarlos en clases.
La abstracción ofrecida por los lenguajes de programación se puede dividir en dos categorías: abstracción de datos (pertenecientes a los datos) y abstracción de control (perteneciente a las estructuras de control).
Encapsulamiento: consiste en unir en la Clase las características y comportamientos, esto es, las variables y métodos. Es tener todo esto es una sola entidad. En los lenguajes estructurados esto era imposible. Es evidente que el encapsulamiento se logra gracias a la abstracción y el ocultamiento que veremos a continuación. La utilidad del encapsulamiento va por la facilidad para manejar la complejidad, ya que tendremos a las Clases como cajas negras donde sólo se conoce el comportamiento pero no los detalles internos, y esto es conveniente porque lo que nos interesará será conocer qué hace la Clase pero no será necesario saber cómo lo hace.
Ocultamiento: Es la capacidad de ocultar los detalles internos del comportamiento de una Clase y exponer sólo los detalles que sean necesarios para el resto del sistema.
El ocultamiento permite 2 cosas: restringir y controlar el uso de la Clase. Restringir porque habrá cierto comportamiento privado de la Clase que no podrá ser accedido por otras Clases. Y controlar porque daremos ciertos mecanismos para modificar el estado de nuestra Clase y es en estos mecanismos dónde se validarán que algunas condiciones se cumplan. En PHP el ocultamiento se logra usando las palabras reservadas: public, private y protected delante de las variables y métodos.
Segun la WIKI el principio de ocultamiento significa que cada objeto está aislado del exterior, es un módulo natural, y cada tipo de objeto expone una interfaz a otros objetos que especifica cómo pueden interactuar con los objetos de la clase. El aislamiento protege a las propiedades de un objeto contra su modificación por quien no tenga derecho a acceder a ellas, solamente los propios métodos internos del objeto pueden acceder a su estado. Esto asegura que otros objetos no pueden cambiar el estado interno de un objeto de maneras inesperadas, eliminando efectos secundarios e interacciones inesperadas. Algunos lenguajes relajan esto, permitiendo un acceso directo a los datos internos del objeto de una manera controlada y limitando el grado de abstracción. La aplicación entera se reduce a un agregado o rompecabezas de objetos.
Polimorfismo: comportamientos diferentes, asociados a objetos distintos, pueden compartir el mismo nombre, al llamarlos por ese nombre se utilizará el comportamiento correspondiente al objeto que se esté usando. O dicho de otro modo, las referencias y las colecciones de objetos pueden contener objetos de diferentes tipos, y la invocación de un comportamiento en una referencia producirá el comportamiento correcto para el tipo real del objeto referenciado. Cuando esto ocurre en “tiempo de ejecución”, esta última característica se llama asignación tardía o asignación dinámica. Algunos lenguajes proporcionan medios más estáticos (en “tiempo de compilación”) de polimorfismo, tales como las plantillas y la sobrecarga de operadores de C++.
Herencia: las clases no están aisladas, sino que se relacionan entre sí, formando una jerarquía de clasificación. Los objetos heredan las propiedades y el comportamiento de todas las clases a las que pertenecen. La herencia organiza y facilita el polimorfismo y el encapsulamiento permitiendo a los objetos ser definidos y creados como tipos especializados de objetos preexistentes. Estos pueden compartir (y extender) su comportamiento sin tener que volver a implementarlo. Esto suele hacerse habitualmente agrupando los objetos en clases y estas en árboles o enrejados que reflejan un comportamiento común. Cuando un objeto hereda de más de una clase se dice que hay herencia múltiple.
Para mayor comprension se puede decir que Es una relación entre clases en la cual una clase comparte la estructura y comportamiento definido en otra clase (Grady Booch)
Cada clase que hereda de otra posee:
- Los atributos de la clase base además de los propios
- Soporta todos o algunos de los métodos de la clase base
Estándares en PHP, Orientado a Objetos
por ObjetivoPHP el Ago.12, 2009, bajo Orientacion a Objetos
El estandar que utilizaremos en PHP es el recomendado por la empresa Zend.
Formato del Archivo
Para aquellos archivos que contienen sólo código PHP los tags de demarcación (”<? “) no estarán permitidos, además no es requerido por PHP y omitirlos nos previene de algún accidente ocasionado por un espacio en blanco.
Identación
La identación consistirá en cuatro espacios en blanco y la tabulación no estará permitida.
Largo máximo de la línea
El largo máximo ideal de una linea de código es de 80 caractéres, esto nos permite una cómoda lectura del mismo. El máximo permitido por PHP es de 120 caractéres.
Fin de línea
El fin de línea seguirá la convención de texto de Unix. La línea debe de terminar con el caracter linefeed (LF) representado con el ordinal 10 ó hexadecimal 0×0A.
No utilice el retorno de carro (Enter) (CF) que es un convecionalismo de los Sistemas operativos de Apple ó el retorno de carro / linefeed (CRLF) que es de Windows.
Convención en los nombres
Clases
El nombre de las clases debe estar compuesto de caractéres alfanuméricos. El catacter Underscore (”_”) solo es permitido para remplazar al separador en el path del archivo, por ejemplo: “Zend/Db/Table.php” quedaría como “Zend_Db_Table”.
Si el nombre de la clase está comprimida en más de una palabra la primera letra debe de ser mayúscula. Letras mayúsculas seguidas no son permitidas.
Ejemplo: “Zend_PDF” no es permitido mientras que “Zend_Pdf” si lo es.
Archivos
En el nombre de los archivos se permite caractéres alfanuméricos, Underscore, dash (”-”), pero no está permitido el espacio en blanco.
Funciones y Métodos
El nombre de las funciones debe estar compuesto de caractéres alfanuméricos, el catactér Underscore no está permitido, siempre tiene que comenzar con letra minúscula, si el nombre consiste en más de una palabra la primera letra de cada una de ella deberá ser mayúscula, por ejemplo: getElementById(), widgetFactory().
Un correcto empleo de verbos describe mejor el propósito y comportamiento de las funciones.
En caso de la programación orientada a objetos suele colocarse prefijos como “get” ó “set”, asi como también el nombre de los patrones. En el caso que el método sea “private” ó “protected” el primer caractér debe ser Underscore ( único caso permitido ), aquelllos declarados “public” no llevan Underscore.
Variables
El nombre de las variables debe estar compuesto de caractéres alfanuméricos, el catactér Underscore no está permitido. En el caso que sean declaradas “private” ó “protected” el primer caractér debe ser Underscore ( único caso permitido ), aquelllas declaradas “public” no llevan Underscore.
Siempre tiene que comenzar con letra minúscula, si el nombre consiste en más de una palabra la primera letra de cada una de ella deberá ser mayúscula. Un correcto empleo de verbos describe mejor la variable. Por ejemplo
aquellas llamadas “$i” y “$n” serían permitidas en caso de que el algortimo sobrepasara las 20 líneas.
Constantes
Está permitido caractéres alfanuméricos y Underscore, asi también Números.
Las letras usadas en las constantes deben ser mayúsculas y las palabras separadas por Underscore, por ejemplo:
EMBED_SUPPRESS_EMBED_EXCEPTION estaría permitido y EMBED_SUPPRESSEMBEDEXCEPTION no lo estaría.
Estilo en el código
PHP Código de Delimitación
Todo código PHP debe estar delimitado por los tags estándares ( los cortos no están permitidos ).
<?php
?>
Estas delimitaciones se omiten en quellos archivos que sólo contengan código PHP.
String Literales
Cuando se le asigna un texto literal ( sin contenido de variables ) se utilizarán comillas simples.
$a = ‘Texto de ejemplo’;
String Literales con apóstrofes
Cuando se le asigna un texto literal con apóstrofes se utilizarán comillas dobles, este caso es principalmente en las sentencias SQL.
$sql = “SELECT `id`, `name` from `some_people` WHERE `name`=’Fred’ OR `name`=’Susan’”;
Sustitución por Variables
Cuando un texto contiene porciones que serán sustituidas por el valor de alguna variable, se toma como correcto únicamente esta dos formas:
$greeting = "Hola $nombre, bienvenido!"; $greeting = "Hola {$nombre}, bienvenido!";
Concatenación
Para concatenar Strings se utilizará el operador “.” (punto), con un espacio entre medio para mejorar la lectura.
$company = 'Zend' . ' ' . 'Technologies';
Arrays
En aquellos arrays de índices numéricos estos deberán ser números positivos, en la declaración de los valores del array se dejará un espacio en blanco luego de la coma para mejorar la lectura.
En caso que se necesiten varias líneas en la construcción del array, se identará cada una donde empezó la primera.
En el caso de los arrays asociativos, se hace un quiebre de línea por cada clave y valor.
$sampleArray = array('firstKey' => 'firstValue', 'secondKey' => 'secondValue');
Clases
En la declaración de la clase el nombre deberá seguir la convención ya expresada anteriormente, debe estar
precedida por una documentación conforme a PHPDocumentor, luego la declaración y desarrollo.
/** * Documentación del bloque aquí. * Documentación del bloque aquí. */ class SampleClass { // Todo el contenido de la clase aquí // identada por cuatro espacios vacíos }
Las funciones deberán seguir la convención de nombres, los métodos de las clases deberán ser declarados utilizando
uno de los modificadores private, protected, ó public. El pasaje por referencia es el único método permitido para
usar una variable externa, el llamado de una variable externa está totalmente prohibido.
A continuación un ejemplo de declaración de una variable, note que el valor de retorno no está entre paréntesis.
/** * Documentación del bloque aquí. */ class Foo { /** * Documentación del bloque aquí. */ public function bar(&$var) { // Todo el contenido de la función aquí // identada por cuatro espacios vacíos return $this->bar; } }
Control de flujo
En las declaraciones if/then/else deberá tener un espacio antes y después del parentesis condicional, en la misma
línea se habre llave y se cierra en una línea diferente, lo mismo se aplica al elseif, a continuación un ejemplo que lo
ilustra:
if ($a != 2) { $a = 2; } elseif ($a == 3) { $a = 4; } else { $a = 7; }
En el caso de un Switch la convención es la misma, adicionando que el break tiene una identación mayor que el resto
a continuación un ejemplo:
switch ($numPeople) { case 1: break; default: break; }
La opción default jamás deberá ser omitida en un Switch.
Nota: en aquel caso que dos case correspondan a un bloque de implementación, se comentará el break para diferenciarlo de un bug.
Documentación
Formato
El formato de los bloques de documentación deberán ser acorde al de PHPDocumentor, para más información visitar: phpdoc.org
Archivos
Todo archivo con Código PHP deberá incluir un Bloque de Documentación en la parte superior con estos tags de PHPDocumentor como mínimo:
/**
* Descripción corta del archivo
*
* Descripción extendida del archivo (si alguien)...
*
* LICENCIA: Algún dato sobre la licencia
*
* @copyright 2008 Zend Technologies
* @license http://framework.zend.com/license BSD License
* @version $Id:$
* @link http://framework.zend.com/package/PackageName
* @since File available since Release 1.5.0
*/Clases
Las clases deberán incluir un Bloque de Documentación en la parte superior con estos tags de PHPDocumentor como mínimo:
/**
* Descripción corta de la clase
*
* Descripción extendida de la clase (si alguien)...
*
* @copyright 2008 Zend Technologies
* @license http://framework.zend.com/license BSD License
* @version Release: @package_version@
* @link http://framework.zend.com/package/PackageName
* @since Class available since Release 1.5.0
* @deprecated Class deprecated in Release 2.0.0
*/ Funciones
Todas las funciones y los métodos deberán tener un Bloque de Documentación conteniendo como mínimo:
- Descripción de la función
- Argumentos
- Retorno
No es necesario utilizar el tag “@access” ya que el nivel de acceso está dado por los modificadores “public”, “private”, ó “protected” usados al declarar la función.
Si algún método/función tiene expeciones utilice el tag @throws.
Fuente
Esto es un resumen para más información visitar:
Zend Framework Coding Standard for PHP