hopkins/generators

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

路径生成器 + 美元引导 + Watsons 验证

1.1 2013-12-14 04:48 UTC

This package is not auto-updated.

Last update: 2024-09-14 15:27:08 UTC


README

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

此 Laravel 4 软件包更新了 Jeffrey Way 原始作品提供的视图,以支持 Bootstrap 3。以下是 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 文件,以要求 dollar/generators

"require": {
	"laravel/framework": "4.0.*",
	"dollar/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

关键字

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

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

要声明字段,使用以逗号分隔的键:值:选项集列表,其中 key 是字段的名称,value列类型,而 option 是指定索引等方式,例如 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 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 模型。
  • 创建包含 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')) }}

方法选项可以接受任意数量的值(添加、编辑、更新、提交、创建等),但本质上,你只是在告诉它你是在创建还是编辑资源。因此,只有两种可能的输出: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

测试

当需要创建一个新的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_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