PHPCon China 2018 - 好孩子的 PHP 撰碼指南

Photo by Steven Libralon on Unsplash
—
(Shengyou Fan)
PHPCon China 2018
2018/05/19

—
•
• Laravel
• JetBrains
•
• PHP / Laravel
shengyoufan@gmail.com

Laravel
—
2014
Laravel
30
https://www.laravel-dojo.com/

Laravel
—
2013 6900
3
PHP Day Laradiner
Laradebut

LaravelConf Taiwan
—
2017 7/8 ( )
450

—
•
•
•
•
•
Photo by Austris Augusts on Unsplash

—
• Boilerplate
• Scaffolding
• Code snippet
Photo by Markus Spiske on Unsplash

—
{ }
$ composer create-project
{vendor/package}

—
•
•
•
$ cp .env.example .env
$ artisan key:generate
$ artisan package:discover
$ composer require {vendor/package}

—
#
# ~/.composer/config.json
{
"repositories": [
{
"type": "...",
"url": "..."
}
]
}
#
$ composer create-project {vendor/package}
Composer
•
•

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

—
• tag Push
•
• Composer
• Script Events

—
• Laravel laravel/laravel
• Symfony symfony/website-skeleton
• Zend zendframework/skeleton-application
• Yii yiisoft/yii2-app-basic
HTTP index.php
public/
vendor/
PHP
app/
bootstrap/
conﬁg/
database/
resources/
storage/
tests/
routes/
Laravel

PHP League skeleton
—
http://thephpleague.com
https://github.com/thephpleague/skeleton
PHP League

PHP Package
development standard
—
http://php-pds.com/
https://github.com/php-pds
PHP Package development
standard Package

—
CRUD
• https://laravelvoyager.com/
• https://www.getcraftable.com/
• https://backpackforlaravel.com/

—
https://github.com/jonathantorres/construct

—
•
•
Photo by rawpixel on Unsplash

—
if () {
// ...
} elseif () {
//...
} else {
//...
}
if()
{
//...
}
else if()
{
//...
}
else
{
//...
}

PHP-FIG
—
PHP-FIG PHP Standards
Recommendations PSR-1
PSR-2
https://www.php-fig.org

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/

—
(camelCase)
# Foo.php
<?php
namespace VendorModel;
class Foo
{
public function fooBar()
{
// method body
}
}

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/

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

PSR-12
—
PSR-12: Extended Coding Style Guide
PSR-12 )
PHP 7

.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

—
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

—
phpcbf php-cs-fixer
Editor/IDE

—
…
• Code Quality
• Code Analysis
Photo by rawpixel on Unsplash

—
PHP Linter Editor/
IDE
https://github.com/JakubOnderka/PHP-Parallel-Lint

Mess Detector
—
https://phpmd.org/

Copy/Paste Detector
—
( )
https://github.com/sebastianbergmann/phpcpd

PHPStan
—
https://github.com/phpstan/phpstan

phpqa
—
https://github.com/EdgedesignCZ/phpqa

Code Inspection
—
Code Inspection

PHP Quality Assurance
—
PHP Quality
Assurance
https://phpqa.io/

Awesome PHP
—
Code
Quality Static Analysis
PHP
https://github.com/ziadoz/awesome-php

—
• Unit Test
• Feature Test
• Browser Test
• API spec and testing
Photo by Jaron Nix on Unsplash

Unit Test
—
Class method
# Class
class Linker
{
public function autolink($text)
{
// ...
return ...
}
}

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);
}
}

—
Laravel PHPUnit
VSCode PHPUnit
Recca Tsai
https://marketplace.visualstudio.com/
items?itemName=recca0120.vscode-
phpunit

Feature Test
—
# Class
class PostController extends Controller
{
public function store(Request $request)
{
Post::create($request->all());
return redirect()->route('...')
->with('message', 'Success');
}
}

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);
}
}

Browser Test
—
# dusk
$ composer require --dev laravel/dusk
#
$ artisan dusk:install
# Browser Tests
$ artisan dusk:make {test}
headless

Browser Test
—
#
public function testSuccessSubmitForm()
{
$this->browse(function (Browser $browser) {
$browser->visit('...')
->assertSee('...')
->type('...', '...')
->pause(1000)
->press('...')
->assertPathIs('...')
->screenshot('...');
});
}

API Spec and Testing
—
API Spec
Postman NewmanAPI Spec
(Ex. Swagger)
Dredd API Server
Request
Response
API Spec
(Ex. Swagger)

—
https://codeception.com
https://codecept.io

—
http://www.phpspec.net/en/stable/
http://behat.org/en/latest/

—
• Pre-commit hooks
• Continuous integration
Photo by Jehyun Sung on Unsplash

Pre-commit hooks
—
VCS
https://git-scm.com/docs/githooks
https://www.atlassian.com/git/tutorials/git-hooks
$ vim .git/hooks/{script}

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

grumphp
—
grumphp git pre-
commit phpcs phpunit…

Editor/IDE
—
Editor/IDE VCS
pre-commit hooks

Continuous integration
—
CI
• / /
• /
• /
CI
• CI
• CI
• CI
Image from: http://www.seleniumeasy.com/jenkins-tutorials/what-is-continous-integration

CI
—
StyleCI Nitpick CI CI
CI phpdbf php-
cs-fixer
https://styleci.io/
https://nitpick-ci.com/

CI
—
SonarQube CI
CI CodeSniffer
Copy/Paste Detector Mess Detector

—
https://www.youtube.com/user/shengyou/
https://www.slideshare.net/shengyou/
https://medium.com/@shengyou/

PHPCon China 2018 - 好孩子的 PHP 撰碼指南

Recommended

More Related Content

What's hot (20)

Similar to PHPCon China 2018 - 好孩子的 PHP 撰碼指南 (20)

More from Shengyou Fan (20)

Recently uploaded (20)

PHPCon China 2018 - 好孩子的 PHP 撰碼指南