PHP PSR 是 PHP 开发的事实标准及规范。但是 PSR 规范内容较多,不方便查阅。本文分享一个 Laravel 常用命名规范表格,可以随用随查。

What How Good Bad
控制器 单数 ArticleController ArticlesController
路由 复数 articles/1 article/1
命名路由 使用“.”号链接的蛇形命名 users.show_active users.show-active, show-active-users
模型 单数 User Users
一对一(及反向)关联 单数 articleComment articleComments, article_comment
除一对一以外的其它关联 复数 articleComments articleComment, article_comments
数据表 复数 article_comments article_comment, articleComments
中间表 单数 按字母顺序排列的模型名称 article_user user_article, articles_users
表字段 不带有模型名称的蛇形命名 meta_title MetaTitle; article_meta_title
模型属性 蛇形命名 $model->created_at $model->createdAt
外键 单数 模型名加上“_id”后缀 article_id ArticleId, id_article, articles_id
主键 id custom_id
表迁移 2017_01_01_000000_create_articles_table 2017_01_01_000000_articles
方法 驼峰 getAll get_all
资源控制器中的方法 table store saveArticle
测试类中的方法 驼峰 testGuestCannotSeeArticle test_guest_cannot_see_article
变量 驼峰 $articlesWithAuthor $articles_with_author
集合 描述性的复数 $activeUsers = User::active()->get() $active, $data
对象 描述性的单数 $activeUser = User::active()->first() $users, $obj
配置和语言文件的索引 蛇形 articles_enabled ArticlesEnabled; articles-enabled
视图 中横连接 show-filtered.blade.php showFiltered.blade.php, show_filtered.blade.php
配置 蛇形 google_calendar.php googleCalendar.php, google-calendar.php
契约(接口) 形容词或名词 AuthenticationInterface Authenticatable, IAuthentication
Trait 形容词 Notifiable NotificationTrait