Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add static create #33

Merged
merged 5 commits into from
Dec 2, 2016
Merged

Add static create #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6afd54f
Added static constructor with()
Dec 2, 2016
39ae6eb
updated documentation
Dec 2, 2016
b544205
Merge branch 'develop' of github.com:dschoenbauer/dot-notation into a…
Dec 2, 2016
348f5c1
Merge branch 'develop' of github.com:dschoenbauer/dot-notation into a…
Dec 2, 2016
3d10f9c
Merge branch 'add-static-create' of github.com:dschoenbauer/dot-notat…
Dec 2, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 55 additions & 11 deletions docs/class-DSchoenbauer.DotNotation.ArrayDotNotation.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,50 @@ <h1>Class ArrayDotNotation</h1>

<table class="summary methods" id="methods">
<caption>Methods summary</caption>
<tr data-order="with" id="_with">

<td class="attributes"><code>
public static

static

</code>
</td>

<td class="name"><div>
<a class="anchor" href="#_with">#</a>
<code><a href="source-class-DSchoenbauer.DotNotation.ArrayDotNotation.html#48-57" title="Go to source code">with</a>( <span>array <var>$data</var> = []</span> )</code>

<div class="description short">
<p>Sets the data to parse in a chain</p>
</div>

<div class="description detailed hidden">
<p>Sets the data to parse in a chain</p>


<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$data</var></dt>
<dd>optional Array of data that will be accessed via dot notation.</dd>
</dl></div>

<h4>Returns</h4>
<div class="list">
static
</div>


<h4>Author</h4>
<div class="list">
John Smart<br>
David Schoenbauer<br>
</div>


</div>
</div></td>
</tr>
<tr data-order="__construct" id="___construct">

<td class="attributes"><code>
Expand All @@ -134,7 +178,7 @@ <h1>Class ArrayDotNotation</h1>

<td class="name"><div>
<a class="anchor" href="#___construct">#</a>
<code><a href="source-class-DSchoenbauer.DotNotation.ArrayDotNotation.html#48-57" title="Go to source code">__construct</a>( <span>array <var>$data</var> = []</span> )</code>
<code><a href="source-class-DSchoenbauer.DotNotation.ArrayDotNotation.html#59-68" title="Go to source code">__construct</a>( <span>array <var>$data</var> = []</span> )</code>

<div class="description short">
<p>An alias for setData</p>
Expand All @@ -147,7 +191,7 @@ <h1>Class ArrayDotNotation</h1>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$data</var></dt>
<dd>Array of data that will be accessed via dot notation.</dd>
<dd>optional Array of data that will be accessed via dot notation.</dd>
</dl></div>


Expand Down Expand Up @@ -177,7 +221,7 @@ <h4>See</h4>

<td class="name"><div>
<a class="anchor" href="#_getData">#</a>
<code><a href="source-class-DSchoenbauer.DotNotation.ArrayDotNotation.html#59-69" title="Go to source code">getData</a>( )</code>
<code><a href="source-class-DSchoenbauer.DotNotation.ArrayDotNotation.html#70-80" title="Go to source code">getData</a>( )</code>

<div class="description short">
<p>returns the array</p>
Expand Down Expand Up @@ -217,7 +261,7 @@ <h4>Since</h4>

<td class="name"><div>
<a class="anchor" href="#_setData">#</a>
<code><a href="source-class-DSchoenbauer.DotNotation.ArrayDotNotation.html#71-81" title="Go to source code">setData</a>( <span>array <var>$data</var></span> )</code>
<code><a href="source-class-DSchoenbauer.DotNotation.ArrayDotNotation.html#82-92" title="Go to source code">setData</a>( <span>array <var>$data</var></span> )</code>

<div class="description short">
<p>sets the array that the dot notation will be used on.</p>
Expand Down Expand Up @@ -260,7 +304,7 @@ <h4>Since</h4>

<td class="name"><div>
<a class="anchor" href="#_get">#</a>
<code><a href="source-class-DSchoenbauer.DotNotation.ArrayDotNotation.html#83-95" title="Go to source code">get</a>( <span>string <var>$dotNotation</var></span>, <span>mixed <var>$defaultValue</var> = <span class="php-keyword1">null</span></span> )</code>
<code><a href="source-class-DSchoenbauer.DotNotation.ArrayDotNotation.html#94-106" title="Go to source code">get</a>( <span>string <var>$dotNotation</var></span>, <span>mixed <var>$defaultValue</var> = <span class="php-keyword1">null</span></span> )</code>

<div class="description short">
<p>Retrieves a value from an array structure as defined by a dot notation string</p>
Expand Down Expand Up @@ -307,7 +351,7 @@ <h4>Since</h4>

<td class="name"><div>
<a class="anchor" href="#_recursiveGet">#</a>
<code><a href="source-class-DSchoenbauer.DotNotation.ArrayDotNotation.html#97-113" title="Go to source code">recursiveGet</a>( <span>array <var>$data</var></span>, <span>array <var>$keys</var></span>, <span>mixed <var>$defaultValue</var></span> )</code>
<code><a href="source-class-DSchoenbauer.DotNotation.ArrayDotNotation.html#108-124" title="Go to source code">recursiveGet</a>( <span>array <var>$data</var></span>, <span>array <var>$keys</var></span>, <span>mixed <var>$defaultValue</var></span> )</code>

<div class="description short">
<p>Recursively works though an array level by level until the final key is found. Once key is found the keys value is returned.</p>
Expand Down Expand Up @@ -354,7 +398,7 @@ <h4>Since</h4>

<td class="name"><div>
<a class="anchor" href="#_set">#</a>
<code><a href="source-class-DSchoenbauer.DotNotation.ArrayDotNotation.html#115-133" title="Go to source code">set</a>( <span>string <var>$dotNotation</var></span>, <span>mixed <var>$value</var></span> )</code>
<code><a href="source-class-DSchoenbauer.DotNotation.ArrayDotNotation.html#126-144" title="Go to source code">set</a>( <span>string <var>$dotNotation</var></span>, <span>mixed <var>$value</var></span> )</code>

<div class="description short">
<p>sets a value into a complicated array data structure</p>
Expand Down Expand Up @@ -409,7 +453,7 @@ <h4>Since</h4>

<td class="name"><div>
<a class="anchor" href="#_recursiveSet">#</a>
<code><a href="source-class-DSchoenbauer.DotNotation.ArrayDotNotation.html#135-157" title="Go to source code">recursiveSet</a>( <span>array <var>&amp; $data</var></span>, <span>array <var>$keys</var></span>, <span>mixed <var>$value</var></span> )</code>
<code><a href="source-class-DSchoenbauer.DotNotation.ArrayDotNotation.html#146-168" title="Go to source code">recursiveSet</a>( <span>array <var>&amp; $data</var></span>, <span>array <var>$keys</var></span>, <span>mixed <var>$value</var></span> )</code>

<div class="description short">
<p>Transverses the keys array until it reaches the appropriate key in the data array and sets that key to the value.
Expand Down Expand Up @@ -458,7 +502,7 @@ <h4>Since</h4>

<td class="name"><div>
<a class="anchor" href="#_merge">#</a>
<code><a href="source-class-DSchoenbauer.DotNotation.ArrayDotNotation.html#159-176" title="Go to source code">merge</a>( <span>string <var>$dotNotation</var></span>, <span>array <var>$value</var></span> )</code>
<code><a href="source-class-DSchoenbauer.DotNotation.ArrayDotNotation.html#170-187" title="Go to source code">merge</a>( <span>string <var>$dotNotation</var></span>, <span>array <var>$value</var></span> )</code>

<div class="description short">
<p>Merges two arrays together over writing existing values with new values, while adding new array structure to the data</p>
Expand Down Expand Up @@ -508,7 +552,7 @@ <h4>Since</h4>

<td class="name"><div>
<a class="anchor" href="#_remove">#</a>
<code><a href="source-class-DSchoenbauer.DotNotation.ArrayDotNotation.html#178-188" title="Go to source code">remove</a>( <span>string <var>$dotNotation</var></span> )</code>
<code><a href="source-class-DSchoenbauer.DotNotation.ArrayDotNotation.html#189-199" title="Go to source code">remove</a>( <span>string <var>$dotNotation</var></span> )</code>

<div class="description short">
<p>Removes data from the array</p>
Expand Down Expand Up @@ -551,7 +595,7 @@ <h4>Since</h4>

<td class="name"><div>
<a class="anchor" href="#_recursiveRemove">#</a>
<code><a href="source-class-DSchoenbauer.DotNotation.ArrayDotNotation.html#190-211" title="Go to source code">recursiveRemove</a>( <span>array <var>&amp; $data</var></span>, <span>array <var>$keys</var></span> )</code>
<code><a href="source-class-DSchoenbauer.DotNotation.ArrayDotNotation.html#201-222" title="Go to source code">recursiveRemove</a>( <span>array <var>&amp; $data</var></span>, <span>array <var>$keys</var></span> )</code>

<div class="description short">
<p>Transverses the keys array until it reaches the appropriate key in the
Expand Down
Loading