From 34acf00b5e2a92a8241be38c71bf3270fe1222f5 Mon Sep 17 00:00:00 2001 From: "Timothy J. Warren" Date: Mon, 12 Oct 2015 14:27:20 -0400 Subject: [PATCH] Fix documentation issues --- src/Aviat/AnimeClient/Controller/Collection.php | 2 +- src/Aviat/AnimeClient/Dispatcher.php | 2 +- src/Aviat/AnimeClient/Model/AnimeCollection.php | 11 ++++++++--- src/Aviat/AnimeClient/RoutingBase.php | 2 +- src/Aviat/Ion/Di/Container.php | 2 +- src/Aviat/Ion/Type/ArrayType.php | 2 +- src/Aviat/Ion/View.php | 3 ++- 7 files changed, 15 insertions(+), 9 deletions(-) diff --git a/src/Aviat/AnimeClient/Controller/Collection.php b/src/Aviat/AnimeClient/Controller/Collection.php index 66829711..3f54c5e0 100644 --- a/src/Aviat/AnimeClient/Controller/Collection.php +++ b/src/Aviat/AnimeClient/Controller/Collection.php @@ -91,7 +91,7 @@ class Collection extends BaseController { /** * Show the anime collection add/edit form * - * @param int $id + * @param integer|null $id * @return void */ public function form($id = NULL) diff --git a/src/Aviat/AnimeClient/Dispatcher.php b/src/Aviat/AnimeClient/Dispatcher.php index 82ab1f44..1eb11978 100644 --- a/src/Aviat/AnimeClient/Dispatcher.php +++ b/src/Aviat/AnimeClient/Dispatcher.php @@ -106,7 +106,7 @@ class Dispatcher extends RoutingBase { * Handle the current route * * @codeCoverageIgnore - * @param object $route + * @param object|null $route * @return void */ public function __invoke($route = NULL) diff --git a/src/Aviat/AnimeClient/Model/AnimeCollection.php b/src/Aviat/AnimeClient/Model/AnimeCollection.php index f66a4580..f4c46cfe 100644 --- a/src/Aviat/AnimeClient/Model/AnimeCollection.php +++ b/src/Aviat/AnimeClient/Model/AnimeCollection.php @@ -169,7 +169,8 @@ class AnimeCollection extends DB { { if ( ! $this->valid_database) return []; - $query = $this->db->select('hummingbird_id, slug, title, alternate_title, show_type, age_rating, episode_count, episode_length, cover_image, notes, media.type as media') + $query = $this->db->select('hummingbird_id, slug, title, alternate_title, show_type, + age_rating, episode_count, episode_length, cover_image, notes, media.type as media') ->from('anime_set a') ->join('media', 'media.id=a.media_id', 'inner') ->order_by('media') @@ -196,7 +197,9 @@ class AnimeCollection extends DB { 'alternate_title' => $anime->alternate_title, 'show_type' => $anime->show_type, 'age_rating' => $anime->age_rating, - 'cover_image' => basename($this->get_cached_image($anime->cover_image, $anime->slug, 'anime')), + 'cover_image' => basename( + $this->get_cached_image($anime->cover_image, $anime->slug, 'anime') + ), 'episode_count' => $anime->episode_count, 'episode_length' => $anime->episode_length, 'media_id' => $data['media_id'], @@ -261,7 +264,9 @@ class AnimeCollection extends DB { 'alternate_title' => $item->alternate_title, 'show_type' => $item->show_type, 'age_rating' => $item->age_rating, - 'cover_image' => basename($this->get_cached_image($item->cover_image, $item->slug, 'anime')), + 'cover_image' => basename( + $this->get_cached_image($item->cover_image, $item->slug, 'anime') + ), 'episode_count' => $item->episode_count, 'episode_length' => $item->episode_length ])->insert('anime_set'); diff --git a/src/Aviat/AnimeClient/RoutingBase.php b/src/Aviat/AnimeClient/RoutingBase.php index e3cc2a07..0d8aa4ea 100644 --- a/src/Aviat/AnimeClient/RoutingBase.php +++ b/src/Aviat/AnimeClient/RoutingBase.php @@ -16,7 +16,7 @@ class RoutingBase { /** * Injection Container - * @var Container $container + * @var ContainerInterface $container */ protected $container; diff --git a/src/Aviat/Ion/Di/Container.php b/src/Aviat/Ion/Di/Container.php index b5bea086..55179ced 100644 --- a/src/Aviat/Ion/Di/Container.php +++ b/src/Aviat/Ion/Di/Container.php @@ -12,7 +12,7 @@ class Container implements ContainerInterface { /** * Array with class instances * - * @var array + * @var ArrayObject */ protected $container = []; diff --git a/src/Aviat/Ion/Type/ArrayType.php b/src/Aviat/Ion/Type/ArrayType.php index 5dbe1438..666f1d33 100644 --- a/src/Aviat/Ion/Type/ArrayType.php +++ b/src/Aviat/Ion/Type/ArrayType.php @@ -136,7 +136,7 @@ class ArrayType { * * @param mixed $value * @param bool $strict - * @return string + * @return false|integer|string */ public function search($value, $strict=FALSE) { diff --git a/src/Aviat/Ion/View.php b/src/Aviat/Ion/View.php index cc9f8ff3..e23ddbd0 100644 --- a/src/Aviat/Ion/View.php +++ b/src/Aviat/Ion/View.php @@ -3,6 +3,7 @@ namespace Aviat\Ion; use Aviat\Ion\Di\ContainerInterface; +use Aviat\Ion\Type\StringType; /** * Base view response class @@ -29,7 +30,7 @@ abstract class View { /** * String of response to be output * - * @var S + * @var StringType */ protected $output;