library yii-illuminate

cst/yii-illuminate

A bridge to Laravel awesomeness

This package makes easy the integration with some Laravel components, _(*1)

Requirements

The following versions of PHP are supported., _(*2)

• PHP 5.6
• HHVM (not tested)

Installation

You can install the package using the Composer package manager. You can install it by running this command in your project root:, _(*3)

composer require cst/yii-illuminate

Components

Migrate command

Supercharges Yii MigrateCommand with all the functionality of the Laravel Schema Builder, _(*4)

Add the following block to your config file:, _(*5)

'commandMap'=> [
    'migrate'=> [
        'class' => '\CST\Yii\Illuminate\Console\MigrateCommand',
        'migrationTable' => 'yii_migrations',
        'connectionID' => 'db',
    ],
],

Queues

Queues allow you to defer the processing of a time consuming task, such as sending an e-mail, until a later time, thus drastically speeding up the web requests to your application., _(*6)

RedisQueue, _(*7)

Add the following block to your config file:, _(*8)

'queue' => [
    'class' => '\CST\Yii\Illuminate\Queue\RedisQueue',
    'encryptionKey' => '<random-string-of-16bytes>',
    'config' => [
        'cluster' => false,
        'default' => [
            'host'     => '<HOST>',
            'port'     => 6379,
            'database' => 0,
        ],
    ]
],

Configuring queue command, _(*9)

Add the following block to your config file:, _(*10)

'commandMap'=> [
    ...,
    'queue'=> [
        'class' => '\CST\Yii\Illuminate\Console\QueueCommand',
    ],
],

Queuing jobs:, _(*11)

Yii::app()->queue->push(new SendEmail($message));

or, _(*12)

use CST\Yii\Illuminate\Queue\DispatchesJobs;

$this->dispatch(new SendEmail($message));

Helper Functions

app(string $component = null)

Get the Yii App instance. It's a shortcut for Yii::app(). You can also pass the component name to get the instance., _(*13)

app('clientScript')->registerScriptFile(...);

t(string $category, string $message, array $params = [], string $source = null, string $language = null)

Yii::t() shortcut for translating messages., _(*14)

t('Project', 'Save changes');

view(string $path, array $data, bool $return)

Renders evaluated view contents for the given view. Replaces the typical $this->render(...), _(*15)

view('user/view', ['user' => $user]);

viewPartial(string $path, array $data, bool $return)

Renders evaluated view contents for the given view and it does not apply a layout to the rendered result. Replaces the typical $this->renderPartial(...), _(*16)

viewPartial('user/pic', ['user' => $user]);

request(string $key, $default = null)

Get an instance of the current request or an input item from the request., _(*17)

$modelId = request('id')

asset(string $path)

Generate an asset path for the application theme., _(*18)

asset('js/main.js');
asset('images/logo.png');

url(string $path, array $parameters, bool $secure)

Generate a url for the application., _(*19)

url('project/view', ['id' => 1]);