Add new static function for parsing simple strings

Author: battye

README.md

@@ -5,7 +5,14 @@ A small library to parse text representations of a PHP array and return an actua
 
 Run `composer install` to run this script (and tests) in a standalone way. Alternatively, this can be used as a dependency in another project by running `composer require battye/php-array-parser "~1.0"`.
 
-If you notice any bugs, please feel free to raise an issue or pull request.
+Reference the namespace at the top of your PHP files to utilise the included classes:
+
+```php
+use battye\array_parser\parser;
+use battye\array_parser\tokens;
+```
+
+If you notice any bugs, please raise an issue or pull request.
 
 ## Example
 
@@ -16,10 +23,8 @@ In both of the following examples, `$result` would contain a PHP array containin
 To parse a simple array is very easy:
 
 ```php
-$string = "array(0 => array('one' => 1, 'two' => 'two'));";
-$tokens = new tokens($string);
-$parser = new parser($tokens);
-$result = $parser->parse_array();
+$value = "array(0 => array('one' => 1, 'two' => 'two'));";
+$result = parser::parse_simple($value);
 ```
 
 In this case, `$result` would produce the following:

src/parser.php

@@ -24,6 +24,21 @@ public function __construct(tokens $tokens)
 		$this->tokens = $tokens;
 	}
 
+	/**
+	 * Simple parser to convert a simple string to an array
+	 * @param $value
+	 * @return array
+	 * @throws \Exception
+	 */
+	public static function parse_simple($value)
+	{
+		$tokens = new tokens($value);
+		$parser = new parser($tokens);
+		$result = $parser->parse_array();
+
+		return $result;
+	}
+
 	/**
 	 * Simple and generic regex parser, made with phpBB in mind.
 	 * @param $regex

tests/ArrayParserTest.php

@@ -9,6 +9,22 @@
 
 class ArrayParserTest extends \PHPUnit\Framework\TestCase
 {
+	/**
+	 * Test a simple multi-dimensional array using the static function
+	 */
+	public function testParseSimple()
+	{
+		$string = "array('test' => [1, 2, 3, 4 => ['a', 'b', 'c']], 'value' => 'text');";
+		$result = parser::parse_simple($string);
+
+		$expected = [
+			'test' => [1, 2, 3, 4 => ['a', 'b', 'c']],
+			'value' => 'text',
+		];
+
+		$this->assertArraySubset($expected, $result);
+	}
+
 	/**
 	 * Test that a simple string is parsed correctly
 	 */