データソース¶

App::uses('HttpSocket', 'Network/Http');

class FarAwaySource extends DataSource {

/**
 * データソースの説明（オプション）
 */
    public $description = 'A far away datasource';

/**
 * デフォルトの設定オプション。これらは ``app/Config/database.php``
 * でカスタマイズされ、 ``__construct()`` の中でマージされます。
 */
    public $config = array(
        'apiKey' => '',
    );

/**
 * create() や update() を行いたい（実装したい）場合、利用できる
 * 項目を指定する必要があります。たとえば固定情報やスキーマの
 * 移行など、CakeSchema でやる場合と同じ配列キーを使います。
 */
    protected $_schema = array(
        'id' => array(
            'type' => 'integer',
            'null' => false,
            'key' => 'primary',
            'length' => 11,
        ),
        'name' => array(
            'type' => 'string',
            'null' => true,
            'length' => 255,
        ),
        'message' => array(
            'type' => 'text',
            'null' => true,
        ),
    );

/**
 * HttpSocket を生成し、設定の調整を行う。
 */
    public function __construct($config) {
        parent::__construct($config);
        $this->Http = new HttpSocket();
    }

/**
 * データソースは通常データベースに接続するので、データベース
 * なしでも動くようにいくらか調整する必要があります。
 */

/**
 * listSources() はキャッシュ操作を行います。あなたはカスタム
 * データソースでも独自のやり方でキャッシュ機構を実装したいと思う
 * かもしれません。とりあえず、単に ``return null`` してください。
 */
    public function listSources($data = null) {
        return null;
    }

/**
 * describe() はモデルに対して ``Model::save()`` のための
 * スキーマを伝えます。
 *
 * モデルごとに異なったスキーマを使いたい場合もあるかもしれませんが、
 * それでも単一のデータソースを使ってください。その場合、モデルに
 * 対して ``schema`` プロパティをセットし、ここでは単に
 * ``$model->schema`` を返すようにします。
 */
    public function describe($model) {
        return $this->_schema;
    }

/**
 * calculate() はレコード数のカウント方法を決定します。これは
 * ``update()`` と ``delete()`` の動作を決めるのに必要です。
 *
 * ここでは実際にはレコードのカウントはせず、 ``read()`` に渡されるべき
 * 文字列を返します。これが実際のカウント処理を行います。
 * 最も簡単なのは、ここでは単に 'COUNT' という文字列を返しておき、
 * ``read()`` の中で ``$data['fields'] === 'COUNT'`` かどうかを
 * 聞くようにすることです。
 */
    public function calculate(Model $model, $func, $params = array()) {
        return 'COUNT';
    }

/**
 * CRUD のうちの R を実装します。 ``Model::find()`` への呼び出しは
 * ここに来ます。
 */
    public function read(Model $model, $queryData = array(),
        $recursive = null) {
        /**
         * ここでは、前述の calculate() メソッドで返されるカウントの
         * 実際の処理を行います。リモートソースのチェックをするか、
         * またはそれ以外の方法でレコードカウントを取得します。
         * ここでは単に 1 を返しているので、 ``update()`` や
         * ``delete()`` ではレコードが存在するものとみなされます。
         */
        if ($queryData['fields'] === 'COUNT') {
            return array(array(array('count' => 1)));
        }
        /**
         * ここではリモートデータを取得およびデコードして返します。
         */
        $queryData['conditions']['apiKey'] = $this->config['apiKey'];
        $json = $this->Http->get(
            'http://example.com/api/list.json',
            $queryData['conditions']
        );
        $res = json_decode($json, true);
        if (is_null($res)) {
            $error = json_last_error();
            throw new CakeException($error);
        }
        return array($model->alias => $res);
    }

/**
 * CRUD のうちの C を実装します。 ``Model::save()`` への呼び出しのうち
 *  $model->id がセットされないケースがここに来ます。
 */
    public function create(Model $model, $fields = null, $values = null) {
        $data = array_combine($fields, $values);
        $data['apiKey'] = $this->config['apiKey'];
        $json = $this->Http->post('http://example.com/api/set.json', $data);
        $res = json_decode($json, true);
        if (is_null($res)) {
            $error = json_last_error();
            throw new CakeException($error);
        }
        return true;
    }

/**
 * CRUD のうちの U を実装します。 ``Model::save()`` への呼び出しのうち
 *  $model->id がセットされているケースがここに来ます。リモートソース
 *  に依存するためここでは単に ``$this->create()`` をコールできます。
 */
    public function update(Model $model, $fields = null, $values = null,
        $conditions = null) {
        return $this->create($model, $fields, $values);
    }

/**
 * CRUD のうちの D を実装します。
 * ``Model::delete()`` への呼び出しがここに来ます。
 */
    public function delete(Model $model, $id = null) {
        $json = $this->Http->get('http://example.com/api/remove.json', array(
            'id' => $id[$model->alias . '.id'],
            'apiKey' => $this->config['apiKey'],
        ));
        $res = json_decode($json, true);
        if (is_null($res)) {
            $error = json_last_error();
            throw new CakeException($error);
        }
        return true;
    }

}

public $faraway = array(
    'datasource' => 'FarAwaySource',
    'apiKey'     => '1234abcd',
);

class MyModel extends AppModel {
    public $useDbConfig = 'faraway';
}

// Get all messages from 'Some Person'
$messages = $this->MyModel->find('all', array(
    'conditions' => array('name' => 'Some Person'),
));

$this->MyModel->save(array(
    'name' => 'Some Person',
    'message' => 'New Message',
));

$this->MyModel->id = 42;
$this->MyModel->save(array(
    'message' => 'Updated message',
));

$this->MyModel->delete(42);

public $faraway = array(
    'datasource' => 'MyPlugin.FarAwaySource',
    'apiKey'     => 'abcd1234',
);

Error: Database connection "Sqlserver" is missing, or could not be created.