PHPStan超クイックマスター

PHPStan超クイックマスター

PHPStan “super” quick master

pixiv Inc.

USAMI Kenta

2021.10.02

お前誰よ

• うさみけんた (@tadsan) / Zonu.EXE / にゃんだーすわん
• ピクシブ株式会社 pixiv事業本部 エンジニア
• 最近はピクシブ百科事典(dic.pixiv.net)を開発しています
• Emacs Lisper, PHPer
• Emacs PHP Modeを開発しています (2017年-)
• プログラミング言語にちょっとこだわりのある素人

さて

PHPerKaigiのチケットを買うとパンフレットがもらえる

PHPStan=Static Analyzer

実行しなくてもバグの可能性を検知できる

全8ページでPHPStanの基礎を押えられる

実務で最低限使うために知っておきたいことを詰め込んだ… はず

PHP本来の型のコンセプトからPHPDocによる拡張までを網羅

僕と契約してPHPStanを完全にマスターしてよ

という話をしたいのではない

PHPStanは完全無料なのでいますぐ入れよう

これからプロになりたい人に本当に伝えたいPHPDocの書きかた

その1配列は使い分ける

世の中にはいろんな配列がある

[1, 2, 3]

['name' => 'Miku','age' => 14,]

['Miku', 'Rin', 'Luka',]

['main' => 'Miku','sub' => 'Rin','chorus' => 'Luka',]

単なる型で書くと

array

interface X{function a(): array;}

function (X $obj) {$a = $obj->a();};

function (X $x) {$a = $x->a();$v = $a[0];};

配列から取り出した要素の型がわからないのは都合が悪い

array<int>array<string>

ちょっと前はint[] とか string[]とか書かれてた

PSR-5式の配列記法(ジェネリクス)

array<int,User>

array<string, User>

• 配列インデックスの型を指定できる
• 以下の配列が区別できる
• [12 => new User(), 34 => new User()]
• ['太郎' => new User(), '花子' => new User()]
• [new User('太郎'), new User('花子')]

list<User>

配列には2通りある

同じような構造が繰り返す配列

キーによって別の意味の値が入っている配列

$a = ['name' => '初音ミク','age' => 16,];

// array{name:string, age: int}

array{name: string,age: int}

$a = ['初音ミク', 16];// array{0: string, 1: int}

繰り返すなら<>キーごとに違うなら{}

その2型は入出力に宿る

クエリパラメータから値をとりたい

function getById(int $id): Article{//}

クエリパラメータからID値をとりたい

実際あぶない

$id = $_GET['id'];

$article = getById($id);

// ?id=1$_GET['id'] === '1';

// ?id=a$_GET['id'] === 'a';

// ?id[]=a$_GET['id'] === ['a'];

危険ではないがよくはない

$id = (int)$_GET['id'];

安全に

int|false

$id = filter_var($_GET['id'] ?? '',FILTER_VALIDATE_INT);

その3むやみに@var書かない

初心者殺しなことに@varには複数の用法

@varはプロパティに付けて書くもの

class Book{/** @var string */public $name;}

class Book{

public string $name;}

class Book{/** @var list<Author> */public $authors;}

class Book{

public list<Author> $authors;}

class Book{/** @var list<Author> */public array $authors;}

@varはconstには基本的に付けない

class Book{/** @var list<int> */const IDS = [1, 2, 3];}

できればつけない方がいい

class Book{/** @var list<int> */const IDS = [1, 2, 3];}

@varをつけない場合

Book::IDS[0] // => 1

Book::IDS[1] // => 2

Book::IDS[2] // => 3

@varを付けると弱くなる

Book::IDS[0] // => int

Book::IDS[1] // => int

Book::IDS[2] // => int

ローカル変数に@varを書く

できれば書かないでくれ！！

むやみに@varを書かないテク

そのうちどこかにちゃんと書きます…