Laravel 5 repository generator.

1.0.5 2016-09-19 07:16 UTC

This package is not auto-updated.

Last update: 2024-11-09 20:50:43 UTC


README

Laravel 5 repository generator.

Usage

Step 1: Install Through Composer

composer require laravel_tools_dev/repoist --dev

Step 2: Add the Service Provider

You'll only want to use these generators for local development, so you don't want to update the production providers array in config/app.php. Instead, add the provider in app/Providers/AppServiceProvider.php, like so:

public function register()
{
	if ($this->app->isLocal()) {
		$this->app->register('Kurt\Repoist\RepoistServiceProvider');
	}
}

Step 3: Publish and edit the configurations

Run php artisan vendor:publish from the console to configure the Repoist according to your needs.

Step 4: Run Artisan!

You're all set. Run php artisan from the console, and you'll see the new commands in the make:repository namespace section.

Examples

Repositories Without Schema

php artisan make:repository Task

Will output:

  • app/Interfaces/Task/TaskRepositoryInterface.php (contract)
  • app/Repositories/Task/TaskRepositoryEloquent.php

Repositories With Schema

php artisan make:repository Task -m

Will output:

  • app/Interfaces/Task/TaskRepositoryInterface.php (contract)
  • app/Repositories/Task/TaskRepositoryEloquent.php
  • app/Models/TaskEloquent.php

Configurations

If somehow you cannot publish the config/repoist.php from artisan here you can copy and use it.

<?php

return [

    /**
     * Default paths.
     * In this case:
     *      app/Interfaces
     *      app/Repositories
     *      app/Models
     */
    'paths' => [
            'contract' => 'app/Interfaces',
            'eloquent' => 'app/Repositories',
            'model' => 'app/Models',
    ],
    /**
     * Configure the naming convention you wish for your repositories.
     *
     * Example: php artisan make:repository Users
     *      - Contract: UsersRepository
     *      - Eloquent: EloquentUsersRepository
     *      - Model   : UsersEloquent
     */
    'fileNames' => [

        'contract' => '{name}RepositoryInterface',
        'eloquent' => '{name}RepositoryEloquent',
        'model' => '{name}Eloquent',

    ],

];