Merge pull request #5 from cheprasov/v2-0-0

v2.0.0

Author: cheprasov

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2015 Alexander Cheprasov <cheprasov.84@ya.ru>
+Copyright (c) Alexander Cheprasov <cheprasov.84@ya.ru>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

README.md

@@ -1,5 +1,5 @@
 [![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)
-# CliArgs v1.0.0 for PHP >= 5.5
+# CliArgs v2.0.0 for PHP >= 5.5
 
 ## About
 Class **CliArgs** helps to get options from the command line argument list easy.
@@ -79,7 +79,6 @@ $config = [
             // 'flag' - will return TRUE, if key is exists in command line argument list.
             // <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
-            // 'help' - use this filter if you want generate and return help about all config.
     ]
 ];
 
@@ -119,7 +118,6 @@ $config4 = [
 $config = [
     'help' => [
         'alias' => 'h',
-        'filter' => 'help',
         'help' => 'Show help about all options',
     ],
     'data' => [
@@ -138,11 +136,15 @@ $CliArgs = new CliArgs($config);
 ```
 Show help
 > some-script.php --help
-<?php if ($CliArgs->isFlagExists('help', 'h')) echo $CliArgs->getArg('help'); ?>
+<?php if ($CliArgs->isFlagExists('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->getArg('help'); ?>
+<?php if ($CliArgs->isFlagExists('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(); ?>
 
 All the same:
 > some-script.php --data='{"foo":"bar"}' --user-id=42
@@ -295,6 +297,13 @@ print_r($CliArgs->getArguments());
 // )
 ```
 
+##### geHelp([string $value = null]): string
+Get help
+```php
+echo $CliArgs->getHelp(); //  Get help for all params
+echo $CliArgs->getHelp('help'); //  Get help for secified params: --help data
+```
+
 ## Installation
 
 ### Composer

composer.json

@@ -1,6 +1,6 @@
 {
   "name": "cheprasov/php-cli-args",
-  "version": "1.0.0",
+  "version": "2.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

@@ -12,14 +12,13 @@
 
 class CliArgs
 {
-    const VERSION = '1.0.0';
+    const VERSION = '2.0.0';
 
     const FILTER_BOOL  = 'bool';
     const FILTER_FLAG  = 'flag';
     const FILTER_FLOAT = 'float';
     const FILTER_INT   = 'int';
     const FILTER_JSON  = 'json';
-    const FILTER_HELP  = 'help';
 
     /**
      * @var array|null
@@ -89,6 +88,7 @@ protected function setConfig(array $config = null)
     }
 
     /**
+     * Get prepared ARGV
      * @return array|null
      */
     public function getArguments()
@@ -100,6 +100,7 @@ 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
      * @return bool
@@ -110,6 +111,7 @@ public function isFlagExists($arg, $alias = null)
     }
 
     /**
+     * Get one param
      * @param string $arg
      * @return mixed
      */
@@ -133,10 +135,7 @@ public function getArg($arg)
             return null;
         }
 
-        if ($cfg['filter'] && $cfg['default'] !== $value
-            || $cfg['filter'] === self::FILTER_FLAG
-            || $cfg['filter'] === self::FILTER_HELP
-        ) {
+        if ($cfg['filter'] && $cfg['default'] !== $value || $cfg['filter'] === self::FILTER_FLAG) {
             $value = $this->filterValue($cfg['filter'], $value, $cfg['default'] ?: null);
         }
 
@@ -146,6 +145,7 @@ public function getArg($arg)
     }
 
     /**
+     * Get all params.
      * @return mixed[]
      */
     public function getArgs()
@@ -186,9 +186,6 @@ protected function filterValue($filter, $value, $default = null)
 
                 case self::FILTER_JSON:
                    return json_decode($value, true);
-
-                case self::FILTER_HELP:
-                    return $this->getHelp($value);
             }
             return $default;
         }
@@ -214,11 +211,16 @@ protected function getArgFromConfig($arg)
     }
 
     /**
-     * @param mixed $value
+     * Get help about
+     * @param string $value
      * @return string mixed
      */
-    protected function getHelp($value = null)
+    public function getHelp($value = null)
     {
+        if ($value) {
+            $value = $this->getArg($value);
+        }
+
         $breakTitle = PHP_EOL . str_repeat(' ', 4);
         $breakInfo = PHP_EOL . str_repeat(' ', 8);
         $help = [];