Skip to content

Commit

Permalink
Guide ja (yiisoft#255)
Browse files Browse the repository at this point in the history
* docs/guide-ja updated [ci skip]

* guide-ja revised [ci skip]
  • Loading branch information
softark authored and SilverFire committed May 4, 2018
1 parent 8c06498 commit 9836aa0
Show file tree
Hide file tree
Showing 12 changed files with 33 additions and 20 deletions.
3 changes: 2 additions & 1 deletion docs/guide-ja/basic-usage.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
基本的な使用方法
================

一旦 MongoDB 接続インスタンスを取得すれば、[[yii\mongodb\Command]] を使って MongoDB のコマンドとクエリを実行することが出来ます。
一旦 MongoDB 接続インスタンスを取得すれば、
[[yii\mongodb\Command]] を使って MongoDB のコマンドとクエリを実行することが出来ます。

```php
// コマンドを実行する
Expand Down
4 changes: 3 additions & 1 deletion docs/guide-ja/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,14 @@
php composer.phar require --prefer-dist yiisoft/yii2-mongodb
```

または、あなたの `composer.json` ファイルの `require` セクションに、下記を追加してください。
または、あなたの `composer.json` ファイルの `require` セクションに、

```
"yiisoft/yii2-mongodb": "~2.1.0"
```

を追加してください。

## アプリケーションを構成する

このエクステンションを使用するために必要なことは、下記のコードをあなたのアプリケーション構成情報に追加することだけです。
Expand Down
3 changes: 2 additions & 1 deletion docs/guide-ja/topics-cache.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
キャッシュ・コンポーネントを使用する
====================================

`Cache` コンポーネントを使用するためには、[インストール](installation.md) の節で説明した接続の構成に加えて、`cache` コンポーネントを `yii\mongodb\Cache` として構成する必要があります。
`Cache` コンポーネントを使用するためには、[インストール](installation.md) の節で説明した接続の構成に加えて、
`cache` コンポーネントを `yii\mongodb\Cache` として構成する必要があります。

```php
return [
Expand Down
4 changes: 2 additions & 2 deletions docs/guide-ja/topics-gii.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
Gii ジェネレータを使用する
==========================

このエクステンションは、Yii の 'gii' モジュールと統合可能なコード¥ジェネレータを提供しています。
これによって、アクティブレコードのコードを生成することが出来ます。
このエクステンションは、Yii の 'gii' モジュールと統合可能なコード¥ジェネレータを提供しています。これによって、アクティブレコードのコードを生成することが出来ます。
ジェネレータを有効にするためには、アプリケーションの構成情報を次のように修正しなければなりません。

```php
Expand All @@ -24,3 +23,4 @@ return [

> Note: MongoDB はスキーマレスであるため、生成されるコードの基礎として使えるような情報が十分にはありません。
従って、生成されるコードは非常に基本的なものとなり、修正が必要であることは確実です。

7 changes: 4 additions & 3 deletions docs/guide-ja/topics-i18n-message-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ return [
];
```


[[\yii\mongodb\i18n\MongoDbMessageSource]] は全ての翻訳を保存するのに単一のコレクションを使用します。
このコレクションの全てのエントリは次の三つのフィールドを持っていなければなりません。

- language: 文字列、翻訳言語
- category: 文字列、翻訳カテゴリ名
- messages: 配列、実際のメッセージ翻訳の配列。各要素において、'message' キーは翻訳される生のメッセージ、`translation` キーは翻訳されたメッセージ。
- messages: 配列、実際のメッセージ翻訳の配列。各要素において、'message' キーは翻訳される生のメッセージ、
`translation` キーは翻訳されたメッセージ。

例えば、

Expand Down Expand Up @@ -65,4 +65,5 @@ return [

ただし、BSON のキーは `.``$` などの記号を含むことが出来ませんので、この手法は推奨されません。

構成と翻訳コレクションのデータ構造に関する詳細は [[\yii\mongodb\i18n\MongoDbMessageSource]] を参照してください。
構成と翻訳コレクションのデータ構造に関する詳細は [[\yii\mongodb\i18n\MongoDbMessageSource]]
を参照してください。
3 changes: 2 additions & 1 deletion docs/guide-ja/topics-logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ return [

> Note: コマンドとクエリに対して生成されるログ・メッセージは、実行されたクエリの実際のテキストは含みません。
それは、PHP MongoDB エクステンション・クラスから抽出可能な値から作成された **クエリの近似値** しか含みません。
実際のクエリのテキストを見る必要がある場合は、そのための専用のツールを使わなければなりません。
実際のクエリのテキストを見る必要がある場合は、
そのための専用のツールを使わなければなりません。

> Tip: ログ・メッセージの作成には、いくらかの時間とプログラム・リソースが必要であることを忘れないで下さい。
従って、実運用環境でロギングを無効にするのは、道理にかなったことです。
3 changes: 2 additions & 1 deletion docs/guide-ja/topics-session.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
セッション・コンポーネントを使用する
====================================

`Session` コンポーネントを使用するためには、[インストール](installation.md) の節で説明した接続の構成に加えて、`session` コンポーネントを `yii\mongodb\Session` として構成する必要があります。
`Session` コンポーネントを使用するためには、[インストール](installation.md) の節で説明した接続の構成に加えて、
`session` コンポーネントを `yii\mongodb\Session` として構成する必要があります。

```php
return [
Expand Down
3 changes: 2 additions & 1 deletion docs/guide-ja/usage-aggregation.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,8 @@ $authors = $collection->aggregate([
]);
```

パイプラインの仕様についての詳細は [MongoDB Aggregation Pipeline Docs](https://docs.mongodb.com/manual/core/aggregation-pipeline/) を参照して下さい。
パイプラインの仕様についての詳細は [MongoDB Aggregation Pipeline Docs](https://docs.mongodb.com/manual/core/aggregation-pipeline/)
を参照して下さい。


## [[\yii\mongodb\Query]] による Aggregation
Expand Down
5 changes: 3 additions & 2 deletions docs/guide-ja/usage-ar.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@ MongoDB のアクティブレコードを使用する
======================================

このエクステンションは [[\yii\db\ActiveRecord]] と同様なアクティブレコードのソリューションを提供します。
アクティブレコード・クラスを宣言するためには、[[\yii\mongodb\ActiveRecord]] から拡張して、`collectionName` と 'attributes' のメソッドを実装する必要があります。
アクティブレコード・クラスを宣言するためには、[[\yii\mongodb\ActiveRecord]] から拡張して、
`collectionName` と 'attributes' のメソッドを実装する必要があります。

```php
use yii\mongodb\ActiveRecord;
Expand All @@ -27,7 +28,7 @@ class Customer extends ActiveRecord
}
```

>Note|注意: コレクションのプライマリ・キーの名前 ('_id') は、常に属性の一つとしてセットアップしなければなりません。
>Note: コレクションのプライマリ・キーの名前 ('_id') は、常に属性の一つとしてセットアップしなければなりません。
[[\yii\mongodb\Query]] および [[\yii\mongodb\ActiveQuery]] によって [[\yii\data\ActiveDataProvider]] を使用することが出来ます。

Expand Down
6 changes: 3 additions & 3 deletions docs/guide-ja/usage-embedded-documents.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@
}
```

Yii のモデルは、属性がスカラ値であることを前提として設計されています。
検証や属性の処理は、この前提に基づいて実行されます。
Yii のモデルは、属性がスカラ値であることを前提として設計されています。検証や属性の処理は、この前提に基づいて実行されます。
もちろん、属性をどのような深さと複雑さを持つ配列にしても構いませんが、その検証はあなた自身が処理しなければなりません。

埋め込みドキュメントに対する明示的なサポートは有りませんが、明示的な制限もありません。
この機能に関しては、あなた自身のソリューションを作成することも出来ますし、[yii2tech/embedded](https://github.com/yii2tech/embedded) のようなサードパーティのエクステンションを使うことも出来ます。
この機能に関しては、あなた自身のソリューションを作成することも出来ますし、[yii2tech/embedded](https://github.com/yii2tech/embedded)
のようなサードパーティのエクステンションを使うことも出来ます。
3 changes: 2 additions & 1 deletion docs/guide-ja/usage-gridfs.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
GridFS を使用する
=================

このエクステンションは、名前空間 "\yii\mongodb\file" の下にある諸クラスによって [MongoGridFS](https://docs.mongodb.com/manual/core/gridfs/) をサポートしています。
このエクステンションは、名前空間 "\yii\mongodb\file" の下にある諸クラスによって
[MongoGridFS](https://docs.mongodb.com/manual/core/gridfs/) をサポートしています。
そこに GridFS のためのコレクション、クエリ、アクティブレコードのクラスがあります。

[[\yii\mongodb\file\Upload]] を使ってファイルをアップロードすることが出来ます。
Expand Down
9 changes: 6 additions & 3 deletions docs/guide-ja/usage-mongoid.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,13 @@ echo $this->createUrl(['item/update', 'id' => (string) $row['_id']]);
```

MongoDB に保存されるユーザ・アイデンティティを実装する場合にも、同じ事があてはまります。
認証プロセスが働くようにするためには、[[\yii\web\IdentityInterface::getId()]] を実装するときに [[\MongoDB\BSON\ObjectID]] クラスをスカラ値に型キャストしなければなりません。
認証プロセスが働くようにするためには、[[\yii\web\IdentityInterface::getId()]] を実装するときに
[[\MongoDB\BSON\ObjectID]] クラスをスカラ値に型キャストしなければなりません。

## スカラ値からドキュメント ID を取得する

検索条件を構築する際には、'_id' キーの値は、単純な文字列である場合でも、自動的に [[\MongoDB\BSON\ObjectID]] インスタンスにキャストされます。
検索条件を構築する際には、'_id' キーの値は、単純な文字列である場合でも、
自動的に [[\MongoDB\BSON\ObjectID]] インスタンスにキャストされます。
従って、文字列で表された '_id' をあなたがキャストして戻す必要はありません。

```php
Expand All @@ -50,4 +52,5 @@ class ItemController extends Controller
}
```

ただし、[[\MongoDB\BSON\ObjectID]] を含む他のカラムがある場合は、型キャストが必要になるかもしれない可能性について、あなた自身が面倒を見なければなりません。
ただし、[[\MongoDB\BSON\ObjectID]] を含む他のカラムがある場合は、型キャストが必要になるかもしれない可能性について、
あなた自身が面倒を見なければなりません。

0 comments on commit 9836aa0

Please sign in to comment.