Wichtige Namenskonventionen von Laravel

Laravel folgt einer Reihe von Namenskonventionen, die dazu beitragen, die Struktur von Anwendungen zu organisieren und die Entwicklung von Code zu vereinfachen. Einige der wichtigsten Namenskonventionen von Laravel sind:

1. Klassen- und Dateinamen: Klassen in Laravel sollten immer nach dem CamelCase-Format benannt werden, während Dateinamen in kebab-case formatiert sein sollten. Zum Beispiel: UserController.php oder PostComment.
2. Namespace: Laravel verwendet ein Namespace-System, um Klassen innerhalb von Modulen zu organisieren. Der Namespace wird normalerweise durch die Ordnerstruktur im Projekt definiert. Zum Beispiel: App\Http\Controllers\Admin.
3. Models: Laravel verwendet eine Konvention für die Benennung von Models. Der Name des Models sollte der Name der zugehörigen Datenbanktabelle entsprechen. Zum Beispiel: User für die Tabelle “users”.
4. Tabellennamen: Tabellennamen sollten immer im Plural formatiert sein. Zum Beispiel: “users” statt “user”.
5. Routennamen: Routennamen sollten in kebab-case formatiert werden und eine eindeutige Beschreibung der Funktion der Route enthalten. Zum Beispiel: post-comment für eine Route, die einen Kommentar für einen Post erstellt.
6. Methodennamen: Methodennamen sollten im CamelCase-Format formatiert sein und eine Beschreibung der ausgeführten Aktion enthalten. Zum Beispiel: getUserById() für eine Methode, die einen Benutzer anhand seiner ID abruft.
7. Variablennamen: Variablennamen sollten im CamelCase-Format formatiert sein und eine Beschreibung des gespeicherten Werts enthalten. Zum Beispiel: $userName für den Benutzernamen eines Benutzers.

Diese Namenskonventionen helfen dabei, die Struktur von Laravel-Anwendungen zu organisieren und erleichtern es Entwicklern, Code effizient zu schreiben und zu warten.

Befolgen Sie die Namenskonventionen von Laravel

Folgen Sie den PSR standards.

Befolgen Sie außerdem die von der Laravel-Community akzeptierten Namenskonventionen:

Was	Wie	Gut	Schlecht
Controller	Singular	ArticleController	ArticlesController
Route	Plural	articles/1	article/1
Benannte Route	snake_case mit Punktnotation	users.show_active	users.show-active, show-active-users
Model	Singular	User	Users
hasOne oder belongsTo Beziehung	Singular	articleComment	articleComments, article_comment
Alle anderen Beziehungen	Plural	articleComments	articleComment, article_comments
Tabelle	Plural	article_comments	article_comment, articleComments
Pivot-Tabelle	singuläre Modellnamen in alphabetischer Reihenfolge	article_user	user_article, articles_users
Tabellenspalte	snake_case ohne Modellname	meta_title	MetaTitle; article_title_title
Model-Eigenschaft	snake_case	$model->created_at	$model->createdAt
Fremdschlüssel	singulärer Modellname mit Suffix _id	article_id	ArticleId, id_article, articles_id
Primärschlüssel	–	id	custom_id
Migration	–	2017_01_01_000000_create_articles_table	2017_01_01_000000_articles
Methode	camelCase	getAll	get_all
Methode im Ressourcencontroller	Tabelle	store	saveArticle
Methode in einer Testklasse	camelCase	testGuestCannotSeeArticle	test_guest_cannot_see_article
Variable	camelCase	$articlesWithAuthor	$articles_with_author
Collection	beschreibend, Plural	$activeUsers = User::active()->get()	$active, $data
Objekt	beschreibend, Singular	$activeUser = User::active()->first()	$users, $obj
Konfigurations- und Sprachdateien index	snake_case	articles_enabled	ArticlesEnabled; articles-enabled
View	kebab-case	show-filtered.blade.php	showFiltered.blade.php, show_filtered.blade.php
Config	snake_case	google_calendar.php	googleCalendar.php, google-calendar.php
Vertrag (Interface)	Adjektiv oder Substantiv	AuthenticationInterface	Authenticatable, IAuthentication
Trait	Adjektiv	Notifiable	NotificationTrait
Trait (PSR)	Adjektiv	NotifiableTrait	Notification
Enum	Singular	UserType	UserTypes, UserTypeEnum
FormRequest	Singular	UpdateUserRequest	UpdateUserFormRequest, UserFormRequest, UserRequest
Seeder	Singular	UserSeeder	UsersSeeder