xloka/generators

该软件包最新版本(1.4)没有可用的许可证信息。

Laravel 4 生成器

1.4 2015-10-26 15:48 UTC

README

从JeffreyWay/Laravel-4-Generators分支而来。

此软件包更新了Jeffrey Way原始作品提供的视图,以适配Material Design Lite。以下为Way作品的原始文档。说明已更新,以反映本软件包内的任何更改。

此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文件以需要xloka/generators

"require": {
	"laravel/framework": "4.0.*",
	"xloka/generators": "dev-master"
},
"minimum-stability" : "dev"

接下来,从终端更新Composer

composer update

此操作完成后,最后一步是添加服务提供者。打开app/config/app.php,并将新项目添加到提供者数组中。

'Xloka\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

关键字

在编写迁移名称时,请使用以下关键字为生成器提供提示。

  • createmake (create_users_table)
  • addinsert (add_user_id_to_posts_table)
  • removedropdelete (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选项,并添加了那些字段。
  • 删除方法足够智能,能够意识到,反过来,应该完全删除表。

要声明字段,使用键值对列表,键名为字段名,键值为column type(列类型),键选项为指定索引等,如uniquenullable。以下是一些示例

  • --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 Basemodel {

}

视图

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模型。
  • 创建一个包含indexshowcreateedit视图的views/dogs文件夹。
  • 创建一个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

……绿色!

脚手架

scaffolding

把脚手架视为资源的扩展。它具有完全相同的界面。

php artisan generate:scaffold tweet --fields="author:string, body:text"

唯一的不同之处在于,它会处理所有样板代码。这特别适用于原型设计——甚至可以学习如何做基本的事情,比如从数据库表中删除记录,或者构建表单,或者对表单进行验证。

view scaffold

view validation

表单

这个方便的新生成器允许你使用单个命令,根据提供的模型属性生成表单所需的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')) }}

方法选项可以接受任意数量的值(例如add, edit, update, post, create等),但本质上,你只是在告诉它你是在创建还是编辑资源。因此,只有两种可能的输出:POSTPATCH(前者是默认值)。

自定义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

测试

使用generate:test创建新的PHPUnit测试类。以下是一个例子

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_idtag_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