Yii2编程规范

本文介绍的是基于Yii2开发的编程规范。
解决怎么在开发中及时发现不规范的地方和如何按照标准修正。

首先:背景知识

1、已经安装composer

2、了解PHP_CodeSniffer

PHP_CodeSniffer is a set of two PHP scripts; the main phpcs script that tokenizes PHP, JavaScript and CSS files to detect violations of a defined coding standard, and a second phpcbf script to automatically correct coding standard violations. PHP_CodeSniffer is an essential development tool that ensures your code remains clean and consistent.

3、PHP的标准,有时间可以看看:PSR中文版
不同的框架有各自的一些额外要求。

Yii官方提供了Yii2规范
并提动了一个支持PHP_CodeSniffer v2(>=2.3.1 <3.0)的标准库
截至到发文时,官方还没有提供PHP_CodeSniffer v3的支持,
于是我个人fork了官方的标准,推荐使用。

其次:安装

 //php_codesniffer
composer global require "squizlabs/php_codesniffer=*"
//也可以只用composer require-dev

//yii2-coding-standards
composer global require "biaoqianwo/yii2-coding-standards"

//拷贝Yii2的标准到php_codesniffer的标准目录
sudo cp -r ~/.config/composer/vendor/biaoqianwo/yii2-coding-standards/Yii2 ~/.config/composer/vendor/squizlabs/php_codesniffer/src/Standards

//查看是否成功
~/.config/composer/vendor/bin/phpcs -i
//最后输出:
The installed coding standards are Squiz, Yii2, MySource, Zend, PSR1, PSR2 and PEAR

最后:如何使用

有两种:一种是在IDE中(这里介绍在PHPStorm中),一种是命令行。

1 PHPStorm(推荐)
1、Settings → Languages & Frameworks → PHP → Code Sniffer →
Configuration:Local→ 'PHP Code Sniffer(phpcs) path'选择你的phpcs的路径 → Validate → OK
2、Settings → Editor → Inspections → PHP → Unused:PHP Code Sniffer validation 勾选上 → Coding standard 选择Yii2 → OK
然后在编辑器中开发时,会自动检查和提示不符合标准的代码.
建议人工按照标准修正。常用 Code → Reformat Code

2 命令行(很少使用)
使用查看composer的二进制安装地址:
composer global config bin-dir --absolute
检查:
~/.config/composer/vendor/bin/phpcs --extensions=php --standard=Yii2 /to/your/yii/code/directory/or/file.php
修正:
~/.config/composer/vendor/bin/phpcbf --extensions=php --standard=Yii2 /to/your/yii/code/directory/or/file.php
命令的帮助:
~/.config/composer/vendor/bin/phpcs -h
~/.config/composer/vendor/bin/phpcbf -h

如果嫌命令太长,可以使用软链接ln -s:
ln -s ~/.config/composer/vendor/bin/phpcs /usr/bin/phpcs,
然后就可以使用phpcs --extensions=php --standard=Yii2 /to/your/yii/code/directory/or/file.php

参考 http://www.cnblogs.com/phpdragon/p/5199011.html
参考 http://www.yiichina.com/tutorial/1120

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 160,706评论 4 366
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 68,002评论 1 301
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 110,462评论 0 250
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,375评论 0 216
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,763评论 3 294
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,849评论 1 224
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 32,033评论 2 317
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,768评论 0 204
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,490评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,734评论 2 253
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,204评论 1 264
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,566评论 3 260
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,227评论 3 241
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,137评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,934评论 0 201
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,926评论 2 283
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,774评论 2 274

推荐阅读更多精彩内容

  • 是什么 如果你知道yum、apt-get、npm、bower等命令中的一种或者多种,那么,你也能很快知道compo...
    旱魃一样阅读 3,080评论 0 9
  • awesome-yii2 Yii2 干货集,欢迎点 Watch 订阅,也欢迎提交 Pull Requests。(提...
    guanguans阅读 1,143评论 0 6
  • Sites 网站 yiifeed:Yii 最新动态都在这里 yiigist:Yii 专用的 Packages my...
    guanguans阅读 2,627评论 0 11
  • Yii简介 Yii是一个高性能、基于组件的PHP框架,用于快速开发现代web应用程序,Yii(读 易)在中文里有“...
    layjoy阅读 1,884评论 0 0
  • 巴菲特说过,作为投资者我们要了解哪些事情是自己可以做到的,哪些是我们无力做到的。他说,在投资股票的时候,投资者根本...
    cuiApple阅读 219评论 0 1