CakePHP - Estructura de carpetas

Aquí, aprenderemos sobre la estructura de carpetas y la Convención de nombres en CakePHP. Comencemos por comprender la estructura de carpetas.

Estructura de carpetas

Eche un vistazo a la siguiente captura de pantalla. Muestra la estructura de carpetas de CakePHP.

La siguiente tabla describe la función de cada carpeta en CakePHP:

No Señor Nombre y descripción de carpeta
1

bin

los bin La carpeta contiene los ejecutables de la consola Cake.

2

config

los configLa carpeta contiene los (pocos) archivos de configuración que CakePHP usa. Los detalles de la conexión de la base de datos, el arranque, los archivos de configuración central y más deben almacenarse aquí.

3

logs

los logs La carpeta normalmente contiene sus archivos de registro, dependiendo de su configuración de registro.

4

plugins

La carpeta de complementos es donde se almacenan los complementos de su aplicación.

5

resources

Los archivos para la internacionalización en la carpeta de configuración regional respectiva se almacenarán aquí. Por ejemplo, locales / en_US.

6

src

los srcLa carpeta será donde trabajarás tu magia. Es donde se colocarán los archivos de su aplicación y usted hará la mayor parte del desarrollo de su aplicación. Veamos un poco más de cerca las carpetas dentro de src.

  • Consola: contiene los comandos de la consola y las tareas de la consola para su aplicación.

  • Controlador: contiene los controladores de su aplicación y sus componentes.

  • Modelo: contiene las tablas, entidades y comportamientos de su aplicación.

  • Ver Las clases de presentación se colocan aquí: celdas, ayudantes y archivos de plantilla.

7

templates

Los archivos de presentación de plantillas se colocan aquí: elementos, páginas de error, diseños y archivos de plantillas de visualización.

8

tests

los tests La carpeta será donde coloque los casos de prueba para su aplicación.

9

tmp

los tmpLa carpeta es donde CakePHP almacena los datos temporales. Los datos reales que almacena dependen de cómo haya configurado CakePHP, pero esta carpeta se usa generalmente para almacenar descripciones de modelos y, a veces, información de sesión.

10

vendor

los vendorLa carpeta es donde se instalarán CakePHP y otras dependencias de la aplicación. Haga un compromiso personal de no editar archivos en esta carpeta. No podemos ayudarlo si ha modificado el núcleo.

11

webroot

los webrootdirectorio es la raíz del documento público de su aplicación. Contiene todos los archivos que desea que estén accesibles públicamente.

Convenio de denominación

La convención de nomenclatura no es algo obligatorio a seguir, pero es una buena práctica de codificación y será muy útil a medida que su proyecto crezca.

Convención del controlador

El nombre de la clase del controlador debe ser plural, PascalCased y el nombre debe terminar con Controller. Por ejemplo, para la clase de Estudiantes, el nombre del controlador puede serStudentsController. Los métodos públicos en los controladores a menudo se exponen como "acciones" accesibles a través de un navegador web.

Por ejemplo, el / users / view se asigna al view()método del UsersController listo para usar. No se puede acceder a métodos protegidos o privados con enrutamiento.

Convención de nombre de archivo y clase

Sobre todo, hemos visto que nuestro nombre de archivo de nombre de clase es casi el mismo. Esto es similar en cakephp.

Por ejemplo, la clase StudentsController tendrá el archivo llamado StudentsController.php. Los archivos deben guardarse como el nombre del módulo y en las carpetas respectivas en la carpeta de la aplicación.

Convenciones de bases de datos

Las tablas utilizadas para los modelos CakePHP, en su mayoría tienen nombres en plural con subrayado.

Por ejemplo, student_details, student_marks. El nombre del campo tiene un guión bajo, si se compone de dos palabras, por ejemplo, nombre, apellido.

Convenciones modelo

Para el modelo, las clases se nombran según la tabla de la base de datos, los nombres son plurales, PascalCased y el sufijo Table.

Por ejemplo, StudentDetailsTable, StudentMarksTable

Ver convenciones

Para las plantillas de vista, los archivos se basan en las funciones del controlador.

Por ejemplo, si la clase StudentDetailsController tiene la función showAll (), la plantilla de vista se llamará show_all.php y se guardará dentro de template / yrmodule / show_all.php.