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

---

Paths

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

Command->color

87	public function color(string $text, string $color, string $background = ''): string
88	{
89	return $this->out()->color($text, $color, $background);
90	}

Command->description

42	return $this->description;
43	}

Command->echo

57	public function echo(string $message, string $color = '', string $background = ''): void
58	{
59	$this->out()->echo($message, $color, $background);
60	}

Command->echoln

62	public function echoln(string $message, string $color = '', string $background = ''): void
63	{
64	$this->out()->echoln($message, $color, $background);
65	}

Command->error

82	public function error(string $message): void
83	{
84	$this->out()->echolnErr($message, 'red');
85	}

Command->group

32	return $this->group;
33	}

Command->help

107	$this->helpHeader(withOptions: false);
108	}

Command->helpHeader

110	protected function helpHeader(bool $withOptions = false): void
111	{
112	$script = $this->script();
113	$name = $this->name;
114	$prefix = $this->prefix();
115	$desc = $this->description;
116
117	if ($desc !== '') {
118	$label = $this->color('Description:', 'brown') . "\n";
119	$this->echo("{$label}  {$desc}\n\n");
120	}
121
122	$usage = $this->color('Usage:', 'brown') . "\n  php {$script} {$prefix}:{$name}";
122	$usage = $this->color('Usage:', 'brown') . "\n  php {$script} {$prefix}:{$name}";
123
124	if ($withOptions) {
125	$this->echo("{$usage} [options]\n\n");
126	$this->echoln($this->color('Options:', 'brown'));
127
128	return;

110	protected function helpHeader(bool $withOptions = false): void
111	{
112	$script = $this->script();
113	$name = $this->name;
114	$prefix = $this->prefix();
115	$desc = $this->description;
116
117	if ($desc !== '') {
118	$label = $this->color('Description:', 'brown') . "\n";
119	$this->echo("{$label}  {$desc}\n\n");
120	}
121
122	$usage = $this->color('Usage:', 'brown') . "\n  php {$script} {$prefix}:{$name}";
122	$usage = $this->color('Usage:', 'brown') . "\n  php {$script} {$prefix}:{$name}";
123
124	if ($withOptions) {
131	$this->echo("{$usage}\n");
132	}

110	protected function helpHeader(bool $withOptions = false): void
111	{
112	$script = $this->script();
113	$name = $this->name;
114	$prefix = $this->prefix();
115	$desc = $this->description;
116
117	if ($desc !== '') {
122	$usage = $this->color('Usage:', 'brown') . "\n  php {$script} {$prefix}:{$name}";
123
124	if ($withOptions) {
125	$this->echo("{$usage} [options]\n\n");
126	$this->echoln($this->color('Options:', 'brown'));
127
128	return;

110	protected function helpHeader(bool $withOptions = false): void
111	{
112	$script = $this->script();
113	$name = $this->name;
114	$prefix = $this->prefix();
115	$desc = $this->description;
116
117	if ($desc !== '') {
122	$usage = $this->color('Usage:', 'brown') . "\n  php {$script} {$prefix}:{$name}";
123
124	if ($withOptions) {
131	$this->echo("{$usage}\n");
132	}

Command->helpOption

134	protected function helpOption(string $option, string $description): void
135	{
136	$this->echo('    ' . $this->color($option, 'green') . "\n");
137	$this->echo($this->indent($description, 8, 80) . "\n");
138	}

Command->indent

93	string $text,
94	int $indent,
95	?int $max = null,
96	): string {
97	return $this->out()->indent($text, $indent, $max);
98	}

Command->info

67	public function info(string $message): void
68	{
69	$this->echoln($message);
70	}

Command->name

27	return $this->name;
28	}

Command->out

102	return $this->output ?? throw new RuntimeException('Output missing');
103	}

Command->output

50	public function output(Output $output): static
51	{
52	$this->output = $output;
53
54	return $this;
55	}

Command->prefix

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

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

Command->script

47	return $_SERVER['argv'][0] ?? '';
48	}

Command->success

72	public function success(string $message): void
73	{
74	$this->echoln($message, 'green');
75	}

Command->warn

77	public function warn(string $message): void
78	{
79	$this->out()->echolnErr($message, 'yellow');
80	}