PHPackages                             megaads/clara - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. megaads/clara

ActiveLibrary[Framework](/categories/framework)

megaads/clara
=============

Module management in Laravel

2.0.0(3y ago)2898↑100%MITPHPPHP >=5.6.4CI failing

Since Aug 13Pushed 7mo ago5 watchersCompare

[ Source](https://github.com/megaads-vn/clara)[ Packagist](https://packagist.org/packages/megaads/clara)[ Docs](https://www.megaads.vn)[ RSS](/packages/megaads-clara/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (4)Versions (63)Used By (0)

Clara
=====

[](#clara)

A module management in Laravel

System requirements
-------------------

[](#system-requirements)

- PHP: >=5.6
- Laravel Framework: >=5.4

Installation
------------

[](#installation)

Clara is packed as a composer package. So it can be installed quickly:

1. Require the composer package

    `composer require megaads/clara`
2. Register the provider:

    `Megaads\Clara\Providers\ModuleServiceProvider`
3. Register the facade:

    `Megaads\Clara\Facades\ModuleFacade`
4. Autoloading

By default, Module classes are not loaded automatically. You can autoload your modules in composer.json

```
{
    "autoload": {
        "psr-4": {
            "App\\": "app/",
            "Modules\\": "app/Modules"
        }
    },
    "extra": {
        "merge-plugin": {
            "include": [
                "app/Modules/*/module.json"
            ]
        }
    }
}
```

5. Publish Clara configurations

To override Clara default configuration options, you will need to publish Clara configuration file to the application's config directory.

```
php artisan vendor:publish --provider="Megaads\Clara\Providers\ModuleServiceProvider"

```

Module Management
-----------------

[](#module-management)

### Create module

[](#create-module)

```
php artisan module:make  ...

```

#### Naming conventions

[](#naming-conventions)

Module names should follow `UpperCamelCase` syntax (without any space characters). For example: `FacebookComment`

and module namespace in `kebab-case` that correspond to a module name in `CamelCase`. For example: `facebook-comment`

#### Folder structure

[](#folder-structure)

```
app
│
└───Modules

    └───ModuleName
        │
        └───Config
        │      app.php
        │
        └───Controllers
        │      Controller.php
        │      ...
        │
        └───Helpers
        │      helper.php
        │      ...
        │
        └───Middlewares
        │      ExampleMiddleware.php
        │      ...
        │
        └───Models
        │      ...
        │
        └───Resources
        │      Views
        │      Assets
        │      ...
        │
        └───Routes
        │      routes.php
        │      ...
        │
        └───Kernel.php
        │
        └───module.json
        │
        └───start.php

```

- `module.json`: the module configuration file is based on `composer.json` form. All properties in the `module.json` will be merged to `composer.json` of the project.
- `start.php`: the module's start file that will be loaded every requests. So module actions, module views... can be registered in this file.

### Module installing

[](#module-installing)

#### Install a module using the module name

[](#install-a-module-using-the-module-name)

```
php artisan module:install

```

Clara takes the name of the module that requested to search for it in the app repository that you have registered in `config/clara.php` configuration, after downloading the module files, Clara adds the module configuration to the `module.json` file

#### Install module list from `module.json`

[](#install-module-list-from-modulejson)

```
php artisan module:install

```

This will searches and downloads the modules listed in `module.json` from the app repository into the `app/Modules/` directory

#### Install a module from a zip file or an URL

[](#install-a-module-from-a-zip-file-or-an-url)

```
php artisan module:install   ...

```

### Enable a module

[](#enable-a-module)

```
php artisan module:enable  ...

```

### Disable a module

[](#disable-a-module)

```
php artisan module:disable  ...

```

### Remove a module

[](#remove-a-module)

```
php artisan module:remove  ...

```

### Remove all modules

[](#remove-all-modules)

```
php artisan module:remove-all

```

Module Action
-------------

[](#module-action)

### Fire a action

[](#fire-a-action)

Using PHP

```
Module::action('action_name', [params]);
```

Using blade statement

```
@action('action_name', [params])
```

### Handle a action

[](#handle-a-action)

```
Module::onAction('action_name', function ($params) {

}, PRIORITY);
```

Handle a action using a controller

```
Module::onAction('action_name', 'Modules\Example\Controllers\HomeController@action', PRIORITY);
```

By default, Clara supplies actions:

- module\_made
- module\_loaded
- module\_disabled
- module\_enabled
- module\_removed
- module\_removed\_all

Module View
-----------

[](#module-view)

### Register a view

[](#register-a-view)

Using PHP

```
Module::view('view_name', [params], IS_MULTI_LAYER);
```

```
Module::view('view_name', 'This is a view placeholder', IS_MULTI_LAYER);
```

```
Module::view('view_name', function() {
    return 'This is a view placeholder';
}, IS_MULTI_LAYER);
```

Using blade statement

```
@view('view_name', [params])
```

### Handle a view

[](#handle-a-view)

```
Module::onView('view_name', function ($params) {
    return view('{module-namespace}:home.index');
}, PRIORITY);
```

Handle a view using a controller

```
Module::onView('view_name', 'Modules\ExampleModule\Controllers\HomeController@index', PRIORITY);
```

Module variable
---------------

[](#module-variable)

### Register a variable

[](#register-a-variable)

Using PHP

```
$variable = Module::variable('handle', $default, PRIORITY);
```

Using blade statement

```
@variable('variable_name', 'handle', $default);
```

### Handle a variable

[](#handle-a-variable)

```
Module::onVariable('hanlde', function ($params) {
}, PRIORITY, NUUM_OF_PARAM);
```

Module Assets
-------------

[](#module-assets)

Clara will create a symbol link from module asset directory `app/Modules/{ModuleName}/Resources/Assets` to `public/modules/{module-namespace}` while a module was installed, made or enabled.

### Include a module asset

[](#include-a-module-asset)

Using PHP

```