Demos · Guide · Class Reference · Wiki · Extensions · Forum · Live Chat · Login

The Definitive Guide to Yii

Language & version

エクステンションを使う

アプリケーションコンポーネント
ウィジェット
アクション
フィルタ
コントローラ
バリデータ
コンソールコマンド
モジュール
一般的なコンポーネント

エクステンションを使うには、通常、次の3つのステップが必要です:

Yii's extension repository より、エクステンションをダウンロードします。
エクステンションをアプリケーションベースディレクトリのサブディレクトリである extensions/xyz 以下に解凍します。 xyz にはエクステンション名が入ります。
インポート、初期構成を行い、エクステンションを使用します。

各エクステンションはユニークで全てのエクステンション中でそれを特定するための名前を持ちます。エクステンション名を xyz にした場合、xyz のすべてのファイルを含むベースディレクトリを示す、application.extensions.xyz というパスエイリアスをいつでも使用できます。

異なるエクステンションは、インポート、初期構成、使用方法に関する異なる要件があります。以下では、エクステンションに関して、概要で記述したカテゴリに従い、一般的な使用方法のシナリオをまとめます。

1. アプリケーションコンポーネント ¶

アプリケーションコンポーネントを使用するために、最初にアプリケーション初期構成へ、 components プロパティを以下のように追加する必要があります:

return array(
    // 'preload'=>array('xyz',...),
    'components'=>array(
        'xyz'=>array(
            'class'=>'application.extensions.xyz.XyzClass',
            'property1'=>'value1',
            'property2'=>'value2',
        ),
        // 他のコンポーネント初期構成
    ),
);

その後に、どこでも Yii::app()->xyz を使って、コンポーネントにアクセスできます。コンポーネントは preload プロパティにリストしない限り、初めてアクセスした時に生成されます。

2. ウィジェット ¶

ウィジェットは主にビュー中で使用されます。ウィジットクラス XyzClass が 'xyz' エクステンションに属している場合、ビュー中で下記のように使用できます。

// 本文（body content）を必要としないウィジェット
<?php $this->widget('application.extensions.xyz.XyzClass', array(
    'property1'=>'value1',
    'property2'=>'value2')); ?>
 
// 本文（body content）を含められるウィジェット
// widget that can contain body content
<?php $this->beginWidget('application.extensions.xyz.XyzClass', array(
    'property1'=>'value1',
    'property2'=>'value2')); ?>
 
...ウィジェットの本文（body content）...
 
<?php $this->endWidget(); ?>

3. アクション ¶

アクションは、特定のユーザーリクエストに応答するためにコントローラにより使用されます。アクションクラス XyzClass が xyz エクステンションに属している場合、コントローラクラスで、CController::actions メソッドを上書き（オーバーライド）すればそれを使用できます:

class TestController extends CController
{
    public function actions()
    {
        return array(
            'xyz'=>array(
                'class'=>'application.extensions.xyz.XyzClass',
                'property1'=>'value1',
                'property2'=>'value2',
            ),
            // other actions
        );
    }
}

その後、ルート（道筋） test/xyz を用いて、アクションにアクセスできます。

4. フィルタ ¶

フィルタもまた、コントローラにより使用されます。それらは主に、アクションにより処理されるユーザーリクエストの前処理や後処理です。フィルタクラス XyzClass が xyz エクステンションに属している場合、コントローラクラスで、CController::filters メソッドを上書き（オーバーライド）すればそれを使用できます:

class TestController extends CController
{
    public function filters()
    {
        return array(
            array(
                'application.extensions.xyz.XyzClass',
                'property1'=>'value1',
                'property2'=>'value2',
            ),
            // 他のフィルタ
        );
    }
}

上記では、限られたアクションだけにフィルタに適用するために、最初の配列要素でプラスやマイナス演算子を使用できます。詳細については、CController ドキュメントを参照してください。

5. コントローラ ¶

コントローラは、ユーザーが要求できるアクションのセットを提供します。コントローラエクステンションを使用するために、アプリケーション初期構成中の CWebApplication::controllerMap プロパティへの初期構成が必要です:

return array(
    'controllerMap'=>array(
        'xyz'=>array(
            'class'=>'application.extensions.xyz.XyzClass',
            'property1'=>'value1',
            'property2'=>'value2',
        ),
        // 他のコントローラ
    ),
);

その後、ルート（道筋） xyz/a を用いてコントローラのアクション a にアクセスできます。

6. バリデータ ¶

バリデータは主に、モデルクラス（CFormModel か CActiveRecord のどちらかから継承された）により使用されます。バリデータクラス XyzClass が xyz エクステンションに属している場合、モデルクラスで、CModel::rules メソッドを上書き（オーバーライド）すればそれを使用できます:

class MyModel extends CActiveRecord // または CFormModel
{
    public function rules()
    {
        return array(
            array(
                'attr1, attr2',
                'application.extensions.xyz.XyzClass',
                'property1'=>'value1',
                'property2'=>'value2',
            ),
            // 他のバリデーションルール
        );
    }
}

7. コンソールコマンド ¶

コンソールコマンドエクステンションは、通常、追加コマンドにより yiic ツールを強化します。コンソールコマンド XyzClass が xyz エクステンションに属している場合、コンソールアプリケーション用の初期構成を設定することでそれを使用できます:

return array(
    'commandMap'=>array(
        'xyz'=>array(
            'class'=>'application.extensions.xyz.XyzClass',
            'property1'=>'value1',
            'property2'=>'value2',
        ),
        // 他のコマンド
    ),
);

その後、追加コマンド xyz を備えている yiic ツールを使用できます。

注意: コンソールアプリケーションは、通常、ウェブアプリケーションで使用されるものとは異なる初期構成ファイルを使用します。もし、アプリケーションを yiic webapp コマンドを使用して作成した場合、コンソールアプリケーション protected/yiic 用の初期構成ファイルは、 protected/config/console.php、また、ウェブアプリケーション用の初期構成ファイルは protected/config/main.php です。

8. モジュール ¶

モジュールの使用方法については、モジュールに関するセクションを参照してください。

9. 一般的なコンポーネント ¶

一般的なコンポーネントを使用するには、はじめに、下記のようにそのクラスファイルをインクルードする必要があります。

Yii::import('application.extensions.xyz.XyzClass');

その後、クラスのインスタンスの生成やプロパティの設定、メソッドのコールを行えます。それを継承して新しい子クラスを作成してもいいです。

$Id: extension.use.txt 749 2009-02-26 02:11:31Z qiang.xue $

エクステンション

エクステンションを作成する

Yii Supporters

The Ext4Yii Framework is a professional PHP Yii extension which provides server-side ExtJS functionality.