Console commands ​

To execute a console command open your terminal and change into the base directory of your LUYA project. The base directory is where folders like vendor, public_html, runtime are located, e. g. when you run the luya-kickstarter its in luya-kickstarter.

./vendor/bin/luya <command>

./vendor/bin/luya <command>

On Windows systems you can run commands from the public_html folder and run: php index.php <command>

Where command is one of the following commands below:

Standard built in commands ​

Global LUYA commands:

Admin UI commands:

CMS module commands:

Create your own command ​

You can create your own custom commands. Custom commands are stored as actions of controllers in the commands directory of a module. Commands can only be executed from the console and do not have view files to render.

Let's assume you have a module yourmodule with a controller NotifyController that includes two actions actionIndex and actionBar (stored in the file NotifyController.php within the commands directory of your module):

<?php

namespace yourmodule\commands;

class NotifyController extends \luya\console\Command
{
    public function actionIndex()
    {
        return $this->outputSuccess('Action successfully done');
    }

    public function actionBar()
    {
        return $this->outputError('Something failed inside this action');
    }
}

<?php

namespace yourmodule\commands;

class NotifyController extends \luya\console\Command
{
    public function actionIndex()
    {
        return $this->outputSuccess('Action successfully done');
    }

    public function actionBar()
    {
        return $this->outputError('Something failed inside this action');
    }
}

Always use ouputError($message) or outputSuccess($message) to return the status of the execution inside of the command, depending on this output we can handle PHPUnit test and return colorized outputs.

To run the actionIndex() from the above mentioned NotfyController controller in the yourmodule module:

./vendor/bin/luya yourmodule/notify

./vendor/bin/luya yourmodule/notify

to execute the actionBar() we have to change the route for the notify controller:

./vendor/bin/luya yourmodule/notify/bar

./vendor/bin/luya yourmodule/notify/bar

If you want to create a command without a module you can just add the the Command controller into the commands folder of your application and add the controller to your controllerMap of your configuration like the example below:

'controllerMap' => [
    'sync' => 'app\commands\SyncController',
],

'controllerMap' => [
    'sync' => 'app\commands\SyncController',
],

Now you could run the sync command like all other commands with ./vendor/bin/luya sync

Views and UrlManger ​

Its very often case where you like to render a view and send a mail inside a console command, like batch processing some data (newsletter for example). Therefore your views use the luya\helpers\Url class in order to generate urls.

As the console command does not know your web server URL and there is no parameter of your web server url, therefore LUYA has a special configuration property called luya\traits\ApplicationTrait -> $consoleHostInfo.

This value will be used when defined as base URL for the urlManager.

'consoleHostInfo' => 'https://luya.io',

'consoleHostInfo' => 'https://luya.io',