forked from NEKOGET/FuelPHP_docs_jp
-
Notifications
You must be signed in to change notification settings - Fork 0
/
module.html
262 lines (245 loc) · 8.03 KB
/
module.html
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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
<!doctype html>
<html lang="ja">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" href="./../assets/css/combined.css">
<link rel="shortcut icon" href="./../favicon.ico" />
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
var path = './../';
var class_prefix = "Module::";
</script>
<script src="./../assets/js/combined.js"></script>
<title>Module - クラス - FuelPHP ドキュメント</title>
</head>
<body>
<div id="container">
<header id="header">
<div class="table">
<h1>
<a href="http://fuelphp.com"><img height="37px" width="147px" src="./../assets/img/fuel.png" /></a>
<strong>Documentation</strong>
</h1>
<form id="google_search">
<p>
<span id="search_clear"> </span>
<input type="submit" name="search_submit" id="search_submit" value="検索" />
<input type="text" value="" id="search_input" name="search_input" />
</p>
</form>
</div>
<nav>
<div class="clear"></div>
</nav>
<a href="#" id="toc_handle">目次</a>
<div class="clear"></div>
</header>
<div id="cse">
<div id="cse_point"></div>
<div id="cse_content"></div>
</div>
<div id="main">
<h2>Module クラス</h2>
<p><kbd>Module</kbd> クラスを使用すると、簡単にモジュールの読み込みや開放、読み込まれているモジュールが存在するかどうかの確認、読み込まれている全てのモジュールリストの取得を行うことができます。</p>
<article>
<h4 class="method" id="method_load">load($module, $path = null)</h4>
<p><strong>load</strong> メソッドを使用すると、実行時に 1 つ以上のモジュールを読み込むことができます。もしもそのモジュールが見つからなかった場合には、例外 <kbd>ModuleNotFoundException</kbd> を発生させます。</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$module</kbd></th>
<td><i>必須</i></td>
<td>読み込みを行うモジュールの名前、またはモジュールの配列。</td>
</tr>
<tr>
<th><kbd>$path</kbd></th>
<td><code>null</code></td>
<td>モジュールへのパス。これを使うと定義されたモジュールパス外にあるモジュールの読み込みを行うことができます。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td><i>void</i></td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// users モジュールの読み込み
Module::load('users');
// 特定のディレクトリにある users モジュールの読み込み
Module::load('users', '/path/to/modules/users/');
// 1 度に複数のモジュールの読み込みを行う
Module::load( array('Users' => '/path/to/modules/users/', 'Groups' => '/path/to/modules/groups/') );
// 存在しないモジュールの読み込み
Module::load('awesome'); // 例外 ModuleNotFoundException が発生する
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_unload">unload($module)</h4>
<p><strong>unload</strong> メソッドを使用すると、実行時にモジュールの開放を行うことができます。</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$module</kbd></th>
<td><i>必須</i></td>
<td>開放を行うモジュールの名前。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td><i>void</i></td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// users モジュールの開放
Module::unload('users');
</code></pre>
</td>
</tr>
</tbody>
</table>
<p class="note">これは、ロードされたとき (routes.php ファイルに) モジュールで定義された場所の、すべてのルートを削除 (しようと努力) します！</p>
</article>
<article>
<h4 class="method" id="method_loaded">loaded($module = null)</h4>
<p><strong>loaded</strong> メソッドを使用すると、そのモジュールが現在読み込まれているかどうかを確認することができます。存在しないモジュールの名前を指定された場合には、読み込まれている全てのモジュールが返されます。</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$module</kbd></th>
<td><kbd>null</kbd></td>
<td>確認したいモジュールの名前。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td><kbd>bool|array</kbd></td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// users モジュールが読み込まれているかどうかの確認
$loaded = Module::loaded('users');
// 読み込まれている全てのモジュールを取得する
$loaded = Module::loaded();
/*
以下のような返り値を得ることができます :
array(
'users' => '/path/to/users',
'groups' => '/path/to/groups',
)
*/
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_exists">exists($module)</h4>
<p>
<strong>exists</strong> メソッドを使用すると、モジュールが存在するかどうかを確認することができます。
例えば、設定されたモジュールのパスが 1 つでも存在した場合にはそのパスを、存在しなかった場合には <strong>false</strong> を返すことができます。
</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$module</kbd></th>
<td><kbd>null</kbd></td>
<td>確認したいモジュールの名前。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td><kbd>bool|string</kbd></td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// 必要に応じて comments モジュールを読み込む
if (Module::exists('comments'))
{
Module::load('comments');
}
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
</div>
<footer>
<p>
© FuelPHP Development Team 2010-2016 - <a href="http://fuelphp.com">FuelPHP</a> is released under the MIT license.
[ <a href="https://github.com/fuel/docs/commits/1.8/develop/classes/module.html">原文コミット履歴</a> | <a href="https://github.com/NEKOGET/FuelPHP_docs_jp/commits/1.8/develop_japanese/classes/module.html">翻訳コミット履歴</a> | <a href="https://github.com/NEKOGET/FuelPHP_docs_jp/blob/1.8/develop_japanese/classes/module.html">GitHubで修正</a> ]
</p>
</footer>
</div>
</body>
</html>