Skip to content

Commit 1974d5c

Browse files
inhereinhere
committed
refactor: rename AbstracutFlags to FlagsParser
1 parent fb565c0 commit 1974d5c

File tree

7 files changed

+30
-30
lines changed

7 files changed

+30
-30
lines changed

‎src/Concern/HelperRenderTrait.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
namespace Toolkit\PFlag\Concern;
44

55
use Toolkit\Cli\Color\ColorTag;
6-
use Toolkit\PFlag\AbstractFlags;
6+
use Toolkit\PFlag\FlagsParser;
77
use Toolkit\PFlag\Flag\Argument;
88
use Toolkit\PFlag\Flag\Option;
99
use Toolkit\PFlag\FlagType;
@@ -180,7 +180,7 @@ protected function doBuildHelp(array $argDefines, array $optDefines, bool $withC
180180
* @param array|Option|Argument $define
181181
*
182182
* @return array
183-
* @see AbstractFlags::DEFINE_ITEM for array $define
183+
* @see FlagsParser::DEFINE_ITEM for array $define
184184
*/
185185
protected function formatDesc($define): array
186186
{

‎src/Concern/RuleParserTrait.php‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
namespace Toolkit\PFlag\Concern;
44

55
use InvalidArgumentException;
6-
use Toolkit\PFlag\AbstractFlags;
6+
use Toolkit\PFlag\FlagsParser;
77
use Toolkit\PFlag\Exception\FlagException;
88
use Toolkit\PFlag\FlagType;
99
use Toolkit\Stdlib\Arr;
@@ -28,7 +28,7 @@ trait RuleParserTrait
2828
* The options rules
2929
*
3030
* **rule item**
31-
* - array It is define item, see {@see AbstractFlags::DEFINE_ITEM}
31+
* - array It is define item, see {@see FlagsParser::DEFINE_ITEM}
3232
* - string Value is rule(format: `type;desc;required;default;shorts`)
3333
*
3434
* **data type**
@@ -61,7 +61,7 @@ trait RuleParserTrait
6161
* The arguments rules
6262
*
6363
* **rule item**
64-
* - array It is define item, see {@see AbstractFlags::DEFINE_ITEM}
64+
* - array It is define item, see {@see FlagsParser::DEFINE_ITEM}
6565
* - string Value is rule(format: `type;desc;required;default;shorts`)
6666
*
6767
* **data type**
@@ -93,7 +93,7 @@ trait RuleParserTrait
9393
*
9494
* **array rule**
9595
*
96-
* - will merge an {@see AbstractFlags::DEFINE_ITEM}
96+
* - will merge an {@see FlagsParser::DEFINE_ITEM}
9797
*
9898
* **string rule**
9999
*
@@ -111,21 +111,21 @@ trait RuleParserTrait
111111
* @param int $index
112112
* @param bool $isOption
113113
*
114-
* @return array {@see AbstractFlags::DEFINE_ITEM}
114+
* @return array {@see FlagsParser::DEFINE_ITEM}
115115
* @see argRules
116116
* @see optRules
117117
*/
118118
protected function parseRule($rule, string $name = '', int $index = 0, bool $isOption = true): array
119119
{
120120
$shortsFromRule = [];
121121
if (is_array($rule)) {
122-
$item = Arr::replace(AbstractFlags::DEFINE_ITEM, $rule);
122+
$item = Arr::replace(FlagsParser::DEFINE_ITEM, $rule);
123123
// set alias by array item
124124
$shortsFromRule = $item['shorts'];
125125
} else { // parse string rule.
126-
$sep = AbstractFlags::RULE_SEP;
127-
$item = AbstractFlags::DEFINE_ITEM;
128-
$rule = trim((string)$rule, AbstractFlags::TRIM_CHARS);
126+
$sep = FlagsParser::RULE_SEP;
127+
$item = FlagsParser::DEFINE_ITEM;
128+
$rule = trim((string)$rule, FlagsParser::TRIM_CHARS);
129129

130130
// not found sep char.
131131
if (strpos($rule, $sep) === false) {
@@ -203,7 +203,7 @@ protected function parseRule($rule, string $name = '', int $index = 0, bool $isO
203203
*/
204204
protected function parseRuleOptName(string $key): array
205205
{
206-
$key = trim($key, AbstractFlags::TRIM_CHARS);
206+
$key = trim($key, FlagsParser::TRIM_CHARS);
207207
if (!$key) {
208208
throw new FlagException('flag option name cannot be empty');
209209
}

‎src/Flags.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
*
3333
* @package Toolkit\PFlag
3434
*/
35-
class Flags extends AbstractFlags
35+
class Flags extends FlagsParser
3636
{
3737
/**
3838
* @var self
@@ -490,7 +490,7 @@ public function setArgRules(array $argRules): void
490490
* @see argRules for an rule
491491
*
492492
*/
493-
public function addArgByRule(string $name, $rule): AbstractFlags
493+
public function addArgByRule(string $name, $rule): FlagsParser
494494
{
495495
parent::addArgByRule($name, $rule);
496496

@@ -689,7 +689,7 @@ public function setOptRules(array $optRules): void
689689
* @see optRules for rule
690690
*
691691
*/
692-
public function addOptByRule(string $name, $rule): AbstractFlags
692+
public function addOptByRule(string $name, $rule): FlagsParser
693693
{
694694
parent::addOptByRule($name, $rule);
695695

‎src/AbstractFlags.php‎ renamed to ‎src/FlagsParser.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@
1818
use function strpos;
1919

2020
/**
21-
* class AbstractFlags
21+
* class FlagsParser
2222
* abstract parser
2323
*/
24-
abstract class AbstractFlags implements ParserInterface
24+
abstract class FlagsParser implements ParserInterface
2525
{
2626
use HelperRenderTrait;
2727
use QuickInitTrait;

‎src/SFlags.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
*
3535
* @package Toolkit\PFlag
3636
*/
37-
class SFlags extends AbstractFlags
37+
class SFlags extends FlagsParser
3838
{
3939
/**
4040
* @var self

‎src/Validator/CondValidator.php‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
namespace Toolkit\PFlag\Validator;
44

55
use Closure;
6-
use Toolkit\PFlag\AbstractFlags;
6+
use Toolkit\PFlag\FlagsParser;
77

88
/**
99
* class CondValidator
1010
*/
1111
abstract class CondValidator extends AbstractValidator
1212
{
1313
/**
14-
* @var AbstractFlags
14+
* @var FlagsParser
1515
*/
1616
protected $fs;
1717

@@ -20,7 +20,7 @@ abstract class CondValidator extends AbstractValidator
2020
* if return false, will skip call checkInput();
2121
*
2222
* @var callable
23-
* @psalm-param Closure($fs AbstractFlags):bool
23+
* @psalm-param Closure($fs FlagsParser):bool
2424
*/
2525
protected $cond;
2626

@@ -41,17 +41,17 @@ public function __invoke($value, string $name): bool
4141
}
4242

4343
/**
44-
* @return AbstractFlags
44+
* @return FlagsParser
4545
*/
46-
public function getFs(): AbstractFlags
46+
public function getFs(): FlagsParser
4747
{
4848
return $this->fs;
4949
}
5050

5151
/**
52-
* @param AbstractFlags $fs
52+
* @param FlagsParser $fs
5353
*/
54-
public function setFs(AbstractFlags $fs): void
54+
public function setFs(FlagsParser $fs): void
5555
{
5656
$this->fs = $fs;
5757
}

‎test/CommonTest.php‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
namespace Toolkit\PFlagTest;
44

5-
use Toolkit\PFlag\AbstractFlags;
5+
use Toolkit\PFlag\FlagsParser;
66
use Toolkit\PFlag\Exception\FlagException;
77
use Toolkit\PFlag\Flags;
88
use Toolkit\PFlag\SFlags;
@@ -21,7 +21,7 @@ public function testStopOnFirstArg(): void
2121
$this->runStopOnFirstArg($sfs);
2222
}
2323

24-
private function runStopOnFirstArg(AbstractFlags $fs): void
24+
private function runStopOnFirstArg(FlagsParser $fs): void
2525
{
2626
$fs->addOptsByRules([
2727
'name' => 'string',
@@ -74,7 +74,7 @@ public function testSkipOnUndefined_false(): void
7474
$this->runSkipOnUndefined_false($sfs);
7575
}
7676

77-
private function runSkipOnUndefined_false(AbstractFlags $fs): void
77+
private function runSkipOnUndefined_false(FlagsParser $fs): void
7878
{
7979
$fs->addOptsByRules([
8080
'name' => 'string',
@@ -100,9 +100,9 @@ public function testSkipOnUndefined_true(): void
100100
}
101101

102102
/**
103-
* @param AbstractFlags $fs
103+
* @param FlagsParser $fs
104104
*/
105-
private function runSkipOnUndefined_true(AbstractFlags $fs): void
105+
private function runSkipOnUndefined_true(FlagsParser $fs): void
106106
{
107107
$fs->addOptsByRules([
108108
'name' => 'string',

0 commit comments

Comments
 (0)