Browse Source

Fix typos in documentation, update Japanese translation (#17551) [skip ci]

tags/2.0.27
Nobuo Kihara 5 years ago committed by Alexander Makarov
parent
commit
4a9c82f9ab
  1. 30
      docs/guide-ja/db-migrations.md
  2. 1
      docs/guide-ja/helper-array.md
  3. 4
      docs/guide-ja/input-file-upload.md
  4. 38
      docs/guide-ja/runtime-sessions-cookies.md
  5. 10
      docs/guide-ja/security-best-practices.md
  6. 8
      docs/guide-ja/structure-assets.md
  7. 3
      docs/guide-ja/structure-modules.md
  8. 2
      docs/guide-ja/test-fixtures.md
  9. 4
      docs/guide-ja/tutorial-console.md
  10. 4
      docs/guide/runtime-sessions-cookies.md
  11. 2
      docs/guide/security-best-practices.md

30
docs/guide-ja/db-migrations.md

@ -690,6 +690,7 @@ class m150101_185401_create_news_table extends Migration
* [[yii\db\Migration::insert()|insert()]]: 一行を挿入
* [[yii\db\Migration::batchInsert()|batchInsert()]]: 複数行を挿入
* [[yii\db\Migration::update()|update()]]: 行を更新
* [[yii\db\Migration::upsert()|upsert()]]: 一行を挿入または既に存在していれば更新 (2.0.14 以降)
* [[yii\db\Migration::delete()|delete()]]: 行を削除
* [[yii\db\Migration::createTable()|createTable()]]: テーブルを作成
* [[yii\db\Migration::renameTable()|renameTable()]]: テーブルの名前を変更
@ -722,7 +723,6 @@ class m150101_185401_create_news_table extends Migration
> }
> ```
## マイグレーションを適用する <span id="applying-migrations"></span>
データベースを最新の構造にアップグレードするためには、利用できる全ての新しいマイグレーションを適用するために、次のコマンドを使わなければなりません。
@ -943,7 +943,7 @@ return [
適切にエスケープしなければならないことに注意して下さい。例えば、
```
yii migrate/create 'app\\migrations\\createUserTable'
yii migrate/create app\\migrations\\createUserTable
```
> Note: [[yii\console\controllers\MigrateController::migrationPath|migrationPath]] によって指定されたマイグレーションは、
@ -956,6 +956,32 @@ yii migrate/create 'app\\migrations\\createUserTable'
これらのマイグレーションは、主として、他の開発者による Yii エクステンションなど、外部ソースに由来するものであり、
新しい手法を使い始めようとしても、名前空間を使うように変更することが簡単には出来ないものだからです。
#### 名前空間を持つマイグレーションを生成する
名前空間を持つマイグレーションは "CamelCase" の命名規則 `M<YYMMDDHHMMSS><Name>` (例えば `M190720100234CreateUserTable`) を持ちます。
このようなマイグレーションを生成するときは、テーブル名が "CamenCase" 形式から "アンダースコア" 形式に変換されることを
覚えておいて下さい。例えば、
```
yii migrate/create app\\migrations\\DropGreenHotelTable
```
上記のコマンドは、名前空間 `app\migrations` の中で、`green_hotel` というテーブルを削除するマイグレーションを生成します。そして、
```
yii migrate/create app\\migrations\\CreateBANANATable
```
というコマンドは、名前空間 `app\migrations` の中で `b_a_n_a_n_a` というテーブルを作成するマイグレーションを生成します。
テーブル名が大文字と小文字を含む(例えば `studentsExam`) ときは、名前の先頭にアンダースコアを付ける必要があります。
```
yii migrate/create app\\migrations\\Create_studentsExamTable
```
このコマンドは、名前空間 `app\migrations` の中で `studentsExam` というテーブルを作成するマイグレーションを生成します。
### 分離されたマイグレーション <span id="separated-migrations"></span>
プロジェクトのマイグレーション全体に単一のマイグレーション履歴を使用することが望ましくない場合もあります。

1
docs/guide-ja/helper-array.md

@ -312,6 +312,7 @@ ArrayHelper::multisort($data, ['age', 'name'], [SORT_ASC, SORT_DESC]);
```php
ArrayHelper::multisort($data, function($item) {
// 存在していれば 'age' で、さもなくば 'name' でソート
return isset($item['age']) ? ['age', 'name'] : 'name';
});
```

4
docs/guide-ja/input-file-upload.md

@ -160,8 +160,8 @@ class UploadForm extends Model
}
```
ビュー・ファイルでは、`fileInput()` の呼び出しに `multiple` オプションを追加して、
ファイル・アップロードのフィールドが複数のファイルを受け取ることが出来るようにしなければなりません
ビュー・ファイルでは、`fileInput()` の呼び出しに `multiple` オプションを追加して、ファイル・アップロードのフィールドが複数のファイルを受け取ることが出来るようにしなければなりません。
また、`imageFiles` を `imageFiles[]` に変更して、属性の値が配列として送信されるようにする必要があります
```php
<?php

38
docs/guide-ja/runtime-sessions-cookies.md

@ -332,11 +332,6 @@ unset($cookies['language']);
他のプロパティを定義して、利用可能なクッキー情報の全てを完全に表しています。
クッキーを準備するときに必要に応じてこれらのプロパティを構成してから、レスポンスのクッキー・コレクションに追加することが出来ます。
> Note: セキュリティを向上させるために、[[yii\web\Cookie::httpOnly]] のデフォルト値は `true` に設定されています。
これは、クライアント・サイド・スクリプトが保護されたクッキーにアクセスする危険を軽減するものです (ブラウザがサポートしていれば)。
詳細については、[httpOnly wiki article](https://www.owasp.org/index.php/HttpOnly) を読んでください。
### クッキー検証 <span id="cookie-validation"></span>
最後の二つの項で示されているように、`request` と `response` のコンポーネントを通じてクッキーを読んだり送信したりする場合には、
@ -369,3 +364,36 @@ return [
> Info: [[yii\web\Request::cookieValidationKey|cookieValidationKey]] は、あなたのアプリケーションにとって、決定的に重要なものです。
これは信頼する人にだけ教えるべきものです。バージョン・コントロール・システムに保存してはいけません。
## セキュリティの設定
[[yii\web\Cookie]] と [[yii\web\Session]] の両者は下記のセキュリティ・フラグをサポートしています。
### httpOnly
セキュリティを向上させるために、[[yii\web\Cookie::httpOnly]] および [[yii\web\Session::cookieParams]] の 'httponly' パラメータの
デフォルト値は `true` に設定されています。
これによって、クライアント・サイド・スクリプトが保護されたクッキーにアクセスする危険が軽減されます (ブラウザがサポートしていれば)。
詳細については、[httpOnly の wiki 記事](https://www.owasp.org/index.php/HttpOnly) を読んでください。
### secure
secure フラグの目的は、クッキーが平文で送信されることを防止することです。ブラウザが secure フラグをサポートしている場合、
リクエストが secure な接続 (TLS) によって送信される場合にのみクッキーがリクエストに含まれます。
詳細については [Secure フラグの wiki 記事](https://www.owasp.org/index.php/SecureFlag) を参照して下さい。
### sameSite
Yii 2.0.21 以降、[[yii\web\Cookie::sameSite]] 設定がサポートされています。これは PHP バージョン 7.3.0 以降を必要とします。
`sameSite` 設定の目的は CSRF (Cross-Site Request Forgery) 攻撃を防止することです。
ブラウザが `sameSite` 設定をサポートしている場合、指定されたポリシー ('Lax' または 'Strict') に従うクッキーだけが送信されます。
詳細については [SameSite の wiki 記事](https://www.owasp.org/index.php/SameSite) を参照して下さい。
更なるセキュリティ強化のために、`sameSite` がサポートされていない PHP のバージョンで使われた場合には例外が投げられます。
この機能を PHP のバージョンに関わりなく使用する場合は、最初にバージョンをチェックして下さい。例えば、
```php
[
'sameSite' => PHP_VERSION_ID >= 70300 ? yii\web\Cookie::SAME_SITE_LAX : null,
]
```
> Note: 今はまだ `sameSite` 設定をサポートしていないブラウザもありますので、
[追加の CSRF 保護](security-best-practices.md#avoiding-csrf) を行うことを強く推奨します。

10
docs/guide-ja/security-best-practices.md

@ -253,9 +253,15 @@ class ContactAction extends Action
> Warning: CSRF を無効化すると、あらゆるサイトから POST リクエストをあなたのサイトに送信することが出来るようになります。その場合には、IP アドレスや秘密のトークンをチェックするなど、追加の検証を実装することが重要です。
> Note: バージョン 2.0.21 以降、Yii は `sameSite` クッキー設定 (PHP バージョン 7.3.0 以上が必要) をサポートしています。
ただし、`sameSite` クッキー設定を行えば、上記の CSRF 対策が不要になるということではありません。何故なら、今はまだ全てのブラウザがこの設定をサポートしている訳ではないからです。
詳細については [セッションとクッキー - sameSite オプション](runtime-sessions-cookies.md#samesite) を参照して下さい。
このトピックについて更に読むべき文書:
- <https://www.owasp.org/index.php/CSRF>
- <https://www.owasp.org/index.php/SameSite>
ファイルの曝露を回避する
------------------------
@ -300,6 +306,10 @@ H5BP プロジェクトが提供する構成例を参考にすることも出来
- [IIS](https://github.com/h5bp/server-configs-iis).
- [Lighttpd](https://github.com/h5bp/server-configs-lighttpd).
> Note: TLS が構成されているときは、(セッションの)クッキーを TLS のみで送信することが推奨されます。
これは、セッション および/または クッキーのの `secure` フラグを設定することで達成されます。
詳細は [セッションとクッキー - secure フラグ](runtime-sessions-cookies.md#secure) を参照して下さい。
サーバの構成をセキュアにする
----------------------------

8
docs/guide-ja/structure-assets.md

@ -266,9 +266,11 @@ Yii を使ってこれらのアセットを発行したい場合は、プロジ
```json
"config": {
"asset-installer-paths": {
"npm-asset-library": "vendor/npm",
"bower-asset-library": "vendor/bower"
"fxp-asset": {
"installer-paths": {
"npm-asset-library": "vendor/npm",
"bower-asset-library": "vendor/bower"
}
}
}
```

3
docs/guide-ja/structure-modules.md

@ -160,6 +160,9 @@ yii <module_id>/<command>/<sub_command>
]
```
> Info: モジュール内のコマンドを使用するためには、
> モジュールを [コンソール・アプリケーション設定](tutorial-console.md#configuration) にも含める必要があります。
[[yii\base\Application::modules|modules]] プロパティは、モジュールの構成情報の配列を取ります。
各配列のキーは、アプリケーションの全てのモジュールの中でそのモジュールを特定するためのユニークな *モジュール ID* を表します。
そして、対応する配列の値は、そのモジュールを作成するための [構成情報](concept-configurations.md) です。

2
docs/guide-ja/test-fixtures.md

@ -154,7 +154,7 @@ class UserProfileTest extends \Codeception\Test\Unit
そうすると、テスト・メソッドの中でエイリアスを使ってフィクスチャ・オブジェクトにアクセスすることが出来るようになります。例えば、
```php
$profile = $I->grabFixture('profiles', 'user1');
$profile = $I->grabFixture('profiles');
```
`UserProfileFixture` オブジェクトを返します。

4
docs/guide-ja/tutorial-console.md

@ -36,9 +36,11 @@
コンソールのコントローラ・アクションは次の構文を使って実行します。
```
yii <route> [--option1=value1 --option2=value2 ... argument1 argument2 ...]
yii <route> [--option1=value1 ... argument1 argument2 ... --option2=value2]
```
オプションはどの位置で指定しても構いません。
上記において、`<route>` はコントローラ・アクションへのルートを示すものです。
オプション (options) はクラスのプロパティに代入され、引数 (arguments) はアクション・メソッドのパラメータとなります。

4
docs/guide/runtime-sessions-cookies.md

@ -377,11 +377,13 @@ the protected cookie (if the browser supports it).
You may read the [HttpOnly wiki article](https://www.owasp.org/index.php/HttpOnly) for more details.
### secure
The purpose of the secure flag is to prevent cookies from being send in clear text. If the browser supports the
The purpose of the secure flag is to prevent cookies from being sent in clear text. If the browser supports the
secure flag it will only include the cookie when the request is sent over a secure (TLS) connection.
You may read the [SecureFlag wiki article](https://www.owasp.org/index.php/SecureFlag) for more details.
### sameSite
Starting with Yii 2.0.21 the [[yii\web\Cookie::sameSite]] setting is supported. It requires PHP version 7.3.0 or higher.
The purpose of the `sameSite` setting is to prevent CSRF (Cross-Site Request Forgery) attacks.
If the browser supports the `sameSite` setting it will only include the cookie according to the specified policy ('Lax' or 'Strict').

2
docs/guide/security-best-practices.md

@ -306,7 +306,7 @@ provided by the H5BP project:
- [IIS](https://github.com/h5bp/server-configs-iis).
- [Lighttpd](https://github.com/h5bp/server-configs-lighttpd).
> Note: When TLS is configured it is recommended that (session) cookies are send over TLS exclusively.
> Note: When TLS is configured it is recommended that (session) cookies are sent over TLS exclusively.
This is achieved by setting the `secure` flag for sessions and/or cookies.
See the [Sessions and Cookies secure flag](runtime-sessions-cookies.md#secure) for more information.

Loading…
Cancel
Save