packages/oil/generate.html

<!doctype html>
<html lang="ja">
<head>
	<meta charset="UTF-8">
	<meta name="viewport" content="width=device-width, initial-scale=1.0">
	<link rel="stylesheet" href="./../../assets/css/combined.css">
	<link rel="shortcut icon" href="./../../favicon.ico" />
	<script src="http://www.google.com/jsapi" type="text/javascript"></script>
	<script type="text/javascript">
		var path = './../../';
	</script>
	<script src="./../../assets/js/combined.js"></script>
	<title>Generate - Oil パッケージ - FuelPHP ドキュメント</title>
</head>
<body>
	<div id="container">
		<header id="header">
			<div class="table">
				<h1>
					<strong>FuelPHP, a PHP 5.3 Framework</strong>
					Documentation
				</h1>

				<form id="google_search">
					<p>
						<span id="search_clear">&nbsp;</span>
						<input type="submit" name="search_submit" id="search_submit" value="検索" />
						<input type="text" value="" id="search_input" name="search_input" />
					</p>
				</form>
			</div>
			<nav>

				<div class="clear"></div>
			</nav>
			<a href="#" id="toc_handle">目次</a>
			<div class="clear"></div>
		</header>

		<div id="cse">
			<div id="cse_point"></div>
			<div id="cse_content"></div>
		</div>

		<div id="main">

			<section>

				<h2 id="generate">Generate</h2>

				<p>
					コード生成を使用すると、多く繰り返すコードをビルドする開発回数をスピードアップすることができます。
					これは - oil 全体にも言えますが- 完全にオプションです。後で全てのコードは好きなように編集可能です。次のような項目を生成することができます:
				</p>

				<ul>
					<li><a href="#controllers">Controllers</a></li>
					<li><a href="#models">Models</a></li>
					<li><a href="#viewmodels">Viewmodels</a></li>
					<li><a href="#migrations">Migrations</a></li>
					<li><a href="#scaffolding">Scaffolding</a></li>
					<li><a href="#tasks">Tasks</a></li>
					<li><a href="#configs">Configs</a></li>
				</ul>

				<h3 id="controllers">Controllers</h3>

				<p>
					事前に定義したアクションやビューを持つ <a href="../../general/controllers/base.html">Controller</a> のスケルトンを生成するために、
					次ようなコマンドを使用します:
				</p>

				<pre class="cli"><code>$ php oil g controller posts action1 action2 action3
	Created view: APPPATH/views/posts/action1.php
	Created view: APPPATH/views/posts/action2.php
	Created view: APPPATH/views/posts/action3.php
	Created controller: APPPATH/classes/controller/posts.php</code></pre>

				<p>これは次のようなコントローラを生成します:</p>

				<pre class="php"><code>class Controller_Posts extends Controller_Template
{

	public function action_action1()
	{
		$this->template->title = 'Posts &raquo; Action1';
		$this->template->content = View::forge('posts/action1');
	}

	public function action_action2()
	{
		$this->template->title = 'Posts &raquo; Action2';
		$this->template->content = View::forge('posts/action2');
	}

	public function action_action3()
	{
		$this->template->title = 'Posts &raquo; Action3';
		$this->template->content = View::forge('posts/action3');
	}

}

/* End of file posts.php */</code></pre>

				<h3 id="models">Models</h3>

				<p>
					フィールドをリストすることでシンプルな <a href="../../general/controllers/base.html">Model</a> を生成し、
					自動的にマッチした <a href="../../general/migrations.html">Migration</a> を生成します:
				</p>

				<pre class="cli"><code>$ php oil g model post title:varchar[50] body:text user_id:int
	Created model: APPPATH/classes/model/post.php
	Created migration: APPPATH/migrations/001_create_posts.php</code></pre>

				<p>これは、<a href="../orm/intro.html">Orm</a> を使うシンプルなモデルを作成しますので、設定ファイルで Orm パッケージが有効になっていることを確認してください。このようなコードになります:</p>

				<pre class="php"><code>class Model_Post extends Orm\Model {

	protected static $_properties = array(
		'id',
		'title',
		'body',
		'created_at',
		'updated_at'
	);

	protected static $_observers = array(
		'Orm\Observer_CreatedAt' => array(
			'events' => array('before_insert'),
			'mysql_timestamp' => false,
		),
		'Orm\Observer_UpdatedAt' => array(
			'events' => array('before_save'),
			'mysql_timestamp' => false,
		),
	);

}

/* End of file post.php */
</code></pre>

			<p>あまりワクワクしませんが、マイグレーションはここでは有用な部分です:</p>

			<pre class="php"><code>namespace Fuel\Migrations;

class Create_posts
{
	public function up()
	{
		\DBUtil::create_table('posts', array(
			'id' => array('constraint' => 11, 'type' => 'int', 'auto_increment' => true),
			'title' => array('constraint' => 50, 'type' => 'varchar'),
			'body' => array('type' => 'text'),
			'user_id' => array('constraint' => 11, 'type' => 'int'),
			'created_at' => array('type' => 'datetime'),

		), array('id'));
	}

	public function down()
	{
		\DBUtil::drop_table('posts');
	}
}</code></pre>

				<p>もしマイグレーションの生成を望まないなら、<strong>--no-migration</strong> を指定してください:</p>

				<pre class="cli"><code>$ php oil g model post title:varchar[50] body:text user_id:int --no-migration
	Created model: APPPATH/classes/model/post.php</code></pre>

				<h4>Model_Crud を使用してモデルを生成する</h4>

				<p>FuelPHP v1.1 はリレーショナルデータのオーバヘッドなしで ORM を使うのと同じような機能を提供するシンプルな Model_Crud ベースのモデルを追加しました。<code>--crud</code> を追加することで、そのようなモデルを生成できます。</p>

				<pre class="cli"><code>$ php oil g model post title:varchar[50] body:text user_id:int created_at:datetime --crud
	Created model: APPPATH/classes/model/post.php
	Created migration: APPPATH/migrations/001_create_posts.php</code></pre>

				<p>これは <a href="../orm/intro.html">Orm</a> を使用したシンプルなモデルを生成します。設定ファイルでパッケージが有効かどうか確認してください。次のようになります:</p>

				<pre class="php"><code>class Model_Post extends \Model_Crud
{
	protected static $_properties = array(
		'id',
		'title',
		'body',
		'user_id',
		'created_at',
		'updated_at'
	);

	protected static $_table_name = 'posts';

}</code></pre>


				<h4 id="no_timestamp">タイムスタンプオプションを指定せずにモデルを生成する</h4>

				<p>created/updated フィールドやオブザーバを除外するために <code>--no-timestamp</code> を追加します。</p>

				<pre class="cli"><code>$ php oil g model post title:varchar[50] body:text user_id:int --no-timestamp</code></pre>
				<pre class="php"><code>class Model_Post extends \Orm\Model
{
  protected static $_properties = array(
    'id',
    'title',
    'body',
    'user_id'
  );

}
</code></pre>

				<pre class="php"><code>namespace Fuel\Migrations;

class Create_posts
{
  public function up()
  {
    \DBUtil::create_table('posts', array(
      'id' => array('constraint' => 11, 'type' => 'int', 'auto_increment' => true),
      'title' => array('constraint' => 50, 'type' => 'varchar'),
      'body' => array('type' => 'text'),
      'user_id' => array('constraint' => 11, 'type' => 'int'),

    ), array('id'));
  }

  public function down()
  {
    \DBUtil::drop_table('posts');
  }
}
</code></pre>

				<h4 id="timestamp_fields">タイムスタンプのフィールドを変更する</h4>

				<p>
					ORM モデルか CRUD モデル (\Model_Crud) でタイムスタンプを使っている場合、
					独自のフィールド名を指定することができます。<strong>--created-at</strong> と <strong>--updated-at</strong>
					オプションを使ってフィールド名を指定してください。
				</p>

				<pre class="cli"><code>$ php oil g model post title:varchar[50] body:text user_id:int --created-at=my_created</code></pre>

				<p>これは以下を生成します:</p>

				<pre class="php"><code>&lt;?php

class Model_Post extends \Orm\Model
{
	protected static $_properties = array(
		'id',
		'title',
		'body',
		'user_id',
		'my_created',
		'updated_at'
	);

	protected static $_observers = array(
		'Orm\Observer_CreatedAt' => array(
			'events' => array('before_insert'),
			'mysql_timestamp' => false,
			'property' => 'my_created',
		),
		'Orm\Observer_UpdatedAt' => array(
			'events' => array('before_save'),
			'mysql_timestamp' => false,
		),
	);
}</code></pre>

<pre class="php"><code>&lt;?php

namespace Fuel\Migrations;

class Create_posts
{
	public function up()
	{
		\DBUtil::create_table('posts', array(
			'id' => array('constraint' => 11, 'type' => 'int', 'auto_increment' => true),
			'title' => array('constraint' => 50, 'type' => 'varchar'),
			'body' => array('type' => 'text'),
			'user_id' => array('constraint' => 11, 'type' => 'int'),
			'my_created' => array('constraint' => 11, 'type' => 'int'),
			'updated_at' => array('constraint' => 11, 'type' => 'int'),

		), array('id'));
	}

	public function down()
	{
		\DBUtil::drop_table('posts');
	}
}</code></pre>

				<h3 id="viewmodels">Viewmodels</h3>

				<p>
					Optionally you have have oil to generate a Viewmodel class to accompany the view.
				</p>

				<pre class="cli"><code>$ php oil g controller posts action1 action2 action3 --with-viewmodel</code></pre>

				<h3 id="running_migrations">Running Migrations</h3>

				<p>
					次のコマンドは有用なマイグレーションタスクを実行する refine コマンドの使い方を示しています。
					システムが現在マイグレーション 5 であると仮定しています。マイグレーションタスクはパラメータを指定し、直接そのバージョンに移動することができます。
					または、バージョンを 1 つ 上げたり下げたりします。
				</p>

				<pre class="cli"><code>$ php oil refine migrate
	Currently on migration: 5.

$ php oil refine migrate --version=4
	Migrated to version: 4.

$ php oil refine migrate --version=5
	Migrated to version: 5.

$ php oil refine migrate:down
	Migrated to version: 4.

$ php oil refine migrate:up
	Migrated to version: 5.</code></pre>

				<p class="note">The following field types are supported: <strong>string[n]</strong>, <strong>varchar[n]</strong>, <strong>int[n]</strong>, <strong>enum[value1, value2]</strong>, <strong>decimal[n, n]</strong>, <strong>float[n, n]</strong>, <strong>text</strong>, <strong>blob</strong>, <strong>datetime</strong>, <strong>date</strong>, <strong>timestamp</strong> and <strong>time</strong>.</p>

				<h3 id="migrations">Generating Migrations</h3>

				<p>
					モデルを生成せずにマイグレーションを生成可能です。テーブルをリネームするために使用されるか、他の環境に簡単にデプロイするためにテーブルにフィールドを追加するために使用されます。
				</p>

				<pre class="cli"><code>$ php oil generate migration rename_table_users_to_accounts
	Building magic migration: rename_table
	Created migration: APPPATH/migrations/002_rename_table_users_to_accounts.php</code></pre>

				<h3 id="magic_migrations">Magic マイグレーション</h3>
				<p>いくるかの "magic" マイグレーションがあり、自動的にあなたのマイグレーション名のプリフィックスに基づいたマイグレーションをビルドします。</p>
				<pre class="cli"><code>$ php oil generate migration create_users name:text email:string[50] password:string[125]
$ php oil generate migration rename_table_users_to_accounts
$ php oil generate migration add_bio_to_accounts bio:text
$ php oil generate migration delete_bio_from_accounts bio:text
$ php oil generate migration rename_field_name_to_username_in_accounts
$ php oil generate migration drop_accounts
</code></pre>
				<p>注意: マイグレーションを名付ける際に、誤ってキーワードで開始しないように注意してください。</p>

				<h3 id="scaffolding">スキャフォールド</h3>

				<p>
					スキャフォールドは、 Oil のコード生成のワクワクする部分です。このアプローチは、Rails から借用しており、偉大な功績があります。
					それは、MVC スケルトンやマイグレーションだけでなく、デフォルトの CRUD コードを埋め込んで、
					コマンドを記述した後にコードが実際に動作するという考えです。
				</p>

				<pre class="cli"><code>$ php oil g scaffold monkey name:string description:text
	Created model: APPPATH/classes/model/monkey.php
	Created migration: APPPATH/migrations/003_create_monkeys.php
	Created controller: APPPATH/classes/controller/monkeys.php
	Created view: APPPATH/views/monkeys/index.php
	Created view: APPPATH/views/monkeys/view.php
	Created view: APPPATH/views/monkeys/create.php
	Created view: APPPATH/views/monkeys/edit.php
	Created view: APPPATH/views/monkeys/_form.php

$ php oil refine migrate
Migrated to latest version: 3.
</code></pre>

				<p>
					2 番目のコマンドで実行されたコマンドを含み、このコマンドによって多くのコードが生成されたことがわかります。
					コントローラは次のようになります:
				</p>

				<pre class="php"><code>class Controller_Monkey extends Controller_Template
{

	public function action_index()
	{
		$data['monkeys'] = Model_Monkey::find('all');
		$this->template->title = "Monkeys";
		$this->template->content = View::forge('monkey/index', $data);

	}

	public function action_view($id = null)
	{
		$data['monkey'] = Model_Monkey::find($id);

		$this->template->title = "Monkey";
		$this->template->content = View::forge('monkey/view', $data);

	}

	public function action_create($id = null)
	{
		if (Input::method() == 'POST')
		{
			$monkey = Model_Monkey::forge(array(
				'name' => Input::post('name'),
				'description' => Input::post('description'),
			));

			if ($monkey and $monkey->save())
			{
				Session::set_flash('success', 'Added monkey #'.$monkey->id.'.');

				Response::redirect('monkey');
			}

			else
			{
				Session::set_flash('error', 'Could not save monkey.');
			}
		}

		$this->template->title = "Monkeys";
		$this->template->content = View::forge('monkey/create');

	}

	public function action_edit($id = null)
	{
		$monkey = Model_Monkey::find($id);

		if (Input::method() == 'POST')
		{
			$monkey->name = Input::post('name');
			$monkey->description = Input::post('description');

			if ($monkey->save())
			{
				Session::set_flash('success', 'Updated monkey #' . $id);

				Response::redirect('monkey');
			}

			else
			{
				Session::set_flash('error', 'Could not update monkey #' . $id);
			}
		}

		else
		{
			$this->template->set_global('monkey', $monkey, false);
		}

		$this->template->title = "Monkeys";
		$this->template->content = View::forge('monkey/edit');

	}

	public function action_delete($id = null)
	{
		if ($monkey = Model_Monkey::find($id))
		{
			$monkey->delete();

			Session::set_flash('success', 'Deleted monkey #'.$id);
		}

		else
		{
			Session::set_flash('error', 'Could not delete monkey #'.$id);
		}

		Response::redirect('monkey');

	}


}</code></pre>

				<h3 id="tasks">Tasks</h3>

				<p>
					You can also have oil generate the skeleton of a new task.
				</p>

				<pre class="cli"><code>$ php oil g task newtask cmd1 cmd2</code></pre>

				<p>
					Which will generate
				</p>

				<pre class="php"><code>&lt;?php

namespace Fuel\Tasks;

class Newtask
{
	public static function run($args = NULL)
	{
		echo "\n===========================================";
		echo "\nRunning DEFAULT task [Newtask:Run]";
		echo "\n-------------------------------------------\n\n";

		/***************************
		 Put in TASK DETAILS HERE
		 **************************/
	}

	public static function cmd1($args = NULL)
	{
		echo "\n===========================================";
		echo "\nRunning task [Newtask:Cmd1]";
		echo "\n-------------------------------------------\n\n";

		/***************************
		 Put in TASK DETAILS HERE
		 **************************/
	}

	public static function cmd2($args = NULL)
	{
		echo "\n===========================================";
		echo "\nRunning task [Newtask:Cmd2]";
		echo "\n-------------------------------------------\n\n";

		/***************************
		 Put in TASK DETAILS HERE
		 **************************/
	}
}
/* End of file tasks/newtask.php */</code></pre>

				<h3 id="configs">Configs</h3>

				<p>
					<a href="../../classes/config.html">Config</a> を生成するために次のコマンドを使用します:
				</p>

				<pre class="cli"><code>$ php oil g config sample hello:world
	Created config: APPPATH/config/sample.php</code></pre>

				<p>これは次のような設定を生成します:</p>

				<pre class="php"><code>return array (
	'hello' => 'world',
);

/* End of file sample.php */</code></pre>

				<h3>COREPATH から設定を生成する</h3>
				<p>
					APPPATH/config がない場合、COREPAT/config から設定を結合します。
				</p>

				<pre class="cli"><code>$ php oil g config package
	Created config: APPPATH/config/package.php</code></pre>

				<p>これは次のような設定を生成します:</p>

				<pre class="php"><code>return array (
	'sources' =>
	array (
		0 => 'github.com/fuel-packages',
	),
);</code></pre>

				<h3>COREPATH や APPPATH から強制的に設定を更新する</h3>
				<p>
					COREPATH/config や combine APPPATH/config から APPPATH/config に設定を結合する
				</p>

				<pre class="cli"><code>$ php oil g config form --overwrite
	Created config: APPPATH/config/form.php</code></pre>

				<p>これは次のような設定を生成します:</p>

				<pre class="php"><code>return array (
	'prep_value' => true,
	'auto_id' => true,
	'auto_id_prefix' => '',
	'form_method' => 'post',
);

/* End of file form.php */</code></pre>

			</section>

		</div>

		<footer>
			<p>
				&copy; FuelPHP Development Team 2010-2013 - <a href="http://fuelphp.com">FuelPHP</a> is released under the MIT license.
[ <a href="https://github.com/fuel/docs/commits/1.5/develop/packages/oil/generate.html">原文コミット履歴</a> | <a href="https://github.com/NEKOGET/FuelPHP_docs_jp/commits/1.5/develop_japanese/packages/oil/generate.html">翻訳コミット履歴</a> | <a href="https://github.com/NEKOGET/FuelPHP_docs_jp/blob/1.5/develop_japanese/packages/oil/generate.html">GitHubで修正</a> ]
			</p>
		</footer>
	</div>
</body>
</html>