valadanchik/laravel-6-generators

快速生成资源、迁移、模型等，作为Jeffrey Way Xethron包的示例创建

维护者

详细信息

github.com/Valadanchik/Laravel-6-Generators

来源

问题

安装: 12

依赖: 0

建议者: 0

安全: 0

星标: 0

关注者: 1

分支: 0

开放问题: 0

dev-master 2020-03-09 13:24 UTC

Requires

Requires (Dev)

MIT 91e3edfd36e473761a75a197485d6e03dec11cf1

  • Volodya Sargsyan <sar.volodya.woop@gmail.com>

This package is not auto-updated.

Last update: 2024-10-01 11:49:54 UTC

README

Build Status

此Laravel包提供各种生成器，以加快您的开发过程。这些生成器包括

  • generate:model
  • generate:view
  • generate:controller
  • generate:seed
  • generate:migration
  • generate:pivot
  • generate:resource
  • generate:scaffold

安装

想要5分钟的视频概述吗？

Laravel 4.2及以下版本

首先，通过Composer安装此包。编辑您项目的composer.json文件，要求way/generators。

"require-dev": {
	"way/generators": "~2.0"
}

由于框架现在已包含许多内置生成器，因此不支持Laravel 5。

接下来，从终端更新Composer

composer update --dev

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

'Way\Generators\GeneratorsServiceProvider'

这就完成了！您已准备好开始。从终端运行artisan命令以查看新的generate命令。

php artisan

接下来，从终端更新Composer

composer update --dev

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

'Way\Generators\GeneratorsServiceProvider'

这就完成了！您已准备好开始。从终端运行artisan命令以查看新的generate命令。

php artisan

用法

将生成器视为加快您工作流程的简单方法。与其打开模型目录、创建新文件、保存并添加类，您只需运行单个生成命令。

迁移

Laravel提供了一个迁移生成器，但它只是创建模式（或表字段）。让我们回顾几个使用generate:migration的例子。

php artisan generate:migration create_posts_table

如果我们没有指定fields选项，将在app/database/migrations中创建以下文件。

<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;

class CreatePostsTable extends Migration {

	/**
	 * Run the migrations.
	 *
	 * @return void
	 */
	public function up()
	{
        Schema::create('posts', function(Blueprint $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;
use Illuminate\Database\Schema\Blueprint;

class AddUserIdToPostsTable extends Migration {

	/**
	 * Run the migrations.
	 *
	 * @return void
	 */
	public function up()
	{
        Schema::table('posts', function(Blueprint $table) {

        });
	}


	/**
	 * Reverse the migrations.
	 *
	 * @return void
	 */
	public function down()
	{
	    Schema::table('posts', function(Blueprint $table) {

        });
	}

}

请注意，这次我们并没有做Schema::create。

关键字

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

  • create 或 make （create_users_table）
  • add 或 insert （add_user_id_to_posts_table）
  • remove （remove_user_id_from_posts_table）
  • delete 或 drop （delete_users_table）

生成模式

这很好，但让我们更进一步，并使用fields选项生成模式。

php artisan generate:migration create_posts_table --fields="title:string, body:text"

在我们解读这个新选项之前，让我们看看输出。

<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;

class CreatePostsTable extends Migration {

	/**
	 * Run the migrations.
	 *
	 * @return void
	 */
	public function up()
	{
        Schema::create('posts', function(Blueprint $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方法足够智能，可以意识到相反地，表应该完全删除。

要声明字段，请使用逗号加空格分隔的关键字：值：选项集列表，其中关键字是字段的名称，值是列类型，而选项是指定索引等的方式，如unique或nullable。以下是一些示例

  • --fields="first:string, last:string"
  • --fields="age:integer, yob:date"
  • --fields="username:string:unique, age:integer:nullable"
  • --fields="name:string:default('John Doe'), bio:text:nullable"
  • --fields="username:string(30):unique, age:integer:nullable:default(18)"

请注意最后一个示例，其中我们指定了字符限制：string(30)。这将产生$table->string('username', 30)->unique();

可以通过以下命令销毁表：

php artisan generate:migration delete_posts_table

最后，让我们运行一个迁移来从tasks表中删除completed字段。

php artisan generate:migration remove_completed_from_tasks_table --fields="completed:boolean"

这次，因为我们使用了“remove”关键字，生成器理解应该删除一个列，并在down()方法中将其添加回来。

<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;

class RemoveCompletedFromTasksTable extends Migration {

	/**
	 * Run the migrations.
	 *
	 * @return void
	 */
	public function up()
	{
        Schema::table('tasks', function(Blueprint $table) {
            $table->dropColumn('completed');
        });
	}


	/**
	 * Reverse the migrations.
	 *
	 * @return void
	 */
	public function down()
	{
	    Schema::table('tasks', function(Blueprint $table) {
            $table->boolean('completed');
        });
	}

}

模型

php artisan generate:model Post

这将创建文件，app/models/Post.php并插入以下模板

<?php

class Post extends \Eloquent {

}

视图

视图生成器相当简单。

php artisan generate:view admin.reports.index

此命令将创建一个空的视图，/app/views/admin/reports/index.blade.php。如果提供的目录树不存在，它将为您创建。

种子

Laravel为我们提供了一个灵活的方式来填充新表。

php artisan generate:seed users

将参数设置为所需种子文件的表名。这将生成app/database/seeds/UsersTableSeeder.php并填充它

<?php

// Composer: "fzaninotto/faker": "v1.3.0"
use Faker\Factory as Faker;

class UsersTableSeeder extends Seeder {

    public function run()
    {
        $faker = Faker::create();

        foreach(range(1, 10) as $index)
        {
            User::create([

            ]);
        }
    }

}

这将提供一些基本的模板，使用流行的Faker库。这是一种很好的方式来填充您的数据库表。别忘了通过Composer引入Faker！

枢纽

当您需要一个新关联表时，generate:pivot命令可以加速创建相应迁移的过程。

只需传递需要连接表的两个表的名称。对于orders和users，您可能这样做

php artisan generate:pivot orders users

这将创建以下迁移

<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;

class CreateOrderUserTable extends Migration {

	/**
	 * Run the migrations.
	 *
	 * @return void
	 */
	public function up()
	{
        Schema::create('order_user', function(Blueprint $table) {
            $table->increments('id');
			$table->integer('order_id')->unsigned()->index();
			$table->foreign('order_id')->references('id')->on('orders')->onDelete('cascade');
			$table->integer('user_id')->unsigned()->index();
			$table->foreign('user_id')->references('id')->on('users')->onDelete('cascade');
			$table->timestamps();
        });
	}


	/**
	 * Reverse the migrations.
	 *
	 * @return void
	 */
	public function down()
	{
	    Schema::drop('order_user');
	}

}

请注意，它根据您提供的两个表正确设置了表名，按字母顺序排列。现在，运行php artisan migrate创建您的关联表！

资源

generate:resource命令会为您做很多事情

  • 生成模型
  • 生成索引、显示、创建和编辑视图
  • 生成控制器
  • 生成包含模式迁移
  • 生成表种子
  • 迁移数据库

触发此命令时，您将需要确认每个这些动作。这样，您可以定制生成以符合您的特定需求。

示例

假设您需要构建一种显示帖子的方式。虽然您可以手动创建控制器、创建模型、创建迁移并在其中填充模式，然后创建表种子……为什么不让生成器做这些呢？

php artisan generate:resource post --fields="title:string, body:text"

如果您对每个确认都说“是”，这个单独的命令将为您提供以下模板的模板

  • app/models/Post.php
  • app/controllers/PostsController.php
  • app/database/migrations/timestamp-create_posts_table.php（包括模式）
  • app/database/seeds/PostsTableSeeder.php

脚手架

脚手架生成器与generate:resource类似，但它将为这些文件添加一些基本的模板，作为便利。

例如，当运行generate:scaffold post时，您的控制器模板将是

<?php

class PostsController extends \BaseController {

	/**
	 * Display a listing of posts
	 *
	 * @return Response
	 */
	public function index()
	{
	    $posts = Post::all();

	    return View::make('posts.index', compact('posts'));
	}

	/**
	 * Show the form for creating a new post
	 *
	 * @return Response
	 */
	public function create()
	{
        return View::make('posts.create');
	}

	/**
	 * Store a newly created post in storage.
	 *
	 * @return Response
	 */
	public function store()
	{
	    $validator = Validator::make($data = Input::all(), Post::$rules);

	    if ($validator->fails())
	    {
	        return Redirect::back()->withErrors($validator)->withInput();
	    }

	    Post::create($data);

	    return Redirect::route('posts.index');
	}

	/**
	 * Display the specified post.
	 *
	 * @param  int  $id
	 * @return Response
	 */
	public function show($id)
	{
	    $post = Post::findOrFail($id);

	    return View::make('posts.show', compact('post'));
	}

	/**
	 * Show the form for editing the specified post.
	 *
	 * @param  int  $id
	 * @return Response
	 */
	public function edit($id)
	{
		$post = Post::find($id);

		return View::make('posts.edit', compact('post'));
	}

	/**
	 * Update the specified resource in storage.
	 *
	 * @param  int  $id
	 * @return Response
	 */
	public function update($id)
	{
		$post = Post::findOrFail($id);

		$validator = Validator::make($data = Input::all(), Post::$rules);

        if ($validator->fails())
        {
            return Redirect::back()->withErrors($validator)->withInput();
        }

		$post->update($data);

		return Redirect::route('posts.index');
	}

	/**
	 * Remove the specified resource from storage.
	 *
	 * @param  int  $id
	 * @return Response
	 */
	public function destroy($id)
	{
		Post::destroy($id);

		return Redirect::route('posts.index');
	}

}

请注意，您被鼓励修改这个生成的控制器。它只是提供了一个起点。

配置

您可能想修改您的模板 - 生成文件的格式。为了允许这样做，您需要发布生成器在幕后将引用的模板。

php artisan generate:publish-templates

这会将所有模板复制到您的app/templates目录。您可以按需修改这些模板以符合您的格式。如果您希望不同的目录

php artisan generate:publish-templates --path=app/foo/bar/templates

当您运行generate:publish-templates命令时，它还会将配置发布到app/config/packages/way/generators/config/config.php。此文件看起来可能如下

<?php

return [

    /*
    |--------------------------------------------------------------------------
    | Where the templates for the generators are stored...
    |--------------------------------------------------------------------------
    |
    */
    'model_template_path' => '/Users/jeffreyway/Desktop/generators-testing/app/templates/model.txt',

    'scaffold_model_template_path' => '/Users/jeffreyway/Desktop/generators-testing/app/templates/scaffolding/model.txt',

    'controller_template_path' => '/Users/jeffreyway/Desktop/generators-testing/app/templates/controller.txt',

    'scaffold_controller_template_path' => '/Users/jeffreyway/Desktop/generators-testing/app/templates/scaffolding/controller.txt',

    'migration_template_path' => '/Users/jeffreyway/Desktop/generators-testing/app/templates/migration.txt',

    'seed_template_path' => '/Users/jeffreyway/Desktop/generators-testing/app/templates/seed.txt',

    'view_template_path' => '/Users/jeffreyway/Desktop/generators-testing/app/templates/view.txt',


    /*
    |--------------------------------------------------------------------------
    | Where the generated files will be saved...
    |--------------------------------------------------------------------------
    |
    */
    'model_target_path'   => app_path('models'),

    'controller_target_path'   => app_path('controllers'),

    'migration_target_path'   => app_path('database/migrations'),

    'seed_target_path'   => app_path('database/seeds'),

    'view_target_path'   => app_path('views')

];

此外，当你在该文件中时，请注意你还可以更新每个生成器的默认目标目录。

快捷键

因为你可能需要反复输入这些命令，创建别名是有意义的。

# Generator Stuff
alias g:m="php artisan generate:model"
alias g:c="php artisan generate:controller"
alias g:v="php artisan generate:view"
alias g:s="php artisan generate:seed"
alias g:mig="php artisan generate:migration"
alias g:r="php artisan generate:resource"

例如，这些可以存储在你的~/.bash_profile或~/.bashrc文件中。