Convenciones CakePHP¶

Convenciones de Controlador¶

Los nombres de las clases Controlador son en plurar, en formato CamelCase, y finalizan con Controller. Ejemplos de nombres son: UsuariosController y CategoriasArticulosController.

Los métodos públicos de los Controladores a menudo se exponen como “acciones” accesibles a través de un navegador web. Tienen formato camelBacked. Por ejemplo, /users/view-me mapea al método viewMe() de UsersController sin tener que hacer nada en el enrutamiento de la aplicación. Los métodos protegidos o privados no son accesibles con el enrutamiento.

$this->Html->link('titulo-enlace', [
    'prefix' => 'MiPrefijo' // CamelCase
    'plugin' => 'MiPlugin', // CamelCase
    'controller' => 'NombreControlador', // CamelCase
    'action' => 'nombreAccion' // camelBack
]

Convenciones de nombre de clase y archivo¶

En general, los nombres de los archivos coinciden con los nombres de las clases y sigue el estándar PSR-4 para cargarse automáticamente. Los siguientes son ejemplos de nombres de clases y de sus archivos:

• La clase Controlador LatestArticlesController debería estar en un archivo llamado LatestArticlesController.php

• La clase Componente MyHandyComponent debería estar en un archivo llamado MyHandyComponent.php

• La clase Tabla OptionValuesTable debería estar en un archivo llamado OptionValuesTable.php.

• La clase Entidad OptionValue debería estar en un archivo llamado OptionValue.php.

• La clase Behavior EspeciallyFunkableBehavior debería estar en un archivo llamado EspeciallyFunkableBehavior.php

• La clase Vista SuperSimpleView debería estar en un archivo llamado SuperSimpleView.php

• La clase Helper BestEverHelper debería estar en un archivo llamado BestEverHelper.php

Cada archivo deberá estar ubicado en la carpeta/namespace correcta dentro de tu carpeta de tu aplicación.

Convenciones de base de datos¶

Los nombres de las tablas correspondientes a los modelos de CakePHP son en plural y con con “_”. Por ejemplo users, menu_links y user_favorite_pages respectivamente. Los nombres de tablas formadas por múltiples palabras sólo deben usar el plural en la última palabra, por ejemplo, menu_links.

Los nombres de campos con dos o más palabras se escriben con “_”, por ejemplo: first_name.

Las claves foráneas en relaciones 1-n (hasMany) y 1-1 (belongsTo/hasOne) son reconocidas por defecto mediante el nombre (en singular) de la tabla relacionada seguido de _id. De este modo si Users tiene varios Articles (relación hasMany), la tabla articles se relacionará con la tabla users a través de la clave foránea user_id. Para una tabla como menu_links cuyo nombre está formado por varias palabras, la clave foránea sería menu_link_id.

Las tablas de unión, usadas en las relaciones n-n (BelongsToMany) entre modelos, deberían ser nombradas después de las tablas que unirán. Los nombres deberán estar en plural y en orden alfabético: articles_tags en lugar de tags_articles o article_tags. El comando ``bake`` no funcionará correctamente si ésta convención no se sigue. Si la tabla de unión guarda alguna información que no sean las claves foráneas, debes crear la clase de la entidad y modelo para esa tabla.

Además de utilizar claves auto-incrementales como claves primarias, también puedes utilizar columnas UUID. CakePHP creará un único UUID de 36 caracteres (Cake\Utility\Text::uuid()) cada vez que guardes un nuevo registro usando el método Table::save() .

Convenciones de modelo¶

Los nombres de las clases para las tablas son en plural, formato CamelCase y terminan en Table. UsersTable, MenuLinksTable y UserFavoritePagesTable son ejemplos de nombres de clases que corresponden a las tablas users, menu_links y user_favorite_pages respectivamente.

Los nombres de las clases para las entidades son en singular, formato CamelCase y no tienen sufijo. User, MenuLink y UserFavoritePage son ejemplos de nombres de clases que corresponden a las entidades users, menu_links y user_favorite_pages respectivamente.

Convenciones de vistas¶

Los archivos de las plantillas de vistas son nombrados según las funciones de controlador que las muestran empleando “_”. La función viewAll() de la clase ArticlesController mostrará la vista templates/Articles/view_all.php.

El patrón base es templates/Controller/nombre_funcion.php.

Convenciones de plugins¶

Es útil añadir el prefijo «cakephp-» en el nombre del paquete para los plugins de CakePHP. Esto hace que el nombre esté relacionado semánticamente al «framework» del que depende.

No uses el espacio de nombre de CakePHP (cakephp) como nombre de «vendor», ya que es un espacio reservado para los plugins que son propiedad de CakePHP. La convención es usar letras en minúscula y guiones como separadores:

// Bad
cakephp/foo-bar

// Good
your-name/cakephp-foo-bar

Ver lista asombrosa de recomendaciones par mas detalles.

Resumen¶

Nombrando los elementos de tu aplicación empleando las convenciones de CakePHP ganarás funcionalidad sin los fastidios y ataduras de mantenimiento de la configuración.

Un último ejemplo que enlaza todas las convenciones:

• Tabla de base de datos: «articles», «menu_links»

• Clase Tabla: ArticlesTable, ubicada en src/Model/Table/ArticlesTable.php

• Clase Entidad: Article, ubicada en src/Model/Entity/Article.php

• Clase Controlador: ArticlesController, ubicada en src/Controller/ArticlesController.php

• Plantilla vista, ubicada en templates/Articles/index.php

Usando estas convenciones, CakePHP sabe que una petición a http://example.com/articles/ hace una llamada a la función index() de la clase ArticlesController, donde el modelo Articles está disponible automáticamente y enlazada automáticamente a la tabla articles en la base de datos . Ninguna de estas relaciones han sido configuradas de ningún modo salvo creando clases y archivos que has tenido que crear de todas formas.

Database Convention Summary¶

Ahora que te has introducido en los fundamentos de CakePHP. puedes tratar de realizar el tutorial Tutorial Gestor de Contenidos para ver como las cosas encajan juntas.