mdsys / laravel_generators
Laravel 4 生成器
Requires
- php: >=5.3.0
- illuminate/console: 4.0.x
- illuminate/filesystem: 4.0.x
- illuminate/support: 4.0.x
- mustache/mustache: dev-master
Requires (Dev)
- mockery/mockery: dev-master
This package is not auto-updated.
Last update: 2024-09-24 01:00:27 UTC
README
此 Laravel 4 包提供各种生成器,以加快您的开发过程。这些生成器包括
generate:model
generate:controller
generate:seed
generate:view
generate:migration
generate:resource
generate:scaffold
generate:form
generate:test
generate:pivot
<-- 新功能!!
想看视频教程吗?
安装
首先,通过 Composer 安装此包。编辑项目的 composer.json
文件,以要求 way/generators
。
"require": {
"laravel/framework": "4.0.*",
"way/generators": "dev-master"
},
"minimum-stability" : "dev"
接下来,在终端更新 Composer
composer update
完成此操作后,最后一步是添加服务提供者。打开 app/config/app.php
,并将新项目添加到 providers 数组中。
'Way\Generators\GeneratorsServiceProvider'
这样就完成了!您现在可以运行终端中的 artisan
命令,查看新的 generate
命令。
php artisan
还有一个 Sublime Text 插件 可用于辅助生成器。当然可以使用它,但在学习以下语法之前不要使用。
使用方法
将生成器视为加快工作流程的简单方法。您不需要打开模型目录,创建新文件,保存并添加类,只需运行一个生成命令即可。
迁移
Laravel 4 提供迁移生成器,但它仅创建模式(或表字段)。让我们使用 generate:migration
查看几个示例。
php artisan generate:migration create_posts_table
如果没有指定 fields
选项,将在 app/database/migrations
内创建以下文件。
<?php use Illuminate\Database\Migrations\Migration; class CreatePostsTable extends Migration { /** * Run the migrations. * * @return void */ public function up() { Schema::create('posts', function($table) { $table->increments('id'); $table->timestamps(); }); } /** * Reverse the migrations. * * @return void */ public function down() { Schema::drop('posts'); } }
请注意,生成器足够智能,可以检测到您正在尝试创建一个表。当命名迁移时,请尽可能详细。迁移生成器将检测迁移名称中的第一个单词,并尽可能确定如何进行。因此,对于 create_posts_table
,关键字是 "create",这意味着我们应该准备必要的模式来创建一个表。
如果您使用类似于 add_user_id_to_posts_table
的迁移名称,那么关键字是 "add",表示我们打算向现有表添加行。让我们看看它会生成什么。
php artisan generate:migration add_user_id_to_posts_table
这将准备以下模板
<?php use Illuminate\Database\Migrations\Migration; class AddUserIdToPostsTable extends Migration { /** * Run the migrations. * * @return void */ public function up() { Schema::table('posts', function($table) { }); } /** * Reverse the migrations. * * @return void */ public function down() { Schema::table('posts', function($table) { }); } }
请注意,这次我们没有做 Schema::create
。
关键字
在编写迁移名称时,请使用以下关键字为生成器提供提示。
create
或make
(《create_users_table》)add
或insert
(《add_user_id_to_posts_table》)remove
或drop
或delete
(《remove_user_id_from_posts_table》)
生成模式
这很棒,但让我们进一步,使用 fields
选项生成模式。
php artisan generate:migration create_posts_table --fields="title:string, body:text"
在我们分析这个新选项之前,让我们看看输出。
<?php use Illuminate\Database\Migrations\Migration; class CreatePostsTable extends Migration { /** * Run the migrations. * * @return void */ public function up() { Schema::create('posts', function($table) { $table->increments('id'); $table->string('title'); $table->text('body'); $table->timestamps(); }); } /** * Reverse the migrations. * * @return void */ public function down() { Schema::drop('posts'); } }
很好!注意以下几点
- 生成器会自动将
id
设置为主键。 - 它还会添加时间戳,因为这是更常见的。
- 它解析了
fields
选项,并添加了这些字段。 - drop 方法足够智能,可以理解,在反向操作中,表应该被完全删除。
要声明字段,请使用以逗号分隔的键:值:选项集列表,其中 key
是字段的名称,value
是 列类型,而 option
是指定索引等的方式,例如 unique
或 nullable
。以下是一些示例
--fields="first:string, last:string"
--fields="age:integer, yob:date"
--fields="username:string:unique, age:integer:nullable"
--fields="name:string:default('John'), email:string:unique:nullable"
--fields="username:string[30]:unique, age:integer:nullable"
请注意最后一个示例,我们指定了字符限制:string[30]
。这将生成 $table->string('username', 30)->unique();
可以通过以下命令销毁表:
php artisan generate:migration destroy_posts_table
如果您想设置精确的 artisan 回滚选项,请同时设置 fields
选项
php artisan generate:migration destroy_posts_table --fields="title:string, body:text"
作为最后的演示,我们将运行一个迁移来从 tasks
表中删除 completed
字段。
php artisan generate:migration remove_completed_from_tasks_table --fields="completed:boolean"
这次,由于我们使用了 "remove" 关键字,生成器理解应该删除一个列,并在 down()
方法中将其重新添加。
<?php use Illuminate\Database\Migrations\Migration; class RemoveCompletedFromTasksTable extends Migration { /** * Run the migrations. * * @return void */ public function up() { Schema::table('tasks', function($table) { $table->dropColumn('completed'); }); } /** * Reverse the migrations. * * @return void */ public function down() { Schema::table('tasks', function($table) { $table->boolean('completed'); }); } }
模型
php artisan generate:model Post
这将创建文件,app/models/Post.php
并插入以下模板代码
<?php class Post extends Eloquent { }
视图
php artisan generate:view dog
此命令将生成 app/views/dog.blade.php
和一个简单的字符串,以便方便。
The dog.blade.php view.
与所有命令一样,您可以使用 --path
选项将此文件放置在其他位置。
php artisan generate:view index --path=views/dogs
现在,我们得到:app/views/dogs/index.blade.php
。
种子
Laravel 4 提供了一种灵活的方式来初始化新表。
php artisan generate:seed dogs
将参数设置为所需的表的名称。这将生成 app/database/seeds/DogsTableSeeder.php
并填充它
<?php class DogsTableSeeder extends Seeder { public function run() { $dogs = [ ]; DB::table('Dogs')->insert($dogs); } }
此命令还会更新 app/database/seeds/DatabaseSeeder.php
以包括对新种子类的调用,这是 Laravel 所必需的。
要完全初始化 dogs
表
- 在
$dogs
数组中,添加任意数量的数组,包含必要的行。 - 返回终端并运行 Laravel 的
db:seed 命令
(php artisan db:seed
)。
资源
将资源生成器视为大菜。它调用所有其兄弟生成命令。假设以下命令
php artisan generate:resource dog --fields="name:string"
以下操作将发生
- 创建一个带有名称列的
create_dogs_table
迁移。 - 创建一个
Dog.php
模型。 - 创建一个
views/dogs
文件夹,其中包含index
、show
、create
和edit
视图。 - 创建一个
database/seeds/DogsTableSeeder.php
种子文件。 - 更新
DatabaseSeeder.php
以运行DogsTableSeeder
- 创建
controllers/DogsController.php
,并填充它以包含 restful 方法。 - 更新
routes.php
以包括:Route::resource('dogs', 'DogsController')
。 - 创建一个
tests/controllers/DogsControllerTest.php
文件,并填充一些模板测试以供您开始。
请注意,资源名称是单数形式 - 与您命名模型的方式相同。
工作流程
让我们创建一个用于以 restful 方式显示狗的资源。
php artisan generate:resource dog --fields="name:string, age:integer"
接下来,我们将初始化这个新的 dogs
表。打开 database/seeds/DogsTableSeeder.php
并添加几行。记住,您只需要编辑此文件中的 $dogs
数组。
$dogs = [
['name' => 'Sparky', 'age' => 5],
['name' => 'Joe', 'age' => 11]
];
现在,我们将迁移数据库并初始化 dogs
表。
php artisan migrate
php artisan db:seed
最后,让我们在访问 dogs/
路由时显示这两只狗。编辑 controllers/DogsController.php
,并更新 index
方法,如下所示
public function index()
{
return View::make('dogs.index')
->with('dogs', Dog::all());
}
最后一步是更新视图以显示传递给它的每个帖子。打开 views/dogs/index.blade.php
并添加
<ul>
@foreach($dogs as $dog)
<li>{{ $dog->name }} : {{ $dog->age }}</li>
@endforeach
</ul>
好吧,好吧,我们不是使用带有正确 HTML 的布局文件。谁在乎呢;这只是个例子,傻瓜。
不管怎样,我们已经准备好了。运行服务器,然后浏览到 localhost:8000/dogs
来查看您的列表。
php artisan serve
- Sparky : 5
- Joe : 11
这种方法难道不是比手动写所有内容快得多吗?最后,让我们运行测试,以确保一切按预期工作。
phpunit
并且……它是绿色的!
脚手架
将脚手架视为资源的扩展。它具有完全相同的接口。
php artisan generate:scaffold tweet --fields="author:string, body:text"
唯一的区别是它会处理所有样板代码。这对于原型设计非常有用——甚至可以学习如何做基本的事情,例如从数据库表中删除记录、构建表单或在表单上执行验证。
表单
这个方便的新生成器允许您通过一个命令,根据提供的模型属性生成所需的表单HTML。也许一个例子是合适的
php artisan generate:form tweet
假设我确实有一个 Tweet
模型和它相关的 tweet
表,这个命令将输出
{{ Form::open(array('route' => 'tweets.store')) }} <ul> <li> {{ Form::label('author', 'Author:') }} {{ Form::text('author') }} </li> <li> {{ Form::label('body', 'Body:') }} {{ Form::textarea('body') }} </li> <li> {{ Form::submit() }} </li> </ul> {{ Form::close() }}
真不错,对吧?它读取了属性和数据类型,并为你准备好了标记!少了一件要担心的事情!
指定表单的方法
但如果你打算更新资源而不是创建新的资源呢?在这种情况下,请使用 --method
选项。
php artisan generate:form tweet --method="update"
这会生成几乎相同的HTML,但是,根据需要,会调整 Form::open()
方法。
{{ Form::open(array('method' => 'PATCH', 'route' => 'tweets.update')) }}
方法选项可以接受任意数量的值(添加、编辑、更新、发布、创建等),但本质上,你只是在告诉它你是创建还是编辑资源。因此,只有两种可能的输出:POST
和 PATCH
(前者是默认值)。
自定义HTML
如果你不喜欢使用无序列表作为表单,可以使用 --html
选项,以及你希望使用的元素名称
php artisan generate:form tweet --html="div"
现在,我们将元素放在 div
中!
{{ Form::open(array('route' => 'tweets.store')) }} <div> {{ Form::label('author', 'Author:') }} {{ Form::text('author') }} </div> <div> {{ Form::label('body', 'Body:') }} {{ Form::textarea('body') }} </div> <div> {{ Form::submit() }} </div> {{ Form::close() }}
复制和保存
至少现在,与这个包中的其他生成器不同,这个命令将输出表单,此时你可以将其复制粘贴到需要的地方。当然,你可以使用现有工具将输出重定向到剪贴板或保存到文件。例如
# copy the output to the clipboard php artisan generate:form tweet | pbcopy # save it to a form partial php artisan generate:form tweet > app/views/posts/form.blade.php
测试
当你需要创建新的PHPUnit测试类时,请使用 generate:test
。以下是一个例子
php artisan generate:test FooTest
这将生成 app/tests/FooTest.php
。
<?php class FooTest extends TestCase { public function test() { } }
交叉表
创建可连接/枢纽表有时可能很复杂。
- 表名应该是复数吗?
- 我们如何编写表名才能让Laravel高兴?
- 枢纽表中应该有哪些字段?
现在,这个过程可以自动化。只需调用 generate:pivot
命令,并提供应可连接的表名。例如,一个帖子可以有多个标签,一个标签可以有多个帖子。运行以下命令以创建所需的枢纽表。
php artisan generate:pivot posts tags
你提供的表名顺序(或是否复数化)无关紧要。该命令将正确创建一个具有 post_id
和 tag_id
字段的 post_tag
迁移。
Schema::create('post_tag', function(Blueprint $table) { $table->integer('post_id'); $table->integer('tag_id'); });
最后,只需迁移数据库以创建它。
php artisan migrate
枢纽表完成!
让我们从头开始,我们需要一个帖子表,一个标签表,以及两个表之间的连接枢纽表。我们可以很容易地使用生成器来完成这项任务。
php artisan generate:migration create_posts_table --fields="title:string, description:text" php artisan generate:migration create_tags_table --fields="name:string" php artisan generate:pivot posts tags