Wichtige Namenskonventionen von Laravel

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:

WasWieGutSchlecht
ControllerSingularArticleControllerArticlesController
RoutePluralarticles/1article/1
Benannte Routesnake_case mit Punktnotationusers.show_activeusers.show-active, show-active-users
ModelSingularUserUsers
hasOne oder belongsTo BeziehungSingulararticleCommentarticleComments, article_comment
Alle anderen BeziehungenPluralarticleCommentsarticleComment, article_comments
TabellePluralarticle_commentsarticle_comment, articleComments
Pivot-Tabellesinguläre Modellnamen in alphabetischer Reihenfolgearticle_useruser_article, articles_users
Tabellenspaltesnake_case ohne Modellnamemeta_titleMetaTitle; article_title_title
Model-Eigenschaftsnake_case$model->created_at$model->createdAt
Fremdschlüsselsingulärer Modellname mit Suffix _idarticle_idArticleId, id_article, articles_id
Primärschlüsselidcustom_id
Migration2017_01_01_000000_create_articles_table
2017_01_01_000000_articles
MethodecamelCasegetAllget_all
Methode im RessourcencontrollerTabellestoresaveArticle
Methode in einer TestklassecamelCasetestGuestCannotSeeArticletest_guest_cannot_see_article
VariablecamelCase$articlesWithAuthor$articles_with_author
Collectionbeschreibend, Plural$activeUsers = User::active()->get()$active, $data
Objektbeschreibend, Singular
$activeUser = User::active()->first()$users, $obj
Konfigurations- und Sprachdateien index
snake_casearticles_enabledArticlesEnabled; articles-enabled
Viewkebab-caseshow-filtered.blade.phpshowFiltered.blade.php, show_filtered.blade.php
Configsnake_casegoogle_calendar.phpgoogleCalendar.php, google-calendar.php
Vertrag (Interface)Adjektiv oder Substantiv
AuthenticationInterfaceAuthenticatable, IAuthentication
TraitAdjektivNotifiableNotificationTrait
Trait (PSR)AdjektivNotifiableTraitNotification
EnumSingularUserTypeUserTypesUserTypeEnum
FormRequestSingularUpdateUserRequestUpdateUserFormRequestUserFormRequestUserRequest
SeederSingularUserSeederUsersSeeder
Newsletter abonnieren!

Newsletter abonnieren!

Möchten Sie immer auf dem Laufenden bleiben und über Neuigkeiten und Angebote informiert werden? Dann melden Sie sich jetzt für unseren Newsletter an!

Sie können sich jederzeit problemlos abmelden, indem Sie auf den Abmelde-Link in einer unserer E-Mails klicken. Verpassen Sie keine Neuigkeiten mehr und melden Sie sich jetzt für unseren Newsletter an!

Datenschutz

Anmeldung erfolgreich! Prüfen Sie Ihren Posteingang oder Spam-Ordner, um das Abonnement zu bestätigen.

WordPress Cookie Hinweis von Real Cookie Banner