Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
Y
yii2
Project
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
PSDI Army
yii2
Commits
ac575076
Commit
ac575076
authored
Nov 10, 2014
by
Nobuo Kihara
Committed by
Nobuo Kihara
Nov 10, 2014
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
docs/guide-ja/structure-widgets.md - WIP [ci skip]
parent
ec266a0d
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
37 additions
and
35 deletions
+37
-35
structure-widgets.md
docs/guide-ja/structure-widgets.md
+37
-35
No files found.
docs/guide-ja/structure-widgets.md
View file @
ac575076
...
@@ -41,11 +41,11 @@ use yii\jui\DatePicker;
...
@@ -41,11 +41,11 @@ use yii\jui\DatePicker;
])
?>
])
?>
```
```
Some widgets can take a block of content which should be enclosed between the invocation of
ウィジェットの中には、コンテントのブロックを受け取ることが出来るものもあります。その場合、コンテントのブロックは
[
[yii\base\Widget::begin()
]
]
and
[
[yii\base\Widget::end()
]
]. For example, the following code uses the
[
[yii\base\Widget::begin()
]
]
と
[
[yii\base\Widget::end()
]
] の呼び出しの間に包むようにしなければなりません。
[
[yii\widgets\ActiveForm
]
] widget to generate a login form. The widget will generate the opening and closing
例えば、次のコードは
[
[yii\widgets\ActiveForm
]
] ウィジェットを使ってログインフォームを生成するものです。
`<form>`
tags at the place where
`begin()`
and
`end()`
are called, respectively. Anything in between will be
このウィジェットは、
`begin()`
と
`end()`
が呼ばれる場所で、それぞれ、開始と終了の
`<form>`
タグを生成します。
rendered as is.
その間に置かれたものは全てそのままレンダリングされます。
```
php
```
php
<?php
<?php
...
@@ -60,25 +60,26 @@ use yii\helpers\Html;
...
@@ -60,25 +60,26 @@ use yii\helpers\Html;
<?=
$form
->
field
(
$model
,
'password'
)
->
passwordInput
()
?>
<?=
$form
->
field
(
$model
,
'password'
)
->
passwordInput
()
?>
<div
class=
"form-group"
>
<div
class=
"form-group"
>
<?=
Html
::
submitButton
(
'
Login
'
)
?>
<?=
Html
::
submitButton
(
'
ログイン
'
)
?>
</div>
</div>
<?php
ActiveForm
::
end
();
?>
<?php
ActiveForm
::
end
();
?>
```
```
Note that unlike
[
[yii\base\Widget::widget()
]
] which returns the rendering result of a widget, the method
[
[yii\base\Widget::widget()
]
] がウィジェットのレンダリング結果を返すのとは違って、
[
[yii\base\Widget::begin()
]
] メソッドが
[
[yii\base\Widget::begin()
]
] returns an instance of the widget which you can use to build the widget content.
ウィジェットのインスタンスを返すことに注意してください。返されたウィジェットのインスタンスを使って、ウィジェットのコンテントを
構築することが出来ます。
##
Creating Widgets
<a name="creating-widgets"></a>
##
ウィジェットを作成する
<a name="creating-widgets"></a>
To create a widget, extend from
[
[yii\base\Widget
]
] and override the
[
[yii\base\Widget::init()
]
] and/or
ウィジェットを作成するためには、
[
[yii\base\Widget
]
] を拡張して、
[
[yii\base\Widget::init()
]
] および/または
[
[yii\base\Widget::run()
]
]
[
[yii\base\Widget::run()
]
] methods. Usually, the
`init()`
method should contain the code that normalizes the widget
メソッドをオーバーライドします。通常、
`init()`
メソッドはウィジェットのプロパティを正規化するコードを含むべきものであり、
properties, while the
`run()`
method should contain the code that generates the rendering result of the widget.
`run()`
メソッドはウィジェットのレンダリング結果を生成するコードを含むべきものです。レンダリング結果は、直接に "echo"
The rendering result may be directly "echoed" or returned as a string by
`run()`
.
しても、
`run()`
の返り値として文字列として返しても構いません。
In the following example,
`HelloWidget`
HTML-encodes and displays the content assigned to its
`message`
property.
次の例では、
`HelloWidget`
が
`message`
プロパティとして割り当てられたコンテントを HTML エンコードして表示します。
If the property is not set, it will display "Hello World" by default.
プロパティがセットされていない場合は、デフォルトとして "Hello World" を表示します。
```
php
```
php
namespace
app\components
;
namespace
app\components
;
...
@@ -105,17 +106,17 @@ class HelloWidget extends Widget
...
@@ -105,17 +106,17 @@ class HelloWidget extends Widget
}
}
```
```
To use this widget, simply insert the following code in a view:
このウィジェットを使うために必要なことは、次のコードをビューに挿入するだけのことです。
```
php
```
php
<?php
<?php
use
app\components\HelloWidget
;
use
app\components\HelloWidget
;
?>
?>
<?=
HelloWidget
::
widget
([
'message'
=>
'
Good morning
'
])
?>
<?=
HelloWidget
::
widget
([
'message'
=>
'
おはよう
'
])
?>
```
```
Below is a variant of
`HelloWidget`
which takes the content enclosed within the
`begin()`
and
`end()`
calls,
下記は
`HelloWidget`
の変種で、
`begin()`
と
`end()`
の間に包まれたコンテントを受け取り、それを
HTML
-encodes it and then displays it.
HTML
エンコードして表示するものです。
```
php
```
php
namespace
app\components
;
namespace
app\components
;
...
@@ -139,14 +140,14 @@ class HelloWidget extends Widget
...
@@ -139,14 +140,14 @@ class HelloWidget extends Widget
}
}
```
```
As you can see, PHP output buffer is started in
`init()`
so that any output between the calls of
`init()`
and
`run()`
ご覧のように、
`init()`
の中で PHP の出力バッファが開始され、
`init()`
と
`run()`
の呼び出しの間の全ての出力がキャプチャされ、
can be captured, processed and returned in
`run()`
.
`run()`
の中で処理されて返されます。
> Info
: When you call [[yii\base\Widget::begin()]], a new instance of the widget will be created and the `init()` method
> Info
|情報: [[yii\base\Widget::begin()]] を呼ぶと、ウィジェットの新しいインスタンスが作成され、ウィジェットのコンストラクタの
will be called at the end of the widget constructor. When you call
[
[yii\base\Widget::end()
]
], the
`run()`
method
最後で
`init()`
メソッドが呼ばれます。
[
[yii\base\Widget::end()
]
] を呼ぶと、
`run()`
メソッドが呼ばれて、その返り値が
`end()`
will be called whose return result will be echoed by
`end()`
.
によって echo されます。
The following code shows how to use this new variant of
`HelloWidget`
:
次のコードは、この
`HelloWidget`
の新しい変種をどのように使うかを示すものです
:
```
php
```
php
<?php
<?php
...
@@ -154,14 +155,14 @@ use app\components\HelloWidget;
...
@@ -154,14 +155,14 @@ use app\components\HelloWidget;
?>
?>
<?php
HelloWidget
::
begin
();
?>
<?php
HelloWidget
::
begin
();
?>
content that may contain
<tag>
's
... タグを含みうるコンテント ...
<?php
HelloWidget
::
end
();
?>
<?php
HelloWidget
::
end
();
?>
```
```
Sometimes, a widget may need to render a big chunk of content. While you can embed the content within the
`run()`
場合によっては、ウィジェットが大きな固まりのコンテントを表示する必要があるかもしれません。コンテントを
`run()`
method, a better approach is to put it in a
[
view
](
structure-views.md
)
and call
[
[yii\base\Widget::render()
]
] to
メソッドの中に埋め込むことも出来ますが、より良い方法は、コンテントを
[
ビュー
](
structure-views.md
)
の中に置いて、
render it. For example,
[
[yii\base\Widget::render()
]
] を呼んでレンダリングすることです。例えば、
```
php
```
php
public
function
run
()
public
function
run
()
...
@@ -170,15 +171,16 @@ public function run()
...
@@ -170,15 +171,16 @@ public function run()
}
}
```
```
By default, views for a widget should be stored in files in the
`WidgetPath/views`
directory, where
`WidgetPath`
既定では、ウィジェット用のビューは
`WidgetPath/views`
ディレクトリの中のファイルに保存すべきものです。ここで
stands for the directory containing the widget class file. Therefore, the above example will render the view file
`WidgetPath`
はウィジェットのクラスファイルを含むディレクトリを指します。したがって、上記の例では、ウィジェットクラスが
`@app/components/views/hello.php`
, assuming the widget class is located under
`@app/components`
. You may override
`@app/components`
に配置されていると仮定すると、
`@app/components/views/hello.php`
というビューファイルがレンダリングされる
the
[
[yii\base\Widget::getViewPath()
]
] method to customize the directory containing the widget view files.
ことになります。
[
[yii\base\Widget::getViewPath()
]
] メソッドをオーバーライドして、ウィジェットのビューファイルを含むディレクトリを
カスタマイズすることが出来ます。
##
Best Practices
<a name="best-practices"></a>
##
最善の慣行
<a name="best-practices"></a>
Widgets are an object-oriented way of reusing view code.
ウィジェットはビューのコードを再利用するためのオブジェクト指向の方法です。
When creating widgets, you should still follow the MVC pattern. In general, you should keep logic in widget
When creating widgets, you should still follow the MVC pattern. In general, you should keep logic in widget
classes and keep presentation in
[
views
](
structure-views.md
)
.
classes and keep presentation in
[
views
](
structure-views.md
)
.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment