diff --git a/docs/guide-ja/README.md b/docs/guide-ja/README.md index 9f9f7caa8..59bb51b37 100644 --- a/docs/guide-ja/README.md +++ b/docs/guide-ja/README.md @@ -14,6 +14,7 @@ Yii 2 Redis キャッシュ・セッション・アクティブレコード -------- * [アクティブレコードを使用する](usage-ar.md) +* [コマンドを直接に使用する](usage-commands.md) 追加のトピック ----------------- diff --git a/docs/guide-ja/topics-cache.md b/docs/guide-ja/topics-cache.md index f945cc587..6d334950c 100644 --- a/docs/guide-ja/topics-cache.md +++ b/docs/guide-ja/topics-cache.md @@ -1,7 +1,7 @@ キャッシュコンポーネントを使用する ================================== -`Cache` コンポーネントを使用するためには、[インストール](installation.md) で説明した接続の構成に加えて、`cache` コンポーネントを `yii\redis\Cache` として構成する必要があります。 +`Cache` コンポーネントを使用するためには、[インストール](installation.md) の節で説明した接続の構成に加えて、`cache` コンポーネントを `yii\redis\Cache` として構成する必要があります。 ```php return [ @@ -15,7 +15,7 @@ return [ ]; ``` -redis をキャッシュとしてのみ使用する場合は、接続のパラメータをキャッシュコンポーネントの中で構成しても構いません +redis をキャッシュとしてのみ使用する場合、すなわち、redis のアクティブレコードやセッションを使用しない場合は、接続のパラメータをキャッシュコンポーネントの中で構成しても構いません (この場合、接続のアプリケーションコンポーネントを構成する必要はありません)。 ```php diff --git a/docs/guide-ja/topics-session.md b/docs/guide-ja/topics-session.md index 37be5ab03..04e6c1ccd 100644 --- a/docs/guide-ja/topics-session.md +++ b/docs/guide-ja/topics-session.md @@ -1,7 +1,7 @@ セッションコンポーネントを使用する ================================== -`Session` コンポーネントを使用するためには、[インストール](installation.md) で説明した接続の構成に加えて、`session` コンポーネントを `yii\redis\Session` として構成する必要があります。 +`Session` コンポーネントを使用するためには、[インストール](installation.md) の節で説明した接続の構成に加えて、`session` コンポーネントを `yii\redis\Session` として構成する必要があります。 ```php return [ @@ -15,7 +15,7 @@ return [ ]; ``` -redis をセッションとしてのみ使用する場合は、接続のパラメータをセッションコンポーネントの中で構成しても構いません +redis をセッションとしてのみ使用する場合、すなわち、redis のアクティブレコードやキャッシュは使わない場合は、接続のパラメータをセッションコンポーネントの中で構成しても構いません (この場合、接続のアプリケーションコンポーネントを構成する必要はありません)。 ```php diff --git a/docs/guide-ja/usage-ar.md b/docs/guide-ja/usage-ar.md index e87f1dbc6..b31ab3fad 100644 --- a/docs/guide-ja/usage-ar.md +++ b/docs/guide-ja/usage-ar.md @@ -3,9 +3,9 @@ Yii のアクティブレコードの使用方法に関する一般的な情報については、[ガイド](https://github.com/yiisoft/yii2/blob/master/docs/guide-ja/db-active-record.md) を参照してください。 -redis の アクティブレコードクラスを定義するためには、[[yii\redis\ActiveRecord]] から拡張して、少なくとも、`attributes()` メソッドを実装して、レコードの属性を定義する必要があります。 +redis の アクティブレコードクラスを定義するためには、[[yii\redis\ActiveRecord]] から拡張して、最低限、レコードの属性を定義する `attributes()` メソッドを実装する必要があります。 プライマリキーは [[yii\redis\ActiveRecord::primaryKey()]] によって定義することが出来ますが、指定されない場合のデフォルト値は `id` となります。 -プライマリキーは属性の中に含まれていなければなりませんので、独自のプライマリキーを指定しない場合は、`id` という属性を定義することを忘れないようにしなければなりません。 +この primaryKey は属性の中に含まれていなければなりませんので、独自のプライマリキーを指定しない場合は、`id` という属性を定義することを忘れないようにしなければなりません。 下記は `Customer` と呼ばれるモデルの例です。 diff --git a/docs/guide-ja/usage-commands.md b/docs/guide-ja/usage-commands.md new file mode 100644 index 000000000..3fa8b40e4 --- /dev/null +++ b/docs/guide-ja/usage-commands.md @@ -0,0 +1,24 @@ +コマンドを直接に使用する +======================== + +Redis は、接続から直接に使用することが出来る数多くの有用なコマンドを持っています。 +[インストール](installation.md) で示されたようにアプリケーションを構成した後は、redis の接続を次のようにして取得することが出来ます。 + +```php +$redis = Yii::$app->redis; +``` + +このようにした後、コマンドを実行することが出来ます。 +最も汎用的な方法は、`executeCommand` メソッドを使用することです。 + +```php +$result = $redis->executeCommand('hmset', ['test_collection', 'key1', 'val1', 'key2', 'val2']); +``` + +サポートされているコマンドのそれぞれに対してショートカットが利用できますので、上記の代りに次のようにすることも出来ます。 + +```php +$result = $redis->hmset(['test_collection', 'key1', 'val1', 'key2', 'val2']); +``` + +利用できるコマンドとそのパラメータについては、[http://redis.io/commands](http://redis.io/commands) のリストを参照してください。