...
- La visibilidad debe definirse en cada momento, incluso cuando se trata de un método público.
- El orden de las propiedades del método debe ser: visibilidad static nombre de la funciónvisibility static function name()
Code Block borderStyle solid private static function foo()
...
- Los nombres del método y la función comienzan siempre con un carácter en minúscula y cada una de las palabras siguientes deben comenzar con un carácter en mayúsculas (CamelCase)
Code Block borderStyle solid public function myExempleMethodWithALotOfWordsInItsName()
- Los corchetes que se presentan en el código de del método tiene tienen que ser precedidos por un retorno
Code Block borderStyle solid public function myMethod($arg1, $arg2) { [...] }
- Los nombres de los métodos y las funciones deben ser nombres explícitos, por lo tanto nombres de función como "b()" o "ef()" están completamente prohibidos.
Info The only exceptions are the translation function calledtitle Exceptions Excepciones Las únicas excepciones son la función de traducción llamada "l()" and debug functions y las funciones de depuración "p()", "d()".
Enumeración
Las comas deben estar seguidas (y sólo seguidas) por un espacio.
...
- Los nombres de las definiciones deben ser escritos ingresados en mayúsculas
- Los nombres de las definiciones deben contar con el prefijo "PS_" dentro del núcleo y el módulo
Code Block borderStyle solid define('PS_DEBUG', 1); define('PS_MODULE_NAME_DEBUG', 1);
- Los nombres de las definiciones no permiten caracteres alfabéticos. Excepto “_”.
...
- Dentro de las funciones y métodos, sólo la etiqueta "//" de comentario es permitida
- Después de la etiqueta "//" de comentario, un espacio “// Comment“ es necesario
Code Block borderStyle solid // My great comment
- La etiqueta "//" de comentario es permitida al final de una línea de código
Code Block $a = 17 + 23; // A comment inside my exemple function
- Funciones y métodos externos, sólo las etiquetas "/" y "/" de comentario son permitidas
Code Block borderStyle solid /* This method is required for compatibility issues */ public function foo() { // Some code explanation right here [...] }
- Comentario PHP Doc Element es necesario antes de las declaraciones de método
Code Block borderStyle solid /** * Return field value if possible (both classical and multilingual fields) * * Case 1 : Return value if present in $_POST / $_GET * Case 2 : Return object value * * @param object $obj Object * @param string $key Field name * @param integer $id_lang Language id (optional) * @return string */ protected function getFieldValue($obj, $key, $id_lang = NULL)
Info title Para más información Para más información acerca de la regla PHP Doc: vea este enlace útil
...
Devolución de valores
- Las declaraciones del devolver de devolución no necesitan paréntesis, excepto cuando se trata de una expresión compuesta
Code Block borderStyle solid return $result; return ($a + $b); return (a() - b()); return true;
- Desarmar una función
Code Block borderStyle solid return;
...
Code Block | ||
---|---|---|
| ||
myfunction() // InEn theel followingsiguiente exempleejemplo wecolocamos putuna a @ forpor securitymotivos reasonsde seguridad @mysql_connect([...]); |
Etiquetas
...
- Las palabras clave deben ser escritas en mayúsculas.
Code Block borderStyle solid SELECT `firstname` FROM `'. _DB_PREFIX_.'customer`
- Las Comillas comillas inversas ("`") deben ser utilizadas alrededor de nombres de campo y tabla
Code Block borderStyle solid SELECT p.`foo`, c.`bar` FROM `'. _DB_PREFIX_.'product` p, `'. _DB_PREFIX_.'customer` c
- Los alias de tablas deben ser realizados utilizando la primera letra de cada palabra y deben estar en minúsculas
Code Block borderStyle solid SELECT p.`id_product`, pl.`name` FROM `'. _DB_PREFIX_.'product` p NATURAL JOIN `'. _DB_PREFIX_.'product_lang` pl
- Cuando ocurran conflictos entre los alias de tablas, el segundo carácter también debe ser tomado.
Code Block borderStyle solid SELECT ca.`id_product`, cu.`firstname` FROM `'.DB_PREFIX.'cart` ca, `'. _DB_PREFIX_.'customer` cu
- La indentación se debe realizar para cada cláusula
Code Block borderStyle solid $query = 'SELECT pl.`name` FROM `'.PS_DBP.'product_lang` pl WHERE pl.`id_product` = 17';
- Está prohibido realizar una combinación en la cláusula WHERE
...