【PHP8.x】sendメソッドの使い方

Copy
1<?php
2
3use SendGrid\Mail\Mail;
4
5/**
6 * SendGrid を使用してメールを送信するサンプル.
7 * Generator::send() を使用して値をジェネレータに送信し、メール内容を動的に生成する。
8 *
9 * @param string $apiKey SendGrid API キー
10 * @param string $toEmail 送信先メールアドレス
11 * @param string $subject メール件名
12 */
13function sendEmailWithGenerator(string $apiKey, string $toEmail, string $subject): void
14{
15    // メール送信処理を生成するジェネレータ
16    $emailGenerator = function (string $toEmail, string $subject) {
17        $email = new Mail();
18        $email->setFrom("from@example.com", "Example Sender");
19        $email->addTo($toEmail, "Example Recipient");
20        $email->setSubject($subject);
21
22        // ジェネレータに値を送信して本文を生成
23        $body = yield; 
24        $email->addContent("text/plain", $body);
25
26        yield $email; // メールオブジェクトを返す
27    };
28
29
30    $generator = $emailGenerator($toEmail, $subject);
31
32    // ジェネレータを開始
33    $generator->rewind();
34
35    // Generator::send() でメール本文をジェネレータに送信
36    $generator->send("This is the dynamic email body sent using Generator::send().");
37
38    /** @var Mail $email */
39    $email = $generator->current();
40    
41    try {
42        $sendgrid = new SendGrid($apiKey);
43        $response = $sendgrid->send($email);
44        
45        // デバッグ用
46        //echo $response->statusCode() . "\n";
47        //print_r($response->headers());
48        //echo $response->body() . "\n";
49
50    } catch (Exception $e) {
51        echo 'Caught exception: '. $e->getMessage() ."\n";
52    }
53}
54
55// SendGrid APIキー、送信先メールアドレス、メール件名を指定して実行
56// sendEmailWithGenerator("YOUR_SENDGRID_API_KEY", "to@example.com", "Dynamic Email Subject");
57

このサンプルコードは、PHPのジェネレータ機能とSendGridライブラリを組み合わせて、動的にメールを生成・送信する方法を示しています。Generator::send()メソッドは、ジェネレータ関数に値を送信するために使用されます。

まず、sendEmailWithGenerator関数は、SendGrid APIキー、送信先メールアドレス、メール件名を引数として受け取ります。この関数内で、メール送信処理を生成するジェネレータ関数 $emailGenerator が定義されています。$emailGenerator は、yield キーワードを使って一時停止し、Generator::send() で送信された値（この場合はメール本文）を受け取ります。そして、受け取った値をメール本文として設定し、最終的にメールオブジェクトを yield します。

次に、$emailGenerator からジェネレータオブジェクトが生成され、rewind() メソッドでジェネレータが開始されます。Generator::send("This is the dynamic email body...") の部分で、メール本文が $emailGenerator に送信されます。送信された値は $body = yield; で受け取られ、メールオブジェクトに設定されます。

ジェネレータからメールオブジェクトを受け取った後、SendGridライブラリを使用して実際にメールを送信します。Generator::send() は、ジェネレータに値を渡すだけでなく、ジェネレータが次に yield する値（この例ではメールオブジェクト）を返す役割も果たします。エラーが発生した場合は、例外がキャッチされ、エラーメッセージが表示されます。最後に、コメントアウトされている sendEmailWithGenerator("YOUR_SENDGRID_API_KEY", "to@example.com", "Dynamic Email Subject"); の部分を、実際のAPIキーとメールアドレスに置き換えることで、メールを送信できます。

Copy
1<?php
2
3/**
4 * Generator::send() の使用例：値をジェネレータに送信し、次の値を生成する
5 */
6function numberGenerator(): Generator
7{
8    $i = 0;
9    while (true) {
10        $value = yield $i;
11
12        // send() で値が送信された場合、それを $i に加算する
13        if ($value !== null) {
14            $i += $value;
15        } else {
16            $i++;
17        }
18    }
19}
20
21$generator = numberGenerator();
22
23// 最初の値を生成
24echo "Initial value: " . $generator->current() . PHP_EOL; // Initial value: 0
25$generator->next();
26
27// 値を送信して次の値を生成
28echo "Value after send(5): " . $generator->send(5) . PHP_EOL; // Value after send(5): 6
29$generator->next();
30
31// 値を送信して次の値を生成
32echo "Value after send(10): " . $generator->send(10) . PHP_EOL; // Value after send(10): 17
33$generator->next();
34
35// 値を送信せずに次の値を生成
36echo "Value after next(): " . $generator->current() . PHP_EOL; // Value after next(): 18
37
38$generator->next();
39
40echo "Value after next(): " . $generator->current() . PHP_EOL; // Value after next(): 19

PHP 8 の Generator::send() メソッドは、ジェネレータ関数内で yield 式に値を送信し、ジェネレータの実行を再開して次の値を生成するために使用されます。Generator クラスに属するメソッドで、ジェネレータの内部状態を制御する重要な役割を担います。

引数 $value には、ジェネレータに送信する値を指定します。この値は、ジェネレータ関数内の yield 式の結果として変数に代入されます。

戻り値は、ジェネレータが次に yield した値です。ジェネレータが終了した場合や、return ステートメントに到達した場合は、NULL が返されます。

サンプルコードでは、numberGenerator() 関数がジェネレータとして定義されています。この関数は、while ループ内で yield $i を使用して値を生成し、send() で送信された値を $i に加算します。send() で値が送信されなかった場合は $i をインクリメントします。

$generator->send(5) は、ジェネレータに値 5 を送信し、ジェネレータの実行を再開します。ジェネレータ関数内では、$value に 5 が代入され、$i に加算されます。その結果、次の yield で生成される値は、加算後の $i の値となります。$generator->next() は、値を送信せずに次の値を生成します。send() と next() を組み合わせることで、ジェネレータの動作を柔軟に制御できます。