README

Quick start

Required setup

In the require key of composer.json file add the following

"msamec/mcl": "dev-master"

Run the Composer update comand

$ composer update

In your config/app.php add 'Msamec\Mcl\MclServiceProvider' to the end of the $providers array

'providers' => array(

    'Illuminate\Foundation\Providers\ArtisanServiceProvider',
    'Illuminate\Auth\AuthServiceProvider',
    ...
    'Msamec\Mcl\MclServiceProvider',

),

Usage

Model

In models directory instead of creating .php file, create folder with the same name you would name previous said model. For example if you wanted to create model User.php, instead you would create folder Something. Inside that folder create .php file named Main.php. This file will be used as a fallback if a file for certain role does not exist. It should look something like this:

|-- app
|   |-- models
|   |   |-- Something
|   |   |   |-- Main.php

Main.php must have namespace because for every model(folder) you create, it must contain class Main.

Example:

<?php namespace Something;
class Main extends Eloquent {
  public static function foo(){
    echo 'foo';
  }
}

Next you can create class for different roles you have.

Note: If one of your roles does one thing and other roles all do the same thing. You don't need to create role class for every role you have and define same behaviour in every class. Define default behaviour in your Main class and MCL will fallback to that class if class for certain role does not exist.

Next we will create class for User role and name it User.php. It is recommended that you name role classes same name as roles in you app.

|-- app
|   |-- models
|   |   |-- Something
|   |   |   |-- Main.php
|   |   |   |-- User.php

<?php namespace Something;
use Something\Main;
class User extends Main {
  public static function bar(){
    echo 'bar';
  }
}

General method for calling those models looks like this:

Mcl::model('namespace', 'function name', 'role', 'arg1', 'arg2', ...);

Examples:

Mcl::model('Something', 'bar', 'User');
Mcl::model('Something', 'foo', 'User');
Mcl::model('Something', 'foo', 'NonExistantClass');

Results:

bar
foo
foo

View

return Mcl::make('view folder', 'role', $data = array(), $merge_data = array());

This is how structure should look:

|-- app
|   |-- views
|   |   |-- something
|   |   |   |-- main.blade.php
|   |   |   |-- god.blade.php

Based on the structure above, you would use code similar to this:

return Mcl::make('something', 'God', $someData);

Mcl::make returns Laravel's view object so you can use View methods like with->() and others.

msamec / mcl

Maintainers

Details