1	<?php
2
3	declare(strict_types=1);
4
5	namespace Celemas\Cli;
6
7	use RuntimeException;
8
9	/**
10	* @api
11	*/
12	abstract class Command
13	{
14	protected string $name = '';
15	protected string $group = '';
16	protected string $prefix = '';
17	protected string $description = '';
18	protected ?Output $output = null;
19
20	abstract public function run(): string|int;
21
22	public function name(): string
23	{
24	return $this->name;
25	}
26
27	public function group(): string
28	{
29	return $this->group;
30	}
31
32	public function prefix(): string
33	{
34	return $this->prefix === '' ? strtolower($this->group) : $this->prefix;
35	}
36
37	public function description(): string
38	{
39	return $this->description;
40	}
41
42	public function script(): string
43	{
44	return $_SERVER['argv'][0] ?? '';
45	}
46
47	public function output(Output $output): static
48	{
49	$this->output = $output;
50
51	return $this;
52	}
53
54	public function echo(string $message, string $color = '', string $background = ''): void
55	{
56	if ($this->output) {
57	$this->output->echo($message, $color, $background);
58
59	return;
60	}
61
62	throw new RuntimeException('Output missing');
63	}
64
65	public function echoln(string $message, string $color = '', string $background = ''): void
66	{
67	if ($this->output) {
68	$this->output->echoln($message, $color, $background);
69
70	return;
71	}
72
73	throw new RuntimeException('Output missing');
74	}
75
76	public function info(string $message): void
77	{
78	$this->echoln($message);
79	}
80
81	public function success(string $message): void
82	{
83	$this->echoln($message, 'green');
84	}
85
86	public function warn(string $message): void
87	{
88	$this->echoln($message, 'yellow');
89	}
90
91	public function error(string $message): void
92	{
93	$this->echoln($message, 'red');
94	}
95
96	public function color(string $text, string $color, string $background = ''): string
97	{
98	if ($this->output) {
99	return $this->output->color($text, $color, $background);
100	}
101
102	throw new RuntimeException('Output missing');
103	}
104
105	public function indent(
106	string $text,
107	int $indent,
108	?int $max = null,
109	): string {
110	if ($this->output) {
111	return $this->output->indent($text, $indent, $max);
112	}
113
114	throw new RuntimeException('Output missing');
115	}
116
117	public function help(): void
118	{
119	$this->helpHeader(withOptions: false);
120	}
121
122	protected function helpHeader(bool $withOptions = false): void
123	{
124	$script = $this->script();
125	$name = $this->name;
126	$prefix = $this->prefix();
127	$desc = $this->description;
128
129	if ($desc !== '') {
130	$label = $this->color('Description:', 'brown') . "\n";
131	$this->echo("{$label}  {$desc}\n\n");
132	}
133
134	$usage = $this->color('Usage:', 'brown') . "\n  php {$script} {$prefix}:{$name}";
135
136	if ($withOptions) {
137	$this->echo("{$usage} [options]\n\n");
138	$this->echoln($this->color('Options:', 'brown'));
139
140	return;
141	}
142
143	$this->echo("{$usage}\n");
144	}
145
146	protected function helpOption(string $option, string $description): void
147	{
148	$this->echo('    ' . $this->color($option, 'green') . "\n");
149	$this->echo($this->indent($description, 8, 80) . "\n");
150	}
151	}

---

Branches

Below are the source code lines that represent each code branch as identified by Xdebug. Please note a branch is not necessarily coterminous with a line, a line may contain multiple branches and therefore show up more than once. Please also be aware that some branches may be implicit rather than explicit, e.g. an if statement always has an else as part of its logical flow even if you didn't write one.

Command->color

96	public function color(string $text, string $color, string $background = ''): string
97	{
98	if ($this->output) {

99	return $this->output->color($text, $color, $background);

102	throw new RuntimeException('Output missing');
103	}

Command->description

39	return $this->description;
40	}

Command->echo

54	public function echo(string $message, string $color = '', string $background = ''): void
55	{
56	if ($this->output) {

57	$this->output->echo($message, $color, $background);
58
59	return;

62	throw new RuntimeException('Output missing');
63	}

Command->echoln

65	public function echoln(string $message, string $color = '', string $background = ''): void
66	{
67	if ($this->output) {

68	$this->output->echoln($message, $color, $background);
69
70	return;

73	throw new RuntimeException('Output missing');
74	}

Command->error

91	public function error(string $message): void
92	{
93	$this->echoln($message, 'red');
94	}

Command->group

29	return $this->group;
30	}

Command->help

119	$this->helpHeader(withOptions: false);
120	}

Command->helpHeader

122	protected function helpHeader(bool $withOptions = false): void
123	{
124	$script = $this->script();
125	$name = $this->name;
126	$prefix = $this->prefix();
127	$desc = $this->description;
128
129	if ($desc !== '') {

130	$label = $this->color('Description:', 'brown') . "\n";
131	$this->echo("{$label}  {$desc}\n\n");
132	}
133
134	$usage = $this->color('Usage:', 'brown') . "\n  php {$script} {$prefix}:{$name}";

134	$usage = $this->color('Usage:', 'brown') . "\n  php {$script} {$prefix}:{$name}";
135
136	if ($withOptions) {

137	$this->echo("{$usage} [options]\n\n");
138	$this->echoln($this->color('Options:', 'brown'));
139
140	return;

143	$this->echo("{$usage}\n");
144	}

Command->helpOption

146	protected function helpOption(string $option, string $description): void
147	{
148	$this->echo('    ' . $this->color($option, 'green') . "\n");
149	$this->echo($this->indent($description, 8, 80) . "\n");
150	}

Command->indent

106	string $text,
107	int $indent,
108	?int $max = null,
109	): string {
110	if ($this->output) {

111	return $this->output->indent($text, $indent, $max);

114	throw new RuntimeException('Output missing');
115	}

Command->info

76	public function info(string $message): void
77	{
78	$this->echoln($message);
79	}

Command->name

24	return $this->name;
25	}

Command->output

47	public function output(Output $output): static
48	{
49	$this->output = $output;
50
51	return $this;
52	}

Command->prefix

34	return $this->prefix === '' ? strtolower($this->group) : $this->prefix;

34	return $this->prefix === '' ? strtolower($this->group) : $this->prefix;

34	return $this->prefix === '' ? strtolower($this->group) : $this->prefix;

34	return $this->prefix === '' ? strtolower($this->group) : $this->prefix;
35	}

Command->script

44	return $_SERVER['argv'][0] ?? '';
45	}

Command->success

81	public function success(string $message): void
82	{
83	$this->echoln($message, 'green');
84	}

Command->warn

86	public function warn(string $message): void
87	{
88	$this->echoln($message, 'yellow');
89	}