Skip to content

Commit 2ec543d

Browse files
socket-managersocket-manager
committed
v1.20.6 Release
「参照渡し | PHP-TECHNIQUE」ページの追加
1 parent 34aea6a commit 2ec543d

File tree

2 files changed

+272
-0
lines changed

2 files changed

+272
-0
lines changed

‎img/php-pass-by-reference/memory.png‎

10.1 KB
Loading

‎php-pass-by-reference.html‎

Lines changed: 272 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,272 @@
1+
<!DOCTYPE html>
2+
<html lang="ja">
3+
<head>
4+
<meta charset="utf-8" />
5+
<meta name="viewport" content="width=device-width, initial-scale=1" />
6+
7+
<title>参照渡し | PHP-TECHNIQUE | SOCKET-MANAGER Framework For PHP</title>
8+
<meta name="description" content="当フレームワークで使っているPHPの技術情報「参照渡し」についての説明です" />
9+
<meta content="PHP,参照渡し" name="keywords">
10+
11+
<script async src="https://www.googletagmanager.com/gtag/js?id=G-LF9W695NNW"></script>
12+
<script>
13+
window.dataLayer = window.dataLayer || [];
14+
function gtag(){dataLayer.push(arguments);}
15+
gtag('js', new Date());
16+
17+
gtag('config', 'G-LF9W695NNW');
18+
</script>
19+
<link rel="icon" href="./favicon.ico" type="image/x-icon" />
20+
<link type="text/css" rel="stylesheet" href="./css/common.css" media="all" />
21+
<script src="./js/jquery-3.7.1.min.js"></script>
22+
<script type="text/javascript" src="./js/common.js"></script>
23+
</head>
24+
<body>
25+
<div class="layout">
26+
<div class="menu">
27+
<h2 class="menu-title">SOCKET-MANAGER</h2>
28+
<h4 class="menu-reference menu-page-title-link"><a href="./reference/index.html" target="blank">&gt;&gt; Reference</a></h4>
29+
<h2 class="menu-label">MAIN-MENU</h2>
30+
<div class="menu-text">
31+
32+
<h3 class="menu-page-title-link"><a href="./index.html">▶フレームワークのご紹介</a></h3>
33+
34+
<h3 class="menu-page-title-link"><a href="./websocket.html">▶Websocket開発環境</a></h3>
35+
36+
<h3 class="menu-page-title-link"><a href="./new-project.html">▶新規プロジェクト開発環境</a></h3>
37+
38+
<h3 class="menu-page-title-link"><a href="./laravel.html">▶Laravelと連携する</a></h3>
39+
40+
<h3 class="menu-page-title-link"><a href="./architecture.html">▶アーキテクチャ</a></h3>
41+
42+
<h3 class="menu-page-title-link"><a href="./multi-server.html">▶マルチサーバーの構成</a></h3>
43+
44+
<h3 class="menu-page-title-link"><a href="./system-setting.html">▶システム設定ファイル</a></h3>
45+
46+
</div>
47+
<h2 class="menu-label">EXTRA-MENU</h2>
48+
<div class="menu-text">
49+
50+
<h3 class="menu-page-title-link"><a href="./extra-demo.html">▶デモサーバーの種類</a></h3>
51+
52+
<h3 class="menu-page-title-link"><a href="./extra-demo-command.html">▶デモのコマンド仕様</a></h3>
53+
54+
<h3 class="menu-page-title-link"><a href="./extra-demo-setting.html">▶デモの設定ファイル</a></h3>
55+
56+
<h3 class="menu-page-title-link"><a href="./extra-minecraft.html">▶マインクラフトの通信仕様</a></h3>
57+
58+
<h3 class="menu-page-title-link"><a href="./extra-close-frame.html">▶切断フレームの検証</a></h3>
59+
60+
</div>
61+
<div class="menu-line"></div>
62+
<div class="menu-text">
63+
64+
<h3 class="menu-page-title-link"><a href="./minecraft-contents/index.html">&gt;&gt; マインクラフトの環境</a></h3>
65+
66+
</div>
67+
<h2 class="menu-label">PHP-TECHNIQUE</h2>
68+
<div class="menu-text">
69+
70+
<h3 class="menu-page-title">▼参照渡し</h3>
71+
72+
<ul>
73+
<li><a href="./php-pass-by-reference.html#begin">はじめに</a></li>
74+
</ul>
75+
<ul>
76+
<li><a href="./php-pass-by-reference.html#address">「アドレス渡し」について</a></li>
77+
</ul>
78+
<ul>
79+
<li><a href="./php-pass-by-reference.html#compare">PHPとC言語との比較</a></li>
80+
</ul>
81+
<ul>
82+
<li><a href="./php-pass-by-reference.html#example">実装例</a></li>
83+
</ul>
84+
<ul>
85+
<li><a href="./php-pass-by-reference.html#last">おわりに</a></li>
86+
</ul>
87+
88+
</div>
89+
</div>
90+
<div class="main">
91+
92+
<h1>【参照渡し】</h1>
93+
94+
<a id="begin"></a>
95+
<h2 class="subtitle">はじめに</h2>
96+
97+
<div class="text-block">
98+
ここでは当フレームワークで使っているPHPの技術情報を中心に備忘録としてまとめています。<br />
99+
今回対象になる環境は<font><a href="./minecraft-contents/index.html" target="_blank">▶マインクラフトの環境</a></font>のページでご紹介している<code>contents-project</code>というプロジェクト環境です。<br />
100+
</div><br />
101+
102+
<a id="address"></a>
103+
<h2 class="subtitle">「アドレス渡し」について</h2>
104+
105+
<div class="text-block">
106+
「参照渡し」でよく使われるのは以下のようなパターンではないでしょうか。<br />
107+
<span>引数での「参照渡し」</span>
108+
<pre color-change="php">
109+
function testFunction(&$test)
110+
{
111+
＜ステートメント＞
112+
}
113+
</pre><br />
114+
115+
上記のように関数呼び出しでリターン値以外のデータを取得したい時によく使われる方法だと思います。<br />
116+
他にもクロージャーとのデータのやり取りをする場合にも使われる事がありますが、ここで注目すべきは<code>$test</code>という引数の先頭に<code>&</code>（アンパサンド）が付いているところです。<br /><br />
117+
118+
これはC言語でもよく使われる書き方で「アドレス渡し」と呼ばれています。<br />
119+
PHPとC言語ではコンパイラの処理に違いがあるので、PHP側の処理では「参照渡し」と呼ぶ事にします。<br />
120+
まずは「アドレス渡し」の考え方を理解しておいた方が早いと思いますので以下をご覧ください。<br /><br />
121+
122+
現実世界で例えるならば、仮に東京１００番地という住所に両親と子供を合わせて３人家族の山田さんの家があったとすると、この「東京１００番地」がメモリ上の配置を表していて、山田さんの家が変数の番地にあたります。<br />
123+
そして山田さんの家では最初３人が住んでいましたが、そのうち子供が出稼ぎに行くようになって両親の２人暮らしになったり、子供が結婚して実家に帰ってくる事で孫が増えたり人数が変化していく変数だと捉える事ができます。<br /><br />
124+
125+
これをメモリ上のイメージに例えると以下のようになります。<br />
126+
127+
<img src="./img/php-pass-by-reference/memory.png" /><br /><br />
128+
129+
ここでいう番地とはメモリ上の住所のようなもので、不変的であり、唯一無二のものですが山田さんの家（変数）の内容は常に変化します。<br />
130+
つまり「アドレス渡し」というのはこの唯一無二の番地の部分を渡している事になるので、変数のコピーを渡しているわけではなく、変数が格納されているメモリ上の実体を常に指し示す事になります。<br /><br />
131+
132+
C言語ではこのアドレスをポインタ変数というものに代入してアドレスそのものを変数として扱う事ができますが、PHPではこのポインタ変数というものが存在しません。PHPのマニュアルでもそう書かれています。<br />
133+
そして以下のようにも書かれていますがUnixシステムの事をご存じでない方もおられると思いますので、同じ場所を指し示すラベルのようなものだと考えてもらった方が分かり易いかもしれません。<br />
134+
<blockquote>
135+
リファレンスは、Unix ファイルシステムの ハードリンクのようなものであると考えられます。
136+
</blockquote>
137+
138+
つまりPHPでは変数の所在をラベルのようなもので表すのに対して、C言語では<code>&</code>（アンパサンド）を使ってアドレスを指し示す事が可能で、ポインタ変数を使ってそのアドレス自身を管理する事ができます。<br />
139+
</div><br />
140+
141+
<a id="compare"></a>
142+
<h2 class="subtitle">PHPとC言語との比較</h2>
143+
144+
<div class="text-block">
145+
以下ではPHPとC言語をソースで比較しながら見ていきます。<br />
146+
※ソース内の黄色の部分に着目してください。<br />
147+
148+
<span>PHPでの「参照渡し」の利用例</span>
149+
<pre color-change="php">
150+
$outside = null;
151+
152+
testFunction($outside);
153+
154+
printf("outside[%d]", $outside);
155+
156+
function testFunction(&$inside)
157+
{
158+
<font class="pre-yellow">$inside = 1;</font>
159+
160+
return;
161+
}
162+
</pre><br />
163+
164+
上記をフローで表すと以下のようになります。
165+
<dl>
166+
<dt>1)$outside変数に初期値としてnullを代入</dt>
167+
<dt>2)$outside変数を「参照渡し」でtestFunction関数の引数へ渡す</dt>
168+
<dt>3)testFunction関数内で$outside変数に１がセットされる</dt>
169+
<dt>4)１の値が標準出力へ出力される</dt>
170+
</dl>
171+
172+
<span>C言語での「アドレス渡し」の利用例</span>
173+
<pre color-change="php">
174+
void main(void)
175+
{
176+
char outside = null;
177+
178+
testFunction(&outside);
179+
180+
printf("outside[%d]", outside);
181+
182+
return;
183+
}
184+
void testFunction(char *inside)
185+
{
186+
<font class="pre-yellow">*inside = 1;</font>
187+
188+
return;
189+
}
190+
</pre><br />
191+
※C言語で<code>char</code>というのは１バイトのデータ型です。<br />
192+
※C言語で変数名の前に<code>*</code>（アスタリスク）をつけて宣言するとポインタ変数になります。また、宣言以外の処理中にアスタリスクをつけて参照するとそのアドレスが指し示す先のメモリ内容を参照できます。<br /><br />
193+
194+
上記をフローで表すと以下のようになります。
195+
<dl>
196+
<dt>1)outside変数に初期値としてnullを代入</dt>
197+
<dt>2)outside変数を「アドレス渡し」でtestFunction関数の引数へ渡す</dt>
198+
<dt>3)testFunction関数内でoutside変数に１がセットされる</dt>
199+
<dt>4)１の値が標準出力へ出力される</dt>
200+
</dl>
201+
202+
以上のように、処理の流れはいずれも同じですが変数の扱い方が異なっています。<br /><br />
203+
204+
PHPでの<code>$inside</code>変数は関数定義のところで<code>&</code>（アンパサンド）を付けて渡されていますが、関数内で値を設定する時は特別な記述をしているわけでもなく、普通に１が代入されています。<br />
205+
これに対してC言語での<code>inside</code>変数は関数へoutside変数を渡す時に<code>&</code>（アンパサンド）を付けて渡されていますが、関数内ではポインタ変数として処理されています。<br /><br />
206+
207+
つまり、C言語での「アドレス渡し」はポインタ変数として制御できるのでその変数をカウントアップ等で更新すればアドレスも変化しますし、<code>inside</code>変数以外のメモリ領域も自由に読み書きできます。<br />
208+
PHPではラベルのようなもので管理しているのでこれができません。<br />
209+
</div><br />
210+
211+
<a id="example"></a>
212+
<h2 class="subtitle">実装例</h2>
213+
214+
<div class="text-block">
215+
それではsocket-managerフレームワーク上での実装を見てみます。<br />
216+
今回対象にしているソースは以下です。<br />
217+
218+
<span>マインクラフトの相対座標の計算処理（app/UnitParameter/ParameterForMinecraft.php内）</span>
219+
<pre color-change="php">
220+
/**
221+
* 現在の座標からヨー角を考慮した相対座標を取得
222+
*
223+
* @param float &$p_x X座標
224+
* @param float &$p_y Y座標
225+
* @param float &$p_z Z座標
226+
* @param float $p_yrot ヨー角
227+
* @param float $p_r 半径
228+
*/
229+
public function getRelativeCoordinates(float &$p_x, float &$p_y, float &$p_z, float $p_yrot, float $p_r)
230+
{
231+
＜ステートメント＞
232+
}
233+
</pre><br />
234+
235+
この<code>ParameterForMinecraft</code>クラス内で実装している<code>getRelativeCoordinates</code>というグローバルメソッドがこれに当たります。<br />
236+
そしてこのメソッドを使っている箇所で以下のように実装しています。<br />
237+
238+
<span>座標計算メソッドの呼び出し側の処理（app/CommandUnits/CommandForMinecraft.php内）</span>
239+
<pre color-change="php">
240+
// 相対座標の取得
241+
$x = $rcv['data']['body']['player']['position']['x'];
242+
$y = $rcv['data']['body']['player']['position']['y'];
243+
$z = $rcv['data']['body']['player']['position']['z'];
244+
$yrot = $rcv['data']['body']['player']['yRot'];
245+
$p_param->getRelativeCoordinates($x, $y, $z, $yrot, 5);
246+
247+
// コマンド送信（座標計算の矢をスポーン）
248+
$cmd_data = $p_param->getCommandDataForStandArrowSpawn($rcv['data']['body']['player']['name'], $x, $y, $z);
249+
$data =
250+
[
251+
'data' => $cmd_data
252+
];
253+
$p_param->setSendStack($data);
254+
</pre><br />
255+
256+
ここではあらかじめ<code>$x</code>、<code>$y</code>、<code>$z</code>変数に退避した座標を<code>getRelativeCoordinates</code>メソッドに渡して座標計算しています。<br />
257+
XYZの座標の情報を配列等のオブジェクトとして戻り値で返す事もできますが、<code>getRelativeCoordinates</code>メソッドを通した後も<code>getCommandDataForStandArrowSpawn</code>メソッドをコールする時にXYZ座標の変数をそのまま使いたかったので「参照渡し」にしています。<br /><br />
258+
259+
※ここで言う「ヨー角」というのはマインクラフトワールド内での水平面の全方位を角度で表したものです。<br />
260+
</div><br />
261+
262+
<a id="last"></a>
263+
<h2 class="subtitle">おわりに</h2>
264+
265+
<div class="text-block">
266+
PHPマニュアルには色々書かれていますが、要はPHPではC言語のポインタ変数のようにアドレスやラベルそのものを操作できないという事を謳っているだけなので、その事さえ押さえておけば特に問題になる事はないでしょう。<br />
267+
「参照渡し」は上記で説明した以外にも使い道はありますが、それはまた別の機会でご紹介したいと思います。<br />
268+
</div>
269+
</div>
270+
</div>
271+
</body>
272+
</html>

0 commit comments

Comments
 (0)