[PHP]PHP-Parserを用いたメタプログラミングについて

こんにちは。24年度入社の吉岡です。
案件で、システムで用いられているPHPソースコードとフレームワークのバージョンアップ作業を行いっています。作業の内容として大量に同様の変更を行いたい箇所があり、自分たちのチームはPHP-Parserを使用しました。PHP-Parserは今後の案件でも作業の効率化に役立ってくれると思いまので、共有させていただきます。

〇PHP-Parserとは
PHP-Parserは「PHPで書かれたPHPパーサー」のことです。
PHPパーサーはPHPソースコードをAST(抽象構文木)に変換し、変更を加え、変更後のASTをPHPソースコードに出力することができます。
AST(抽象構文木)は指定されたプログラミング言語の文法に従ってソースコードの構造を表す中間プログラムです。ソースコードのアイテムごとに対応するノードを用いて表現されます。

「手作業でよいのでは？」と思われるかもしれませんね。確かに変更箇所が少数であったり複雑な変更を加えたい場合は手作業の方が楽な場合も多いでしょう。
しかし、単純な変更を大量にしなければならない場合はどうでしょうか？
「システム内のすべてのファイルに declare(strict_types=1); を追加したい」「システム内のすべての配列を、array() から [] に記述を統一したい」という場合に、手作業で行うと多くの時間が掛かりミスが生じやすくなってしまうかもしれません。

そんな時はPHP-Parserの使用を検討されてはいかがでしょうか？

〇PHP-Parserを用いた変更処理の流れ
1 PHPソースコードからASTへパース
2 ASTへ変更を加える
3 新ASTから新PHPソースコードへパース

＊インストール
パースしたいPHPソースコードのバージョンによって、PHP-Parserのバージョンを選択してください。

・PHP-Parser 4.x
動作環境: PHP7.0以上で動く
サポート範囲: PHP5.2～8.3( PHP5.xの解析を完全にサポート)
https://github.com/nikic/PHP-Parser/blob/4.x/doc/0_Introduction.markdown

・PHP-Parser 5.x
動作環境：PHP7.4以上で動く
サポート範囲：PHP7～8( PHP5.xの解析も部分的にサポート)
https://github.com/nikic/PHP-Parser/blob/master/doc/0_Introduction.markdown

コマンド

composer require nikic/php-parser

1	composer require nikic/php-parser

1 PHPソースコードからASTへパース
PHPソースコードを取得し、パーサーを用いてASTへパースを行います。

・入力用PHPソースコード (inputSampleData.php)

<?php

namespace Sample\StandardClass;

class SampleA
{
    public function do_something(): bool
    {
        $this->standard->do(array(123,false));

        return true;
    }

    public function do_nothing(): bool
    {
        $this->standard->donot(array('abc','xyz'));

        return false;
    }
}
}

<?php

namespace Sample\StandardClass;

class SampleA

{

public function do_something(): bool

{

$this->standard->do(array(123,false));

return true;

}

public function do_nothing(): bool

{

$this->standard->donot(array('abc','xyz'));

return false;

}

・パース処理(changePhp.php)

<?php

require __DIR__ . '/../vendor/autoload.php';

use PhpParser\Error;
use PhpParser\NodeDumper;
use PhpParser\ParserFactory;

$inputFileDirPath = '/var/www/laravel/public/phpParser';
$outputFileDirPath = '/var/www/laravel/public/phpParser';

// 変更したいファイルを取得
$fromPath = $inputFileDirPath . '/inputSampleData.php';
$code = file_get_contents($fromPath, false, null, 0, null);
if (!is_string($code)) {
    throw new \RuntimeException('ファイルの読み込みエラー');
}

// PHPソースコードからASTにパース
$parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);
try {
    $ast = $parser->parse($code);
} catch (Error $error) {
    echo "Parse error: {$error->getMessage()}\n";
    return;
}

// パースしたASTをダンプ
$dumper = new NodeDumper;
echo $dumper->dump($ast) . "\n";

<?php

require __DIR__ . '/../vendor/autoload.php';

use PhpParser\Error;

use PhpParser\NodeDumper;

use PhpParser\ParserFactory;

$inputFileDirPath = '/var/www/laravel/public/phpParser';

$outputFileDirPath = '/var/www/laravel/public/phpParser';

// 変更したいファイルを取得

$fromPath = $inputFileDirPath . '/inputSampleData.php';

$code = file_get_contents($fromPath, false, null, 0, null);

if (!is_string($code)) {

throw new \RuntimeException('ファイルの読み込みエラー');

}

// PHPソースコードからASTにパース

$parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);

try {

$ast = $parser->parse($code);

} catch (Error $error) {

echo "Parse error: {$error->getMessage()}\n";

return;

}

// パースしたASTをダンプ

$dumper = new NodeDumper;

echo $dumper->dump($ast) . "\n";

・実行

php sample.php

1	php sample.php

・実行結果(変換されたAST)
コストコのレシートくらい長いですので、ざっと目を通していただければ十分です。「Stmt_Classってやつはクラス定義のことなんだろうな」「Expr_Array_って書いてあるから配列のなんだろうな」ぐらいでOKです。

array(
    0: Stmt_Namespace(
        name: Name(
            parts: array(
                0: Sample
                1: StandardClass
            )
        )
        stmts: array(
            0: Stmt_Class(
                attrGroups: array(
                )
                flags: 0
                name: Identifier(
                    name: SampleA
                )
                extends: null
                implements: array(
                )
                stmts: array(
                    0: Stmt_ClassMethod(
                        attrGroups: array(
                        )
                        flags: MODIFIER_PUBLIC (1)
                        byRef: false
                        name: Identifier(
                            name: do_something
                        )
                        params: array(
                        )
                        returnType: Identifier(
                            name: bool
                        )
                        stmts: array(
                            0: Stmt_Expression(
                                expr: Expr_MethodCall(
                                    var: Expr_PropertyFetch(
                                        var: Expr_Variable(
                                            name: this
                                        )
                                        name: Identifier(
                                            name: standard
                                        )
                                    )
                                    name: Identifier(
                                        name: do
                                    )
                                    args: array(
                                        0: Arg(
                                            name: null
                                            value: Expr_Array(
                                                items: array(
                                                    0: Expr_ArrayItem(
                                                        key: null
                                                        value: Scalar_LNumber(
                                                            value: 123
                                                        )
                                                        byRef: false
                                                        unpack: false
                                                    )
                                                    1: Expr_ArrayItem(
                                                        key: null
                                                        value: Expr_ConstFetch(
                                                            name: Name(
                                                                parts: array(
                                                                    0: false
                                                                )
                                                            )
                                                        )
                                                        byRef: false
                                                        unpack: false
                                                    )
                                                )
                                            )
                                            byRef: false
                                            unpack: false
                                        )
                                    )
                                )
                            )
                            1: Stmt_Return(
                                expr: Expr_ConstFetch(
                                    name: Name(
                                        parts: array(
                                            0: true
                                        )
                                    )
                                )
                            )
                        )
                    )
                    1: Stmt_ClassMethod(
                        attrGroups: array(
                        )
                        flags: MODIFIER_PUBLIC (1)
                        byRef: false
                        name: Identifier(
                            name: do_nothing
                        )
                        params: array(
                        )
                        returnType: Identifier(
                            name: bool
                        )
                        stmts: array(
                            0: Stmt_Expression(
                                expr: Expr_MethodCall(
                                    var: Expr_PropertyFetch(
                                        var: Expr_Variable(
                                            name: this
                                        )
                                        name: Identifier(
                                            name: standard
                                        )
                                    )
                                    name: Identifier(
                                        name: donot
                                    )
                                    args: array(
                                        0: Arg(
                                            name: null
                                            value: Expr_Array(
                                                items: array(
                                                    0: Expr_ArrayItem(
                                                        key: null
                                                        value: Scalar_String(
                                                            value: abc
                                                        )
                                                        byRef: false
                                                        unpack: false
                                                    )
                                                    1: Expr_ArrayItem(
                                                        key: null
                                                        value: Scalar_String(
                                                            value: xyz
                                                        )
                                                        byRef: false
                                                        unpack: false
                                                    )
                                                )
                                            )
                                            byRef: false
                                            unpack: false
                                        )
                                    )
                                )
                            )
                            1: Stmt_Return(
                                expr: Expr_ConstFetch(
                                    name: Name(
                                        parts: array(
                                            0: false
                                        )
                                    )
                                )
                            )
                        )
                    )
                )
            )
        )
    )
)

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

array(

0: Stmt_Namespace(

parts: array(

0: Sample

1: StandardClass

)

stmts: array(

0: Stmt_Class(

attrGroups: array(

)

flags: 0

)

extends: null

implements: array(

)

stmts: array(

0: Stmt_ClassMethod(

attrGroups: array(

)

flags: MODIFIER_PUBLIC (1)

byRef: false

)

params: array(

)

returnType: Identifier(

)

stmts: array(

0: Stmt_Expression(

expr: Expr_MethodCall(

var: Expr_PropertyFetch(

var: Expr_Variable(

)

)

)

args: array(

0: Arg(

value: Expr_Array(

items: array(

0: Expr_ArrayItem(

key: null

value: Scalar_LNumber(

value: 123

)

byRef: false

unpack: false

)

1: Expr_ArrayItem(

key: null

value: Expr_ConstFetch(

parts: array(

0: false

)

byRef: false

unpack: false

)

byRef: false

unpack: false

)

1: Stmt_Return(

expr: Expr_ConstFetch(

parts: array(

0: true

)

1: Stmt_ClassMethod(

attrGroups: array(

)

flags: MODIFIER_PUBLIC (1)

byRef: false

)

params: array(

)

returnType: Identifier(

)

stmts: array(

0: Stmt_Expression(

expr: Expr_MethodCall(

var: Expr_PropertyFetch(

var: Expr_Variable(

)

)

)

args: array(

0: Arg(

value: Expr_Array(

items: array(

0: Expr_ArrayItem(

key: null

value: Scalar_String(

value: abc

)

byRef: false

unpack: false

)

1: Expr_ArrayItem(

key: null

value: Scalar_String(

value: xyz

)

byRef: false

unpack: false

)

byRef: false

unpack: false

)

1: Stmt_Return(

expr: Expr_ConstFetch(

parts: array(

0: false

)

ノードを用いて変更箇所を指定して、追加・変更・削除などの変更処理を行います。それぞれのノードクラス定義に関する詳細は、nikic/php-parserの公式ドキュメント(5.x版) または vendor/nikic/php-parser/lib/PhpParser/Node/ ディレクトリ配下から探してください。(どのクラスなのか名前で推測できるものが多いと思います)

2 ASTへ変更を加える
今回の本命である、パースされたASTに対して変更を行います。変更を行うにNodeVisitorクラスを基に任意の操作を行うクラスを作成し、「どのタイミングでどの操作を」定義します。

・変更処理セットして実行(changePhp.php 続き)

$traverser = new NodeTraverser();
// PHPの厳密な型判定を設定する記述を追加するNodeVisitorを追加
$traverser->addVisitor(new StrictModeRevisingVisitor());
// 配列をarray()から[]に統一するNodeVisitorを追加
$traverser->addVisitor(new ArrayKindRevisingVisitor());

// 実行！
$newAst = $traverser->traverse($ast);

$traverser = new NodeTraverser();

// PHPの厳密な型判定を設定する記述を追加するNodeVisitorを追加

$traverser->addVisitor(new StrictModeRevisingVisitor());

// 配列をarray()から[]に統一するNodeVisitorを追加

$traverser->addVisitor(new ArrayKindRevisingVisitor());

// 実行！

$newAst = $traverser->traverse($ast);

・PHPの厳密な型判定を設定する記述を追加するNodeVisitor(StrictModeRevisingVisitor.php)

<?php

declare(strict_types=1);

namespace phpParser;

use \PhpParser\NodeVisitorAbstract;

class StrictModeRevisingVisitor extends NodeVisitorAbstract
{
    /**
     * ノードを走破する前に最上位ノードに型指定に厳密にチェックする設定を追加する
     * @param array $nodes 走破する前のノード全体
     * @return array 変更を行ったこれから走破するノード全体
     */
    public function beforeTraverse(array $nodes): array
    {
        if (count($nodes) === 0) {
            return [];
        }
        // declare(strict_types=1); のノードで作成し、ノード全体の最上位ノードに加えて返す
        $value = new \PhpParser\Node\Scalar\LNumber(1, []);
        $newDeclareDeclare = new \PhpParser\Node\Stmt\DeclareDeclare('strict_types', $value, []);
        $newDeclare = new \PhpParser\Node\Stmt\Declare_([$newDeclareDeclare], null, []);
        $newNodes = [$newDeclare];
        foreach ($nodes as $node) {
            $newNodes[] = $node;
        }
        return $newNodes;
    }
}

<?php

declare(strict_types=1);

namespace phpParser;

use \PhpParser\NodeVisitorAbstract;

class StrictModeRevisingVisitor extends NodeVisitorAbstract

{

/**

* ノードを走破する前に最上位ノードに型指定に厳密にチェックする設定を追加する

* @param array $nodes 走破する前のノード全体

* @return array 変更を行ったこれから走破するノード全体

public function beforeTraverse(array $nodes): array

{

if (count($nodes) === 0) {

return [];

}

// declare(strict_types=1); のノードで作成し、ノード全体の最上位ノードに加えて返す

$value = new \PhpParser\Node\Scalar\LNumber(1, []);

$newDeclareDeclare = new \PhpParser\Node\Stmt\DeclareDeclare('strict_types', $value, []);

$newDeclare = new \PhpParser\Node\Stmt\Declare_([$newDeclareDeclare], null, []);

$newNodes = [$newDeclare];

foreach ($nodes as $node) {

$newNodes[] = $node;

}

return $newNodes;

}

・配列をarray()から[]に統一するNodeVisitor(ArrayKindRevisingVisitor.php)

<?php

declare(strict_types=1);

namespace phpParser;

use \PhpParser\NodeVisitorAbstract;

class ArrayKindRevisingVisitor extends NodeVisitorAbstract
{
    /**
     * ノードに入る際に、配列ノードでかつarray()のものを[]に変更する
     * @param \PhpParser\Node $node 入るノード
     * @return \PhpParser\Node|null 操作後のノード(操作しない場合はnullを返す)
     */
    public function enterNode(Node $node): ?Node
    {
        // 配列ノードであり、括弧の書式がarray()であるもの以外は変更せずに返す
        if (!$node instanceof \PhpParser\Node\Expr\Array_ || $node->getAttribute('kind') === 2) {
            return null;
        }
        $newAttributes = $node->getAttributes();
        // 1だとarray()、2だと[]
        $newAttributes['kind'] = 2;
        // 括弧が[]で、中身の値は変更前の値の、配列ノードを作成し、変更前の配列ノードの代わりに返す
        return new \PhpParser\Node\Expr\Array_($node->items, $newAttributes);
    }
}

<?php

declare(strict_types=1);

namespace phpParser;

use \PhpParser\NodeVisitorAbstract;

class ArrayKindRevisingVisitor extends NodeVisitorAbstract

{

/**

* ノードに入る際に、配列ノードでかつarray()のものを[]に変更する

* @param \PhpParser\Node $node 入るノード

* @return \PhpParser\Node|null 操作後のノード(操作しない場合はnullを返す)

public function enterNode(Node $node): ?Node

{

// 配列ノードであり、括弧の書式がarray()であるもの以外は変更せずに返す

if (!$node instanceof \PhpParser\Node\Expr\Array_ || $node->getAttribute('kind') === 2) {

return null;

}

$newAttributes = $node->getAttributes();

// 1だとarray()、2だと[]

$newAttributes['kind'] = 2;

// 括弧が[]で、中身の値は変更前の値の、配列ノードを作成し、変更前の配列ノードの代わりに返す

return new \PhpParser\Node\Expr\Array_($node->items, $newAttributes);

}

これで変更を加えることができました。

3 新ASTから新PHPソースコードへパース

・changePhp.php 続き

// ASTからPHPソースコードにパース
$prettyPrinter = new PhpParser\PrettyPrinter\Standard();
$newCode = $prettyPrinter->prettyPrintFile($newAst);

// 出力
$toPath = $outputFileDirPath . '/outputSampleData.php';
if (file_put_contents($toPath, $newCode, 0, null) === false) {
    throw new RuntimeException('ファイルの書き込みエラー');
}

// ASTからPHPソースコードにパース

$prettyPrinter = new PhpParser\PrettyPrinter\Standard();

$newCode = $prettyPrinter->prettyPrintFile($newAst);

// 出力

$toPath = $outputFileDirPath . '/outputSampleData.php';

if (file_put_contents($toPath, $newCode, 0, null) === false) {

throw new RuntimeException('ファイルの書き込みエラー');

}

・出力ファイル(outputSampleData.php)

<?php

declare (strict_types=1);
namespace Sample\StandardClass;

class SampleA
{
    public function do_something() : bool
    {
        $this->standard->do([123, false]);
        return true;
    }
    public function do_nothing() : bool
    {
        $this->standard->donot(['abc', 'xyz']);
        return false;
    }
}

<?php

declare (strict_types=1);

namespace Sample\StandardClass;

class SampleA

{

public function do_something() : bool

{

$this->standard->do([123, false]);

return true;

}

public function do_nothing() : bool

{

$this->standard->donot(['abc', 'xyz']);

return false;

}

変更できました。ただこの記述だとパース時に空欄削除などのフォーマットが行われます。

元のソースコードの書式を保ったままパースする記述を載せておきます。

・変更処理セットして実行(changePhpNoFormat.php)

<?php

declare(strict_types=1);

require __DIR__ . '/../vendor/autoload.php';
require __DIR__ . '/StrictModeRevisingVisitor.php';
require __DIR__ . '/ArrayKindRevisingVisitor.php';

use PhpParser\Error;
use PhpParser\NodeTraverser;
use phpParser\ArrayKindRevisingVisitor;
use PhpParser\NodeVisitor\CloningVisitor;
use PhpParser\PrettyPrinter\Standard;
use phpParser\StrictModeRevisingVisitor;

$inputFileDirPath = '/var/www/laravel/public/phpParser';
$outputFileDirPath = '/var/www/laravel/public/phpParser';

// 変更したいファイルを取得
$fromPath = $inputFileDirPath . '/inputSampleData.php';
$code = file_get_contents($fromPath, false, null, 0, null);
if (!is_string($code)) {
    throw new RuntimeException('ファイルの読み込みエラー');
}

// PHPソースコードからASTにパース
//$parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);
$lexer = new \PhpParser\Lexer\Emulative([
    'usedAttributes' => [
        'comments',
        'startLine', 'endLine',
        'startTokenPos', 'endTokenPos',
    ],
]);
$parser = new \PhpParser\Parser\Php7($lexer, [
    'useIdentifierNodes' => true,
    'useConsistentVariableNodes' => true,
    'useExpressionStatements' => true,
    'useNopStatements' => false,
]);
$oldTokens = $lexer->getTokens();
try {
    $ast = $parser->parse($code);
} catch (Error $error) {
    echo "Parse error: {$error->getMessage()}\n";
    return;
}
// 変更前の書式を保ったASTを取得
$beforeTraverser = new NodeTraverser();
$beforeTraverser->addVisitor(new CloningVisitor());
$beforeAst = $beforeTraverser->traverse($ast);
// ノードを走破しながら、NodeVisitorを用いて変更操作を行う
$traverser = new NodeTraverser();
$traverser->addVisitor(new StrictModeRevisingVisitor());
$traverser->addVisitor(new ArrayKindRevisingVisitor());
$newAst = $traverser->traverse($beforeAst);

// ASTからPHPソースコードにフォーマットを保ったパース
$prettyPrinter = new Standard();
$newCode = $prettyPrinter->printFormatPreserving($newAst, $ast, $oldTokens);

// 新たなファイルを作成し書き込み
$toPath = $outputFileDirPath . '/outputSampleData.php';
if (file_put_contents($toPath, $newCode, 0, null) === false) {
    throw new RuntimeException('ファイルの書き込みエラー');
}

<?php

declare(strict_types=1);

require __DIR__ . '/../vendor/autoload.php';

require __DIR__ . '/StrictModeRevisingVisitor.php';

require __DIR__ . '/ArrayKindRevisingVisitor.php';

use PhpParser\Error;

use PhpParser\NodeTraverser;

use phpParser\ArrayKindRevisingVisitor;

use PhpParser\NodeVisitor\CloningVisitor;

use PhpParser\PrettyPrinter\Standard;

use phpParser\StrictModeRevisingVisitor;

$inputFileDirPath = '/var/www/laravel/public/phpParser';

$outputFileDirPath = '/var/www/laravel/public/phpParser';

// 変更したいファイルを取得

$fromPath = $inputFileDirPath . '/inputSampleData.php';

$code = file_get_contents($fromPath, false, null, 0, null);

if (!is_string($code)) {

throw new RuntimeException('ファイルの読み込みエラー');

}

// PHPソースコードからASTにパース

//$parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);

$lexer = new \PhpParser\Lexer\Emulative([

'usedAttributes' => [

'comments',

'startLine', 'endLine',

'startTokenPos', 'endTokenPos',

]);

$parser = new \PhpParser\Parser\Php7($lexer, [

'useIdentifierNodes' => true,

'useConsistentVariableNodes' => true,

'useExpressionStatements' => true,

'useNopStatements' => false,

]);

$oldTokens = $lexer->getTokens();

try {

$ast = $parser->parse($code);

} catch (Error $error) {

echo "Parse error: {$error->getMessage()}\n";

return;

}

// 変更前の書式を保ったASTを取得

$beforeTraverser = new NodeTraverser();

$beforeTraverser->addVisitor(new CloningVisitor());

$beforeAst = $beforeTraverser->traverse($ast);

// ノードを走破しながら、NodeVisitorを用いて変更操作を行う

$traverser = new NodeTraverser();

$traverser->addVisitor(new StrictModeRevisingVisitor());

$traverser->addVisitor(new ArrayKindRevisingVisitor());

$newAst = $traverser->traverse($beforeAst);

// ASTからPHPソースコードにフォーマットを保ったパース

$prettyPrinter = new Standard();

$newCode = $prettyPrinter->printFormatPreserving($newAst, $ast, $oldTokens);

// 新たなファイルを作成し書き込み

$toPath = $outputFileDirPath . '/outputSampleData.php';

if (file_put_contents($toPath, $newCode, 0, null) === false) {

throw new RuntimeException('ファイルの書き込みエラー');

}

・実行結果

入力したPHPソースコードと同じく、クラスメソッドが値を返す処理の前に空欄行が残したままにできていますね！

<?php

declare (strict_types=1);
namespace Sample\StandardClass;

class SampleA
{
    public function do_something(): bool
    {
        $this->standard->do(array(123,false));

        return true;
    }

    public function do_nothing(): bool
    {
        $this->standard->donot(array('abc','xyz'));

        return false;
    }
}

<?php

declare (strict_types=1);

namespace Sample\StandardClass;

class SampleA

{

public function do_something(): bool

{

$this->standard->do(array(123,false));

return true;

}

public function do_nothing(): bool

{

$this->standard->donot(array('abc','xyz'));

return false;

}

〇おわりに
プログラミングやITの知識だけではなく、「必要な情報を得る力」は本当に重要ですね。特に、ネットの記事で親切丁寧に紹介されていない知識を得たい場合や古いドキュメントから使用を知りたい場合などだと、自分の「必要な情報を得る力」のなさを痛感することが多くあります…
今後AIがより身近になってきて仕事上でも活用しそうだからこそ、検索の仕方や質問の仕方をより一層鍛えていきます！

・参考にさせていただいた記事
https://www.komtaki.com/posts/php-meta-programming-introduction
https://qiita.com/ktplato/items/23ad2893d741bfb564f9meta-programming-introduction

https://qiita.com/ktplato/items/23ad2893d741bfb564f9

テストの基本の”き”をおさえよう！

’23年度入社の紙屋です！
本年度は単体テストに対して理解を深め、成果物のクオリティを担保するという点を目標の一つとして業務に取り組んでまいりました。
リリース前にテストを行い、早期に不具合を発見することもできましたが、テスト内容の不十分さや検証環境へリリース後、お客様からのご指摘で不具合を発見するなどの反省点もありました。
テストを行うための心構えとして備忘録的にまとめようと思います！

テストの目的と重要性

バグの早期発見と修正が可能
プログラマーの心理的安全性を保つ
機能改修時の予期せぬエラーを防ぐ
コードの挙動理解を助ける

テストの考え方

FeatureとUnitに分けて管理することが多い
* Feature（機能）テスト：
ユーザー目線のテストです。
より大きい範囲で行い、アプリケーションに求められる機能を確認します。
* Unit（単体）テスト：
プログラマ目線のテストです。
より小さい範囲で行い、各パーツごとにエラーがないかを確認します。
ブラックボックステスト、ホワイトボックステストの目的を意識する
* ブラックボックステスト：
システムの外部から機能や仕様を検証します。
システムが仕様通りに動作するか、画面レイアウトや使いやすさを評価することに重点を置きます。
* ホワイトボックステスト：
内部のコード構造や処理フローを検証します。
内部ロジックのの正確性を評価します。

テストの作成

テストの作成から実行方法までLaravelを使用した方法でまとめようと思います。

テスト作成のコマンド：

php artisan make:test XxxxTest

1

php artisan make:test XxxxTest

上記コマンドはFeatureテストとして作成されます。
もしもUnitテストとして作る際は、オプションを付けましょう。

php artisan make:test XxxxTest --unit

1

php artisan make:test XxxxTest --unit

* ファイル名は通常 ‘XxxxTest.php’ の形式を指定します。

テストケース名には必ず「test」と入れ、「test***」とテスト名と条件なども記載します。

テストコードの構造

テストコードは以下のような形をとります。

class ExampleTest extends TestCase
{
    protected function setUp(): void
    {
        // テスト前の準備
        parent::setUp();
    }

    protected function tearDown(): void
    {
        // テスト後のクリーンアップ
        parent::tearDown();
    }

    public function testExample()
    {
        // テストケース
        $this->assertTrue(true);
    }
}

class ExampleTest extends TestCase

{

protected function setUp(): void

{

// テスト前の準備

parent::setUp();

}

protected function tearDown(): void

{

// テスト後のクリーンアップ

parent::tearDown();

}

public function testExample()

{

// テストケース

$this->assertTrue(true);

}

setUp や tearDown はテストケースの事前・事後処理を行います。
* setUp：事前処理（変数の初期化やデータの準備など）
* tearDown：事後処理（不要なデータの削除など）
* setUpやtearDownを書く際は、メソッドの戻りと指定 ‘: void’ も忘れずに書くことが必要です。

アサーションについて

プログラミングのデバッグやテストのために用いられる方法の1つです。
以下のような働きをします。

テスト結果を即座に確認できる
テストが意図した通りに動作したかを検証できる
テスト条件が妥当なデータかを判断できる
テストが失敗した要因を特定しやすい

アサーションメソッドは主に以下のようなものがあります。

assertTrue：実測値がtrueであることを期待
assertFalse：実測値がfalseであることを期待
assertEquals：実測値と予測値が一致することを期待
assertSame：実測値と予測値が型も含めて一致することを期待
assertEmpty：中身が空であることを期待
assertNotEmpty：中身が空でないことを期待
assetStatus：アクセス結果のステータスコードを確認
assertRedirest：アクセス後、どこにリダイレクトされるかを確認
assertSee：レスポンス内に特定の文字列が存在することを確認

テストの実行方法

全てのテストを実行する場合

php artisan test

1

php artisan test
フォルダを指定してテストを実行する場合（例：フォルダ名tests/Feature）

php artisan test tests/Feature

1

php artisan test tests/Feature
ファイルを指定してテストを実行する場合（例：ファイル名ExampleTest.php）

php artisan test tests/Feature/ExampleTest.php

1

php artisan test tests/Feature/ExampleTest.php
メソッド名を指定してテストを実行する場合（例：メソッド名testExample）

php artisan test --filter testExample tests/Feature/ExampleTest.php

1

php artisan test --filter testExample tests/Feature/ExampleTest.php

テストコード作成のポイント

テストメソッドは簡潔に保つ
呼ばれるアサーションを条件分岐してしまうと、一貫したテスト結果が得られなくなる可能性があります。結果が数パターンある場合は、愚直にそのパターン数分テストを準備する必要があります。
必ず通るテストを書く（時間依存や確率的要素を避ける）
ダミーデータは実際の内容に近い内容にする
データはより正確な方が本番環境に近い挙動のテストを行うことができます。
テスト対象となるロジックはシンプルにする
複雑な条件になりそうな場合はメソッド化して対応します。そのほうがテストケースも少なくて済むことがあります。
ロジックはネスト構造を複数持たないよう心掛け、アーリーリターンを設けるなど対応します。
３つのAを意識する
〇 Arrange（準備）：テストを行うにあたっての必要な準備段階のこと
〇 Act（実行）：準備したデータを元にアクションを起こすこと
〇 Assert（検証）：アクション後に期待する結果になっているか検証すること
上記3つのAを意識してテストを行います。

以上がテストについての基本になります。
単体テストを適切に実施することで、コードの品質向上とメンテナンス性の改善につながります。
なかなか時間が十分にとれず、また、多数存在する条件の洗い出しもできないとシステムの品質を担保することは難しいです。
先日参加したPHPカンファレンスでもテストの重要性に触れ、テストを書く習慣をつけ、継続して改善、向上していくように意識するようになりました。
開発に時間がかかりがちですが、テストの時間も十分に設け、自分へのフィードバックも兼ねて今後も取り組んでいきたいと思います。
日々の取り組みを重ね、また理解が進んだ段階でアウトプットできればと思います！

PHP phar拡張モジュールの素敵な仕様

久しぶりにやってくれたPHP。
気づかず同じところに引っかかる人が出ると思ったので書いておきます。

今回PHPで.tar.gz圧縮/解凍を実装することになりまして、
phar拡張モジュールが対応しているということなので、素直にこれで実装したところ動作確認中にエラーが発生しました。

PHP Fatal error:  Uncaught BadMethodCallException: Unable to add newly converted phar "/path/to/hogehoge.tar.gz" to the list of phars, a phar with that name already exists in C:\Users\Kurosawa\Desktop\phar.php:18
Stack trace:
#0 /path/to/phar.php(18): PharData->compress()
#1 {main}
 thrown in /path/to/phar.php on line 18

PHP Fatal error: Uncaught BadMethodCallException: Unable to add newly converted phar "/path/to/hogehoge.tar.gz" to the list of phars, a phar with that name already exists in C:\Users\Kurosawa\Desktop\phar.php:18

Stack trace:

#0 /path/to/phar.php(18): PharData->compress()

#1 {main}

thrown in /path/to/phar.php on line 18

再現のための最小コードがこちらになります。

<?php

// 適当に.tar.gzに入れるファイル
file_put_contents('hogehoge.txt', 'このままでは俺の寿命がストレスでﾏｯﾊなんだが・・');

// .tarと.tar.gzファイルを作成
$phar = new \PharData('hogehoge.tar');
$phar->addFile('hogehoge.txt', 'hogehoge.txt');
$phar->compress(\Phar::GZ);

// .tarと.tar.gzファイルを削除
unlink('hogehoge.tar');
unlink('hogehoge.tar.gz');

// 同じ名前の.tarと.tar.gzファイルを作成したい
$phar = new \PharData('hogehoge.tar');
$phar->addFile('hogehoge.txt', 'hogehoge.txt');
$phar->compress(\Phar::GZ);

<?php

// 適当に.tar.gzに入れるファイル

file_put_contents('hogehoge.txt', 'このままでは俺の寿命がストレスでﾏｯﾊなんだが・・');

// .tarと.tar.gzファイルを作成

$phar = new \PharData('hogehoge.tar');

$phar->addFile('hogehoge.txt', 'hogehoge.txt');

$phar->compress(\Phar::GZ);

// .tarと.tar.gzファイルを削除

unlink('hogehoge.tar');

unlink('hogehoge.tar.gz');

// 同じ名前の.tarと.tar.gzファイルを作成したい

$phar = new \PharData('hogehoge.tar');

$phar->addFile('hogehoge.txt', 'hogehoge.txt');

$phar->compress(\Phar::GZ);

PharDataは内部でファイルパスをキーとして静的な領域にデータをキャッシュする実装になっているようで、上記のように同じファイルパスだと、複数PharDataを作成しても同じデータを指すことになり、2回目のcompressを実行しようとしたタイミングで「それはもう有るよエラー」ということです。

逆に以下のようなコードで1つのファイルを複数のPharDataで操作出来ます(意味は無い)

$phar1 = new \PharData('hogehoge.tar');
$phar2 = new \PharData('hogehoge.tar');
$phar1->addFile('hogehoge.txt', 'hogehoge1.txt');
$phar2->addFile('hogehoge.txt', 'hogehoge2.txt');
$phar1->compress(\Phar::GZ, '.tar.gz');

$phar1 = new \PharData('hogehoge.tar');

$phar2 = new \PharData('hogehoge.tar');

$phar1->addFile('hogehoge.txt', 'hogehoge1.txt');

$phar2->addFile('hogehoge.txt', 'hogehoge2.txt');

$phar1->compress(\Phar::GZ, '.tar.gz');

この現象については報告されていたのですが、ソースとかディスカッションを見るに
意図して実装されており、良い悪いは別として仕様な気がします。

https://bugs.php.net/bug.php?id=75101

1処理中に同じファイルパスで複数回ファイルを作り直すみたいなのはレアケースだと思うので遭遇する確率は低いと思いますが、記憶の片隅に留めておくとよいと思います。

Laravel Sailで記事投稿フォームを作成してみた

こんにちは。22年度入社の中島です。

前回はLinuxについて書きましたが、今回は少し前に学習していたLaravel Sailについてまとめました。

●Laravel Sailとは
Dockerを使った開発環境であり、ターミナルでコマンド実行するだけで、DockerでLaravel環境を一発で作ってくれる便利なコマンドラインツールです。
Laravel Sailを使うメリットは次の通りです。

・開発に最低限必要なツールを一度にインストールでき、インストールの手間を省ける
・本番環境と同じ環境を手元に用意して、動作を確認できる
・PHPのバージョンが異なる複数のプロジェクトの管理が楽にできる
（Laravel 8.x からLaravel Sailは標準でインストールされています。）

●なぜLaravel Sailを使っているのか？
Laravelの学習するときに使用していた技術書がLaravel Sailでの環境構築、実装方法を紹介しているのを見て、docker環境との連携も取りやすいと思ったため、復習を兼ねてSailの紹介をやってみようと思いました。

使用したテキスト：『Laravelの教科書』

Laravel Sailのセットアップ及びLaravelトップ画面の表示
1.Docker Desktopをインストール
Dockerのインストールです。Dockerの公式サイトからDocker Desktop のインストーラーをダウンロードします。

2.Laravel Sailをインストールするディレクトリを予め作成しておきます。
今回はtest-projectフォルダを作成しました。

mkdir test-project
cd test-project

1 2	mkdir test-project cd test-project

3.Laravel Sailのインストール
Ubuntuまたはターミナルで、次のコマンドを実行します。（今回はUbuntuを使用）

curl -s https://laravel.build/test-project | bash

1	curl -s https://laravel.build/test-project \| bash

4.途中でパスワードが求められたらPCのパスワードを入力。

5.下記メッセージが出たらインストール完了です。

Thank you! We hope you build something incredible. Dive in with: cd test-project && ./vendor/bin/sail up

1	Thank you! We hope you build something incredible. Dive in with: cd test-project && ./vendor/bin/sail up

6.「test-project」ディレクトリへ移動します。

cd test-project

1	cd test-project

7.Dockerコンテナを起動します。

./vendor/bin/sail up

1	./vendor/bin/sail up

これによりLaravel Sailが使用する複数のDockerコンテナが起動します。
起動したコンテナについて、Docker Desktopのウィンドウで確認してみましょう。

※./vendor/bin/sail コマンドを毎回入力するのは大変です。
これを「sail」だけで使えるようにするため、エイリアス登録を行います。

alias sail=./vendor/bin/sail

1	alias sail=./vendor/bin/sail

以降は sail コマンドとして記載していきます。

8.マイグレーションコマンドを実行して、初期テーブルを作成する。

$ sail artisan migrate

1	$ sail artisan migrate

9.ブラウザで「http://localhost/」へアクセスするとLaravelのスタート画面が表示されます。※Ubuntuまたはターミナルを開いたまま、ブラウザでアクセスしてください。

今回は、Laravelの復習として過去に作成したフォームの一部を紹介したいと思います。
『件名』『本文』にテキストエリアがあり、フォームの下に『送信する』ボタンがあるフォームを作成していきます。

１．モデルとマイグレーションファイルを作成
まずは、モデルとマイグレーションファイルを作ります。下記コマンドを実行して、Postモデルとマイグレーションファイルを作ります。

$ sail artisan make:model Post -m

1	$ sail artisan make:model Post -m

このコマンドを実行すると、database/migrations 配下と app/Modelsにファイルが作成されます。次にdatabase/migrations 配下に作成されたマイグレーションファイルに、postsテーブルを作成するためのtitleカラムとbodyカラムを設定します。

./database/migrations/(年)_(月)_(日)_(時刻)_create_posts_table.php

public function up(): void
    {
        Schema::create('posts', function (Blueprint $table) {
            $table->id();
            $table->string('title');
            $table->text('body');
            $table->timestamps();
        });
    }

public function up(): void

{

Schema::create('posts', function (Blueprint $table) {

$table->id();

$table->string('title');

$table->text('body');

$table->timestamps();

});

}

マイグレート実行し、データベースにpostsテーブルを作成

$ sail artisan migrate

1	$ sail artisan migrate

２．ビューファイルの作成
次にビューファイルを作ります。resources/viewsの中にpostフォルダを作り、その中に create.blade.phpファイルを作ります。create.blade.phpファイルの中には以下のコードを追加します。

create.blade.php

<x-app-layout>
    <x-slot name="header">
        <h2 class="font-semibold text-xl text-gray-800 leading-tight">
            フォーム
        </h2>
    </x-slot>

    <div class="max-w-7xl mx-auto px-6">
        <form method="post" action="{{ route('post.store') }}">
        @csrf
            <div class="mt-8">    
                <div class="w-full flex flex-col">
                    <label for="title" class="font-semibold mt-4">件名</label>
                    <input type="text" name="title" class="w-auto py-2 border border-gray-300 rounded-md" id="title">
                </div>
            </div>
        
            <div class="w-full flex flex-col">
                <label for="body" class="font-semibold mt-4">本文</label> 
                <textarea name="body" class="w-auto py-2 border border-gray-300 rounded-md" id="body" cols="30" rows="5">
                </textarea>
            </div>
        
            <x-primary-button class="mt-4">
                送信する
            </x-primary-button>
        </form>
    </div>
</x-app-layout>

<x-app-layout>

<x-slot name="header">

フォーム

</h2>

</x-slot>

@csrf

</div>

</textarea>

</div>

<x-primary-button class="mt-4">

送信する

</x-primary-button>

</form>

</div>

</x-app-layout>

３．ビューファイル表示用コードを追加
次にコントローラです。下記コマンドを実行して、PostControllerを作成。

$ sail artisan make:controller PostController

1	$ sail artisan make:controller PostController

コマンド実行後、app/Http/Controllerの中のPostController.phpを開きます。先ほど作成した resources/views/post/create.blade.phpファイルを表示するためと投稿データ保存のために、下記のように記述します。

PostController.php

use Illuminate\Http\Request;
use App\Models\Post;
class PostController extends Controller
{
     public function create(){
         return view('post.create');
     }

 　　public function store(Request $request) {
 　　    $post = Post::create([
  　　　    'title' => $request->title,
  　　　    'body' => $request->body
　　　　　]);
 　　    return back();
 　　}
}

use Illuminate\Http\Request;

use App\Models\Post;

class PostController extends Controller

{

public function create(){

return view('post.create');

}

　　public function store(Request $request) {

　　 $post = Post::create([

　　　 'title' => $request->title,

　　　 'body' => $request->body

　　　　　]);

　　 return back();

　　}

４．ルーティングの設定(ビューファイル表示用のルート設定)を追加
ルート設定の作成です。routes/web.phpの中に、下記のuse宣言とフォーム表示用のルート設定と投稿データ保存用のルート設定を加えます。これにより今回作成したフォームがブラウザに表示されます。

web.php

use App\Http\Controllers\PostController;
(省略)
Route::get('post/create', [PostController::class, 'create']);
Route::post('post', [PostController::class, 'store'])->name('post.store');

use App\Http\Controllers\PostController;

(省略)

Route::get('post/create', [PostController::class, 'create']);

Route::post('post', [PostController::class, 'store'])->name('post.store');

これまで記述したコードによって、次の流れが実現します。

ユーザーがログイン後にhttp://localhost/postにアクセスする
ルート設定により、PostControllerのcreateメソッドに処理が割り振られる
処理が実行され、resources/views/post/create.blade.phpの内容がブラウザに表示される

実際に作成したもの

4.件名(title)と本文(body)を入力し『送信する』ボタンを押すことで、PostControllerにフォーム(http://localhost/post)を通じて値が送信される
5.ルート設定により、PostControllerのstoreメソッドに処理が割り振られる
6.処理が実行され、件名が$request->titleに、本文が$request->body にそれぞれ入っているため、Post::create() に渡してやることでpostsレコードの対応するフィールドに値がセットされる
7.returu back()によっての元ページに戻る

いかがでしょうか。

今回は振り返る形でLaravel Sailのことを書きました。
今後も学んだことを忘れないようにLaravelやLinux、業務で行った作業なども復習する形でブログ更新していきたいと思います。

今回はここまで
最後までご覧いただきありがとうございました！

2023年新入社員ブログ松井(第3回)

こんにちは。松井です。
もう11月になって上着を着用してる人が増えてきましたね!

前回までの内容は下に貼っておきます!

第1回はこちら
第2回はこちら

第2回ではSQL演習について紹介しましたが、今回と次回でPHP/Laravel演習について紹介します。今回はPHP側の演習について紹介します。演習内容の前にPHPについて簡単に紹介します!

PHPとはWebページを作ることがサーバサイドのプログラミング言語です。HTMLやJavaScriptと混同されやすいです。HTMLやJavaScriptはブラウザ側(ユーザ側)で動かしていますが、PHPはサーバ側で動かしています。PHPを使う最大の利点はデータベースとの連携を容易に行えるということです。サーバ側で動かしているので、Webサイト上でよく見るデータのやりとりを実現できるということです。

PHP/Laravel演習の課題は「会員登録フォームの作成」です。主な実装内容は以下の通りです。

会員登録フォームの内容

会員登録/ログイン機能の実装
会員一覧機能の実装
会員情報変更機能の実装
会員削除機能の実装

基本的に上記の内容を実装するという内容ですが、ユーザにとって使いやすいように配慮することが大変でした。例えば間違えてページのリロードをしたら入力内容が全て消えてしまうという問題は「値を保持させないといけない」ということや必要です。また、誤って入力した内容が直ぐにデータベースに登録されるのを防ぐために「確認画面を作る」ことや登録したかどうか確認するために「完了画面を作る」機能も必要でした。機能作成の面で特に大変だったことは「ページネーション機能の実装」でした。実装するために多くの行数を書く必要があることやページを遷移することによって入力した値が保持できないといったバグを対処することがとても大変でした。作成した会員一覧ページはこのような感じです。

次回はLaravel演習について書きます。LaravelはPHPと比べ、複雑な機能を簡単に書けるという特徴を持っていますのでPHPとの違いについても紹介していきます!
最後まで読んでくれてありがとうございました!

ヘルパー関数のあれこれ！紙屋03

おつかれさまです！
‘23年度入社の紙屋です！
９月に入って朝晩の暑さがすこーーしずつ和らいでいたような気がしますね。早く日中の暑さも和らいでいくといいですね。

８月で課題の会員登録のアプリケーションを作り終えました。
外部研修でもLaravelでwebアプリケーションをつくりましたが、そのときはとりあえずの実装を優先して、「この関数がどんな仕事をしているのか、どんな機能があるのか」ということを考えていませんでした。
そこで、今回はLaravelにおけるヘルパ関数に焦点をあてて振り返ろうと思います！

ヘルパ関数とは？
Laravelに搭載されている独自の関数のことで、いろいろなところで呼び出せる便利な関数です。

Laravelの公式ドキュメントをみえると数えただけで213個ありました(今回Laravel ver9で実装)。
まだまだ分からないことが多いので、今回は使ったものに触れながら振り返ります！
今回の会員登録フォームで使用したヘルパ関数は、
・view ・redirect ・route ・request ・session
・old ・dd ・dump ・config
でした。
Contollerや入力フォーム、処理の確認で使うものが多く、外部研修でも使っていたので、コードレビューいただく前から使っていました。しかし、config関数は教えていただいてからの導入でした。

よくアドバイスいただく内容として、同じコードで内容量が多く、その処理を複数個所で使用する場合は、可読性や再利用性を考えてコーディングした方が良いと教えていただきます。
今回config関数をどこに用いたかというと、formタグで会員情報の登録や編集を行う箇所でバリデーションを実装するときに、バリデーションの中身は同じものなので、バリデーション時にコードが冗長にならないように利用しました。

まずは、config関数の公式ドキュメントを確認します。
「config関数は設定変数の値を取得します。設定値はファイル名とアクセスしたいオプションを「ドット」記法で指定します。」
とあります。

$value = config('[ファイル名].[キー]');

1	$value = config('[ファイル名].[キー]');

となっており、「/config/(.phpファイル)」内に記述されている配列を呼び出します。
では、私はどのように実装したかというと、
Controller内には以下のように記述し、

// バリデーションの実行
$request->validate(config('mySetting.validate'));

1 2	// バリデーションの実行 $request->validate(config('mySetting.validate'));

「/config/mySetting.php」ファイル内に

return [
    'validate' => [
        'last_name' => 'required|max:20',
        'first_name' => 'required|max:20',
        … 長いので以下省略 …
    ],
];

return [

'validate' => [

'last_name' => 'required|max:20',

'first_name' => 'required|max:20',

… 長いので以下省略 …

];

と記述しました(教えてもらいながらですが…)。

これでバリデーションチェック時の項目をController内に何度も記述する必要が無く、バリデーション内容の変更・修正時も配列の中身を記述することでスッキリします。

ちなみに、ヘルパ関数がどんな処理をしているのかは、「/vender/laravel/framwork/src/illuminate/Foudation/helpers.php」ファイル内に記述してありました。

// 一部抜粋
if (is_array($key)) {
    return app('config')->set($key);
}

// 一部抜粋

if (is_array($key)) {

return app('config')->set($key);

}

確かに配列があればキーを返してくれているみたいです。

ちなみに、今回使用した「ドット記法」についてちょっと触れると、配列からの値の取得時にキーを「.」でつなげることで、多次元配列の場合、より深い階層へネストし値を取得してくれます。
例えば、Arr:get()関数の公式ドキュメントを参照すると、

use Illuminate\Support\Arr;

$array = [
    'products' => [
        'desk' => [
            'price' => 100
        ]
    ]
];

$price = Arr::get($array, 'products.desk.price');

// 100

use Illuminate\Support\Arr;

$array = [

'products' => [

'desk' => [

'price' => 100

]

];

$price = Arr::get($array, 'products.desk.price');

// 100

となっています。$arrayのような多次元配列から値を取得したい場合は、第2引数のキーの部分をドット記法で、欲しい値までネストしていきます。
ちなみにArr::get()関数に第3引数をセットすると、第2引数に指定したキーが存在しない場合の値を返してくれます。

改めて振り返ってみると、「なるほど！」と思いました！
今後も、いろいろと忘れないようにまとめていきたいと思います。
では、また次回!!

新入社員ブログ　中島04 『PHPテキスト学習1』

こんにちは！そして明けましておめでとうございます。

22年度入社の中島です。

新年が明けたと思ったらもう一ヶ月が終わりました…
とても早い気がします。

『一月往ぬる二月逃げる三月去る』という言葉があるように、ぼーっとしていたらあっという間に四月になるかもしれませんね。

このままだとまずいと思い、今年の1月から技術力向上のためPHPのテキストで学習に取り組んでいます。

今回はその復習も兼ねて、簡単にブログにまとめていきます。

学習に使用したPHPのテキストはこのテキストです。

そして、学習した内容を大まかにまとめると

・PHPの基本
変数、定義、データ型、配列など

・演算子
代入演算子、比較演算子、論理演算子、ビット演算子など

・制御構文
if命令、switch命令、while/do命令、for命令、foreach命令など

・組み込み関数
文字列関数（mb_strlen関数、mb_substr関数、str_replace 関数）
配列関数（count 関数、array_merge 関数、implode関数）
正規表現(PCRE)関数（preg_match 関数、preg_replace関数、preg_split 関数）
ファイルシステム関数（fopen/fclose関数、fwrite関数、fgetcsv関数）

など現在進行形で学習しています。
そして表紙に書いてあるように
『手を動かしながら学ぶ』と書いてあるので、実際にプログラムを打って実行して動きを確認しながら学習しています。

テキストプログラム

テキストプログラム

<?php
$str='彼の電話番号は0399-88-9785,私のは0398-99-1234です。 郵便番号はどちら687-1109です。';
if(preg_match('/([0-9]{2,4})-([0-9]{2,4})-([0-9]{4})/', $str, $data)) {
print "電話番号: {$data[0]}<br />";
print "市外局番: {$data[1]}<br />";
print "市内局番: {$data[2]}<br />";
print "加入者番号: {$data[3]}<br />";
}

<?php

$str='彼の電話番号は0399-88-9785,私のは0398-99-1234です。郵便番号はどちら687-1109です。';

if(preg_match('/([0-9]{2,4})-([0-9]{2,4})-([0-9]{4})/', $str, $data)) {

print "電話番号: {$data[0]}<br />";

print "市外局番: {$data[1]}<br />";

print "市内局番: {$data[2]}<br />";

print "加入者番号: {$data[3]}<br />";

}

[crayon-685bf6f5bf96a182292927  ]電話番号: 0399-88-9785
市外局番: 0399
市内局番: 88
加入者番号: 9785

[crayon-685bf6f5bf96a182292927 ]電話番号: 0399-88-9785

市外局番: 0399

市内局番: 88

加入者番号: 9785

[/crayon]

『テキストを読む』→『プログラムを打ち込む』→『プログラムを実行する』
この流れで学習を行い、理解できない部分は上司に聞いたりGoogleで調べながらより理解を深めていきます。
先ほどもお話ししたように現在進行形で学習中です。テキストのページも半分ほどでまだまだこれからなので、一生懸命取り組んでいきます。

今回はここまで
最後までご覧いただきありがとうございました！

PHP7の新規機能その２

福岡拠点の永嵜です。

前回に引き続き、PHP7.0以降に追加された機能を紹介します。

１．define() を用いた配列定数の定義
define() で配列の定数を定義できるようになりました。

サンプルプログラム
echoでANIMALSの要素1を出力しています。

define('ANIMALS', [
    'dog',
    'cat',
    'bird'
]);

echo ANIMALS[1]; // "cat" と出力します

define('ANIMALS', [

'dog',

'cat',

'bird'

]);

echo ANIMALS[1]; // "cat" と出力します

２．use 宣言のグループ化
複数のクラスや関数そして定数を同じ namespace からインポートする際に、
単一の use 文にまとめられるようになりました。

サンプルプログラム

// 以前のバージョンのコード
use some\namespace\ClassA;
use some\namespace\ClassB;
use some\namespace\ClassC as C;

// PHP 7 以降のコード
use some\namespace\{ClassA, ClassB, ClassC as C};

// 以前のバージョンのコード

use some\namespace\ClassA;

use some\namespace\ClassB;

use some\namespace\ClassC as C;

// PHP 7 以降のコード

use some\namespace\{ClassA, ClassB, ClassC as C};

３．例外処理における複数の例外の catch
ひとつの catch ブロックで複数の例外を扱えるようになりました。
パイプ文字 (|) を使って指定します。
異なる例外を同じように処理したい場合に有用です。

サンプルプログラム

try {
    // 何かのコード
} catch (FirstException | SecondException $e) {
    // FirstException と SecondException をこのブロックで処理します
}

try {

// 何かのコード

} catch (FirstException | SecondException $e) {

// FirstException と SecondException をこのブロックで処理します

}

４．list() におけるキーのサポート
list() (あるいはその短縮版である [] 構文) の内部でキーを
指定できるようになりました。
list()及び[]で変数の中身を受け取る時もキーを指定した書き方が
出来るようになりました。

サンプルプログラム

$data = [
["id" => 1, "name" => 'Tom'],
["id" => 2, "name" => 'Fred'],
];

// list() 形式
foreach ($data as list("id" => $id, "name" => $name)) {
print "結果1 "."id: " .$id." name:".$name ."\n" ;
}

foreach ($data as list("name" => $name,"id" => $id )) {
print "結果2 "."id: " .$id." name:".$name ."\n" ; 
}

// [] 形式
foreach ($data as ["id" => $id, "name" => $name]) {
print "結果3 "."id: " .$id." name:".$name ."\n" ;
}

foreach ($data as ["name" => $name,"id" => $id ]) {
print "結果4 "."id: " .$id." name:".$name ."\n" ;
}

function getList(){
$test = [
["id" => 1,"name" => "田中"]
];
return $test[0];
}

list("name" => $name,"id" => $id) = getList();
print "結果5 "."id: " .$id." name:".$name ."\n" ;

$data = [

["id" => 1, "name" => 'Tom'],

["id" => 2, "name" => 'Fred'],

];

// list() 形式

foreach ($data as list("id" => $id, "name" => $name)) {

print "結果1 "."id: " .$id." name:".$name ."\n" ;

}

foreach ($data as list("name" => $name,"id" => $id )) {

print "結果2 "."id: " .$id." name:".$name ."\n" ;

}

// [] 形式

foreach ($data as ["id" => $id, "name" => $name]) {

print "結果3 "."id: " .$id." name:".$name ."\n" ;

}

foreach ($data as ["name" => $name,"id" => $id ]) {

print "結果4 "."id: " .$id." name:".$name ."\n" ;

}

function getList(){

$test = [

["id" => 1,"name" => "田中"]

];

return $test[0];

}

list("name" => $name,"id" => $id) = getList();

print "結果5 "."id: " .$id." name:".$name ."\n" ;

実行結果

結果1 id: 2 name:Fred
結果2 id: 1 name:Tom
結果2 id: 2 name:Fred
結果3 id: 1 name:Tom
結果3 id: 2 name:Fred
結果4 id: 1 name:Tom
結果4 id: 2 name:Fred
結果5 id: 1 name:田中

結果1 id: 2 name:Fred

結果2 id: 1 name:Tom

結果2 id: 2 name:Fred

結果3 id: 1 name:Tom

結果3 id: 2 name:Fred

結果4 id: 1 name:Tom

結果4 id: 2 name:Fred

結果5 id: 1 name:田中

５．最後に
PHP7.0以降に多くの機能が機能が追加されています。
今回紹介した機能以外にも便利な機能が追加されていますので
詳細を知りたい方は下記をチェックしてみてください。

PHP マニュアル
http://php.net/manual/ja/migration70.new-features.php
http://php.net/manual/ja/migration71.new-features.php
http://php.net/manual/ja/migration72.new-features.php

PHP7の新規機能その1

福岡拠点の永嵜です。

現時点(2019/2/25)でのPHPの最新バージョンは7.3です。
PHP7.0リリースの際にパフォーマンスの向上や多くの新機能が追加されていますが、私自身があまり新機能を使えていなかったので新機能について調べました。
このブログでPHP7.0以降に追加された機能をいくつか紹介したいと思います。

１．引数/戻り値の型宣言
関数の引数/戻り値に明示的に型を指定することができるようになりました。
型を指定することで不正な値が渡されるのが防げます。
通常、Nullは許容されませんが型の前にクエスチョンマークをつけるとNullを許容でき指定した型だけでなく Nullも引数/戻り値として使用できるようになります。

サンプルプログラム
引き数 $a、$b、戻り値にint型指定を指定しています。

function getAddValue(?int $a,?int $b):?int{
    return $a + $b;

}

$sum = getAddValue('A',1);

print "合計値は{$sum}です。\n";

function getAddValue(?int $a,?int $b):?int{

return $a + $b;

}

$sum = getAddValue('A',1);

print "合計値は{$sum}です。\n";

実行結果
宣言した型以外(キャスト出来る場合OK)が引数で指定されるとTypeErrorの例外がスローされます。

PHP Fatal error: Uncaught TypeError: Argu
Fatal error: Uncaught TypeError: Argument 1 passed to getAddValue() must be of the type integer or null, string given, called

1 2	PHP Fatal error: Uncaught TypeError: Argu Fatal error: Uncaught TypeError: Argument 1 passed to getAddValue() must be of the type integer or null, string given, called

注意点
引数/戻り値が指定した型にキャストできる場合は、自動的にキャスト変換されて
正常終了します。厳密に型チェックを行いたい場合は、declare(strict_types=1)命令を使用する必要があります。

※PHP５でも型宣言(タイプフィンディング)は使用できましたが、
以下の制約がありました。
・戻り値では型宣言ができない。
・引数で型を宣言できるのは配列/オブジェクトのみ
(int/floatのような型宣言はできない)

指定可能な型は以下の通りです。

型名	概要	使用可能バージョン
bool	真偽値	7.0.0～
float	浮動小数点数	7.0.0～
int	整数	7.0.0～
string	文字列	7.0.0～
array	配列	5.1.0～
callable	コールバック関数	5.4.0～
クラス名	指定したクラス	5.0.0～
インターフェイス名	指定したインターフェイス	5.0.0～
self	そのメソッドが定義されているクラスと同じクラスのインスタンス	5.0.0～
void	戻り値が特に無いことを指定	7.1.0～

２．Null合体演算子
式1 ?? 式2
式1がNullでない場合には式1をそうでない場合は式2を返します。

サンプルプログラム

$message1 = 'こんにちは'."\n";
$message2 = null;

print $message1??'ノーコメント1'."\n";
print $message2??'ノーコメント2'."\n";

$message1 = 'こんにちは'."\n";

$message2 = null;

print $message1??'ノーコメント1'."\n";

print $message2??'ノーコメント2'."\n";

実行結果
$message2はNullのため式2の値が表示されています。

こんにちは
ノーコメント2

1 2	こんにちはノーコメント2

３．宇宙船演算子
2つの式を比較するための演算子です。
左辺<=>右辺
左辺が大きい：戻り値「1」
右辺が大きい：戻り値「-1」
両辺が等しい：戻り値「0」

サンプルプログラム

// 整数値
echo (1 <=> 1) ."\n"; // 0
echo (1 <=> 2)."\n"; // -1
echo (2 <=> 1) ."\n"; // 1

// 浮動小数点数値
echo (1.5 <=> 1.5) ."\n"; // 0
echo (1.5 <=> 2.5) ."\n"; // -1
echo (2.5 <=> 1.5) ."\n"; // 1

// 文字列
echo ("a" <=> "a")."\n"; // 0
echo ("a" <=> "b")."\n"; // -1
echo ("b" <=> "a")."\n"; // 1

// 整数値

echo (1 <=> 1) ."\n"; // 0

echo (1 <=> 2)."\n"; // -1

echo (2 <=> 1) ."\n"; // 1

// 浮動小数点数値

echo (1.5 <=> 1.5) ."\n"; // 0

echo (1.5 <=> 2.5) ."\n"; // -1

echo (2.5 <=> 1.5) ."\n"; // 1

// 文字列

echo ("a" <=> "a")."\n"; // 0

echo ("a" <=> "b")."\n"; // -1

echo ("b" <=> "a")."\n"; // 1

実行結果

-1

４．最後に
今回紹介しきれなかった機能を次回紹介します。

[Laravel]ビュー

福岡拠点の香月です。

今回はビューです。前回のルートとコントローラで呼び出されたURLに対してPHPでのプログラム処理ができるようになりました。
今回はここで実際にデータを集計して、結果を画面に表示したいと思います。この画面表示部分がMVCモデルのV（View）です。
Laravelの標準テンプレートエンジンはBladeとなっています。

それでは早速コントローラの実装です。
前回の実装ではLaravelのようこそ画面を呼び出していましたが、今回は”top”とう名前のテンプレートを使用して画面を表示するようにします。テンプレートファイルは後で作成します。
app/Http/Controllers/TopController.phpファイルを編集します。

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use App\Score;
use App\Student;
use App\Subject;
use Input;

class TopController extends Controller
{
    public function index(Request $request)
    {
        $dispday = $request->input('day');
        $days = Score::getDays();
        if (empty($dispday)) {
            $dispday = array_last($days);
        }
        $scores = Score::getList($dispday);
        $subjects = Subject::all();

        $students = [];
        foreach ($scores as $score) {
            $name = $score->family_name . $score->first_name;
            if (!isset($students[$name])) {
                $students[$name] = [];
            }
            $students[$name][$score->subject_id] = $score->score;
        }

        return view('top')
            ->with('days', $days)
            ->with('dispday', $dispday)
            ->with('subjects', $subjects)
            ->with('students', $students);
    }
}

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

use App\Score;

use App\Student;

use App\Subject;

use Input;

class TopController extends Controller

{

public function index(Request $request)

{

$dispday = $request->input('day');

$days = Score::getDays();

if (empty($dispday)) {

$dispday = array_last($days);

}

$scores = Score::getList($dispday);

$subjects = Subject::all();

$students = [];

foreach ($scores as $score) {

$name = $score->family_name . $score->first_name;

if (!isset($students[$name])) {

$students[$name] = [];

}

$students[$name][$score->subject_id] = $score->score;

}

return view('top')

->with('days', $days)

->with('dispday', $dispday)

->with('subjects', $subjects)

->with('students', $students);

}

モデルScoreに追加した2つのメソッドを呼び出して得点に関するデータを取得しています（ソースは後ほど）。$daysには試験実施日の一覧が、$scoresには試験の点数データが入ってきます。
$subjectsでは科目一覧を取得しています。
$studentsは配列として定義していて、続くforeachで点数データ列挙しながら二次元配列を作成します。一次元目に生徒名、二次元目に科目ID、その値として点数を設定しています。
最後にreturn view(‘top’)で画面を呼び出すと同時に、topテンプレート内で使用するデータを->with()で指定しています。（->with()の複数回の呼び出しは、一回の->with()の呼び出しに置き換えることができます。その場合、->with()の引数にはキー、バリューの配列を設定します）

実装の先頭で$request->input(‘day’)を使っています。コントローラメソッド（ここでいうindex()）ではメソッドインジェクション（依存注入機能）を使ってRequestクラスのインスタンスを取得することができ、ユーザーリクエストの内容を利用できます。

次はScoreにメソッドを追加します。app\Score.phpを編集しましょう。

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Score extends Model
{
    public static function getDays()
    {
        $scores = self::select('exam_day')
            ->groupBy('exam_day')
            ->orderBy('exam_day')
            ->get();

        $days = [];
        foreach ($scores as $s) {
            $days[] = date('Y/m/d', strtotime($s->exam_day));
        }
        return $days;
    }

    public static function getList($day)
    {
        $scores = self::whereDate('exam_day', $day)
            ->leftJoin('subjects', 'subject_id', '=', 'subjects.id')
            ->leftJoin('students', 'student_id', '=', 'students.id')
            ->orderBy('student_id')
            ->orderBy('subject_id')
            ->get();

        return $scores;
    }
}

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Score extends Model

{

public static function getDays()

{

$scores = self::select('exam_day')

->groupBy('exam_day')

->orderBy('exam_day')

->get();

$days = [];

foreach ($scores as $s) {

$days[] = date('Y/m/d', strtotime($s->exam_day));

}

return $days;

}

public static function getList($day)

{

$scores = self::whereDate('exam_day', $day)

->leftJoin('subjects', 'subject_id', '=', 'subjects.id')

->leftJoin('students', 'student_id', '=', 'students.id')

->orderBy('student_id')

->orderBy('subject_id')

->get();

return $scores;

}

getDays()では試験日フィールドexam_dayをグルーピングして、日付の昇順に並び替えた結果を取得しています。exam_dayフィールドは時間まで入っているので、日付だけの書式に書き換えて配列に置き換えています。

getList()では引数で指定された試験日だけのデータを取得し、それに対してLEFT OUTER JOINで科目と生徒を連結した結果を返します。

さあ、ここまでくるとあとはビューを作成します。
resource/views/welcome.blade.phpをコピーしてresource/views/top.blade.phpを作成し、中身を編集します。
コントローラの最後で return view(‘top’) を呼び出していましたが、Laravelではこれでresource/viewsフォルダにあるtop.blade.phpの呼び出しと判断してくれます。

<!doctype html>
<html lang="{{ str_replace('_', '-', app()->getLocale()) }}">
    <head>
　　　：
    </head>
    <body>
        <div class="flex-center position-ref full-height">
            <div class="content">
                <div class="title m-b-md">
                    Score sheet
                </div>

                @foreach ($days as $day)
                    @if ($dispday == $day)
                        <span class="emphasis">{{ $day }}</span>
                    @else
                        <span><a href="{{ route('top') . '?day=' . $day }}">{{ $day }}</a></span>
                    @endif
                @endforeach

                <table border="1" cellspacing="0" width="100%">
                    <tr>
                        <td></td>
                        @foreach ($subjects as $subject)
                            <td>{{ $subject->name }}</td>
                        @endforeach
                    </tr>
                    @foreach ($students as $name => $student)
                        <tr>
                            <td>{{ $name }}</td>
                        @foreach ($subjects as $subject)
                            <td>{{ $student[$subject->id] }}</td>
                        @endforeach
                        </tr>
                    @endforeach
                </table>
            </div>
        </div>
    <br><br><br>
    </body>
</html>

<!doctype html>

<html lang="{{ str_replace('_', '-', app()->getLocale()) }}">

<head>

　　　：

</head>

<body>

Score sheet

</div>

@foreach ($days as $day)

@if ($dispday == $day)

@else

@endif

@endforeach

<tr>

@foreach ($subjects as $subject)

<td>{{ $subject->name }}</td>

@endforeach

</tr>

@foreach ($students as $name => $student)

<tr>

@foreach ($subjects as $subject)

<td>{{ $student[$subject->id] }}</td>

@endforeach

</tr>

@endforeach

</table>

</div>

</body>

</html>

画面のタイトル「Score sheet」を表示します。
その下には試験日の一覧$daysを@foreachで列挙して表示します。各試験日はaタグでリンクを作成し、クリックするとその日の表示に切り替わるようにしています。ここでroute(‘top’)を呼び出していますが、前回route/web.phpファイル内でRoute::get(‘/’, ‘TopController@index’)->name(‘top’);と指定した名前ですね。これによりこのリンク先が。/ に設定されます。
最後にtableタグで点数表を表示します。縦に生徒軸、横に科目軸を設定して、各生徒の点数を表示するようにしています。それぞれ@foreachでループしながらテーブルを生成しています。

これで実装が完了しました。実際に画面を表示して見ましょう。
表示するデータはシーダーで用意したデータです。
こんな感じで画面が表示されます。

Bladeテンプレートエンジンでは@foreach以外にも@if, @elseや@switch, @case, @breakなどの制御構文が使えます。

また、テンプレートの継承や@includeなど、他のテンプレートファイルと組み合わせて1つの画面を作成することができます。同じ内容を複数のファイルに書くと、後からの編集が大変ですね。その手間をなくすために積極的に活用しましょう。

2025年6月
月	火	水	木	金	土	日
						1
2	3	4	5	6	7	8
9	10	11	12	13	14	15
16	17	18	19	20	21	22
23	24	25	26	27	28	29
30