{"id":38459,"date":"2017-07-07T09:17:18","date_gmt":"2017-07-07T14:17:18","guid":{"rendered":"http:\/\/webirix.com\/?p=38459"},"modified":"2017-07-07T09:31:04","modified_gmt":"2017-07-07T14:31:04","slug":"estandares-de-programacion-2","status":"publish","type":"post","link":"https:\/\/webirix.com\/en\/estandares-de-programacion-2\/","title":{"rendered":"Programming standards"},"content":{"rendered":"
\"imagen_php\"<\/div>\n
\n

Nombres de variables<\/strong><\/h3>\n
    \n
  1. La primer letra de una variable debe iniciar con min\u00fascula<\/li>\n
  2. Las variables\u00a0nativas<\/em>\u00a0o\u00a0arrays<\/em>\u00a0deben ir separadas por\u00a0gui\u00f3n bajo<\/em>(_) cada cambio de palabra\u00a0: $my_var<\/li>\n
  3. Las varibles que sean\u00a0Objetos\u00a0<\/em>deben cambiar a may\u00fasculas cada cabo de palabra, ejemplo: $myVar<\/li>\n
  4. Las varibles globales deben ir todas con mayusculas, ejemplo: $MY_VAR<\/li>\n<\/ol>\n

    Asignaciones<\/strong><\/h3>\n
      \n
    1. Debe haber un espacio entre la variable y los operadores:<\/li>\n<\/ol>\n

       <\/p>\n

      $my_var = 17;\r\n\r\n$a = $b;<\/pre>\n
       <\/p>\n
      Operadores<\/h3>\n
        \n
      1. “+”, “-“, “*”, “\/”, “=” y cualquier combinaci\u00f3n de ellos (ej. “\/=”) necesitan un espacio entre
        \nmiembros de la izquierda y la derecha<\/p>\n\n\n\n
        $a +\u00a0<\/code>17<\/code>;<\/code><\/p>\n
        $result = $b \/\u00a0<\/code>2<\/code>;<\/code><\/p>\n
        $i +=\u00a0<\/code>34<\/code>;<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n
      2. “.” no llevan espacio entre los miembros de la izquierda y la derecha
        \n\n\n\n
        echo $a.$b;<\/code><\/p>\n
        $c = $d.$<\/code>this<\/code>->foo();<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
        Recomendaci\u00f3n<\/p>\n
        Por motivos de rendimiento, no exceda el uso de la concatenaci\u00f3n.<\/li>\n
      3. “.=” necesita un espacio entre los miembros de la izquierda y la derecha
        \n\n\n\n
        $a .=\u00a0<\/code>'Debug'<\/code>;<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<\/ol>\n
        Declaraciones<\/h3>\n
          \n
        1. if, elseif, while, for:deben presentar un espacio entre la palabra clave if y el par\u00e9ntesis
          \n\n\n\n
          if<\/code>\u00a0(<condition>)<\/code><\/p>\n
          while<\/code>\u00a0(<condition>)<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n
        2. Cuando una combinaci\u00f3n de if y else else es utilizada y si ambas deben ofrecer un valor, el else debe ser evitado.
          \n\n\n\n
          if<\/code>\u00a0(<condition>)<\/code><\/p>\n
          \u00a0\u00a0\u00a0\u00a0<\/code>return<\/code>\u00a0false<\/code>;<\/code><\/p>\n
          return<\/code>\u00a0true<\/code>;<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
          Recomendaci\u00f3n<\/p>\n
          Le recomendamos un resultado por m\u00e9todo \/ funci\u00f3n<\/li>\n
        3. Cuando un m\u00e9todo \/ funci\u00f3n ofrece un valor booleano y el valor actual del m\u00e9todo \/ funci\u00f3n depende de ello, la declaraci\u00f3n if debe ser evitada
          \n\n\n\n
          public<\/code>\u00a0aFirstMethod()<\/code><\/p>\n
          {<\/code><\/p>\n
          \u00a0\u00a0\u00a0\u00a0<\/code>return<\/code>\u00a0$<\/code>this<\/code>->aSecondMethod();<\/code><\/p>\n
          }<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n
        4. Las pruebas deben ser agrupadas por “entidad”
          \n\n\n\n
          if<\/code>\u00a0($price AND !empty($price))<\/code><\/p>\n
          \u00a0\u00a0\u00a0\u00a0<\/code>[...]<\/code><\/p>\n
          if<\/code>\u00a0(!Validate::$myObject OR $myObject->id === NULL)<\/code><\/p>\n
          \u00a0\u00a0\u00a0\u00a0<\/code>[...]<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<\/ol>\n
          Visibilidad<\/h3>\n
            \n
          1. La visibilidad debe definirse en cada momento, incluso cuando se trata de un m\u00e9todo p\u00fablico.<\/li>\n
          2. El orden de las propiedades del m\u00e9todo debe ser: visibility static function name()
            \n\n\n\n
            private<\/code>\u00a0static<\/code>\u00a0function foo()<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<\/ol>\n
            Nombres de M\u00e9todo \/ Funci\u00f3n<\/h3>\n
              \n
            1. Los nombres del m\u00e9todo y la funci\u00f3n comienzan siempre con un car\u00e1cter en min\u00fascula y cada una de las palabras siguientes deben comenzar con un car\u00e1cter en may\u00fasculas (CamelCase)
              \n\n\n\n
              public<\/code>\u00a0function myExempleMethodWithALotOfWordsInItsName()<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n
            2. Los corchetes que se presentan en el c\u00f3digo del m\u00e9todo tienen que ser precedidos por un retorno
              \n\n\n\n
              public<\/code>\u00a0function myMethod($arg1, $arg2)<\/code><\/p>\n
              {<\/code><\/p>\n
              \u00a0\u00a0\u00a0\u00a0<\/code>[...]<\/code><\/p>\n
              }<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n
            3. Los nombres de los m\u00e9todos y las funciones deben ser nombres expl\u00edcitos, por lo tanto nombres de funci\u00f3n como “b()” o “ef()” est\u00e1n completamente prohibidos.Excepciones\n
              Las \u00fanicas excepciones son la funci\u00f3n de traducci\u00f3n llamada “l()” y las funciones de depuraci\u00f3n “p()”, “d()”.<\/li>\n<\/ol>\n
              Enumeraci\u00f3n<\/h3>\n
              Las comas deben estar seguidas (y s\u00f3lo seguidas) por un espacio.<\/p>\n\n\n\n
              protected<\/code>\u00a0function myProtectedMethod($arg1, $arg2, $arg3 =\u00a0<\/code>null<\/code>)<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
              Objetos \/ Clases<\/h3>\n
                \n
              1. El nombre del objeto debe colocarse en singular
                \n\n\n\n
                class<\/code>\u00a0Customer<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n
              2. El nombre de la clase debe seguir el modelo CamelCase, excepto que la primera letra sea may\u00fascula
                \n\n\n\n
                class<\/code>\u00a0MyBeautifulClass<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<\/ol>\n
                Definiciones<\/h3>\n
                  \n
                1. Los nombres de las definiciones deben ser ingresados en may\u00fasculas<\/li>\n
                2. Los nombres de las definiciones deben contar con el prefijo “PS_” dentro del n\u00facleo y el m\u00f3dulo
                  \n\n\n\n
                  define(<\/code>'PS_DEBUG'<\/code>,\u00a0<\/code>1<\/code>);<\/code><\/p>\n
                  define(<\/code>'PS_MODULE_NAME_DEBUG'<\/code>,\u00a0<\/code>1<\/code>);<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n
                3. Los nombres de las definiciones no permiten caracteres alfab\u00e9ticos. Excepto \u201c_\u201d.<\/li>\n<\/ol>\n
                  Palabras claves<\/h3>\n
                  Todas las palabras clave deben colocarse en min\u00fasculas
                  \nej. as, case, if, echo, null<\/p>\n
                  Constantes<\/h3>\n
                  Las constantes deben estar en may\u00fasculas, excepto “verdadero” y “falso” y “nulo”, que debe estar en min\u00fasculas
                  \nej. “ENT_NOQUOTE”, “true”<\/p>\n
                  Variables de configuraci\u00f3n<\/h3>\n
                  Las variables de configuraci\u00f3n siguen las mismas reglas que las definiciones<\/p>\n
                  Cadenas<\/h3>\n
                  Las Cadenas deben ir entre comillas simples, nunca dobles<\/p>\n\n\n\n
                  echo\u00a0<\/code>'Debug'<\/code>;<\/code><\/p>\n
                  $myObj->name =\u00a0<\/code>'Hello '<\/code>.$name;<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
                  Comentarios<\/h3>\n
                    \n
                  1. Dentro de las funciones y m\u00e9todos, s\u00f3lo la etiqueta “\/\/” de comentario es permitida<\/li>\n
                  2. Despu\u00e9s de la etiqueta “\/\/” de comentario, un espacio \u201c\/\/ Comment\u201c es necesario
                    \n\n\n\n
                    \/\/ My great comment<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n
                  3. La etiqueta “\/\/” de comentario es permitida al final de una l\u00ednea de c\u00f3digo
                    \n\n\n\n
                    $a =\u00a0<\/code>17<\/code>\u00a0+\u00a0<\/code>23<\/code>;\u00a0<\/code>\/\/ A comment inside my exemple function<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n
                  4. Funciones y m\u00e9todos externos, s\u00f3lo las etiquetas “\/” y “<\/strong>\/” de comentario son permitidas
                    \n\n\n\n
                    \/* This method is required for compatibility issues *\/<\/code><\/p>\n
                    public<\/code>\u00a0function foo()<\/code><\/p>\n
                    {<\/code><\/p>\n
                    \/\/ Some code explanation right here<\/code><\/p>\n
                    [...]<\/code><\/p>\n
                    }<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n
                  5. Comentario PHP Doc Element es necesario antes de las declaraciones de m\u00e9todo
                    \n\n\n\n
                    \/**<\/code><\/p>\n
                    \u00a0<\/code>* Return field value if possible (both classical and multilingual fields)<\/code><\/p>\n
                    \u00a0<\/code>*<\/code><\/p>\n
                    \u00a0<\/code>* Case 1 : Return value if present in $_POST \/ $_GET<\/code><\/p>\n
                    \u00a0<\/code>* Case 2 : Return object value<\/code><\/p>\n
                    \u00a0<\/code>*<\/code><\/p>\n
                    \u00a0<\/code>* @param object $obj Object<\/code><\/p>\n
                    \u00a0<\/code>* @param string $key Field name<\/code><\/p>\n
                    \u00a0<\/code>* @param integer $id_lang Language id (optional)<\/code><\/p>\n
                    \u00a0<\/code>* @return string<\/code><\/p>\n
                    \u00a0<\/code>*\/<\/code><\/p>\n
                    protected<\/code>\u00a0function getFieldValue($obj, $key, $id_lang = NULL)<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
                    Para m\u00e1s informaci\u00f3n<\/p>\n
                    Para m\u00e1s informaci\u00f3n acerca de la regla PHP Doc: vea\u00a0este enlace \u00fatil<\/a><\/li>\n<\/ol>\n
                    Devoluci\u00f3n de valores<\/h3>\n
                      \n
                    1. Las declaraciones de devoluci\u00f3n no necesitan par\u00e9ntesis, excepto cuando se trata de una expresi\u00f3n compuesta
                      \n\n\n\n
                      return<\/code>\u00a0$result;<\/code><\/p>\n
                      return<\/code>\u00a0($a + $b);<\/code><\/p>\n
                      return<\/code>\u00a0(a() - b());<\/code><\/p>\n
                      return<\/code>\u00a0true<\/code>;<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n
                    2. Desarmar una funci\u00f3n
                      \n\n\n\n
                      return<\/code>;<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<\/ol>\n
                      Llamada<\/h3>\n
                      La funci\u00f3n de llamada precedida por una “@” est\u00e1 prohibida pero tenga cuidado con la llamada a la funci\u00f3n \/ m\u00e9todo con login \/ contrase\u00f1a o ruta de argumentos.<\/p>\n\n\n\n
                      myfunction()<\/code><\/p>\n
                      \/\/ En el siguiente ejemplo colocamos una @ por motivos de seguridad<\/code><\/p>\n
                      @mysql_connect<\/code>([...]);<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
                      Etiquetas<\/h3>\n
                        \n
                      1. Una l\u00ednea en blanco debe dejarse despu\u00e9s de la etiqueta de apertura de PHP
                        \n\n\n\n
                        <?php<\/code><\/p>\n
                         <\/p>\n
                        require_once(<\/code>'my_file.inc.php'<\/code>);<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n
                      2. La etiqueta final de PHP est\u00e1 prohibida<\/li>\n<\/ol>\n
                        Indentaci\u00f3n<\/h3>\n
                          \n
                        1. El car\u00e1cter de tabulaci\u00f3n (“\\t”) es el \u00fanico caracter de indentaci\u00f3n que se permite<\/li>\n
                        2. Cada nivel de indentaci\u00f3n debe ser representado por un solo caracter de tabulaci\u00f3n
                          \n\n\n\n
                          function foo($a)<\/code><\/p>\n
                          {<\/code><\/p>\n
                          \u00a0\u00a0\u00a0\u00a0<\/code>if<\/code>\u00a0($a ==\u00a0<\/code>null<\/code>)<\/code><\/p>\n
                          \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/code>return<\/code>\u00a0false<\/code>;<\/code><\/p>\n
                          \u00a0\u00a0\u00a0\u00a0<\/code>[...]<\/code><\/p>\n
                          }<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<\/ol>\n
                          Matriz<\/h3>\n
                            \n
                          1. La palabra clave de la matriz no debe ser seguida por un espacio
                            \n\n\n\n
                            array(<\/code>17<\/code>,\u00a0<\/code>23<\/code>,\u00a0<\/code>42<\/code>);<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n
                          2. La indentaci\u00f3n debe ser de la siguiente forma cuando muchos datos se encuentran dentro de una matriz:
                            \n\n\n\n
                            $a = array(<\/code><\/p>\n
                            \u00a0\u00a0\u00a0\u00a0<\/code>36<\/code>\u00a0=> $b,<\/code><\/p>\n
                            \u00a0\u00a0\u00a0\u00a0<\/code>$c =>\u00a0<\/code>'foo'<\/code>,<\/code><\/p>\n
                            \u00a0\u00a0\u00a0\u00a0<\/code>$d => array(<\/code>17<\/code>,\u00a0<\/code>23<\/code>,\u00a0<\/code>42<\/code>),<\/code><\/p>\n
                            \u00a0\u00a0\u00a0\u00a0<\/code>$e => array(<\/code><\/p>\n
                            \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/code>0<\/code>\u00a0=>\u00a0<\/code>'zero'<\/code>,<\/code><\/p>\n
                            \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/code>1<\/code>\u00a0=> $one<\/code><\/p>\n
                            \u00a0\u00a0\u00a0\u00a0<\/code>)<\/code><\/p>\n
                            );<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<\/ol>\n
                            Bloque<\/h3>\n
                            Los corchetes est\u00e1n prohibidos cuando se define solamente una instrucci\u00f3n o una combinaci\u00f3n de declaraci\u00f3n<\/p>\n\n\n\n
                            if<\/code>\u00a0(!$result)<\/code><\/p>\n
                            \u00a0\u00a0\u00a0\u00a0<\/code>return<\/code>\u00a0false<\/code>;<\/code><\/p>\n
                             <\/p>\n
                            for<\/code>\u00a0($i =\u00a0<\/code>0<\/code>; $i <\u00a0<\/code>17<\/code>; $i++)<\/code><\/p>\n
                            \u00a0\u00a0\u00a0\u00a0<\/code>if<\/code>\u00a0($myArray[$i] == $value)<\/code><\/p>\n
                            \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/code>$result[] = $myArray[$i];<\/code><\/p>\n
                            \u00a0\u00a0\u00a0\u00a0<\/code>else<\/code><\/p>\n
                            \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/code>$failed++;<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
                             <\/p>\n","protected":false},"excerpt":{"rendered":"
                            Variable names The first letter of a variable must start with a lowercase Native variables or arrays must be separated by an underscore (_) each word change: $my_var Variables that are Objects must change to uppercase each word end, example: $myVar Global variables must be all capitalized, example: $MY_VAR Assignments There must be a space between the variable ...<\/p>","protected":false},"author":24,"featured_media":38473,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[2023],"tags":[],"class_list":["post-38459","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-wordpress"],"jetpack_featured_media_url":"https:\/\/webirix.com\/wp-content\/uploads\/2017\/07\/imagen_php.png","_links":{"self":[{"href":"https:\/\/webirix.com\/en\/wp-json\/wp\/v2\/posts\/38459","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/webirix.com\/en\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/webirix.com\/en\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/webirix.com\/en\/wp-json\/wp\/v2\/users\/24"}],"replies":[{"embeddable":true,"href":"https:\/\/webirix.com\/en\/wp-json\/wp\/v2\/comments?post=38459"}],"version-history":[{"count":2,"href":"https:\/\/webirix.com\/en\/wp-json\/wp\/v2\/posts\/38459\/revisions"}],"predecessor-version":[{"id":38474,"href":"https:\/\/webirix.com\/en\/wp-json\/wp\/v2\/posts\/38459\/revisions\/38474"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/webirix.com\/en\/wp-json\/wp\/v2\/media\/38473"}],"wp:attachment":[{"href":"https:\/\/webirix.com\/en\/wp-json\/wp\/v2\/media?parent=38459"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/webirix.com\/en\/wp-json\/wp\/v2\/categories?post=38459"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/webirix.com\/en\/wp-json\/wp\/v2\/tags?post=38459"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}