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 documentation to the library #5

Merged
merged 1 commit into from Sep 12, 2017
Merged

Add documentation to the library #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
27 changes: 18 additions & 9 deletions README.md
View file
Open in desktop
@@ -1,11 +1,20 @@
# Config

Object Relational Mapper... This is my vision for an ORM. It uses an event driven
process that makes updating information in a persistent manner hopefully easier to
understand and maintain.

[![Build Status](https://travis-ci.org/dschoenbauer/config.svg?branch=develop)](https://travis-ci.org/dschoenbauer/config)
[![Coverage Status](https://coveralls.io/repos/github/dschoenbauer/config/badge.svg?branch=develop)](https://coveralls.io/github/dschoenbauer/config?branch=develop)
[![License](https://img.shields.io/packagist/l/dschoenbauer/config.svg)](https://github.com/dschoenbauer/config)
[![Downloads](https://img.shields.io/packagist/dt/dschoenbauer/config.svg)](https://packagist.org/packages/dschoenbauer/config)
[![Version](https://img.shields.io/packagist/v/dschoenbauer/config.svg)](https://github.com/dschoenbauer/config/releases)
A common library to load a directory full of JSON files into a massive array that
can be accessed.

[![Build Status](https://travis-ci.org/dschoenbauer/config.svg?branch=develop)](https://travis-ci.org/dschoenbauer/config) [![Coverage Status](https://coveralls.io/repos/github/dschoenbauer/config/badge.svg?branch=develop)](https://coveralls.io/github/dschoenbauer/config?branch=develop) [![License](https://img.shields.io/packagist/l/dschoenbauer/config.svg)](https://github.com/dschoenbauer/config) [![Downloads](https://img.shields.io/packagist/dt/dschoenbauer/config.svg)](https://packagist.org/packages/dschoenbauer/config) [![Version](https://img.shields.io/packagist/v/dschoenbauer/config.svg)](https://github.com/dschoenbauer/config/releases)


### Methods summary
|Method | Description|
| ----- | ----- |
|public **__construct( string $path = null )**|
|public **mixed get( string $dotNotation, mixed $defaultValue = null )**|retrieves a value from the amalgamation of all the JSON files data|
|public **array getFiles( string $path )**|retrieves an array of JSON files found in a directory|
|public **importData( array $files = [] )**|loads data into the object from a list of JSON files. If run multiple times the data will be continually added to|
|public **load( string $path )**|loads JSON files from a directory path|
|public **DSchoenbauer\DotNotation\ArrayDotNotation #getArrayDot( )**|Array dot notation allows for quick and easy access to a complicated data structure|
|public **setArrayDot( DSchoenbauer\DotNotation\ArrayDotNotation $arrayDot )**|Array dot notation allows for quick and easy access to a complicated data structure|
|public string **filterPath( string $path )**|Cleans a string so that it is truly a path relevant to the class.|

95 changes: 95 additions & 0 deletions docs/404.html
View file
Open in desktop
@@ -0,0 +1,95 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="robots" content="noindex">

<title>Page not found</title>

<link rel="stylesheet" href="resources/style.css?e99947befd7bf673c6b43ff75e9e0f170c88a60e">

</head>

<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>


<div id="groups">
<h3>Namespaces</h3>
<ul>
<li>
<a href="namespace-DSchoenbauer.html">
DSchoenbauer<span></span>
</a>

<ul>
<li>
<a href="namespace-DSchoenbauer.Config.html">
Config </a>

</li>
</ul></li>
</ul>
</div>

<hr>


<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-DSchoenbauer.Config.Config.html">DSchoenbauer\Config\Config</a></li>
</ul>





</div>
</div>
</div>

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="">
<input type="hidden" name="ie" value="UTF-8">
<input type="text" name="q" class="text" placeholder="Search">
</form>

<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<span>Namespace</span> </li>
<li>
<span>Class</span> </li>
</ul>
<ul>
</ul>
<ul>
</ul>
</div>

<div id="content">
<h1>Page not found</h1>
<p>The requested page could not be found.</p>
<p>You have probably clicked on a link that is outdated and points to a page that does not exist any more or you have made an typing error in the address.</p>
<p>To continue please try to find requested page in the menu, or use search field on the top.</p>
</div>

<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen</a>
</div>
</div>
</div>
<script src="resources/combined.js?f7badff2f2de0c3bf398e35dcb6d70ee78436369"></script>
<script src="elementlist.js"></script>
</body>
</html>