iankov/control-panel

There is no license information available for the latest version (v1.0.13) of this package.

Admin panel for laravel

v1.0.13 2018-09-01 21:00 UTC

This package is not auto-updated.

Last update: 2020-03-20 18:30:36 UTC


README

 composer require iankov/control-panel
  • Update guards, providers, passwords in config/auth.php

    'guards' => [
        ...
        'admin' => [
            'driver' => 'session',
            'provider' => 'admins',
        ],
    ],
    'providers' => [
        ...
        'admins' => [
            'driver' => 'eloquent',
            'model' => Iankov\ControlPanel\Models\Admin::class,
        ],
    ],
    'passwords' => [
        ...
        'admins' => [
            'provider' => 'admins',
            'table' => 'admin_password_resets',
            'expire' => 60,
        ],
    ],
  • Publish config file

    php artisan vendor:publish --tag=icp_config
  • Publish public assets

    php artisan vendor:publish --tag=icp_public
  • Publish migrations

    php artisan vendor:publish --tag=icp_migrations
  • Publish seeds

    php artisan vendor:publish --tag=icp_seeds
  • Run migrations

    php artisan migrate
  • Run dump autoload

    composer dump-autoload
  • Run seeder to insert initial admin user. Login: admin@admin.com, Password: admin

    php artisan db:seed --class=Admins

Elfinder file manager integration

Laravel elfinder package

Configuration options

  • Add the ServiceProvider to the providers array in app/config/app.php

    Barryvdh\Elfinder\ElfinderServiceProvider::class
  • You need to copy the assets to the public folder, using the following artisan command:

    php artisan elfinder:publish
  • Copy vendor/iankov/control-panel/public/packages/barryvdh to public/barryvdh. You can do this by publishing iankov/control-panel assets

    php artisan vendor:publish --tag=icp_public
  • Publish the config file

    php artisan vendor:publish --provider='Barryvdh\Elfinder\ElfinderServiceProvider' --tag=config
  • Change elfinder config

        'route' => [
            'prefix' => 'control/elfinder',
            'middleware' => 'icp', //Set to null to disable middleware filter
        ],
        
        //required for default ckeditor integration: images/files browse/upload
        'roots' => [
            'images' => [
                'alias' => '/images',
                'driver' => 'LocalFileSystem', // driver for accessing file system (REQUIRED)
                'path' => public_path('images'), // path to files (REQUIRED)
                'URL' => '/images', // URL to files (REQUIRED)
                'uploadOrder' => ['allow', 'deny'],
                'uploadAllow' => ['image'], # allow any images
            ],
            'root' => [
                'alias' => '/',
                'driver' => 'LocalFileSystem', // driver for accessing file system (REQUIRED)
                'path' => public_path(''), // path to files (REQUIRED)
                'URL' => '/', // URL to files (REQUIRED)
            ]
        ],
        
        //default options for all roots
        'root_options' => array(
            'accessControl' => '', // filter callback (OPTIONAL)
            'tmbURL' => '/_tmb',
            'tmbPath' => public_path('_tmb').'/',
        ),
  • Create 'images' folder in your public dir to match roots.images config path

Developing a new module

Basic concept

Basic concept of building a module is to make a separate route file for the module. You can place it in a standard routes/ folder. I.e. if you make a module to create and delete news, it could be routes/control/news.php file with the following content:

Route::group(['prefix' => 'news', 'as' => 'news.'], function(){
    Route::get('create', ['as' => 'create', 'uses' => 'NewsController@create']);
    Route::delete('{id}', ['as' => 'delete', 'uses' => 'NewsController@delete']);
});

Registering a module

When you make a new module, you need to add it to config/icp.php file. Minimum requirement is to add route path to the module array like this:

'news' => [
    'route' => [
        'path' => base_path('routes/control/news.php'), //required
        'namespace' => '\App\Http\Controllers\Control', //optional
    ]
],

Optional parameter namespace defines a namespace for our controller. In our case NewsController is most likely located in /app/Http/Controllers/Control/NewsController.php

Adding menu item

After you register a module, you'll be able to use routes in config/icp-menu.php like this:

[
    'icon' => 'list', //menu icon <i class="fa fa-list"></i>
    'title' => 'News', //menu title text
    'link' => icp_route('news') //<a href="icp_route('news')"
],

This will add a new menu item into master template menu of your control panel. If you don't register your module you'll get an error route not found when using icp_route() or route() function in config/icp-menu.php.
However you can always use a regular string to define a link. It could be relative path like /control/news/list or a full url like http://you-site.com/news/1/edit.

icp_route() function is the same as standard laravel route() except that it adds the prefix config('icp.route.prefix-name') on the beginning of the given route.
I.e. config('icp.route.prefix-name') = 'control.'(by default) then icp_route('news.view') is equal to route('control.news.view)

Views

Most likely you'd want to use a master template of iankov/control-panel for you admin panel pages. This can easily be done by extending your blade template.

Sections available:

  • title - obviously it's a title
  • content - it can be any html, javascript, css, etc... to be inserted in the main part of master template
@extends('icp::master')

@section('title', 'Creating a new page...')

@section('content')
    main html body
@endsection

Changing stardard iankov/control-panel views

For this purpose just publish all views to resources/views directory.

php artisan vendor:publish --tag=icp_views

Now you have a set of files available for making changes in resources/views/vendor/icp.

Horizontal form groups

  • Create horizontal group elements like this
<div class="form-group ">
    <label class="col-sm-2 control-label">Name</label>
    <div class="col-sm-10">
        <input name="name" value="" placeholder="John Mitchel" type="text" class="form-control">
    </div>
</div>

When validation error occured, text of an error be shown in the bottom of the field. The field itself will have a red border.

  • Required array fields:

    • name - html field name attribute
    • label - label text
    • value - value of html element
    • items - only for icp::forms.horizontal.select-group. Array/object of items for <select> options
  • Additional array fields:

    • attr - array, any html attribute applied to html field
    • col1_class - first column class (default: col-sm-2)
    • col1_class - second column class (default: col-sm-10)
    • prepend - the same as items only for select-group, but these elements stay in front of other options
  • Example of form group usage.

    • Create <input> element

      @include('icp::forms.horizontal.text-group', ['name' => 'title', 'label' => 'Title', 'value' => old('title', $article->title)])
    • Create <select> element

      @include('icp::forms.horizontal.select-group', [
          'name' => 'category_id',
          'label' => 'Category',
          'value' => old('category_id', $article->category_id),
          'items' => $categories->pluck('title', 'id'),
          'prepend' => [0 => ' - ']
      ])
    • Create <input type="checkbox"> element

      @include('icp::forms.horizontal.checkbox-group', ['name' => 'active', 'value' => old('active', $article->active), 'label' => 'Active'])
    • Create <textarea> element

      @include('icp::forms.horizontal.textarea-group', ['name' => 'description', 'label' => 'Meta description', 'value' => old('description', $article->description)])