https://github.com/loveorigami/yii2-webshell
https://github.com/loveorigami/yii2-webshell
shell yii2
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/loveorigami/yii2-webshell
- Owner: loveorigami
- License: mit
- Created: 2018-06-13T10:39:42.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-06-07T06:45:30.000Z (about 7 years ago)
- Last Synced: 2025-12-30T22:32:59.525Z (6 months ago)
- Topics: shell, yii2
- Language: PHP
- Size: 8.79 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# yii2-webshell
It is a [fork from] (https://github.com/asinfotrack/yii2-webshell)
Yii2-Webshell allows you to execute any shell command from a web-interface. This is especially useful
to call console-commands from the frontend. The execution is done via AJAX and a special action-class
(`ShellAction`).
The output of the shell action __is displayed live__ (line by line).
## Installation
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
"loveorigami/yii2-webshell": "*"
###### ShellAction
This is the action you can attach to any controller via its `actions()`-method. Here you define who and who
the action can be accessed. All the regular RBAC-controls are of course available.
The following is an example for a configuration calling a yii-console-command under windows:
```php
class MyController extends \yii\web\Controller
{
//...
public function actions()
{
return [
'my-shell-action'=>[
'class'=>'lo\wshell\actions\ShellAction',
'command'=>'my-console-command/index',
'yiiScript'=>'@app/yii',
],
];
}
//...
}
```
### Widgets
###### ShellWidget
The widget allows you to create a console like container in your views, which communicates with a `ShellAction`
as documented above. The following represents a full configuration:
```php
echo Button::widget([
'label'=>'Run',
'options'=>[
'data-shell-widget-run'=>'my-shell-widget',
],
])
echo ShellWidget::widget([
'id'=>'my-shell-widget',
'route'=>['my-controller/my-shell-action'],
'autorun'=>false,
'initialContent'=>Yii::t('app', 'Ready and waiting...'),
'clientOptions'=>[
//custom client options here
],
])
```
As you can see, the console can either be ran automatically or not. In any case you can create buttons which will then
trigger the action. To do so simply use the attribute `data-shell-widget-run` and fill it with the id of the `ShellWidget`.
You can customize all the js-options (including the attribute name) with the `clientOptions` property of the widget.
For a full documentation of the widgets possibilities check out the doc within its code.