-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
65 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
<mddoc> | ||
<docpage target="README.md" autoloader="psr0" autoloader-root="src"> | ||
<section title="Dot Notation Parser"> | ||
<badge-poser type="version" /> | ||
<badge-poser type="downloads" /> | ||
<badge-poser type="license" /> | ||
<badge-travis name="QuorumCollection/DotNotationParser" /> | ||
<text><![CDATA[ | ||
DotNotationParser is a simple parser that will parse `foo.bar.baz` into `[ 'foo', 'bar', 'baz' ]` and `foo."bar.baz"` into `[ 'foo', 'bar.baz' ]`. | ||
]]></text> | ||
<section title="Requirements"> | ||
<composer-requires/> | ||
</section> | ||
<section title="Installing"> | ||
<composer-install/> | ||
</section> | ||
<section title="Documentation"> | ||
<file name="src/DotNotationParser.php" /> | ||
</section> | ||
</section> | ||
</docpage> | ||
</mddoc> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,43 @@ | ||
# DotNotationParser | ||
# Dot Notation Parser | ||
|
||
[![Latest Stable Version](https://poser.pugx.org/quorum/dot-notation/version)](https://packagist.org/packages/quorum/dot-notation) | ||
[![Total Downloads](https://poser.pugx.org/quorum/dot-notation/downloads)](https://packagist.org/packages/quorum/dot-notation) | ||
[![License](https://poser.pugx.org/quorum/dot-notation/license)](https://packagist.org/packages/quorum/dot-notation) | ||
[![Build Status](https://travis-ci.org/QuorumCollection/DotNotationParser.svg?branch=master)](https://travis-ci.org/QuorumCollection/DotNotationParser) | ||
|
||
|
||
DotNotationParser is a simple parser that will parse `foo.bar.baz` into `[ 'foo', 'bar', 'baz' ]` and `foo."bar.baz"` into `[ 'foo', 'bar.baz' ]`. | ||
|
||
|
||
|
||
## Requirements | ||
|
||
- **php**: >=7.1 | ||
|
||
## Installing | ||
|
||
Install the latest version with: | ||
|
||
```bash | ||
composer require 'quorum/dot-notation' | ||
``` | ||
|
||
## Documentation | ||
|
||
### Class: \Quorum\DotNotation\DotNotationParser | ||
|
||
Class DotPathParser | ||
|
||
#### Method: DotNotationParser->parse | ||
|
||
```php | ||
function parse(string $path) : array | ||
``` | ||
|
||
##### Parameters: | ||
|
||
- ***string*** `$path` | ||
|
||
##### Returns: | ||
|
||
- ***string[]*** |