wislem/scaffenger

0.6.6 2015-06-12 08:00 UTC

Requires

• php: >=5.5.9
• folklore/image: 0.2.*
• illuminate/support: >=5.1.0
• laravelcollective/html: ~5.0
• pingpong/trusty: 2.1.*@dev

MIT

• Peter Lazaridis

README

A scaffolding generator for any database setup ;)

It has its own UI (can be swapped with any custom made template).

Supports a total of 17 column types including:

Column type	Description
pk	The primary key of the table (usually id)
slug	A varchar that gets slugified by the column with name title and type text
text	Plain text
textarea	Plain textarea
password	A password column (has several functionalities for changing it or not preloading its value etc.)
wysiwyg	It's a textarea marked as a wysiwyg along with the proper css class to load your preferred js editor (I'm using summernote here)
date	A date field that gets formatted according to your needs and shows a datepicker in forms
datetime	See date plus time support
fk	If your table has relationships, then this type is for you
image	Using dropzone.js to handle this on forms, shows thumbnail with lightbox in list view
file	TODO
bool	A 0
order	input[type="number"] in forms and can be updated in the list view on the fly
select	A set of custom selections (can be anything in your db table -- enum, tinyint... w/e)
url	Text column (input[type="url"] in forms)
number	Int column (input[type="number"] in forms)
email	Email column (input[type="email"] in forms)
address	TODO

Installation steps

Step 1: Install package

Add the package inside your composer.json requirements:

composer require wislem/scaffenger

Add the ServiceProvider to your config/app.php file:

'Wislem\Scaffenger\ScaffengerServiceProvider',

In the User class, add the ShinobiTrait:

use Pingpong\Traits\TrustyTrait;

class User extends Model implements AuthenticatableContract, CanResetPasswordContract {

	use Authenticatable, CanResetPassword, TrustyTrait;
	
	// ...
}

Step 2: Publish

php artisan vendor:publish

This will publish the following:

• Config files
• Migrations
• Seeds
• Assets
• Views

Step 3: Run migrations and seeds

Add seeds to your main DatabaseSeeder class

<?php

use Illuminate\Database\Seeder;
use Illuminate\Database\Eloquent\Model;

class DatabaseSeeder extends Seeder {

	/**
	 * Run the database seeds.
	 *
	 * @return void
	 */
	public function run()
	{
		Model::unguard();
		
		$this->call('PermissionTableSeeder');
		$this->call('RoleTableSeeder');
		$this->call('UserTableSeeder');
	}

}

Migrate and seed:

php artisan migrate
php artisan db:seed
composer dump-autoload

That last command is so that Scaff's seeders will be autoloaded.

Result of the above actions

• DB tables: users, password_resets (default Laravel migration) permissions, roles, permission_role, role_user (Pingpong\Trusty migrations) media, tests (Scaffenger's migrations)
• Seeds
  • Roles
    • Administrator
    • Moderator
    • Member
  • Permission
    • access.admin
  • Users
    • [e-mail]:admin

Step 4

Navigate to /admin and play around.

What now?

Create your db table config files inside

/config/scaffenger/tables

based on

/config/scaffenger/tables/guide.php

E.g.

/config/scaffenger/tables/pages.php

and then you can navigate to

/admin/list/pages

to manage your db table through the UI.

Don't forget to add your newly created scaffold to the menu

/config/scaffenger/config.php

Set your own custom controller for Scaffenger's custom actions like so:

Create your custom controller in your app/Http/Controllers

<?php namespace App\Http\Controllers;

class CustomScaffengerController extends Controller {

  public function __construct()
  {
    $this->middleware('scaffenger.auth');
  }

  public function yourCustomAction(){
    //
  }

}

and set the route in /config/scaffenger/config.php