aviat/ion
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update file header, and fix some style issues

Browse Source
This commit is contained in:
Timothy Warren 2016-08-26 23:10:20 -04:00
parent 733c481a4c
commit 2adb02daaa
41 changed files with 340 additions and 152 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
RoboFile.php
View File

@ -44,9 +44,9 @@ class RoboFile extends \Robo\Tasks {
$this->prepare(); $this->prepare();
$this->lint(); $this->lint();
$this->phploc(TRUE); $this->phploc(TRUE);
$this->phpcs(TRUE);
$this->dependencyReport(); $this->dependencyReport();
$this->phpcpdReport(); $this->phpcpdReport();
$this->phpcsReport();
} }
/** /**
@ -143,15 +143,24 @@ class RoboFile extends \Robo\Tasks {
/** /**
* Run the phpcs tool * Run the phpcs tool
*
* @param bool $report - if true, generates reports instead of direct output
*/ */
public function phpcs() public function phpcs($report = FALSE)
{ {
$cmd_parts = [ $report_cmd_parts = [
'vendor/bin/phpcs', 'vendor/bin/phpcs',
'--standard=./build/phpcs.xml', '--standard=./build/phpcs.xml',
'--report=summary' '--report-checkstyle=./build/logs/phpcs.xml',
]; ];
$normal_cmd_parts = [
'vendor/bin/phpcs',
'--standard=./build/phpcs.xml',
];
$cmd_parts = ($report) ? $report_cmd_parts : $normal_cmd_parts;
$this->_run($cmd_parts); $this->_run($cmd_parts);
} }
@ -285,20 +294,7 @@ class RoboFile extends \Robo\Tasks {
} }
/** /**
* Generate code style report * Shortcut for joining an array of command arguments
*/
protected function phpcsReport()
{
$cmd_parts = [
'vendor/bin/phpcs',
'--standard=./build/phpcs.xml',
'--report-xml=./build/logs/phpcs.xml'
];
$this->_run($cmd_parts);
}
/**
* Short cut for joining an array of command arguments
* and then running it * and then running it
* *
* @param array $cmd_parts - command arguments * @param array $cmd_parts - command arguments

1
build/CodeIgniter-for-PHP_CodeSniffer

@ -1 +0,0 @@
Subproject commit b501f01403216a917754e3f76ba7022d4ad37a4e

10
build/ion_header_comment.txt
View File

@ -3,8 +3,12 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* PHP version 5.6
*
* @package Ion * @package Ion
* @author Timothy J. Warren * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright Copyright (c) 2015 - 2016 * @copyright 2015 - 2016 Timothy J. Warren
* @license MIT * @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */

31
build/phpcs.xml
View File

@ -4,6 +4,8 @@
<file>../src/</file> <file>../src/</file>
<encoding>utf-8</encoding>
<rule ref="Generic.Files.LineEndings"> <rule ref="Generic.Files.LineEndings">
<properties> <properties>
<property name="eolChar" value="\n"/> <property name="eolChar" value="\n"/>
@ -24,15 +26,28 @@
<rule ref="Generic.Formatting.DisallowMultipleStatements"/> <rule ref="Generic.Formatting.DisallowMultipleStatements"/>
<!-- Classes and functions should be commented --> <!-- Classes and functions should be commented -->
<rule ref="PEAR.Commenting.ClassComment"/> <rule ref="PEAR.Commenting.ClassComment">
<rule ref="PEAR.Commenting.FunctionComment"/> <exclude name="PEAR.Commenting.ClassComment.MissingCategoryTag" />
<rule ref="Squiz.Commenting.FunctionCommentThrowTag"/> <exclude name="PEAR.Commenting.ClassComment.MissingPackageTag" />
<exclude name="PEAR.Commenting.ClassComment.MissingAuthorTag" />
<exclude name="PEAR.Commenting.ClassComment.MissingLicenseTag" />
<exclude name="PEAR.Commenting.ClassComment.MissingLinkTag" />
</rule>
<rule ref="PEAR.Commenting.FunctionComment">
<!-- Exclude this sniff because it doesn't understand multiple types -->
<exclude name="PEAR.Commenting.FunctionComment.MissingParamComment" />
</rule>
<!-- Use warnings for docblock comments for files and variables, since nothing is cleary explained --> <!-- Use warnings for docblock comments for files and variables, since nothing is cleary explained -->
<rule ref="PEAR.Commenting.FileComment"> <rule ref="PEAR.Commenting.FileComment">
<exclude name="PEAR.Commenting.FileComment.InvalidVersion" />
<exclude name="PEAR.Commenting.FileComment.MissingCategoryTag" />
<properties> <properties>
<property name="error" value="false"/> <property name="error" value="false"/>
</properties> </properties>
</rule> </rule>
<rule ref="Squiz.Commenting.FunctionCommentThrowTag"/>
<rule ref="Squiz.Commenting.VariableComment"> <rule ref="Squiz.Commenting.VariableComment">
<properties> <properties>
<property name="error" value="false"/> <property name="error" value="false"/>
@ -45,9 +60,19 @@
<rule ref="PEAR.WhiteSpace.ScopeClosingBrace"/> <rule ref="PEAR.WhiteSpace.ScopeClosingBrace"/>
<rule ref="Generic.Functions.FunctionCallArgumentSpacing"/> <rule ref="Generic.Functions.FunctionCallArgumentSpacing"/>
<!-- Use only short array syntax -->
<rule ref="Generic.Arrays.DisallowLongArraySyntax" />
<rule ref="Generic.PHP.ForbiddenFunctions"> <rule ref="Generic.PHP.ForbiddenFunctions">
<properties> <properties>
<property name="forbiddenFunctions" type="array" value="create_function=>null,eval=>null" /> <property name="forbiddenFunctions" type="array" value="create_function=>null,eval=>null" />
</properties> </properties>
</rule> </rule>
<!-- Inherit CodeIgniter Rules -->
<rule ref="./CodeIgniter">
<properties>
<property name="error" value="false" />
</properties>
</rule>
</ruleset> </ruleset>

2
build/phpdox.xml
View File

@ -85,7 +85,7 @@
</source> </source>
<!-- PHP Code Sniffer findings --> <!-- PHP Code Sniffer findings -->
<source type="phpcs"> <source type="checkstyle">
<file name="phpcs.xml" /> <file name="phpcs.xml" />
</source> </source>

5
composer.json
View File

@ -9,7 +9,8 @@
}, },
"autoload-dev": { "autoload-dev": {
"psr-4": { "psr-4": {
"Aviat\\Ion\\Tests\\": "tests/Ion/" "Aviat\\Ion\\Tests\\": "tests/Ion/",
"CodeIgniter\\": "build/CodeIgniter/"
} }
}, },
"require": { "require": {
@ -36,7 +37,7 @@
"nikic/php-parser": "3.0.*@alpha", "nikic/php-parser": "3.0.*@alpha",
"monolog/monolog": "1.*", "monolog/monolog": "1.*",
"predis/predis": "1.1.*", "predis/predis": "1.1.*",
"squizlabs/php_codesniffer": "^2.6" "squizlabs/php_codesniffer": "^3.0.0@alpha"
}, },
"suggest": { "suggest": {
"monolog/monolog": "Provides implementation of psr/log", "monolog/monolog": "Provides implementation of psr/log",

10
src/Ion/ArrayWrapper.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* PHP version 5.6
*
* @package Ion * @package Ion
* @author Timothy J. Warren * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright Copyright (c) 2015 - 2016 * @copyright 2015 - 2016 Timothy J. Warren
* @license MIT * @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion; namespace Aviat\Ion;

10
src/Ion/Cache/CacheInterface.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* PHP version 5.6
*
* @package Ion * @package Ion
* @author Timothy J. Warren * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright Copyright (c) 2015 - 2016 * @copyright 2015 - 2016 Timothy J. Warren
* @license MIT * @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion\Cache; namespace Aviat\Ion\Cache;

10
src/Ion/Cache/CacheManager.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* PHP version 5.6
*
* @package Ion * @package Ion
* @author Timothy J. Warren * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright Copyright (c) 2015 - 2016 * @copyright 2015 - 2016 Timothy J. Warren
* @license MIT * @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion\Cache; namespace Aviat\Ion\Cache;

12
src/Ion/Cache/Driver/DriverInterface.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* @package Ion * PHP version 5.6
* @author Timothy J. Warren *
* @copyright Copyright (c) 2015 - 2016 * @package Ion
* @license MIT * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright 2015 - 2016 Timothy J. Warren
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion\Cache\Driver; namespace Aviat\Ion\Cache\Driver;

16
src/Ion/Cache/Driver/DriverTrait.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* @package Ion * PHP version 5.6
* @author Timothy J. Warren *
* @copyright Copyright (c) 2015 - 2016 * @package Ion
* @license MIT * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright 2015 - 2016 Timothy J. Warren
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion\Cache\Driver; namespace Aviat\Ion\Cache\Driver;
@ -22,8 +26,10 @@ trait DriverTrait {
/** /**
* Key prefix for key / value cache stores * Key prefix for key / value cache stores
*
* @var string
*/ */
protected static $CACHE_KEY_PREFIX = "hbac:cache:"; protected static $CACHE_KEY_PREFIX = "aviat:ion:cache:";
/** /**
* Set key prefix for cache drivers that have global keys * Set key prefix for cache drivers that have global keys

14
src/Ion/Cache/Driver/NullDriver.php
View File

@ -4,14 +4,17 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* @package Ion * PHP version 5.6
* @author Timothy J. Warren *
* @copyright Copyright (c) 2015 - 2016 * @package Ion
* @license MIT * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright 2015 - 2016 Timothy J. Warren
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion\Cache\Driver; namespace Aviat\Ion\Cache\Driver;
use Aviat\Ion\ConfigInterface;
/** /**
* The Driver for no real cache * The Driver for no real cache
@ -20,6 +23,7 @@ class NullDriver implements DriverInterface {
/** /**
* 'Cache' for Null data store * 'Cache' for Null data store
* @var array
*/ */
protected $data = []; protected $data = [];

12
src/Ion/Cache/Driver/RedisDriver.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* @package Ion * PHP version 5.6
* @author Timothy J. Warren *
* @copyright Copyright (c) 2015 - 2016 * @package Ion
* @license MIT * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright 2015 - 2016 Timothy J. Warren
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion\Cache\Driver; namespace Aviat\Ion\Cache\Driver;

12
src/Ion/Cache/Driver/SQLDriver.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* @package Ion * PHP version 5.6
* @author Timothy J. Warren *
* @copyright Copyright (c) 2015 - 2016 * @package Ion
* @license MIT * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright 2015 - 2016 Timothy J. Warren
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion\Cache\Driver; namespace Aviat\Ion\Cache\Driver;

10
src/Ion/Config.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* PHP version 5.6
*
* @package Ion * @package Ion
* @author Timothy J. Warren * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright Copyright (c) 2015 - 2016 * @copyright 2015 - 2016 Timothy J. Warren
* @license MIT * @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion; namespace Aviat\Ion;

10
src/Ion/ConfigInterface.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* PHP version 5.6
*
* @package Ion * @package Ion
* @author Timothy J. Warren * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright Copyright (c) 2015 - 2016 * @copyright 2015 - 2016 Timothy J. Warren
* @license MIT * @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion; namespace Aviat\Ion;

12
src/Ion/Di/Container.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* PHP version 5.6
*
* @package Ion * @package Ion
* @author Timothy J. Warren * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright Copyright (c) 2015 - 2016 * @copyright 2015 - 2016 Timothy J. Warren
* @license MIT * @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion\Di; namespace Aviat\Ion\Di;
@ -160,7 +164,7 @@ class Container implements ContainerInterface {
$uses_trait = in_array($trait_name, class_uses($obj)); $uses_trait = in_array($trait_name, class_uses($obj));
$implements_interface = in_array($interface_name, class_implements($obj)); $implements_interface = in_array($interface_name, class_implements($obj));
if ($uses_trait || $implements_interface) if ($uses_trait OR $implements_interface)
{ {
$obj->setContainer($this); $obj->setContainer($this);
} }

10
src/Ion/Di/ContainerAware.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* PHP version 5.6
*
* @package Ion * @package Ion
* @author Timothy J. Warren * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright Copyright (c) 2015 - 2016 * @copyright 2015 - 2016 Timothy J. Warren
* @license MIT * @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion\Di; namespace Aviat\Ion\Di;

10
src/Ion/Di/ContainerAwareInterface.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* PHP version 5.6
*
* @package Ion * @package Ion
* @author Timothy J. Warren * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright Copyright (c) 2015 - 2016 * @copyright 2015 - 2016 Timothy J. Warren
* @license MIT * @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion\Di; namespace Aviat\Ion\Di;

10
src/Ion/Di/ContainerInterface.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* PHP version 5.6
*
* @package Ion * @package Ion
* @author Timothy J. Warren * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright Copyright (c) 2015 - 2016 * @copyright 2015 - 2016 Timothy J. Warren
* @license MIT * @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion\Di; namespace Aviat\Ion\Di;

10
src/Ion/Di/Exception/ContainerException.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* PHP version 5.6
*
* @package Ion * @package Ion
* @author Timothy J. Warren * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright Copyright (c) 2015 - 2016 * @copyright 2015 - 2016 Timothy J. Warren
* @license MIT * @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion\Di\Exception; namespace Aviat\Ion\Di\Exception;

10
src/Ion/Di/Exception/NotFoundException.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* PHP version 5.6
*
* @package Ion * @package Ion
* @author Timothy J. Warren * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright Copyright (c) 2015 - 2016 * @copyright 2015 - 2016 Timothy J. Warren
* @license MIT * @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion\Di\Exception; namespace Aviat\Ion\Di\Exception;

10
src/Ion/Enum.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* PHP version 5.6
*
* @package Ion * @package Ion
* @author Timothy J. Warren * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright Copyright (c) 2015 - 2016 * @copyright 2015 - 2016 Timothy J. Warren
* @license MIT * @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion; namespace Aviat\Ion;

12
src/Ion/Exception/ConfigException.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* @package Ion * PHP version 5.6
* @author Timothy J. Warren *
* @copyright Copyright (c) 2015 - 2016 * @package Ion
* @license MIT * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright 2015 - 2016 Timothy J. Warren
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion\Exception; namespace Aviat\Ion\Exception;

10
src/Ion/Exception/DoubleRenderException.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* PHP version 5.6
*
* @package Ion * @package Ion
* @author Timothy J. Warren * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright Copyright (c) 2015 - 2016 * @copyright 2015 - 2016 Timothy J. Warren
* @license MIT * @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion\Exception; namespace Aviat\Ion\Exception;

12
src/Ion/Friend.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* PHP version 5.6
*
* @package Ion * @package Ion
* @author Timothy J. Warren * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright Copyright (c) 2015 - 2016 * @copyright 2015 - 2016 Timothy J. Warren
* @license MIT * @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion; namespace Aviat\Ion;
@ -39,6 +43,7 @@ class Friend {
* Create a friend object * Create a friend object
* *
* @param object $obj * @param object $obj
* @throws InvalidArgumentException
*/ */
public function __construct($obj) public function __construct($obj)
{ {
@ -90,6 +95,7 @@ class Friend {
* @param string $method * @param string $method
* @param array $args * @param array $args
* @return mixed * @return mixed
* @throws BadMethodCallException
*/ */
public function __call($method, $args) public function __call($method, $args)
{ {

11
src/Ion/Json.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* PHP version 5.6
*
* @package Ion * @package Ion
* @author Timothy J. Warren * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright Copyright (c) 2015 - 2016 * @copyright 2015 - 2016 Timothy J. Warren
* @license MIT * @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion; namespace Aviat\Ion;
@ -103,6 +107,7 @@ class Json {
* Call the json error functions to check for errors encoding/decoding * Call the json error functions to check for errors encoding/decoding
* *
* @throws JsonException * @throws JsonException
* @return void
*/ */
protected static function check_json_error() protected static function check_json_error()
{ {

10
src/Ion/JsonException.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* PHP version 5.6
*
* @package Ion * @package Ion
* @author Timothy J. Warren * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright Copyright (c) 2015 - 2016 * @copyright 2015 - 2016 Timothy J. Warren
* @license MIT * @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion; namespace Aviat\Ion;

10
src/Ion/Model.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* PHP version 5.6
*
* @package Ion * @package Ion
* @author Timothy J. Warren * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright Copyright (c) 2015 - 2016 * @copyright 2015 - 2016 Timothy J. Warren
* @license MIT * @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion; namespace Aviat\Ion;

10
src/Ion/Model/DB.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* PHP version 5.6
*
* @package Ion * @package Ion
* @author Timothy J. Warren * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright Copyright (c) 2015 - 2016 * @copyright 2015 - 2016 Timothy J. Warren
* @license MIT * @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion\Model; namespace Aviat\Ion\Model;

14
src/Ion/StaticInstance.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* PHP version 5.6
*
* @package Ion * @package Ion
* @author Timothy J. Warren * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright Copyright (c) 2015 - 2016 * @copyright 2015 - 2016 Timothy J. Warren
* @license MIT * @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion; namespace Aviat\Ion;
@ -25,13 +29,13 @@ trait StaticInstance {
private static $instance = []; private static $instance = [];
/** /**
* Call methods protected to allow for * Call protected methods to allow for
* static and instance calling * static and instance calling
* *
* @codeCoverageIgnore * @codeCoverageIgnore
* @param string $method * @param string $method
* @param array $args * @param array $args
* @retun mixed * @return mixed
*/ */
public function __call($method, $args) public function __call($method, $args)
{ {

10
src/Ion/StringWrapper.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* PHP version 5.6
*
* @package Ion * @package Ion
* @author Timothy J. Warren * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright Copyright (c) 2015 - 2016 * @copyright 2015 - 2016 Timothy J. Warren
* @license MIT * @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion; namespace Aviat\Ion;

10
src/Ion/Transformer/AbstractTransformer.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* PHP version 5.6
*
* @package Ion * @package Ion
* @author Timothy J. Warren * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright Copyright (c) 2015 - 2016 * @copyright 2015 - 2016 Timothy J. Warren
* @license MIT * @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion\Transformer; namespace Aviat\Ion\Transformer;

10
src/Ion/Transformer/TransformerInterface.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* PHP version 5.6
*
* @package Ion * @package Ion
* @author Timothy J. Warren * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright Copyright (c) 2015 - 2016 * @copyright 2015 - 2016 Timothy J. Warren
* @license MIT * @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion\Transformer; namespace Aviat\Ion\Transformer;

12
src/Ion/Type/ArrayType.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* PHP version 5.6
*
* @package Ion * @package Ion
* @author Timothy J. Warren * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright Copyright (c) 2015 - 2016 * @copyright 2015 - 2016 Timothy J. Warren
* @license MIT * @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion\Type; namespace Aviat\Ion\Type;
@ -214,7 +218,7 @@ class ArrayType {
foreach ($key as $level) foreach ($key as $level)
{ {
if (empty($pos) || ! is_array($pos)) if (empty($pos) OR ! is_array($pos))
{ {
// Directly returning a NULL value here will // Directly returning a NULL value here will
// result in a reference error. This isn't // result in a reference error. This isn't

10
src/Ion/Type/StringType.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* PHP version 5.6
*
* @package Ion * @package Ion
* @author Timothy J. Warren * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright Copyright (c) 2015 - 2016 * @copyright 2015 - 2016 Timothy J. Warren
* @license MIT * @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion\Type; namespace Aviat\Ion\Type;

36
src/Ion/View.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* PHP version 5.6
*
* @package Ion * @package Ion
* @author Timothy J. Warren * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright Copyright (c) 2015 - 2016 * @copyright 2015 - 2016 Timothy J. Warren
* @license MIT * @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion; namespace Aviat\Ion;
@ -16,12 +20,13 @@ use Psr\Http\Message\ResponseInterface;
use Aviat\Ion\Di\ContainerInterface; use Aviat\Ion\Di\ContainerInterface;
use Aviat\Ion\Exception\DoubleRenderException; use Aviat\Ion\Exception\DoubleRenderException;
use Aviat\Ion\Type\StringType;
/** /**
* Base view response class * Base view response class
*/ */
abstract class View /* partially */ implements ViewInterface { abstract class View
// partially
implements ViewInterface {
use Di\ContainerAware; use Di\ContainerAware;
use StringWrapper; use StringWrapper;
@ -64,7 +69,11 @@ abstract class View /* partially */ implements ViewInterface {
} }
/** /**
* @inheritdoc * Return rendered output as string. Renders the view,
* and any attempts to call again will result in a DoubleRenderException
*
* @throws DoubleRenderException
* @return string
*/ */
public function __toString() public function __toString()
{ {
@ -77,7 +86,10 @@ abstract class View /* partially */ implements ViewInterface {
} }
/** /**
* @inheritdoc * Set the output string
*
* @param string $string
* @return ViewInterface
*/ */
public function setOutput($string) public function setOutput($string)
{ {
@ -87,7 +99,10 @@ abstract class View /* partially */ implements ViewInterface {
} }
/** /**
* @inheritdoc * Append additional output.
*
* @param string $string
* @return ViewInterface
*/ */
public function appendOutput($string) public function appendOutput($string)
{ {
@ -95,7 +110,10 @@ abstract class View /* partially */ implements ViewInterface {
} }
/** /**
* @inheritdoc * Get the current output as a string. Does not
* render view or send headers.
*
* @return string
*/ */
public function getOutput() public function getOutput()
{ {

10
src/Ion/View/HtmlView.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* PHP version 5.6
*
* @package Ion * @package Ion
* @author Timothy J. Warren * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright Copyright (c) 2015 - 2016 * @copyright 2015 - 2016 Timothy J. Warren
* @license MIT * @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion\View; namespace Aviat\Ion\View;

16
src/Ion/View/HttpView.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* PHP version 5.6
*
* @package Ion * @package Ion
* @author Timothy J. Warren * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright Copyright (c) 2015 - 2016 * @copyright 2015 - 2016 Timothy J. Warren
* @license MIT * @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion\View; namespace Aviat\Ion\View;
@ -68,7 +72,11 @@ class HttpView extends BaseView {
} }
/** /**
* @inheritdoc * Send output to client. As it renders the view,
* any attempt to call again will result in a DoubleRenderException.
*
* @throws DoubleRenderException
* @return void
*/ */
public function send() public function send()
{ {

10
src/Ion/View/JsonView.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* PHP version 5.6
*
* @package Ion * @package Ion
* @author Timothy J. Warren * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright Copyright (c) 2015 - 2016 * @copyright 2015 - 2016 Timothy J. Warren
* @license MIT * @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion\View; namespace Aviat\Ion\View;

10
src/Ion/ViewInterface.php
View File

@ -4,10 +4,14 @@
* *
* Building blocks for web development * Building blocks for web development
* *
* PHP version 5.6
*
* @package Ion * @package Ion
* @author Timothy J. Warren * @author Timothy J. Warren <tim@timshomepage.net>
* @copyright Copyright (c) 2015 - 2016 * @copyright 2015 - 2016 Timothy J. Warren
* @license MIT * @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 1.0.0
* @link https://git.timshomepage.net/timw4mail/ion
*/ */
namespace Aviat\Ion; namespace Aviat\Ion;