documentation/api/html/classes.xhtml
<?xml version="1.0" encoding="utf-8"?>
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<title>phpDox - Overview</title>
<link rel="stylesheet" type="text/css" href="css/style.css" media="screen"/>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
</head>
<body>
<nav class="topnav">
<ul>
<li>
<div class="logo"><span>/**</span>phpDox</div>
</li>
<li class="separator">
<a href="index.xhtml">Overview</a>
</li>
<li class="separator">
<a href="namespaces.xhtml">Namespaces</a>
</li>
<li>
<a href="interfaces.xhtml">Interfaces</a>
</li>
<li>
<a href="classes.xhtml">Classes</a>
</li>
<li>
<a href="traits.xhtml">Traits</a>
</li>
<li class="separator">
<a href="source/index.xhtml">Source</a>
</li>
</ul>
</nav>
<div id="mainstage">
<h1>Classes</h1>
<div class="container">
<h2 id="">\</h2>
<table class="styled">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th/>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="classes/Exception.xhtml">Exception</a>
</td>
<td>
<span class="unavailable">No description available</span>
</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
</tbody>
</table>
</div>
<div class="container">
<h2 id="Nectary">\Nectary</h2>
<table class="styled">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th/>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="classes/Nectary_Command.xhtml">Command</a>
</td>
<td>Commands are used as general task runners, specifically, they differ from services and other types of actions in that they should not communicate back to the caller.</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
<tr>
<td>
<a href="classes/Nectary_Configuration.xhtml">Configuration</a>
</td>
<td>Configuration Singleton</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
<tr>
<td>
<a href="classes/Nectary_Controller.xhtml">Controller</a>
</td>
<td>Controllers should be used to take in requests and return data, either through views or raw data</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
<tr>
<td>
<a href="classes/Nectary_Dao.xhtml">Dao</a>
</td>
<td>Just a common class for all daos to extend</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
<tr>
<td>
<a href="classes/Nectary_Data_Model.xhtml">Data_Model</a>
</td>
<td>Data model</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
<tr>
<td>
<a href="classes/Nectary_Decorator.xhtml">Decorator</a>
</td>
<td>Decorators provide a layer between an object that lets you attach properties and methods to that object ar runtime.</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
<tr>
<td>
<a href="classes/Nectary_Factory.xhtml">Factory</a>
</td>
<td>Factories should be used to build an object.</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
<tr>
<td>
<a href="classes/Nectary_Fail_Fast_Request.xhtml">Fail_Fast_Request</a>
</td>
<td>A request will validate based on a set of rules</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
<tr>
<td>
<a href="classes/Nectary_Request.xhtml">Request</a>
</td>
<td>A request will validate based on a set of rules</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
<tr>
<td>
<a href="classes/Nectary_Response.xhtml">Response</a>
</td>
<td>View Model for head, content, and footer data</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
<tr>
<td>
<a href="classes/Nectary_Router.xhtml">Router</a>
</td>
<td>The base presenter has functionality to route undefined methods to other class methods.</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
<tr>
<td>
<a href="classes/Nectary_Singleton.xhtml">Singleton</a>
</td>
<td>Support singletons in PHP</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
<tr>
<td>
<a href="classes/Nectary_View.xhtml">View</a>
</td>
<td>This abstract view contains functionality for rendering views.</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
</tbody>
</table>
</div>
<div class="container">
<h2 id="Nectary_Daos">\Nectary\Daos</h2>
<table class="styled">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th/>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="classes/Nectary_Daos_Select_SQL_Query_Builder.xhtml">Select_SQL_Query_Builder</a>
</td>
<td>Select_SQL_Query_Builder - Helper class for building PDO select statements</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
</tbody>
</table>
</div>
<div class="container">
<h2 id="Nectary_Exceptions">\Nectary\Exceptions</h2>
<table class="styled">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th/>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="classes/Nectary_Exceptions_Invalid_Configuration_Exception.xhtml">Invalid_Configuration_Exception</a>
</td>
<td>Exception to throw when the configuration file that is loaded is invalid, for whatever reason.</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
</tbody>
</table>
</div>
<div class="container">
<h2 id="Nectary_Facades">\Nectary\Facades</h2>
<table class="styled">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th/>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="classes/Nectary_Facades_Feed_Facade.xhtml">Feed_Facade</a>
</td>
<td>Provide an interface for interacting with Feed Services and Feeds</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
</tbody>
</table>
</div>
<div class="container">
<h2 id="Nectary_Factories">\Nectary\Factories</h2>
<table class="styled">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th/>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="classes/Nectary_Factories_Dependency_Injection_Factory.xhtml">Dependency_Injection_Factory</a>
</td>
<td>Given a class name and method for the class (the constructor is an allowed method), this factory will automatically build the given object and provide the dependencies for the given method using the given arguments as suggestions.</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
<tr>
<td>
<a href="classes/Nectary_Factories_Html_Carousel_Factory.xhtml">Html_Carousel_Factory</a>
</td>
<td>Lazily create HTML Bootstrap based Carousels</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
<tr>
<td>
<a href="classes/Nectary_Factories_Html_Factory.xhtml">Html_Factory</a>
</td>
<td>Factory that provides a programmatic approach to building html. Provides basic building blocks, such as links, headings, text, images, and divs</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
<tr>
<td>
<a href="classes/Nectary_Factories_Html_Slide_Factory.xhtml">Html_Slide_Factory</a>
</td>
<td>Create Html Slides for Html Carousels</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
<tr>
<td>
<a href="classes/Nectary_Factories_View_Factory.xhtml">View_Factory</a>
</td>
<td>This factory is slightly different because it has chainable methods.</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
</tbody>
</table>
</div>
<div class="container">
<h2 id="Nectary_Models">\Nectary\Models</h2>
<table class="styled">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th/>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="classes/Nectary_Models_Json_Feed.xhtml">Json_Feed</a>
</td>
<td>Json Feed class for pulling and parsing JSON feeds from the web</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
<tr>
<td>
<a href="classes/Nectary_Models_Presentable_Model.xhtml">Presentable_Model</a>
</td>
<td>A Viewable model is one that can present itself so that all of its properties and calculated properties are usable within a template</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
<tr>
<td>
<a href="classes/Nectary_Models_Rss_Feed.xhtml">Rss_Feed</a>
</td>
<td>Rss Feed class for pulling and parsing RSS feeds from the web</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
</tbody>
</table>
</div>
<div class="container">
<h2 id="Nectary_Services">\Nectary\Services</h2>
<table class="styled">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th/>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="classes/Nectary_Services_Excerpt_Service.xhtml">Excerpt_Service</a>
</td>
<td>Service for using PHP Humanizer</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
<tr>
<td>
<a href="classes/Nectary_Services_Feed_Service.xhtml">Feed_Service</a>
</td>
<td>Feed Services should implement a public get_feed( $url ) to abstract away how a particular feed is retreived.</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
<tr>
<td>
<a href="classes/Nectary_Services_Json_Feed_Service.xhtml">Json_Feed_Service</a>
</td>
<td>Service for the Json Feed. Defaults to using get_curl_feed_data</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
<tr>
<td>
<a href="classes/Nectary_Services_Twitter_Feed_Service.xhtml">Twitter_Feed_Service</a>
</td>
<td>Feed Service for Twitter. Defaults to using curl.</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
</tbody>
</table>
</div>
<div class="container">
<h2 id="Nectary_Utilities">\Nectary\Utilities</h2>
<table class="styled">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th/>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="classes/Nectary_Utilities_Json_Utilities.xhtml">Json_Utilities</a>
</td>
<td>Helper utility functions for dealing with JSON</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
</tbody>
</table>
</div>
<div class="container">
<h2 id="Nectary_Views">\Nectary\Views</h2>
<table class="styled">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th/>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="classes/Nectary_Views_Handlebars_View.xhtml">Handlebars_View</a>
</td>
<td>View Handlebars</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
<tr>
<td>
<a href="classes/Nectary_Views_Simple_Handlebars_View.xhtml">Simple_Handlebars_View</a>
</td>
<td>Simple implementation of the Handlebars_View</td>
<td class="testresult-EMPTY">EMPTY
</td>
</tr>
</tbody>
</table>
</div>
</div>
<footer>
<span>Generated using phpDox 0.8.2-dev - Copyright (C) 2010 - 2017 by Arne Blankerts</span>
</footer>
</body>
</html>