@@ -33,7 +33,7 @@ $config = [
3333 // Default value will returned if param is not setted
3434 // or params has not value.
3535
36- 'help' => 'p ',
36+ 'help' => 'Some description about param ',
3737 // [optional], [string]
3838 // Text that will returned, if you request help
3939
@@ -58,7 +58,7 @@ $CliArgs = new CliArgs($config);
5858
5959Examples of config:
6060
61- # 0
61+ 0
6262``` php
6363
6464// Simple configs
@@ -72,8 +72,8 @@ $config2 = [
7272];
7373
7474// The config3 and config4 are equal
75- $config = ['foo' => 'f', 'bar' => 'b', 'a'];
76- $config = [
75+ $config3 = ['foo' => 'f', 'bar' => 'b', 'a'];
76+ $config4 = [
7777 'foo' => [
7878 'alias' => 'f',
7979 ],
@@ -84,7 +84,7 @@ $config = [
8484];
8585```
8686
87- # 1
87+ 1
8888``` php
8989$config = [
9090 'help' => [
@@ -130,7 +130,7 @@ $CliArgs = new CliArgs($config);
130130 print_r($CliArgs->getArg('u'));
131131```
132132
133- # 2
133+ 2
134134``` php
135135 $config = [
136136 'flag' => [
@@ -161,7 +161,7 @@ $CliArgs = new CliArgs($config);
161161
162162```
163163
164- # 3
164+ 3
165165``` php
166166 $config = [
167167 'name' => [
@@ -207,11 +207,61 @@ $CliArgs = new CliArgs($config);
207207```
208208### Create a new instance
209209``` php
210-
211210// simple config
212211$config = ['foo' => 'f', 'bar' => 'b'];
213212$CliArgs = new CliArgs($config);
213+ ```
214+
215+ ### Methods
216+
217+ ```
218+ > example.php --foo Hello --bar World
219+ ```
220+
221+ ###### new CliArgs([ array|null] )
222+ Constructor.
223+ ``` php
224+ $config = ['foo' => 'f', 'bar' => 'b'];
225+ $CliArgs = new CliArgs($config);
226+ ```
227+
228+ ###### getArgs(): array
229+ Get all params.
230+ ``` php
231+ $argv = $CliArgs->getArgs();
232+ print_r($argv);
233+ // array(
234+ // 'foo' => 'Hello',
235+ // 'bar' => 'World',
236+ // )
237+ ```
214238
239+ ###### getArg(string $arg): mixed
240+ Get one param
241+ ``` php
242+ $arg = $CliArgs->getArg('foo');
243+ // or $CliArgs->getArg('f');
244+ echo $arg; // Hello
245+ ```
246+
247+ ###### isFlagExists(string $arg, string|null $alias): bool
248+ Checks if the given key exists in the arguments console list.
249+ Returns true if $arg or $alias are exists
250+ ``` php
251+ echo $CliArgs->isFlagExists('f'); // false
252+ echo $CliArgs->isFlagExists('foo'); // true
253+ echo $CliArgs->isFlagExists('foo', 'f'); // true
254+ ```
255+
256+ ###### getArguments(): array
257+ Get prepared ARGV
258+ ``` php
259+ print_r($CliArgs->getArguments());
260+ // array(
261+ // 0 => 'example.php'
262+ // 'foo' => 'Hello',
263+ // 'bar' => 'World',
264+ // )
215265```
216266
217267## Installation
0 commit comments