Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/megaads-vn/clara-app-store
https://github.com/megaads-vn/clara-app-store
Last synced: 10 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/megaads-vn/clara-app-store
- Owner: megaads-vn
- License: mit
- Created: 2019-09-25T09:06:19.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-05-15T03:56:30.000Z (over 3 years ago)
- Last Synced: 2024-09-18T12:52:03.541Z (4 months ago)
- Language: PHP
- Size: 79.1 KB
- Stars: 0
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Clara
A module management in Laravel
## System requirements
- PHP: >=5.6
- Laravel Framework: >=5.4
## 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 the module classes are not loaded automatically. You can autoload your modules in composer.json
```json
{
"autoload": {
"psr-4": {
"App\\": "app/",
"Modules\\": "app/Modules"
}
},
"extra": {
"merge-plugin": {
"include": [
"app/Modules/*/module.json"
]
}
}
}
```
5. Publish file config
With the module submit function, must have url configuration of store. To generate clara configuration file:
```
php artisan vendor:publish --provider="Megaads\Clara\Providers\ModuleServiceProvider"
```
## Module Management
### Create module
```
php artisan module:make ...
```
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 composer.json. All configurations in the module.json will be merged to main composer.json.
- start.php: the module's start file that will be loaded every requests. So module actions, module views... can be registered in this file.
### Install module from a file or an URL
```
php artisan module:install ...
```
### Enable module
```
php artisan module:enable ...
```
### Disable module
```
php artisan module:disable ...
```
### Remove module
```
php artisan module:remove ...
```
### Remove all modules
```
php artisan module:remove-all
```
## Module Action
### Fire a action
Using PHP
```php
Module::action('action_name', [params]);
```
Using blade statement
```php
@action('action_name', [params])
```
### Handle a action
```php
Module::onAction('action_name', function ($params) {
}, PRIORITY);
```
Handle a action using a controller
```php
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
### Register a view
Using PHP
```php
Module::view('view_name', [params], IS_MULTI_LAYER);
```
```php
Module::view('view_name', 'This is a view placeholder', IS_MULTI_LAYER);
```
```php
Module::view('view_name', function() {
return 'This is a view placeholder';
}, IS_MULTI_LAYER);
```
Using blade statement
```php
@view('view_name', [params])
```
### Handle a view
```php
Module::onView('view_name', function ($params) {
return view('module-namespace:home.index');
}, PRIORITY);
```
Handle a view using a controller
```php
Module::onView('view_name', 'Modules\Example\Controllers\HomeController@index', PRIORITY);
```
## Module variable
### Register a variable
Using PHP
```php
$variable = Module::variable('handle', $default, PRIORITY);
```
Using blade statement
```php
@variable('variable_name', 'handle', $default);
```
### Handle a variable
```php
Module::onVariable('hanlde', function ($params) {
}, PRIORITY, NUUM_OF_PARAM);
```
## Module Assets
Clara will create a symbol link from module asset directory `app/Modules/{ModuleName}/Resources/Assets` to `public/modules/{ModuleNamespace}`
### Include a module asset
Using PHP
```php
```
Using blade statement
```php
```
### Create module asset link manually
```
php artisan module:asset:link ...
```
## Module Utility Methods
### Get all modules
```php
$modules = Module::all();
```
### Get the current module
```php
$module = Module::this();
```
### Get module options
```php
$option = Module::option('option.name');
```
### Set module option
```php
$option = Module::option('option.name', 'option.value');
```
## License
The Clara is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)
## Contact us / Instant feedback
Email: [email protected] | [email protected]
If you find a bug, please report it [here on Github](https://github.com/megaads-vn/clara/issues)