1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace luya\console; |
4
|
|
|
|
5
|
|
|
use Yii; |
6
|
|
|
use yii\helpers\Console; |
7
|
|
|
use yii\console\Controller as BaseController; |
8
|
|
|
use luya\helpers\ObjectHelper; |
9
|
|
|
use yii\base\InvalidCallException; |
10
|
|
|
|
11
|
|
|
/** |
12
|
|
|
* Console Controller base class. |
13
|
|
|
* |
14
|
|
|
* Extends the base controller by adding helper methods to output responses based on its |
15
|
|
|
* muted behavior to run unit tests without respones. |
16
|
|
|
* |
17
|
|
|
* @author Basil Suter <[email protected]> |
18
|
|
|
* @since 1.0.0 |
19
|
|
|
*/ |
20
|
|
|
abstract class Controller extends BaseController |
21
|
|
|
{ |
22
|
|
|
public function init() |
23
|
|
|
{ |
24
|
|
|
parent::init(); |
25
|
|
|
|
26
|
|
|
// Ensure the console command is running under web application object. |
27
|
|
|
if (!ObjectHelper::isInstanceOf(Yii::$app, 'yii\console\Application', false)) { |
28
|
|
|
throw new InvalidCallException("The console controller can only run within a console Application context."); |
29
|
|
|
} |
30
|
|
|
} |
31
|
|
|
|
32
|
|
|
/** |
33
|
|
|
* Helper method to see if the current Application is muted or not. If the Application is muted, no output |
34
|
|
|
* will displayed. |
35
|
|
|
* |
36
|
|
|
* @return bool |
37
|
|
|
*/ |
38
|
|
|
public function isMuted() |
39
|
|
|
{ |
40
|
|
|
return Yii::$app->mute; |
41
|
|
|
} |
42
|
|
|
|
43
|
|
|
/** |
44
|
|
|
* Generates a printable string from a message. |
45
|
|
|
* |
46
|
|
|
* If a message is not a string, it will return var export to generate |
47
|
|
|
* a returnable string from a message. |
48
|
|
|
* |
49
|
|
|
* @param mixed $message |
50
|
|
|
* @return string |
51
|
|
|
* @since 1.0.22 |
52
|
|
|
*/ |
53
|
|
|
public function printableMessage($message) |
54
|
|
|
{ |
55
|
|
|
return is_scalar($message) ? $message : var_export($message, true); |
56
|
|
|
} |
57
|
|
|
|
58
|
|
|
/** |
59
|
|
|
* Helper method for writting console application output, include before and after wrappers. |
60
|
|
|
* |
61
|
|
|
* @param string $message The message which is displayed |
62
|
|
|
* @param string $color A color from {{\yii\helpers\Console}} color constants. |
63
|
|
|
*/ |
64
|
|
|
protected function output($message, $color = null) |
65
|
|
|
{ |
66
|
|
|
$format = []; |
67
|
|
|
if (!$this->isMuted()) { |
68
|
|
|
if ($color !== null) { |
69
|
|
|
$format[] = $color; |
70
|
|
|
} |
71
|
|
|
echo Console::ansiFormat("\r".$this->printableMessage($message)."\n", $format); |
72
|
|
|
} |
73
|
|
|
} |
74
|
|
|
|
75
|
|
|
/** |
76
|
|
|
* Helper method to stop the console command with an error message, outputError returns exit code 1. |
77
|
|
|
* |
78
|
|
|
* @param string $message The message which should be displayed. |
79
|
|
|
* @return int Exit code 1 |
80
|
|
|
*/ |
81
|
|
|
public function outputError($message) |
82
|
|
|
{ |
83
|
|
|
$this->output($message, Console::FG_RED); |
84
|
|
|
|
85
|
|
|
return 1; |
86
|
|
|
} |
87
|
|
|
|
88
|
|
|
/** |
89
|
|
|
* Helper method to stop the console command with a success message, outputSuccess returns exit code 0. |
90
|
|
|
* |
91
|
|
|
* @param string $message The message which sould be displayed |
92
|
|
|
* @return int Exit code 0 |
93
|
|
|
*/ |
94
|
|
|
public function outputSuccess($message) |
95
|
|
|
{ |
96
|
|
|
$this->output($message, Console::FG_GREEN); |
97
|
|
|
|
98
|
|
|
return 0; |
99
|
|
|
} |
100
|
|
|
|
101
|
|
|
/** |
102
|
|
|
* Helper method to stop the console command with a info message which is threated in case of returns as success |
103
|
|
|
* but does have a different output color (blue). outputInfo returns exit code 0. |
104
|
|
|
* |
105
|
|
|
* @param string $message The message which sould be displayed. |
106
|
|
|
* @return int Exit code 0 |
107
|
|
|
*/ |
108
|
|
|
public function outputInfo($message) |
109
|
|
|
{ |
110
|
|
|
$this->output($message, Console::FG_CYAN); |
111
|
|
|
|
112
|
|
|
return 0; |
113
|
|
|
} |
114
|
|
|
} |
115
|
|
|
|