v3.0.0

Author: cheprasov

CHANGELOG.md

@@ -0,0 +1,11 @@
+## CHANGELOG
+
+### v3.0.0 (2019-02-02)
+Major:
+- Removed method `isFlagOrAliasExists`, please use isFlagExist
+- Renamed method `isFlagExists` to `isFlagExist`, changed second parameter of the method.
+- Will be thrown `CongifErrorException` if it is passed wrong config to constructor.
+- Method `getArg($key)` returns `true` or `false` when filter is `flag`.
+
+Patch:
+- Fixed default default arguments of default params

README.md

@@ -1,5 +1,5 @@
 [![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)
-# CliArgs v2.1.0 for PHP >= 5.5
+# CliArgs v3.0.0 for PHP >= 5.5
 
 ## About
 Class **CliArgs** helps to get options from the command line argument list easy.
@@ -76,7 +76,7 @@ $config = [
             // 'float' - cast to float before return.
             // 'bool' - cast to bool before return. Yes, true, 1 = TRUE, other = FALSE
             // 'json' - decode JSON data before return.
-            // 'flag' - will return TRUE, if key is exists in command line argument list.
+            // 'flag' - will return TRUE, if key is exists in command line argument list, otherwise - FALSE
             // <array> - use array for enums. Example use ['a', 'b', 'c'] to get only one of these.
             // <callable> - use function($value, $default) { ... } to process value by yourself
     ]
@@ -87,7 +87,7 @@ $CliArgs = new CliArgs($config);
 
 Examples of config:
 
-0
+Example 1
 ```php
 
 // Simple configs
@@ -113,7 +113,7 @@ $config4 = [
 ];
 ```
 
-1
+Example 2
 ```php
 $config = [
     'help' => [
@@ -136,15 +136,15 @@ $CliArgs = new CliArgs($config);
 ```
 Show help
 > some-script.php --help
-<?php if ($CliArgs->isFlagExists('help', 'h')) echo $CliArgs->getHelp('help'); ?>
+<?php if ($CliArgs->isFlagExist('help', 'h')) echo $CliArgs->getHelp('help'); ?>
 
 Show help only for param data
 > some-script.php --help data
-<?php if ($CliArgs->isFlagExists('help', 'h')) echo $CliArgs->getHelp('help'); ?>
+<?php if ($CliArgs->isFlagExist('help', 'h')) echo $CliArgs->getHelp('help'); ?>
 
 Show help for all params data
 > some-script.php --help data
-<?php if ($CliArgs->isFlagExists('help', 'h')) echo $CliArgs->getHelp(); ?>
+<?php if ($CliArgs->isFlagExist('help', 'h')) echo $CliArgs->getHelp(); ?>
 
 All the same:
 > some-script.php --data='{"foo":"bar"}' --user-id=42
@@ -162,7 +162,7 @@ or
     print_r($CliArgs->getArg('u'));
 ```
 
-2
+Example 3
 ```php
     $config = [
         'flag' => [
@@ -185,15 +185,15 @@ or
 > some-script.php --any="any value"
 
 <?php
-    print_r($CliArgs->isFlagExists('flag', 'f'));
+    print_r($CliArgs->isFlagExist('flag', 'f'));
     print_r($CliArgs->getArg('data'));
     print_r($CliArgs->getArg('d'));
     print_r($CliArgs->getArg('user-id'));
     print_r($CliArgs->getArg('u'));
 
 ```
 
-3
+Example 4
 ```php
     $config = [
         'name' => [
@@ -251,15 +251,15 @@ $CliArgs = new CliArgs($config);
 > example.php --foo Hello --bar World
 ```
 
-##### new CliArgs([array|null])
-Constructor.
+##### new CliArgs(array|null $config = null)
+Constructor. If config contents wrong aliases then ConfigErrorException will be thrown.
 ```php
 $config = ['foo' => 'f', 'bar' => 'b'];
 $CliArgs = new CliArgs($config);
 ```
 
 ##### getArgs(): array
-Get all params.
+The method returns all passed arguments which is specified in config.
 ```php
 $argv = $CliArgs->getArgs();
 print_r($argv);
@@ -269,38 +269,26 @@ print_r($argv);
 // )
 ```
 
-##### getArg(string $arg): mixed
-Get one param
+##### getArg(string $key): mixed | null
+Returns value for argument by key. If argument is not set, then it will return default value or `null`
 ```php
 $arg = $CliArgs->getArg('foo');
 // or $CliArgs->getArg('f');
 echo $arg; // Hello
 ```
 
-##### isFlagOrAliasExists(string $arg): bool
-Checks if the given key (or alias) exists in the arguments console list.
-Returns true if $arg or his alias are exists
+##### isFlagExist(string $key, boolean $checkAlias = true): bool
+Return `true` if key exists, otherwise the method returns `false`
+If `$checkAlias` is `true`, then the method will check key and alias, and will return `true` if key or alias exists.
+If `$checkAlias` is `false`, then the method will check only key and will return `true` only if key exists.
 ```php
-echo $CliArgs->isFlagOrAliasExists('f'); // true
-echo $CliArgs->isFlagOrAliasExists('foo'); // true
-
-$CliArgs->isFlagExists('foo', 'f') === $CliArgs->isFlagOrAliasExists('f');
-```
-
-##### isFlagExists(string $arg, string|null $alias): bool
-Checks if the given key exists in the arguments console list.
-Check of key or alias is independent.
-Returns true if $arg or $alias are exists
-```php
-echo $CliArgs->isFlagExists('f'); // false
-echo $CliArgs->isFlagExists('foo'); // true
-echo $CliArgs->isFlagExists('foo', 'f'); // true
-
-$CliArgs->isFlagExists('foo', 'f') === $CliArgs->isFlagOrAliasExists('f');
+echo $CliArgs->isFlagExist('f'); // false
+echo $CliArgs->isFlagExist('foo'); // true
+echo $CliArgs->isFlagExist('foo', 'f'); // true
 ```
 
 ##### getArguments(): array
-Get prepared ARGV
+Get prepared arguments from ARGV
 ```php
 print_r($CliArgs->getArguments());
 // array(
@@ -335,4 +323,4 @@ and add dependency to your project:
 
 ## Something doesn't work
 
-Feel free to fork project, fix bugs and finally request for pull
+Feel free to fork project, fix bugs and finally request for pull (do not forget write tests please)

composer.json

@@ -1,6 +1,6 @@
 {
   "name": "cheprasov/php-cli-args",
-  "version": "2.1.0",
+  "version": "3.0.0",
   "description": "Easy way to gets options from the command line argument list",
   "homepage": "http://github.com/cheprasov/php-cli-args",
   "minimum-stability": "stable",

src/CliArgs/CliArgs.php

@@ -10,9 +10,11 @@
  */
 namespace CliArgs;
 
+use CliArgs\Exception\ConfigErrorException;
+
 class CliArgs
 {
-    const VERSION = '2.1.0';
+    const VERSION = '3.0.0';
 
     const FILTER_BOOL  = 'bool';
     const FILTER_FLAG  = 'flag';
@@ -42,6 +44,7 @@ class CliArgs
 
     /**
      * @param array $config
+     * @throws ConfigErrorException
      */
     public function __construct(array $config = null)
     {
@@ -50,6 +53,7 @@ public function __construct(array $config = null)
 
     /**
      * @param array|null $config
+     * @throws ConfigErrorException
      */
     protected function setConfig(array $config = null)
     {
@@ -71,7 +75,7 @@ protected function setConfig(array $config = null)
             $newConfig[$key] = [
                 'key' => $key,
                 'alias' => isset($cfg['alias']) ? $cfg['alias'] : null,
-                'default' => array_key_exists('default', $cfg) ? $cfg['default'] : null,
+                'default' => isset($cfg['default']) ? $cfg['default'] : null,
                 'help' => isset($cfg['help']) ? $cfg['help'] : null,
                 'filter' => isset($cfg['filter']) ? $cfg['filter'] : null,
             ];
@@ -80,8 +84,14 @@ protected function setConfig(array $config = null)
 
         $this->aliases = [];
         foreach ($this->config as $key => $cfg) {
+            if (isset($this->aliases[$key])) {
+                throw new ConfigErrorException("Key or alias `{$key}` is already defined");
+            }
             $this->aliases[$key] = &$this->config[$key];
             if ($cfg['alias']) {
+                if (isset($this->aliases[$cfg['alias']])) {
+                    throw new ConfigErrorException("Key or alias `{$cfg['alias']}` is already defined");
+                }
                 $this->aliases[$cfg['alias']] = &$this->config[$key];
             }
         }
@@ -101,61 +111,71 @@ public function getArguments()
 
     /**
      * Checks if the given key exists in the arguments console list. Returns true if $arg or $alias are exists
-     * @param string $arg
-     * @param string|null $alias
+     * @param string $key
+     * @param boolean $checkAlias
      * @return bool
      */
-    public function isFlagExists($arg, $alias = null)
+    public function isFlagExist($key, $checkAlias = true)
     {
-        return array_key_exists($arg, $this->getArguments()) || $alias && array_key_exists($alias, $this->getArguments());
+        $arguments = $this->getArguments();
+        if (array_key_exists($key, $arguments)) {
+            return true;
+        }
+
+        if ($checkAlias && ($alias = $this->getAlias($key))) {
+            return array_key_exists($alias, $arguments);
+        }
+
+        return false;
     }
 
     /**
-     * Checks if the given key (or alias) exists in the arguments console list.
-     * @param string $arg
-     * @return bool
+     * @param string $key
+     * @return string|null
      */
-    public function isFlagOrAliasExists($arg)
+    protected function getAlias($key)
     {
-        if (!isset($this->aliases[$arg])) {
-            return false;
+        if (!isset($this->aliases[$key])) {
+            return null;
         }
-        $key = $this->aliases[$arg]['key'];
-        if (isset($this->aliases[$arg]['alias'])) {
-            $alias = $this->aliases[$arg]['alias'];
-        } else {
-            $alias = null;
+        $cfg = $this->aliases[$key];
+        if ($cfg['key'] === $key) {
+            return $cfg['alias'];
         }
-        return $this->isFlagExists($key, $alias);
+        return $cfg['key'];
     }
 
     /**
      * Get one param
-     * @param string $arg
+     * @param string $key
      * @return mixed
      */
-    public function getArg($arg)
+    public function getArg($key)
     {
-        if (!$cfg = $this->getArgFromConfig($arg)) {
+        if (!$cfg = $this->getArgConfig($key)) {
             return null;
         }
-        if (array_key_exists($arg, $this->cache)) {
+        if (array_key_exists($key, $this->cache)) {
             return $this->cache[$cfg['key']];
         }
         $arguments = $this->getArguments();
 
-        if ($this->isFlagExists($cfg['key'])) {
+        if ($this->isFlagExist($cfg['key'], false)) {
             $value = $arguments[$cfg['key']];
-        } elseif ($this->isFlagExists($cfg['alias'])) {
+        } elseif ($cfg['alias'] && $this->isFlagExist($cfg['alias'], false)) {
             $value = $arguments[$cfg['alias']];
         } elseif (isset($cfg['default'])) {
-            return $cfg['default'];
+            $value = $cfg['default'];
         } else {
-            return null;
+            $value = null;
         }
 
-        if ($cfg['filter'] && $cfg['default'] !== $value || $cfg['filter'] === self::FILTER_FLAG) {
-            $value = $this->filterValue($cfg['filter'], $value, $cfg['default'] ?: null);
+        if ($cfg['filter']) {
+            if ($cfg['filter'] === self::FILTER_FLAG) {
+                $value = $this->isFlagExist($key);
+            } elseif ($cfg['default'] !== $value)  {
+                $value = $this->filterValue($cfg['filter'], $value, $cfg['default']);
+            }
         }
 
         $this->cache[$cfg['key']] = $value;
@@ -171,7 +191,7 @@ public function getArgs()
     {
         $args = [];
         $arguments = $this->getArguments();
-        foreach ($arguments as $key => $arg) {
+        foreach ($arguments as $key => $value) {
             if (!isset($this->aliases[$key])) {
                 continue;
             }
@@ -191,9 +211,6 @@ protected function filterValue($filter, $value, $default = null)
     {
         if (is_string($filter)) {
             switch ($filter) {
-                case self::FILTER_FLAG:
-                    return true;
-
                 case self::FILTER_BOOL:
                    return filter_var($value, FILTER_VALIDATE_BOOLEAN);
 
@@ -218,13 +235,13 @@ protected function filterValue($filter, $value, $default = null)
     }
 
     /**
-     * @param $arg
+     * @param $key
      * @return null
      */
-    protected function getArgFromConfig($arg)
+    protected function getArgConfig($key)
     {
-        if (isset($this->aliases[$arg])) {
-            return $this->aliases[$arg];
+        if (isset($this->aliases[$key])) {
+            return $this->aliases[$key];
         }
         return null;
     }

src/CliArgs/Exception/ConfigErrorException.php

@@ -0,0 +1,13 @@
+<?php
+/**
+ * This file is part of CliArgs.
+ * git: https://github.com/cheprasov/php-cli-args
+ *
+ * (C) Alexander Cheprasov <acheprasov84@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace CliArgs\Exception;
+
+class ConfigErrorException extends Exception {}

src/CliArgs/Exception/Exception.php

@@ -0,0 +1,13 @@
+<?php
+/**
+ * This file is part of CliArgs.
+ * git: https://github.com/cheprasov/php-cli-args
+ *
+ * (C) Alexander Cheprasov <acheprasov84@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace CliArgs\Exception;
+
+class Exception extends \Exception {}