Changeset 147

Timestamp:

03/09/08 10:00:20 (9 months ago)

Author:

Slynderdale

Message:

Added a parseArguments function that takes a given string and extracts all the commands like arguments from it then returns an array. See the function's comments for more information on it.

Files:

• trunk/Phergie/Plugin/Abstract/Base.php (modified) (1 diff)

trunk/Phergie/Plugin/Abstract/Base.php

@@ -278 +278 @@
-    }
-
+        /**
+        * Parses a string of command line like arguments and returns them as an array
+        * Parses the following:
+        *    -Strings: "" | "foo" | "foo bar" | "foo \" bar" | foo
+        *    -Options: --opt | --opt foo | --opt= | --opt=foo | --opt="" | --opt="foo" | --opt="foo bar"
+        *      @Note: If no parameter is given, the value returned by the option defaults to
+        *            1 unless its an empty value such as --opt="" or --opt=
+        *    -Flags: -flag +flag
+        *      @Note: Flags are handled using bitwise. 1 = -flag, 2 = +flag, 3 = Both a +flag and -flag
+        *
+        * The results get stored in an array for the following structure:
+        *     Array -> strings []                   -Array containing all the string matches
+        *     Array -> commands [command] => value  -Array containing all the string matches
+        *     Array -> flags [flag] => bitwise      -Array containing all the string matches
+        *     Array -> all [strings|commands|flags] -Array containing a list of all the
+        *                                            strings, commands and flags
+        *
+        * @param string $args String of arguments that will be parsed
+        * @return array
+        */
+        public function parseArguments($args) {
+                // Strip away multiple spaces
+                $args = ' '.preg_replace('#\s+#', ' ', trim($args)).' ';
+
+                // Check the args string for agurments
+                preg_match_all('{'.
+                // String Regex: Matches "" | "foo" | "foo bar" | "foo \" bar" | foo
+                '(".*?(?<!\\\)" | [^-+\s]+) | '.
+                // Option Regex: Matches --opt | --opt foo | --opt= | --opt=foo | --opt="" | --opt="foo" | --opt="foo bar"
+                '(--\w+ (?:=".*?(?<!\\\)" | [=\s][^-+"\s]*)?) | '.
+                // Flag Regex: Matches -flag +flag
+                '([-+]\w+)'.
+                '}xi',
+                $args, $matches);
+                // Shifts the first group matches element off of matches
+                $matches = array_shift($matches);
+
+                // Returned data structure
+                $data = array(
+                    'strings'    => array(),
+                    'commands' => array(),
+                    'flags'    => array(),
+                    'all'      => array(
+                        'strings'    => '',
+                        'commands' => array(),
+                        'flags'    => array()
+                    )
+                );
+
+                // Loop through the results
+                foreach ($matches as $match) {
+                        $match = trim($match);
+                        // Check to see if the current match an an --option
+                        if (substr($match, 0, 2 ) === '--') {
+                                $value = preg_split('/[=\s]/', $match, 2);
+                                $com   = substr(array_shift($value), 2);
+                                $value = trim(join($value));
+                                // Strip quotes from the option's value
+                                $realValue = (substr($value, 0, 1) === '"' && substr($value, -1) === '"' || substr($match, -1) === '=');
+                                if(substr($value, 0, 1) === '"' && substr($value, -1) === '"') {
+                                        $value = trim(substr($value, 1, -1));
+                                }
+                                if (!in_array($com, $data['all']['commands']))
+                                $data['all']['commands'][] = $com;
+                                $data['commands'][$com] = (!empty($value) || $realValue? str_replace('\"', '"', $value) : true);
+                                continue;
+                        }
+
+                        // Check to see if the current match is a -flag
+                        if (substr($match, 0, 1) === '-' || substr($match, 0, 1) === '+') {
+                                $flag = substr($match, 1);
+                                if (!in_array($flag, $data['all']['flags']))
+                                $data['all']['flags'][] = $flag;
+                                // Handle the flags using bitwise operations. 1=-flag, 2=+flag, 3=Both a plus and minus
+                                $data['flags'][$flag] |= (substr($match, 0, 1) === '-' ? 0x1 : 0x2);
+                                continue;
+                        }
+
+                        // Strip the quotes away from match
+                        if(substr($match, 0, 1) === '"' && substr($match, -1) === '"') {
+                                $match = trim(substr($match, 1, -1));
+                        }
+                        // The match value isn't a flag or an option so consider it a string
+                        if (!empty($match))
+                        $data['strings'][] = str_replace('\"', '"', $match);
+                }
+
+                $data['all']['strings'] = trim(implode(' ', $data['strings']));
+                return $data;
+        }
+
-    /**
-    * Returns whether or not the current environment meets the requirements