File: README.md

Recommend this page to a friend!

README.md

File:	`README.md`
Role:	Documentation
Content type:	`text/markdown`
Description:	Documentation
Class:	Laravel Admin Manage users and the site content they publish
Author:	By Shun Ram
Last change:
Date:	1 year ago
Size:	`18,632 bytes`

Download

Content Management System using laravel framework

Features:

Cms
Admin interface
Module based app
Theme based
Plugins
Roles and Permissions
Menu creation
User Management
Page Creation
Mail configurations
Site Configuration,etc </ol>

Version

| Laravel Version | Version | | --------------- | ---------- | | 5.4 | 1.0 to 2.0 | | 5.5 | >=2.1 | | 5.6 | >=2.1 | | 5.7 | >=2.1 | | 5.8 | >=2.2 | | 6 | >=2.3 | | 7 | >=2.3 | | 8 | >=2.4 |

Change Logs

Version v2.4

Data table version update
Seed command bug fix

Version v2.2

Data table version update
Bug fix

Version v2.1.1

CRUD Module added easy crud module with single command

##### `php artisan make:cms-module {module-name} {--crud}`
eg:
php artisan make:cms-module test --crud

CRUD view create crud views using artisan command

##### `php artisan make:cms-crudviews`
it will create 2 file inside resources/views/admin

`index.blade.php` `edit.blade.php`

Install:

composer require phpworkers/cms

Requiremments:

Laravel 5.4 or later
laravelcollective/html: ~5.0
yajra/laravel-datatables-oracle: ~9.0
unisharp/laravel-filemanager: ^1.8

After Install:

// Add following Lines to `config/app.php` providers array
//html
Collective\Html\HtmlServiceProvider::class,
//datatable
Yajra\DataTables\DatatablesServiceProvider::class,
Ramesh\Cms\CmsServiceProvider::class,

// Add Following Lines to `config/app.php`  aliases array
'Form' => Collective\Html\FormFacade::class,
'Html' => Collective\Html\HtmlFacade::class,
'Cms' => Ramesh\Cms\Facades\Cms::class,

Then Run Following commands

# Publishing css,js,config files,core modules,theme,etc
php artisan vendor:publish

# Publishing filemanager resources
php artisan vendor:publish --provider="UniSharp\LaravelFilemanager\LaravelFilemanagerServiceProvider"

composer dump-autoload

# Migrate our tables
php artisan cms-migrate

# Seeding
php artisan db:cms-seed

#register modules to table
php artisan update:cms-module

#register plugins
php artisan update:cms-plugins

#regiser menus
php artisan update:cms-menu

Open your route/web.php and remove rollowing lines(route)

Route::get('/', function () {
    return view('welcome');
});

then run

php artisan serve

and open localhost:8000/administrator

Username : admin

Password : admin123

Documents

Folder Structure
Theme
What is Module?
Core
Local
List of core modules
Create Own module
Artisian Commands
Skin
Helper
Core Helper functions
Plugins

Folder Structure

Main path

  cms (main)
    |
    |__core
    |  |
    |  |__core modules
    |
    |__local
        |
        |__themes
            |
            |__local modules

1.cms : cms path is the main path of our app,that contain

      1.1 : core
      1.2 : local

    1.1 : core : core path is core module path ,that contain number of core modules,avoid to write core modules

        1.1.1 : core modules -> core path contain number of core modules

    1.2 : local : local path contain theme,we can create multiple theme

      1.2.1 : local modules -> theme path contain number of local module(user create module)

Skin path

  public
    public (main)
    |
    |_skin
        |
        |__theme name
                |
                |__css,js,vendor,fonts,etc

    1 : public ->public folder is default folder in laravel

        1.1 : skin -> skin folder is our assets folder

        1.1.1 : theme name -> folder name is theme name , that contain css, fonts ,js,etc

Theme

Theme is main part of our package,we can create multiple theme,our package is theme and moduler based,all theme is placed on cms->local folder <br> Default theme is theme1

Create Theme

Just create new folder inside of cms->local

Change theme

If you want to change theme?its very easy <br> Go to adminpanel->site configuration->change theme <br>

Modules

Module is is a mechanism to group controller, views, modules, etc that are related, otherword module is pice of code or package of laravel

Core

core is folder,that contain core modules (pre-defind) Module<br>

> Note: Don't change any code of core module's

Local

local folder contain local module,which is created by user

Create own module

php artisan make:cms-module {module-name}

eg :

php artisan make:cms-module helloworld

<br>helloworld module is created under current theme folder <br> then register our module to database for feature use <br> <b>php artisan update:cms-module</b> <br />

<h5>Where is the entry point (provider) of the module?</h5> open provider folder under cms/local/{module} <br /> that provider is same as laravel provider so boot and register method is important and additionaly we have some functions <br /> <ol> <li>

registerRoot   -> registerRoot method is used to registreing our custom module routes

</li> <li>

registerAdminRoot -> registerAdminRoot method is used to registering our custom module admin routes

</li> <li>

registerViews -> registerViews method is used to registering our custom module views

</li> </ol> if you want to enable this method,just uncommands calls inside register method of your provider thats all :) ,lets see files in modules,<br> <ol> <li>module.json ->file</li> <li>composer.json ->file</li> <li>menu.xml -> file</li> <li>routes.php -> file</li> <li>adminroutes -> file</li> <li>Controller -> folder</li> <li>Database ->folder</li> <li>Models -> folder</li> <li>config -> folder</li> <li>resourcesc-> folder</li> <li>Events -> folder</li> <li>Listeners -> folder</li> <li>Mail -> folder</li> <li>Middleware -> folder</li> <li>helpers ->folder</li> </ol>

module.json

{
    "name": "helloworld",
    "version": "0.0.1",
    "type": "local",
    "providers": ["Providers\\HelloworldServiceProvider"]
}

<tr>
  <th>
    Parameter
  </th>
  <th>
    Data type
  </th>
  <th>
    Use
  </th>
  <th>
    is optional?
  </th>
</tr>

</thead> <tbody>

<tr>
  <td>
    name
  </td>
  <td>
    string 
  </td>
  <td>
    name of the module
  </td>
  <td>
    NO
  </td>
</tr>
<tr>
  <td>
    version
  </td>
  <td>
    string 
  </td>
  <td>
    version of the module
  </td>
  <td>
    NO
  </td>
</tr>
<tr>
  <td>
    type
  </td>
  <td>
    string (core/local) 
  </td>
  <td>
    type of the module
  </td>
  <td>
    NO
  </td>
</tr>
<tr>
  <td>
    providers
  </td>
  <td>
    Array 
  </td>
  <td>
    Provider of this module,provider is register point of our module
  </td>
  <td>
    NO
  </td>
</tr>
<tr>
  <td>
    plugins
  </td>
  <td>
    string (relative path of plugin)
  </td>
  <td>
    plugin path,that used to defind plugin
  </td>
  <td>
    YES
  </td>
</tr>
<tr>
  <td>
    helpers
  </td>
  <td>
    object (relative path of helpers)
  </td>
  <td>
    helpers path,that used to defind helpers,helpers contain common functions,we can use any where
    <br>
    eg:<br>
    <code>
      "helpers" : {
          "HelperName1":"cms\\core\\blog\\helpers\\Blog",
          "HelperName2":"some path",
          ....
        }
    </code>
  </td>
  <td>
    YES
  </td>
</tr>
<tr>
  <td>
    search
  </td>
  <td>
    object (relative path of search class)
  </td>
  <td>
    search path,that used to defind search helper,search class functions, this is used to make our module is searchable
    <br>
    eg:<br>
    <code>
      "helpers" : {
          "HelperName1":"cms\\core\\blog\\helpers\\Blog",
          "HelperName2":"some path",
          ....
        }
    </code>
  </td>
  <td>
    YES
  </td>
</tr>
<tr>
  <td>configuration</td>
  <td>string (view file path of configuration)</td>
  <td>configuration is used to view or edit module configuration
    eg:<br />
    <code>
      "configuration" : "user::admin.configuration.configuration",
    </code>
    <br />
    Above example is taken from user module,that mean user configuration is place on cms/core/user/admin/configuration/configuraion.blade.php
  </td>
  <td>
    YES
  </td>
</tr>
<tr>
  <td>configuration_data</td>
  <td>string (configuration data function path)</td>
  <td>configuration data is get module configuration from function,its define function name,this function should return module configuration<br />
    eg:<br />
    <code>
      "configuration_data" : "\\cms\\core\\user\\Controllers\\UserController@getConfigurationData"
    </code>
    <br />
    Above example is taken from user module, <br />
    that mean user configuration function is place on <b>cms/core/user/controller/UserController.php <b>and function name is <b>getConfigurationData</b>
    <br />
    <code>
      /* <br />
       * configurations option<br />
       */<br />
      public function getConfigurationData()<br />
      {<br />
          $group = UserGroupModel::where('status',1)->where('id','!=',1)->orderBy('group','Asc')->pluck("group","id");<br />
          return ['user_group'=>$group];<br />
      }<br />
    </code>
    <br />
    Above function return available user groups
  </td> 
  <td>
    YES
  </td>
</tr>

</tbody> </table> <h4>composer.json</h4> <code> { "name": "cms/user", "description": "", "authors": [

{
  "name": "Ramesh",
  "email": "shunramit@gmail.com"
}

], "autoload": {

"psr-4": {     
}

} } </code><br /> composer.json file is contain detail about module and author and that contain autoload <br /> just leave it this one, we will add autoload feature in later <br /> <h4>menu.xml</h4> menu.xml is used for add menu and menu group in adminpanel like joomla menu <br /> <pre class='brush: xml;'> < ?xml version="1.0" encoding="utf-8"? > <menus>

 &lt;group name="General" order="0">
     &lt;menugroup name="Users" icon="fa fa-user" order="0">
         &lt;menu name="View Users" route="user.index" />
         &lt;menu name="Add User" route="user.create" />
      &lt;/menugroup>
  &lt;/group>

</menus> </pre> <table> <thead>

<tr>
  <th>
    Tag
  </th>
  <th>
    Use
  </th>
  <th>
    Parent
  </th>
  <th>
    Attributes
  </th>
</tr>

</thead> <tbody>

<tr>
  <td>
     <code>&lt;menus></code>
  </td>
  <td>
    menus tag is main tag of the menu.xml,that is bootstarp of menu.xml
  </td>
  <td>
    NULL
  </td>
  <td>
    NULL
  </td>
</tr>
<tr>
  <td>
     <code>&lt;group></code>
  </td>
  <td>
    group tag is defind menu type,default type is general,you can create own group using name attribute
  </td>
  <td>
    <code>&lt;menus></code>
  </td>
  <td>
    <ul>
      <li>name <br />
        name attribute is defind name of the menu type<br />
        name is mandtory attribute
      </li>
      <li>
        order <br />
        order attribute defind order of the menutype
      </li>
    </ul>
  </td>
</tr>
<tr>
  <td>
     <code>&lt;menugroup></code>
  </td>
  <td>
    menugroup tag is defind menu group for example user module menus is placed under user menugroup
    <i>Menugroup is optional</i>
  </td>
  <td>
    <code>&lt;menus></code>
  </td>
  <td>
    <ul>
      <li>name <br />
        name attribute is defind name of the menu group<br />
        name is mandtory attribute
      </li>
      <li>
        order <br />
        order attribute defind order of the menu group
      </li>
    </ul>
  </td>
</tr>
<tr>
  <td>
     <code>&lt;menu></code>
  </td>
  <td>
    menu tag is used to give a link otherword its just clickable link
  </td>
  <td>
    <code>&lt;menus> OR &lt;menugroup> </code>
  </td>
  <td>
    <ul>
      <li>name <br />
        name attribute is defind name of the menu group<br />
        name is mandtory attribute
      </li>
      <li>icon <br />
        icon attribute is used to add font awsome icon<br />
      </li>
      <li>route <br />
        route attribute is accept named route<br />
        <i>if you want add url?just use <b>is_url </b> attribute <br />
          eg : <br />
          <code>
            &lt;menu name="Module Configurations" route="/administrator/configurations/module/1" is_url="1"/>
          </code>
        </i>
      </li>
      <li>is_url <br />
        is_url attribute is used to identify given menu route is url or named route,if is_url="1" means given route is url otherwise given route is named roue
      </li>
      <li>
        order <br />
        order attribute defind order of the menu group
      </li>
    </ul>
  </td>
</tr>

</tbody> </table> <h4> routes.php </h4> <p>routes.php file contain routes of the frontend app exclude admin routes<br /> don't have routes.php?,just create it.. :) <br /> if you don't like file name?<br /> we have good solution for you <br /> go to your module main provider and find registerRoot function then change it <br /> </p> <h4>adminroutes.php</h4> <p> adminroutes.php file contain routes of the admin <br /> this file is include admin middlewares and admin route group with administrator prefix<br /> if you dont want admin middleware of current module <br /> go to your module provider and find registerAdminRoot method and remove middleware </p> <h4>Folders of the modules</h4> <table> <thead>

<tr>
  <th>
    Name
  </th>
  <th>
    Use
  </th>
  <th>
    Sub-folders
  </th>
</tr>

</thead> <tbody>

<tr>
  <td>
    Controller
  </td>
  <td>
    controller folder contain controllers
  </td>
  <td>
    -
  </td>
</tr>
<tr>
  <td>
    Database
  </td>
  <td>
    Database folder contain migrations and seeds
  </td>
  <td>
    Migration  -> that contain migrations
    Seeds  -> that contain seeds
  </td>
</tr>
<tr>
  <td>Models</td>
  <td>Models folder contain Models class</td>
  <td>-</td>
</tr>
<tr>
  <td>helpers</td>
  <td>helpers folder contain helpers class</td>
  <td>-</td>
</tr>
<tr>
  <td>providers</td>
  <td>providers folder contain providers class</td>
  <td>-</td>
</tr>
<tr>
  <td>resources</td>
  <td>resources folder contain assets and views</td>
  <td>views,assets</td>
</tr>
<tr>
  <td>Mail</td>
  <td>Mail folder contain Mail class</td>
  <td>-</td>
</tr>
<tr>
  <td>Events</td>
  <td>Events folder contain Events class</td>
  <td>-</td>
</tr>
<tr>
  <td>Listeners</td>
  <td>Listeners folder contain Listeners class</td>
  <td>-</td>
</tr>
<tr>
  <td>Middleware</td>
  <td>Middleware folder contain Middleware class</td>
  <td>-</td>
</tr>
<tr>
  <td>Console</td>
  <td>Console folder contain artisan comands</td>
  <td>Commands</td>
</tr> 
<tr>
  <td>config </td>
  <td>config folder contain config array like roles (deprecated) and mailer configurations</td>
  <td>-</td>
</tr>

</tbody> </table> <h3>Artisian Commands</h3> <p>we provide more artisan commands</p> <p>imagin we have more than 30 artisan commands,its not remebarable,but you know default laravel commands so we have some idea,we added one common word for all laravel commands,thats it,now easily you can remember our commands</p> eg: <br /> default command for creating laravel controller is <br /> <b>php artisan make:controller {controller-name} </b> <br /> our comand is <br /> <b>php artisan make:<u>cms-</u>controller {controller-name} <u>{module-name}</u></b> <br /> deafult migrate command is <br> <b>php artisan migrate</b> our migrate command is <br> <b>php artisan cms-migrate</b> <br> and one more we have our own commands,its not high count,but very usefull <h4>List of our commands</h4> <ol> <li>

<b>php artisan make:cms-module {module-name}</b>
<br />
this is used to make new module

</li> <li>

<b>php artisan update:cms-menu</b> <br>
this command is used to update or register menus

</li> </ol> <h4>create new artisan commands for your module</h4> if you want create new comand <br /> <b>php artisan make:cms-command {command-name} {module-name}</b> <br> file is created under console/commands folder inside of your module <br> <h4>how to enable own commands?</h4> <br> open your module provider then create commands array <br> eg : <br /> <pre>

/*
 * artisan command
 */
protected $commands = [
    'cms\core\{module-name}\Console\Commands\{Commandclass}'
];

</pre> please replace module-name and commandclass like <pre>

/*
 * artisan command
 */
protected $commands = [
    'cms\core\menu\Console\Commands\AdminMenu'
];

</pre> <br> then create method <br> <pre>

/*
 * register commands
 */
protected function registerCommand()
{
    $this->commands($this->commands);
}

</pre> then add following line to register method <pre> $this->registerCommand(); </pre> eg: <pre> public function register() {

  $this->registerViews();
  $this->registerRoot();
  $this->registerAdminRoot();
  $this->registerCommand();

} </pre>

<h1>What is next?</h1> now i am working on moving this package to react,V3.O will release soon

About us

Advertise on this site

For more information send a message to info at phpclasses dot org.

File: README.md

Contents

Content Management System using laravel framework

Features:

Version

Change Logs

Version v2.4

Version v2.2

Version v2.1.1

Install:

Requiremments:

After Install:

Then Run Following commands

Username : admin

Password : admin123

Documents

Folder Structure

Main path

Skin path

Theme

Create Theme

Change theme

Modules

Core

Local

Create own module

module.json