Doctrine

Timestamp:

06/21/08 13:55:07 (13 months ago)

Author:

moksahero

Message:

put together more japanese text for japanese section names

Files:

• branches/0.11/manual/docs/ja/getting-started.txt (modified) (1 diff)

branches/0.11/manual/docs/ja/getting-started.txt

@@ -84 +84 @@
 </code>
 
-++ Starting new project
-++ Working with existing databases
-++ Creating tables
+++ 新しいプロジェクトを始める
+
+Doctrine_RecordはすべてのDoctrineを使ったプロジェクトの基本コンポーネントになります。少なくともそれぞれのデータベーステーブルに対してDoctrine_Recordが一つあります。Doctrine_Record は [http://www.martinfowler.com/eaaCatalog/activeRecord.html Active Record pattern] のパターンを継承しています。
+
+Doctrineは常に主キーを持たないテーブルに対して'id'という名前の主キーを追加します。Doctrine_Record を継承してsetTableDefinitionメソッドをhasColumn()で定義してそれらのクラスをエクスポートするだけでデータベースのテーブルが作成されます。
+
+'user'というデータベーステーブルを作成することを考えてみます。カラムはid(primary key)、name、username、passwordとcreatedです。Doctrineが既にインストールされているとして、必要なものは下記の数行です:
+
+User.php :
+<code type="php">
+class User extends Doctrine_Record 
+{
+    public function setTableDefinition() 
+    {
+        // set 'user' table columns, note that
+        // id column is auto-created as no primary key is specified
+        
+        $this->hasColumn('name', 'string',30);
+        $this->hasColumn('username', 'string',20);
+        $this->hasColumn('password', 'string',16);
+    }
+    
+    public function setUp()
+    {
+        $this->actAs('Timestampable');
+    }
+}
+</code>
+
+この代わりにYAMLスキーマを使ってDoctrineのスキーマ情報を指定することも可能です。以下がDoctrine_Recordから生成するためのuser.ymlの例です
+
+<code type="yml">
+---
+User:
+  actAs: [Timestampable]
+  columns:
+    name: string(30)
+    username: string(20)
+    password: string(16)
+</code>
+
+以下のコマンドを走らせてyamlからphpこーどを生成することができます
+
+<code type="php">
+Doctrine::generateModelsFromYaml('/path/to/user.yml', '/path/to/generate/models);
+</code>
+
+パス /path/to/generate/models/ か /path/to/generate/models/generated を見てください。ここにUser.phpとBaseUser.phpがあるはずです。User.phpにこーどを追加することで任意の機能を追加することができます。まだBaseUser.phpにはYAMLスキーマファイルから毎回生成されます。
+
+これでDoctrine_Recordクラスが使えるようになりました、ここからデータベースにエクスポートしたり、テーブルを作成したりできます。上のUserクラスをデータベースにエクスポートするために次のシンプルなビルドスクリプトを使います：
+
+<code type="php">
+//Doctrineのベースクラスを読み込む
+require_once('path-to-doctrine/lib/Doctrine.php');
+
+//autoloaderの登録
+spl_autoload_register(array('Doctrine', 'autoload'));
+
+require_once('User.php');
+
+//接続のセットアップ
+Doctrine_Manager::connection('mysql://user:pass@localhost/test');
+
+//クラスのエクスポート
+Doctrine::createTablesFromArray(array('User'));
+</code>
+
+これで基本的なCRUDオペレーションをサポートするUserモデルが使えるようになりました！
+
+++ 既存のデータベースと連携する
+
++++ はじめに
+
+DoctrineのようなORMツールを使ってよく起こることはデータベースとコードが肥大/複雑になることです。SQLを直書きするより、よいツールが必要です。
+
+Doctrineは既存のデータベースからDoctrine_Recordクラスの生成をサポートします。ドメインモデルに対してすべてのDoctrine_Recordクラスを一から書く必要はありません。 
+
++++ 最初のインポートを作成する
+
+'file'という名前の一つのテーブルを持つtestというMySQLのデータベースを考えてみましょう。
+
+fileテーブルは次のSQL命令文で作成されました:
+
+<code type="sql">
+CREATE TABLE file (
+    id INT UNSIGNED AUTO_INCREMENT NOT NULL,
+    name VARCHAR(150),
+    size BIGINT,
+    modified BIGINT,
+    type VARCHAR(10),
+    content TEXT,
+    path TEXT,
+    PRIMARY KEY(id))
+</code>
+
+これをDoctrine_Recordクラスに変換することを考えます。これは次のコードを使って簡単にできます：
+
+<code type="php">
+require_once('path-to-doctrine/lib/Doctrine.php');
+
+spl_autoload_register(array('Doctrine', 'autoload'));
+Doctrine_Manager::connection('mysql://root:dc34@localhost/test');
+
+// インポートメソッドはインポートディレクトの入ったパラメータを１つとります。
+//インポートディレクトリには生成されたファイルが保存されます。
+Doctrine::generateModelsFromDb('myrecords');
+</code>
+
+
+これでおしまいです！myrecords/generatedディレクトリ以下にでFile.phpという名前のファイルが保存されました。ファイルの内容は以下の通りです:
+
+<code type="php">
+/**
+ * This class has been auto-generated by the Doctrine ORM Framework
+ */
+abstract class BaseFile extends Doctrine_Record
+{
+
+  public function setTableDefinition()
+  {
+    $this->setTableName('file');
+    $this->hasColumn('id', 'integer', 4, array('unsigned' => 1, 'values' =>  array(), 'primary' => true, 'notnull' => true, 'autoincrement' => true));
+    $this->hasColumn('name', 'string', 150, array('fixed' => false, 'values' =>  array(), 'primary' => false, 'notnull' => false, 'autoincrement' => false));
+    $this->hasColumn('size', 'integer', 8, array('unsigned' => 0, 'values' =>  array(), 'primary' => false, 'notnull' => false, 'autoincrement' => false));
+    $this->hasColumn('modified', 'integer', 8, array('unsigned' => 0, 'values' =>  array(), 'primary' => false, 'notnull' => false, 'autoincrement' => false));
+    $this->hasColumn('type', 'string', 10, array('fixed' => false, 'values' =>  array(), 'primary' => false, 'notnull' => false, 'autoincrement' => false));
+    $this->hasColumn('content', 'string', null, array('fixed' => false, 'values' =>  array(), 'primary' => false, 'notnull' => false, 'autoincrement' => false));
+    $this->hasColumn('path', 'string', null, array('fixed' => false, 'values' =>  array(), 'primary' => false, 'notnull' => false, 'autoincrement' => false));
+  }
+
+  public function setUp()
+  {
+    parent::setUp();
+  }
+
+}
+</code>
+
+またFile.phpというファイルがmyrecordsディレクトリ内に保存されています。ファイルの内容は以下の通り：
+
+
+<code type="php">
+/**
+ * This class has been auto-generated by the Doctrine ORM Framework
+ */
+class FileTable extends Doctrine_Table
+{
+
+
+
+}
+</code>
+
+ここにカスタムメソッドを追加してDoctrine::getTable('User')を使って呼ぶことができます。
+
++++ Singularizing Import
+
+デフォルトではDoctrineは既存のデータベースから読み込まれた各モデルの名前を単数型にしようとします。この機能を望まない方は以下の方法で簡単にoffにしてください
+
+<code type="php">
+Doctrine_Manager::getInstance()->setAttribute('singularize_import', false);
+</code>
+
+これで"files"というテーブル名からは"File.php"というモデルは無く、"Files.php"というモデルが生成されます。
+
+++ テーブルの作成
+
++++ はじめに
+
+Doctrineはレコードクラスをデータベースにエクスポートすることをサポートします。レコードクラスにある定義からDoctrineがデータベース内にテーブルを作ります。
+
+次の定義を持つUserとPhonenumberという名前のクラスを考えます:
+
+<code type="php">
+// file User.php
+class User extends Doctrine_Record
+{
+    public function setTableDefinition()
+    {
+        $this->hasColumn('name', 'string', 20);
+    }
+    public function setUp()
+    {
+        $this->hasMany('Phonenumber', array('local' => 'id',
+                                            'foreign' => 'user_id'));
+    }
+}
+// file Phonenumber.php
+class Phonenumber extends Doctrine_Record
+{
+    public function setTableDefinition()
+    {
+        $this->hasColumn('phonenumber', 'string', 20);
+        $this->hasColumn('user_id', 'integer');
+    }
+    public function setUp()
+    {
+        $this->hasOne('User', array('local' => 'user_id',
+                                    'foreign' => 'id',
+                                    'onDelete' => 'CASCADE'));
+    }
+}
+</code>
+
+これらのクラスは'models/'ディレクトリにあるとします。このディレクトリの中をDoctrineに回遊させて、以下のスクリプトを使って各クラスをデータベース構造に追加します:
+
+<code type="php">
+
+require_once('path-to-doctrine/lib/Doctrine.php');
+
+spl_autoload_register(array('Doctrine', 'autoload'));
+
+//エクスポートするためにデータベース接続が必要
+Doctrine_Manager::connection('mysql://user:pass@localhost/test');
+
+Doctrine::createTablesFromModels('models');
+</code>
+
+これはMySQL上で次のクエリーを実行します。
+
+<code type="sql">
+CREATE TABLE user (id BIGINT AUTO_INCREMENT, name VARCHAR(20), PRIMARY KEY(id), INDEX(id));
+CREATE TABLE phonenumber (id INT AUTO_INCREMENT, phonenumber VARCHAR(20), user_id BIGINT, PRIMARY KEY(id), INDEX(user_id));
+ALTER TABLE phonenumber ADD CONSTRAINT FOREIGN KEY (user_id) REFERENCES user(id) ON DELETE CASCADE;
+</code>
+
+以下の点に注意してください:
+
+# 主キーカラムを指定していないのでオートインクリメントの主キーが自動追加されます
+# Doctrineはインデックスを参照された関連カラムに自動追加します(これはMySQLが必要とします)
+
++++ エクスポートクエリーを手に入れる
+
+エクスポートクエリーをすぐに実行するのではなく、クエリーの文字列を入手してそれらをbuild.sqlファイルに保存したい状況があるとします。これは次のように達成できます:
+
+<code type="php">
+require_once('path-to-doctrine/lib/Doctrine.php');
+
+spl_autoload_register(array('Doctrine', 'autoload'));
+
+Doctrine_Manager::connection('mgsql://user:pass@localhost/test');
+
+$queries = Doctrine::generateSqlFromModels('models');
+
+echo $queries;
+</code>
+
+同じ様にエクスポートを実行するために必要なSQLクエリーの文字を取得したい場合は Doctrine::generateSqlFromModels() を使います。
+
++++ エクスポートオプション
+
+<code type="php">
+// テーブル定義と制約などのすべてをエクスポートする
+$manager = Doctrine_Manager::getInstance();
+
+$manager->setAttribute(Doctrine::ATTR_EXPORT, Doctrine::EXPORT_ALL);
+
+// 制約無しでクラスをエクスポートする
+
+$manager->setAttribute(Doctrine::ATTR_EXPORT, Doctrine::EXPORT_TABLES ^ 
+                                              Doctrine::EXPORT_CONSTRAINTS);
+
+//エクスポートをoffにする
+
+$manager->setAttribute(Doctrine::ATTR_EXPORT, Doctrine::EXPORT_NONE);
+
+$sql = Doctrine::generateSqlFromModels();
+</code>
+
 ++ Generating models
 ++ Auto loading models