Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
David Schoenbauer committed Nov 30, 2016
1 parent b3cf340 commit 5b54689
Show file tree
Hide file tree
Showing 19 changed files with 1,202 additions and 25 deletions.
72 changes: 69 additions & 3 deletions docs/classes/DSchoenbauer.DotNotation.ArrayDotNotation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,12 @@
</a>
</li>

<li class="method public">
<a href="#method_merge" title="merge :: Merges two arrays together over writing existing values with new values, while adding new array structure to the data">
<span class="description">Merges two arrays together over writing existing values with new values, while adding new array structure to the data</span><pre>merge</pre>
</a>
</li>

<li class="method public">
<a href="#method_set" title="set :: sets a value into a complicated array data structure">
<span class="description">sets a value into a complicated array data structure</span><pre>set</pre>
Expand All @@ -153,7 +159,7 @@
</li>
<li class="nav-header protected">» Protected
<ul>
<li class="method protected">
<li class="method protected">
<a href="#method_recursiveGet" title="recursiveGet :: Recursively works though an array level by level until the final key is found. Once key is found the keys value is returned.">
<span class="description">Recursively works though an array level by level until the final key is found. Once key is found the keys value is returned.</span><pre>recursiveGet</pre>
</a>
Expand All @@ -167,7 +173,7 @@
</li>
<li class="nav-header private">» Private
<ul>
</ul>
</ul>
</li>
<li class="nav-header">
<i class="icon-custom icon-constant"></i> Constants
Expand Down Expand Up @@ -348,6 +354,48 @@ <h3>Response</h3>
</div>
</div>

</div>
<a id="method_merge"></a>
<div class="element clickable method public method_merge" data-toggle="collapse" data-target=".method_merge .collapse">
<h2>Merges two arrays together over writing existing values with new values, while adding new array structure to the data</h2>
<pre>merge(string $dotNotation, array $value) : $this</pre>
<div class="labels">
</div>


<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>

<table class="table">
<tr>
<th>
throws
</th>
<td>

<p>if a value in the dot notation path is not an array</p>

<p>if the value in the dot notation target is not an array</p>
</td>
</tr>
</table>

<h3>Arguments</h3>
<div class="subelement argument">
<h4>$dotNotation</h4>
<code>string</code><p><p>dot notation representation of keys of where to set a value</p></p>
</div>
<div class="subelement argument">
<h4>$value</h4>
<code>array</code><p><p>array to be merged with an existing array</p></p>
</div>

<h3>Response</h3>
<code>$this</code><p></p>
</div>
</div>

</div>
<a id="method_recursiveGet"></a>
<div class="element clickable method protected method_recursiveGet" data-toggle="collapse" data-target=".method_recursiveGet .collapse">
Expand Down Expand Up @@ -417,6 +465,15 @@ <h2>Transverses the keys array until it reaches the appropriate key in the data
</tr>
<tr>
<th>
throws
</th>
<td>

<p>if a value in the dot notation path is not an array</p>
</td>
</tr>
<tr>
<th>

</th>
<td>
Expand Down Expand Up @@ -467,6 +524,15 @@ <h2>sets a value into a complicated array data structure</h2>
1.0.0

</td>
</tr>
<tr>
<th>
throws
</th>
<td>

<p>if a value in the dot notation path is not an array</p>
</td>
</tr>
</table>

Expand Down Expand Up @@ -571,7 +637,7 @@ <h3>Type(s)</h3>
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by
<a href="http://glyphicons.com/">Glyphicons</a>.<br/>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and<br/>
generated on Tue, 29 Nov 2016 15:53:43 +0000.<br/>
generated on Wed, 30 Nov 2016 11:56:30 +0000.<br/>
</footer>
</body>
</html>
200 changes: 200 additions & 0 deletions docs/classes/DSchoenbauer.DotNotation.Exception.ExceptionInterface.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,200 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
<meta charset="utf-8"/>
<title> API Documentation &raquo; \DSchoenbauer\DotNotation\Exception\ExceptionInterface
</title>
<meta name="author" content=""/>
<meta name="description" content=""/>

<link href="../css/template.css" rel="stylesheet" media="all"/>

<!--[if lt IE 9]>
<script src="https://html5shim.googlecode.com/svn/trunk/html5.js" type="text/javascript"></script>
<![endif]-->
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script>
<script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script>
<script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script>
<script src="../js/bootstrap.js" type="text/javascript"></script>
<script src="../js/template.js" type="text/javascript"></script>
<script src="../js/prettify/prettify.min.js" type="text/javascript"></script>

<link rel="shortcut icon" href="../img/favicon.ico"/>
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png"/>
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png"/>
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png"/>
</head>
<body>

<div class="navbar navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span> <span class="icon-bar"></span>
<span class="icon-bar"></span> </a>
<a class="brand" href="../index.html">API Documentation</a>

<div class="nav-collapse">
<ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li><a>Namespaces</a></li>
<li><a href="../namespaces/DSchoenbauer.html">DSchoenbauer</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="../graph_class.html">
<i class="icon-list-alt"></i>&#160;Class hierarchy diagram
</a>
</li>
</ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="../errors.html">
<i class="icon-list-alt"></i>&#160;Errors
</a>
</li>
<li>
<a href="../markers.html">
<i class="icon-list-alt"></i>&#160;Markers
</a>
</li>
<li>
<a href="../deprecated.html">
<i class="icon-list-alt"></i>&#160;Deprecated
</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div class="go_to_top">
<a href="#___" style="color: inherit">Back to top&#160;&#160;<i class="icon-upload icon-white"></i></a>
</div>
</div>

<div id="___" class="container">
<noscript>
<div class="alert alert-warning">
Javascript is disabled; several features are only available if Javascript is enabled.
</div>
</noscript>


<style>
.deprecated h2 {
text-decoration: line-through;
}
</style>
<div class="row">
<div class="span4">
<div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button>
<button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<div class="btn-group visibility" data-toggle="buttons-checkbox">
<button class="btn public active" title="Show public elements">Public</button>
<button class="btn protected" title="Show protected elements">Protected</button>
<button class="btn private" title="Show private elements">Private</button>
<button class="btn inherited active" title="Show inherited elements">Inherited</button>
</div>

<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods
<ul>
</ul>
</li>
<li class="nav-header protected">» Protected
<ul>
</ul>
</li>
<li class="nav-header private">» Private
<ul>
</ul>
</li>
<li class="nav-header">
<i class="icon-custom icon-constant"></i> Constants
<ul>
</ul>
</li>
</ul>


</div>

<div class="span8">
<div class="element class">
<h1>ExceptionInterface</h1>
<small style="display: block; text-align: right">
Extends
</small>
<p class="short_description">A base interface for trapping and validating that the exception is of this library</p>
<div class="details">
<div class="long_description">

</div>
<table class="table table-bordered">
<tr>
<th>
author
</th>
<td>

<p>David Schoenbauer <a href="mailto:dschoenbauer@gmail.com">dschoenbauer@gmail.com</a></p>
</td>
</tr>
<tr>
<th>
package
</th>
<td>

<p>Default</p>
</td>
</tr>
</table>

<h3><i class="icon-custom icon-method"></i> Methods</h3>


</div>
</div>
<a id="\DSchoenbauer\DotNotation\Exception\ExceptionInterface"></a>
<ul class="breadcrumb">
<li><a href="../index.html"><i class="icon-custom icon-class"></i></a></li>


<li><span class="divider">\</span><a href="../namespaces/DSchoenbauer.DotNotation.Exception.html">Exception</a></li>

<li class="active"><span class="divider">\</span><a href="../classes/DSchoenbauer.DotNotation.Exception.ExceptionInterface.html">ExceptionInterface</a></li>
</ul>
</div>
</div>

</div>

<footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by
<a href="http://glyphicons.com/">Glyphicons</a>.<br/>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and<br/>
generated on Wed, 30 Nov 2016 11:56:30 +0000.<br/>
</footer>
</body>
</html>
Loading

0 comments on commit 5b54689

Please sign in to comment.