refact: refacting the flag and sflag common logic

Author: inhere

README.md

@@ -33,7 +33,7 @@ $flags = ['--name', 'inhere', '--age', '99', '--tag', 'php', '-t', 'go', '--tag'
 
 $optRules = [
     'name', // string
-    'age'   => 'int,required', // set required
+    'age'   => 'int;required', // set required
     'tag,t' => FlagType::ARRAY,
     'f'     => FlagType::BOOL,
 ];
@@ -81,7 +81,7 @@ $scriptFile = array_shift($rawFlags);
 $optRules = [
     // some option rules
     'name', // string
-    'age'   => 'int,required', // set required
+    'age'   => 'int;required', // set required
     'tag,t' => FlagType::ARRAY,
     'f'     => FlagType::BOOL,
 ];
@@ -92,7 +92,8 @@ $argRules = [
     'arrArg' => 'array',
 ];
 
-$fs = SFlags::new()->parseDefined($rawFlags, $optRules, $argRules);
+$fs = SFlags::new();
+$fs->parseDefined($rawFlags, $optRules, $argRules);
 ```
 
 Run demo:
@@ -148,7 +149,7 @@ $arrArg = $fs->getArg('arrArg'); // array{"arr0", "arr1"}
 
 The options/arguments rules
 
-- string value is rule(`type,required,default,desc`).
+- string value is rule(`type;required;default;desc`).
 - array is define item `SFlags::DEFINE_ITEM`
 - supportted type see `FlagType::*`
 
@@ -161,8 +162,8 @@ $rules = [
      'long,s' => 'int',
      'f'      => 'bool',
      'long'   => FlagType::STRING,
-     'tags'   => 'array', // can also: int[], string[]
-     'name'   => 'type,required,default,the description message', // with default, desc, required
+     'tags'   => 'array', // can also: ints, strings
+     'name'   => 'type;required;default;the description message', // with default, desc, required
 ]
 ```
 

example/flag-demo.php

@@ -0,0 +1,46 @@
+<?php declare(strict_types=1);
+
+/**
+ * This file is part of toolkit/pflag.
+ *
+ * @link     https://github.com/php-toolkit
+ * @author   https://github.com/inhere
+ * @license  MIT
+ */
+
+use Toolkit\PFlag\Flags;
+use Toolkit\PFlag\FlagType;
+
+require dirname(__DIR__) . '/test/bootstrap.php';
+
+// run demo:
+// php example/sflags-demo.php --name inhere --age 99 --tag go -t php -t java -f arg0 arr0 arr1
+$flags = $_SERVER['argv'];
+// NOTICE: must shift first element.
+$scriptFile = array_shift($flags);
+
+$fs = Flags::new();
+$fs->setScriptFile($scriptFile);
+
+// add options
+$fs->addOpt('age', 'a', 'this is a int option', FlagType::INT);
+$fs->addOptByRule('name,n', 'string;true;;this is a string option');
+$fs->addOptsByRules([
+    'tag,t' => 'strings;no;;array option, allow set multi times',
+    'f'     => 'bool;no;;this is an bool option',
+]);
+
+// add arguments
+$fs->addArg('strArg', 'the first arg, is string', 'string', true);
+$fs->addArg('arrArg', 'the second arg, is array', 'strings');
+
+// edump($fs);
+if (!$fs->parse($flags)) {
+    return;
+}
+
+vdump(
+// $fs->getRawArgs(),
+    $fs->getOpts(),
+    $fs->getArgs()
+);

example/sflags-demo.php

@@ -1,4 +1,5 @@
 <?php declare(strict_types=1);
+
 /**
  * This file is part of toolkit/pflag.
  *
@@ -7,40 +8,42 @@
  * @license  MIT
  */
 
-use Toolkit\PFlag\FlagType;
 use Toolkit\PFlag\SFlags;
 
 require dirname(__DIR__) . '/test/bootstrap.php';
 
 // run demo:
 // php example/sflags-demo.php --name inhere --age 99 --tag go -t php -t java -f arg0 arr0 arr1
-$rawFlags = $_SERVER['argv'];
+$flags = $_SERVER['argv'];
 // NOTICE: must shift first element.
-$scriptFile = array_shift($rawFlags);
+$scriptFile = array_shift($flags);
 
 $optRules = [
     // some option rules
-    'name', // string
-    'age'    => 'int,required', // set required
-    'tag,t' => FlagType::ARRAY,
-    'f'      => FlagType::BOOL,
+    'name'  => 'string;;;this is an string option', // string
+    'age'   => 'int;required;;this is an int option', // set required
+    'tag,t' => 'strings;no;;array option, allow set multi times',
+    'f'     => 'bool;no;;this is an bool option',
 ];
 $argRules = [
     // some argument rules
     'string',
     // set name
-    'arrArg' => 'array',
+    'arrArg' => 'strings;[a,b];;this is an array arg, allow multi value',
 ];
 
 $fs = SFlags::new();
-// $fs = $fs->parseDefined($rawFlags, $optRules, $argRules);
+$fs->setScriptFile($scriptFile);
 
 $fs->setOptRules($optRules);
 $fs->setArgRules($argRules);
-$fs->parse($rawFlags);
+
+if (!$fs->parse($flags)) {
+    return;
+}
 
 vdump(
-    // $fs->getRawArgs(),
+// $fs->getRawArgs(),
     $fs->getOpts(),
     $fs->getArgs()
 );