From 2adb02daaad6597343d7f3c3bb98cc494b2ed566 Mon Sep 17 00:00:00 2001 From: "Timothy J. Warren" Date: Fri, 26 Aug 2016 23:10:20 -0400 Subject: [PATCH] Update file header, and fix some style issues --- RoboFile.php | 32 ++++++++--------- build/CodeIgniter-for-PHP_CodeSniffer | 1 - build/ion_header_comment.txt | 10 ++++-- build/phpcs.xml | 31 +++++++++++++++-- build/phpdox.xml | 2 +- composer.json | 5 +-- src/Ion/ArrayWrapper.php | 10 ++++-- src/Ion/Cache/CacheInterface.php | 10 ++++-- src/Ion/Cache/CacheManager.php | 10 ++++-- src/Ion/Cache/Driver/DriverInterface.php | 12 ++++--- src/Ion/Cache/Driver/DriverTrait.php | 16 ++++++--- src/Ion/Cache/Driver/NullDriver.php | 14 +++++--- src/Ion/Cache/Driver/RedisDriver.php | 12 ++++--- src/Ion/Cache/Driver/SQLDriver.php | 12 ++++--- src/Ion/Config.php | 10 ++++-- src/Ion/ConfigInterface.php | 10 ++++-- src/Ion/Di/Container.php | 12 ++++--- src/Ion/Di/ContainerAware.php | 10 ++++-- src/Ion/Di/ContainerAwareInterface.php | 10 ++++-- src/Ion/Di/ContainerInterface.php | 10 ++++-- src/Ion/Di/Exception/ContainerException.php | 10 ++++-- src/Ion/Di/Exception/NotFoundException.php | 10 ++++-- src/Ion/Enum.php | 10 ++++-- src/Ion/Exception/ConfigException.php | 12 ++++--- src/Ion/Exception/DoubleRenderException.php | 10 ++++-- src/Ion/Friend.php | 12 +++++-- src/Ion/Json.php | 11 ++++-- src/Ion/JsonException.php | 10 ++++-- src/Ion/Model.php | 10 ++++-- src/Ion/Model/DB.php | 10 ++++-- src/Ion/StaticInstance.php | 14 +++++--- src/Ion/StringWrapper.php | 10 ++++-- src/Ion/Transformer/AbstractTransformer.php | 10 ++++-- src/Ion/Transformer/TransformerInterface.php | 10 ++++-- src/Ion/Type/ArrayType.php | 12 ++++--- src/Ion/Type/StringType.php | 10 ++++-- src/Ion/View.php | 36 +++++++++++++++----- src/Ion/View/HtmlView.php | 10 ++++-- src/Ion/View/HttpView.php | 16 ++++++--- src/Ion/View/JsonView.php | 10 ++++-- src/Ion/ViewInterface.php | 10 ++++-- 41 files changed, 340 insertions(+), 152 deletions(-) delete mode 160000 build/CodeIgniter-for-PHP_CodeSniffer diff --git a/RoboFile.php b/RoboFile.php index 3690d95..2af1ee8 100644 --- a/RoboFile.php +++ b/RoboFile.php @@ -44,9 +44,9 @@ class RoboFile extends \Robo\Tasks { $this->prepare(); $this->lint(); $this->phploc(TRUE); + $this->phpcs(TRUE); $this->dependencyReport(); $this->phpcpdReport(); - $this->phpcsReport(); } /** @@ -143,15 +143,24 @@ class RoboFile extends \Robo\Tasks { /** * 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', '--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); } @@ -285,20 +294,7 @@ class RoboFile extends \Robo\Tasks { } /** - * Generate code style report - */ - 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 + * Shortcut for joining an array of command arguments * and then running it * * @param array $cmd_parts - command arguments diff --git a/build/CodeIgniter-for-PHP_CodeSniffer b/build/CodeIgniter-for-PHP_CodeSniffer deleted file mode 160000 index b501f01..0000000 --- a/build/CodeIgniter-for-PHP_CodeSniffer +++ /dev/null @@ -1 +0,0 @@ -Subproject commit b501f01403216a917754e3f76ba7022d4ad37a4e diff --git a/build/ion_header_comment.txt b/build/ion_header_comment.txt index 50a3025..dd5b924 100644 --- a/build/ion_header_comment.txt +++ b/build/ion_header_comment.txt @@ -3,8 +3,12 @@ * * Building blocks for web development * + * PHP version 5.6 + * * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * @author Timothy J. Warren + * @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 */ \ No newline at end of file diff --git a/build/phpcs.xml b/build/phpcs.xml index 419771f..2432930 100644 --- a/build/phpcs.xml +++ b/build/phpcs.xml @@ -4,6 +4,8 @@ ../src/ + utf-8 + @@ -24,15 +26,28 @@ - - - + + + + + + + + + + + + + + + + @@ -45,9 +60,19 @@ + + + + + + + + + + \ No newline at end of file diff --git a/build/phpdox.xml b/build/phpdox.xml index 7ec37a2..5b83b8f 100644 --- a/build/phpdox.xml +++ b/build/phpdox.xml @@ -85,7 +85,7 @@ - + diff --git a/composer.json b/composer.json index 78fe0d6..362d959 100644 --- a/composer.json +++ b/composer.json @@ -9,7 +9,8 @@ }, "autoload-dev": { "psr-4": { - "Aviat\\Ion\\Tests\\": "tests/Ion/" + "Aviat\\Ion\\Tests\\": "tests/Ion/", + "CodeIgniter\\": "build/CodeIgniter/" } }, "require": { @@ -36,7 +37,7 @@ "nikic/php-parser": "3.0.*@alpha", "monolog/monolog": "1.*", "predis/predis": "1.1.*", - "squizlabs/php_codesniffer": "^2.6" + "squizlabs/php_codesniffer": "^3.0.0@alpha" }, "suggest": { "monolog/monolog": "Provides implementation of psr/log", diff --git a/src/Ion/ArrayWrapper.php b/src/Ion/ArrayWrapper.php index 74ec7da..65af76a 100644 --- a/src/Ion/ArrayWrapper.php +++ b/src/Ion/ArrayWrapper.php @@ -4,10 +4,14 @@ * * Building blocks for web development * + * PHP version 5.6 + * * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * @author Timothy J. Warren + * @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; diff --git a/src/Ion/Cache/CacheInterface.php b/src/Ion/Cache/CacheInterface.php index 6658a2b..0b2695b 100644 --- a/src/Ion/Cache/CacheInterface.php +++ b/src/Ion/Cache/CacheInterface.php @@ -4,10 +4,14 @@ * * Building blocks for web development * + * PHP version 5.6 + * * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * @author Timothy J. Warren + * @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; diff --git a/src/Ion/Cache/CacheManager.php b/src/Ion/Cache/CacheManager.php index 7f98cdc..4422987 100644 --- a/src/Ion/Cache/CacheManager.php +++ b/src/Ion/Cache/CacheManager.php @@ -4,10 +4,14 @@ * * Building blocks for web development * + * PHP version 5.6 + * * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * @author Timothy J. Warren + * @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; diff --git a/src/Ion/Cache/Driver/DriverInterface.php b/src/Ion/Cache/Driver/DriverInterface.php index 171a61c..71b9b9c 100644 --- a/src/Ion/Cache/Driver/DriverInterface.php +++ b/src/Ion/Cache/Driver/DriverInterface.php @@ -4,10 +4,14 @@ * * Building blocks for web development * - * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * PHP version 5.6 + * + * @package Ion + * @author Timothy J. Warren + * @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; diff --git a/src/Ion/Cache/Driver/DriverTrait.php b/src/Ion/Cache/Driver/DriverTrait.php index 57b6b75..542dedd 100644 --- a/src/Ion/Cache/Driver/DriverTrait.php +++ b/src/Ion/Cache/Driver/DriverTrait.php @@ -4,10 +4,14 @@ * * Building blocks for web development * - * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * PHP version 5.6 + * + * @package Ion + * @author Timothy J. Warren + * @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; @@ -22,8 +26,10 @@ trait DriverTrait { /** * 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 diff --git a/src/Ion/Cache/Driver/NullDriver.php b/src/Ion/Cache/Driver/NullDriver.php index 98b9ce6..170020c 100644 --- a/src/Ion/Cache/Driver/NullDriver.php +++ b/src/Ion/Cache/Driver/NullDriver.php @@ -4,14 +4,17 @@ * * Building blocks for web development * - * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * PHP version 5.6 + * + * @package Ion + * @author Timothy J. Warren + * @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; -use Aviat\Ion\ConfigInterface; /** * The Driver for no real cache @@ -20,6 +23,7 @@ class NullDriver implements DriverInterface { /** * 'Cache' for Null data store + * @var array */ protected $data = []; diff --git a/src/Ion/Cache/Driver/RedisDriver.php b/src/Ion/Cache/Driver/RedisDriver.php index 073f2e0..1d948af 100644 --- a/src/Ion/Cache/Driver/RedisDriver.php +++ b/src/Ion/Cache/Driver/RedisDriver.php @@ -4,10 +4,14 @@ * * Building blocks for web development * - * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * PHP version 5.6 + * + * @package Ion + * @author Timothy J. Warren + * @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; diff --git a/src/Ion/Cache/Driver/SQLDriver.php b/src/Ion/Cache/Driver/SQLDriver.php index 28a019c..daf4924 100644 --- a/src/Ion/Cache/Driver/SQLDriver.php +++ b/src/Ion/Cache/Driver/SQLDriver.php @@ -4,10 +4,14 @@ * * Building blocks for web development * - * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * PHP version 5.6 + * + * @package Ion + * @author Timothy J. Warren + * @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; diff --git a/src/Ion/Config.php b/src/Ion/Config.php index 8f72924..a50d2b8 100644 --- a/src/Ion/Config.php +++ b/src/Ion/Config.php @@ -4,10 +4,14 @@ * * Building blocks for web development * + * PHP version 5.6 + * * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * @author Timothy J. Warren + * @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; diff --git a/src/Ion/ConfigInterface.php b/src/Ion/ConfigInterface.php index 65af546..305e6fa 100644 --- a/src/Ion/ConfigInterface.php +++ b/src/Ion/ConfigInterface.php @@ -4,10 +4,14 @@ * * Building blocks for web development * + * PHP version 5.6 + * * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * @author Timothy J. Warren + * @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; diff --git a/src/Ion/Di/Container.php b/src/Ion/Di/Container.php index d4b0917..f324c69 100644 --- a/src/Ion/Di/Container.php +++ b/src/Ion/Di/Container.php @@ -4,10 +4,14 @@ * * Building blocks for web development * + * PHP version 5.6 + * * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * @author Timothy J. Warren + * @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\Di; @@ -160,7 +164,7 @@ class Container implements ContainerInterface { $uses_trait = in_array($trait_name, class_uses($obj)); $implements_interface = in_array($interface_name, class_implements($obj)); - if ($uses_trait || $implements_interface) + if ($uses_trait OR $implements_interface) { $obj->setContainer($this); } diff --git a/src/Ion/Di/ContainerAware.php b/src/Ion/Di/ContainerAware.php index 8aaf016..675d891 100644 --- a/src/Ion/Di/ContainerAware.php +++ b/src/Ion/Di/ContainerAware.php @@ -4,10 +4,14 @@ * * Building blocks for web development * + * PHP version 5.6 + * * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * @author Timothy J. Warren + * @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\Di; diff --git a/src/Ion/Di/ContainerAwareInterface.php b/src/Ion/Di/ContainerAwareInterface.php index 64de7b6..19322d4 100644 --- a/src/Ion/Di/ContainerAwareInterface.php +++ b/src/Ion/Di/ContainerAwareInterface.php @@ -4,10 +4,14 @@ * * Building blocks for web development * + * PHP version 5.6 + * * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * @author Timothy J. Warren + * @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\Di; diff --git a/src/Ion/Di/ContainerInterface.php b/src/Ion/Di/ContainerInterface.php index f86f71d..694d31e 100644 --- a/src/Ion/Di/ContainerInterface.php +++ b/src/Ion/Di/ContainerInterface.php @@ -4,10 +4,14 @@ * * Building blocks for web development * + * PHP version 5.6 + * * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * @author Timothy J. Warren + * @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\Di; diff --git a/src/Ion/Di/Exception/ContainerException.php b/src/Ion/Di/Exception/ContainerException.php index 0f82e9e..4dd8a81 100644 --- a/src/Ion/Di/Exception/ContainerException.php +++ b/src/Ion/Di/Exception/ContainerException.php @@ -4,10 +4,14 @@ * * Building blocks for web development * + * PHP version 5.6 + * * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * @author Timothy J. Warren + * @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\Di\Exception; diff --git a/src/Ion/Di/Exception/NotFoundException.php b/src/Ion/Di/Exception/NotFoundException.php index 5374da7..6db671e 100644 --- a/src/Ion/Di/Exception/NotFoundException.php +++ b/src/Ion/Di/Exception/NotFoundException.php @@ -4,10 +4,14 @@ * * Building blocks for web development * + * PHP version 5.6 + * * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * @author Timothy J. Warren + * @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\Di\Exception; diff --git a/src/Ion/Enum.php b/src/Ion/Enum.php index c2eceae..353a281 100644 --- a/src/Ion/Enum.php +++ b/src/Ion/Enum.php @@ -4,10 +4,14 @@ * * Building blocks for web development * + * PHP version 5.6 + * * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * @author Timothy J. Warren + * @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; diff --git a/src/Ion/Exception/ConfigException.php b/src/Ion/Exception/ConfigException.php index ea1d21c..a8ddf8c 100644 --- a/src/Ion/Exception/ConfigException.php +++ b/src/Ion/Exception/ConfigException.php @@ -4,10 +4,14 @@ * * Building blocks for web development * - * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * PHP version 5.6 + * + * @package Ion + * @author Timothy J. Warren + * @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; diff --git a/src/Ion/Exception/DoubleRenderException.php b/src/Ion/Exception/DoubleRenderException.php index 556c0cc..08236dd 100644 --- a/src/Ion/Exception/DoubleRenderException.php +++ b/src/Ion/Exception/DoubleRenderException.php @@ -4,10 +4,14 @@ * * Building blocks for web development * + * PHP version 5.6 + * * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * @author Timothy J. Warren + * @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; diff --git a/src/Ion/Friend.php b/src/Ion/Friend.php index b44ee58..941aacc 100644 --- a/src/Ion/Friend.php +++ b/src/Ion/Friend.php @@ -4,10 +4,14 @@ * * Building blocks for web development * + * PHP version 5.6 + * * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * @author Timothy J. Warren + * @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; @@ -39,6 +43,7 @@ class Friend { * Create a friend object * * @param object $obj + * @throws InvalidArgumentException */ public function __construct($obj) { @@ -90,6 +95,7 @@ class Friend { * @param string $method * @param array $args * @return mixed + * @throws BadMethodCallException */ public function __call($method, $args) { diff --git a/src/Ion/Json.php b/src/Ion/Json.php index c9e55d0..a7a4228 100644 --- a/src/Ion/Json.php +++ b/src/Ion/Json.php @@ -4,10 +4,14 @@ * * Building blocks for web development * + * PHP version 5.6 + * * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * @author Timothy J. Warren + * @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; @@ -103,6 +107,7 @@ class Json { * Call the json error functions to check for errors encoding/decoding * * @throws JsonException + * @return void */ protected static function check_json_error() { diff --git a/src/Ion/JsonException.php b/src/Ion/JsonException.php index 3a0d7c5..ce3e3cf 100644 --- a/src/Ion/JsonException.php +++ b/src/Ion/JsonException.php @@ -4,10 +4,14 @@ * * Building blocks for web development * + * PHP version 5.6 + * * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * @author Timothy J. Warren + * @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; diff --git a/src/Ion/Model.php b/src/Ion/Model.php index eb1e169..4fd6f33 100644 --- a/src/Ion/Model.php +++ b/src/Ion/Model.php @@ -4,10 +4,14 @@ * * Building blocks for web development * + * PHP version 5.6 + * * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * @author Timothy J. Warren + * @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; diff --git a/src/Ion/Model/DB.php b/src/Ion/Model/DB.php index 04b915e..a63f409 100644 --- a/src/Ion/Model/DB.php +++ b/src/Ion/Model/DB.php @@ -4,10 +4,14 @@ * * Building blocks for web development * + * PHP version 5.6 + * * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * @author Timothy J. Warren + * @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\Model; diff --git a/src/Ion/StaticInstance.php b/src/Ion/StaticInstance.php index 3750ea6..2d7eb79 100644 --- a/src/Ion/StaticInstance.php +++ b/src/Ion/StaticInstance.php @@ -4,10 +4,14 @@ * * Building blocks for web development * + * PHP version 5.6 + * * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * @author Timothy J. Warren + * @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; @@ -25,13 +29,13 @@ trait StaticInstance { private static $instance = []; /** - * Call methods protected to allow for + * Call protected methods to allow for * static and instance calling * * @codeCoverageIgnore * @param string $method * @param array $args - * @retun mixed + * @return mixed */ public function __call($method, $args) { diff --git a/src/Ion/StringWrapper.php b/src/Ion/StringWrapper.php index 568dfd9..c5df19c 100644 --- a/src/Ion/StringWrapper.php +++ b/src/Ion/StringWrapper.php @@ -4,10 +4,14 @@ * * Building blocks for web development * + * PHP version 5.6 + * * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * @author Timothy J. Warren + * @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; diff --git a/src/Ion/Transformer/AbstractTransformer.php b/src/Ion/Transformer/AbstractTransformer.php index f0bb1b4..26d5c2d 100644 --- a/src/Ion/Transformer/AbstractTransformer.php +++ b/src/Ion/Transformer/AbstractTransformer.php @@ -4,10 +4,14 @@ * * Building blocks for web development * + * PHP version 5.6 + * * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * @author Timothy J. Warren + * @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\Transformer; diff --git a/src/Ion/Transformer/TransformerInterface.php b/src/Ion/Transformer/TransformerInterface.php index 2517038..57e02b8 100644 --- a/src/Ion/Transformer/TransformerInterface.php +++ b/src/Ion/Transformer/TransformerInterface.php @@ -4,10 +4,14 @@ * * Building blocks for web development * + * PHP version 5.6 + * * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * @author Timothy J. Warren + * @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\Transformer; diff --git a/src/Ion/Type/ArrayType.php b/src/Ion/Type/ArrayType.php index 7df4ff3..a13f333 100644 --- a/src/Ion/Type/ArrayType.php +++ b/src/Ion/Type/ArrayType.php @@ -4,10 +4,14 @@ * * Building blocks for web development * + * PHP version 5.6 + * * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * @author Timothy J. Warren + * @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\Type; @@ -214,7 +218,7 @@ class ArrayType { foreach ($key as $level) { - if (empty($pos) || ! is_array($pos)) + if (empty($pos) OR ! is_array($pos)) { // Directly returning a NULL value here will // result in a reference error. This isn't diff --git a/src/Ion/Type/StringType.php b/src/Ion/Type/StringType.php index 02c8cd8..6326548 100644 --- a/src/Ion/Type/StringType.php +++ b/src/Ion/Type/StringType.php @@ -4,10 +4,14 @@ * * Building blocks for web development * + * PHP version 5.6 + * * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * @author Timothy J. Warren + * @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\Type; diff --git a/src/Ion/View.php b/src/Ion/View.php index f26ad41..62c10b3 100644 --- a/src/Ion/View.php +++ b/src/Ion/View.php @@ -4,10 +4,14 @@ * * Building blocks for web development * + * PHP version 5.6 + * * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * @author Timothy J. Warren + * @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; @@ -16,12 +20,13 @@ use Psr\Http\Message\ResponseInterface; use Aviat\Ion\Di\ContainerInterface; use Aviat\Ion\Exception\DoubleRenderException; -use Aviat\Ion\Type\StringType; /** * Base view response class */ -abstract class View /* partially */ implements ViewInterface { +abstract class View + // partially + implements ViewInterface { use Di\ContainerAware; 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() { @@ -77,7 +86,10 @@ abstract class View /* partially */ implements ViewInterface { } /** - * @inheritdoc + * Set the output string + * + * @param string $string + * @return ViewInterface */ 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) { @@ -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() { diff --git a/src/Ion/View/HtmlView.php b/src/Ion/View/HtmlView.php index 01af7a8..91533e4 100644 --- a/src/Ion/View/HtmlView.php +++ b/src/Ion/View/HtmlView.php @@ -4,10 +4,14 @@ * * Building blocks for web development * + * PHP version 5.6 + * * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * @author Timothy J. Warren + * @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\View; diff --git a/src/Ion/View/HttpView.php b/src/Ion/View/HttpView.php index 71c134b..1417fe5 100644 --- a/src/Ion/View/HttpView.php +++ b/src/Ion/View/HttpView.php @@ -4,10 +4,14 @@ * * Building blocks for web development * + * PHP version 5.6 + * * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * @author Timothy J. Warren + * @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\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() { diff --git a/src/Ion/View/JsonView.php b/src/Ion/View/JsonView.php index 6474609..de32167 100644 --- a/src/Ion/View/JsonView.php +++ b/src/Ion/View/JsonView.php @@ -4,10 +4,14 @@ * * Building blocks for web development * + * PHP version 5.6 + * * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * @author Timothy J. Warren + * @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\View; diff --git a/src/Ion/ViewInterface.php b/src/Ion/ViewInterface.php index 91a2514..cb68947 100644 --- a/src/Ion/ViewInterface.php +++ b/src/Ion/ViewInterface.php @@ -4,10 +4,14 @@ * * Building blocks for web development * + * PHP version 5.6 + * * @package Ion - * @author Timothy J. Warren - * @copyright Copyright (c) 2015 - 2016 - * @license MIT + * @author Timothy J. Warren + * @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;