CakePHP - Struktura folderów
Tutaj dowiemy się o strukturze folderów i konwencji nazewnictwa w CakePHP. Zacznijmy od zrozumienia struktury folderów.
Struktura folderów
Spójrz na poniższy zrzut ekranu. Pokazuje strukturę folderów CakePHP.
Poniższa tabela opisuje rolę każdego folderu w CakePHP -
Sr.No | Nazwa i opis folderu |
---|---|
1 | bin Plik bin folder zawiera pliki wykonywalne konsoli Cake. |
2 | config Plik configfolder zawiera (kilka) plików konfiguracyjnych używanych przez CakePHP. Szczegóły połączenia z bazą danych, ładowanie, podstawowe pliki konfiguracyjne i inne powinny być tutaj przechowywane. |
3 | logs Plik logs folder zwykle zawiera pliki dziennika, w zależności od konfiguracji dziennika. |
4 | plugins Folder wtyczek to miejsce, w którym przechowywane są wtyczki używane przez Twoją aplikację. |
5 | resources Pliki do internacjonalizacji w odpowiednim folderze lokalizacji będą przechowywane tutaj. Np. Locales / en_US. |
6 | src Plik srcfolder będzie miejscem, w którym będziesz pracować swoją magią. Jest to miejsce, w którym zostaną umieszczone pliki aplikacji i będziesz wykonywać większość prac związanych z tworzeniem aplikacji. Przyjrzyjmy się bliżej folderom wewnątrz src.
|
7 | templates Pliki prezentacji szablonów są umieszczane tutaj: elementy, strony błędów, układy i pliki szablonów widoku. |
8 | tests Plik tests folder będzie miejscem, w którym umieścisz przypadki testowe dla swojej aplikacji. |
9 | tmp Plik tmpfolder to miejsce, w którym CakePHP przechowuje dane tymczasowe. Rzeczywiste dane, które przechowuje, zależą od tego, jak skonfigurowałeś CakePHP, ale ten folder jest zwykle używany do przechowywania opisów modeli, a czasami informacji o sesji. |
10 | vendor Plik vendorfolder to miejsce, w którym zostaną zainstalowane CakePHP i inne zależności aplikacji. Podejmij osobiste zobowiązanie, że nie będziesz edytować plików w tym folderze. Nie możemy ci pomóc, jeśli zmodyfikowałeś rdzeń. |
11 | webroot Plik webrootkatalog to publiczny katalog główny Twojej aplikacji. Zawiera wszystkie pliki, które chcesz, aby były publicznie dostępne. |
Konwencja nazewnictwa
Konwencja nazewnictwa nie jest czymś, czego należy przestrzegać, ale jest dobrą praktyką kodowania i będzie bardzo pomocna, gdy Twój projekt będzie się rozwijał.
Konwencja dotycząca kontrolerów
Nazwa klasy kontrolera musi być liczbą mnogą PascalCased, a nazwa musi kończyć się na Controller. Na przykład w przypadku klasy Students nazwą kontrolera może byćStudentsController. Metody publiczne na kontrolerach są często ujawniane jako „akcje” dostępne przez przeglądarkę internetową.
Na przykład / users / view mapuje do view()metoda UsersController po wyjęciu z pudełka. Za pomocą routingu nie można uzyskać dostępu do metod chronionych lub prywatnych.
Konwencja nazw plików i klas
Przeważnie widzieliśmy, że nazwa naszego pliku z nazwą klasy jest prawie taka sama. Podobnie jest w przypadku cakephp.
Na przykład klasa StudentsController będzie miała plik o nazwie StudentsController.php. Pliki muszą być zapisane jako nazwa modułu oraz w odpowiednich folderach w folderze aplikacji.
Konwencje baz danych
Tabele używane w modelach CakePHP, w większości mają nazwy w liczbie mnogiej z podkreśleniem.
Na przykład student_details, student_marks. Nazwa pola ma podkreślenie, jeśli składa się z dwóch słów, na przykład imię, nazwisko.
Konwencje modeli
W przypadku modelu klasy są nazywane zgodnie z tabelą bazy danych, nazwy są w liczbie mnogiej, PascalCased i sufiksem Table.
Na przykład StudentDetailsTable, StudentMarksTable
Zobacz konwencje
W przypadku szablonów widoków pliki są oparte na funkcjach kontrolera.
Na przykład, jeśli klasa StudentDetailsController ma funkcję showAll (), szablon widoku zostanie nazwany jako show_all.php i zapisany w szablonie / yrmodule / show_all.php.