PHP Quality Assurance Tools and Best Practices
•
2 likes•494 views
This document provides information on various tools and best practices for PHP development. It discusses code quality tools like PHP CodeSniffer, PHP Mess Detector and PHPStan that can be used for static analysis and linting. It also covers code standards like PSR-1 and PSR-2, testing tools like PHPUnit and tools for continuous integration like Travis CI.
Recommended
Recommended
More Related Content
What's hot
What's hot (20)
Similar to PHP Quality Assurance Tools and Best Practices
Similar to PHP Quality Assurance Tools and Best Practices (20)
More from Shengyou Fan
More from Shengyou Fan (20)
Recently uploaded
Recently uploaded (20)
PHP Quality Assurance Tools and Best Practices
- 1. Photo by Steven Libralon on Unsplash — (Shengyou Fan) PHPCon China 2018 2018/05/19
- 2. — • • Laravel • JetBrains • • PHP / Laravel shengyoufan@gmail.com
- 4. Laravel — 2013 6900 3 PHP Day Laradiner Laradebut
- 5. LaravelConf Taiwan — 2017 7/8 ( ) 450
- 6. — • • • • • Photo by Austris Augusts on Unsplash
- 7. — • Boilerplate • Scaffolding • Code snippet Photo by Markus Spiske on Unsplash
- 8. — { } $ composer create-project {vendor/package}
- 9. — • • • $ cp .env.example .env $ artisan key:generate $ artisan package:discover $ composer require {vendor/package}
- 10. — # # ~/.composer/config.json { "repositories": [ { "type": "...", "url": "..." } ] } # $ composer create-project {vendor/package} Composer • •
- 11. Composer — # # ./composer.json { "scripts": { "post-root-package-install": [ "..." ], "post-create-project-cmd": [ "..." ], "post-autoload-dump": [ "..." ] } } # $ composer run-script {event} • Command Events • Installer Events • Package Events • Plugin Events https://getcomposer.org/doc/articles/scripts.md
- 12. — • tag Push • • Composer • Script Events
- 13. — • Laravel laravel/laravel • Symfony symfony/website-skeleton • Zend zendframework/skeleton-application • Yii yiisoft/yii2-app-basic HTTP index.php public/ vendor/ PHP app/ bootstrap/ config/ database/ resources/ storage/ tests/ routes/ Laravel
- 14. PHP League skeleton — http://thephpleague.com https://github.com/thephpleague/skeleton PHP League
- 15. PHP Package development standard — http://php-pds.com/ https://github.com/php-pds PHP Package development standard Package
- 17. — CRUD • https://laravelvoyager.com/ • https://www.getcraftable.com/ • https://backpackforlaravel.com/
- 20. — Editor/IDE
- 21. — • • Photo by rawpixel on Unsplash
- 22. — if () { // ... } elseif () { //... } else { //... } if() { //... } else if() { //... } else { //... }
- 23. PHP-FIG — PHP-FIG PHP Standards Recommendations PSR-1 PSR-2 https://www.php-fig.org
- 24. PSR-1 — PSR-1: Basic Coding Standard PSR-1 ‣ <?php <?= ‣ PHP BOM UTF-8 ‣ symbols ( … ) side-effects ( .ini … ) ‣ (Namespaces) PSR-4 ‣ (StudlyCaps) ‣ ‣ (camelCase) https://www.php-fig.org/psr/psr-1/
- 25. — (camelCase) # Foo.php <?php namespace VendorModel; class Foo { public function fooBar() { // method body } }
- 26. PSR-2 — ‣ PSR-1 ‣ 4 tabs ‣ 120 80 ‣ namespace use ‣ ‣ ‣ (Visibility) abstract final static ‣ ‣ ‣ PSR-2: Coding Style Guide PSR-2 https://www.php-fig.org/psr/psr-2/
- 27. PSR-2 — else elseif elseif else if <?php # if ($expr1) { // if body } elseif ($expr2) { // elseif body } else { // else body; } # for ($i = 0; $i < 10; $i++) { // for body } foreach ($iterable as $key => $value) { // foreach body } for foreach
- 28. PSR-12 — PSR-12: Extended Coding Style Guide PSR-12 ) PHP 7
- 30. .editorconfig — • ini • UTF-8 LF • [ ] ( .gitignore) • (/) • # ; # This file is for unifying the coding style for different editors and IDEs # editorconfig.org root = true [*.php] charset = utf-8 indent_size = 4 indent_style = space end_of_line = lf insert_final_newline = true trim_trailing_whitespace = true
- 32. — PHP # phpcbf $ wget https://.../phpcbf.phar $ chmod a+x phpcbf.phar # phpcbf $ [php] bin/phpcbf.phar --standard=PSR2 --runtime-set ignore_errors_on_exit 1 --runtime-set ignore_warnings_on_exit 1 {src} # php-cs-fixer $ wget http://.../php-cs-fixer-v2.phar $ chmod a+x php-cs-fixer-v2.phar # php-cs-fixer $ [php] php-cs-fixer.phar fix {src} --rules=@PSR2
- 35. — … • Code Quality • Code Analysis Photo by rawpixel on Unsplash
- 42. PHP Quality Assurance — PHP Quality Assurance https://phpqa.io/
- 43. Awesome PHP — Code Quality Static Analysis PHP https://github.com/ziadoz/awesome-php
- 44. — • Unit Test • Feature Test • Browser Test • API spec and testing Photo by Jaron Nix on Unsplash
- 45. Unit Test — Class method # Class class Linker { public function autolink($text) { // ... return ... } }
- 46. Unit Test — Class method # Class class LinkerTest extends TestCase { public function testAutolink() { // arrange $text = '...'; $target = new Linker(); $expected = '...'; // act $actual = $target->autolink($text); // assert $this->assertEquals($expected, $actual); } }
- 48. — Laravel PHPUnit VSCode PHPUnit Recca Tsai https://marketplace.visualstudio.com/ items?itemName=recca0120.vscode- phpunit
- 49. Feature Test — # Class class PostController extends Controller { public function store(Request $request) { Post::create($request->all()); return redirect()->route('...') ->with('message', 'Success'); } }
- 50. Feature Test — # Class class PostControllerTest extends TestCase { use RefreshDatabase; use WithoutMiddleware; public function testPostStoreAction() { $data = [ 'title' => '...', 'content' => '...', ]; $response = $this->post('...', $data); $response->assertRedirect('...'); $this->assertDatabaseHas('...', $data); } }
- 52. Browser Test — # dusk $ composer require --dev laravel/dusk # $ artisan dusk:install # Browser Tests $ artisan dusk:make {test} headless
- 53. Browser Test — # public function testSuccessSubmitForm() { $this->browse(function (Browser $browser) { $browser->visit('...') ->assertSee('...') ->type('...', '...') ->pause(1000) ->press('...') ->assertPathIs('...') ->screenshot('...'); }); }
- 54. Browser Test —
- 55. API Spec and Testing — API Spec Postman NewmanAPI Spec (Ex. Swagger) Dredd API Server Request Response API Spec (Ex. Swagger)
- 58. — • Pre-commit hooks • Continuous integration Photo by Jehyun Sung on Unsplash
- 59. Pre-commit hooks — VCS https://git-scm.com/docs/githooks https://www.atlassian.com/git/tutorials/git-hooks $ vim .git/hooks/{script}
- 60. grumphp — grumphp PHP pre-commit # grumphp composer require --dev phpro/grumphp # grumphp # grumphp.yml parameters: git_dir: . bin_dir: vendor/bin tasks: phpcs: ~ phpcsfixer2: ~ phpcpd: ~ phpmd: ~ phan: ~ phpunit: ~ https://github.com/phpro/grumphp
- 61. grumphp — grumphp git pre- commit phpcs phpunit…
- 63. Continuous integration — CI • / / • / • / CI • CI • CI • CI Image from: http://www.seleniumeasy.com/jenkins-tutorials/what-is-continous-integration
- 64. CI — StyleCI Nitpick CI CI CI phpdbf php- cs-fixer https://styleci.io/ https://nitpick-ci.com/
- 65. CI — SonarQube CI CI CodeSniffer Copy/Paste Detector Mess Detector
- 66. CI — CI
- 67. —
- 68. — 沒有銀彈
- 69. — 最小施力點
- 70. — 建立團隊共識