From f696e7afa6929101e214db2ae221cd7895695075 Mon Sep 17 00:00:00 2001 From: Justin Hileman Date: Tue, 25 Mar 2014 07:21:02 -0700 Subject: [PATCH] Fix incorrect or missing type annotations. --- src/Mustache/Engine.php | 2 +- src/Mustache/Exception/SyntaxException.php | 7 +++++++ src/Mustache/Exception/UnknownFilterException.php | 3 +++ src/Mustache/Exception/UnknownHelperException.php | 3 +++ src/Mustache/Exception/UnknownTemplateException.php | 3 +++ src/Mustache/LambdaHelper.php | 2 +- src/Mustache/Loader/CascadingLoader.php | 2 +- src/Mustache/Loader/MutableLoader.php | 4 ++++ src/Mustache/Logger/StreamLogger.php | 4 ++-- test/Mustache/Test/Cache/FilesystemCacheTest.php | 3 +++ test/Mustache/Test/CompilerTest.php | 3 +++ test/Mustache/Test/EngineTest.php | 3 +++ .../Test/FiveThree/Functional/MustacheSpecTest.php | 3 ++- test/Mustache/Test/Functional/HigherOrderSectionsTest.php | 3 +++ test/Mustache/Test/Functional/MustacheSpecTest.php | 3 ++- 15 files changed, 41 insertions(+), 7 deletions(-) diff --git a/src/Mustache/Engine.php b/src/Mustache/Engine.php index bf234c9..c9bc847 100644 --- a/src/Mustache/Engine.php +++ b/src/Mustache/Engine.php @@ -194,7 +194,7 @@ class Mustache_Engine /** * Get the current Mustache escape callback. * - * @return mixed Callable or null + * @return callable|null */ public function getEscape() { diff --git a/src/Mustache/Exception/SyntaxException.php b/src/Mustache/Exception/SyntaxException.php index e666111..7a16f7e 100644 --- a/src/Mustache/Exception/SyntaxException.php +++ b/src/Mustache/Exception/SyntaxException.php @@ -16,12 +16,19 @@ class Mustache_Exception_SyntaxException extends LogicException implements Musta { protected $token; + /** + * @param string $msg + * @param array $token + */ public function __construct($msg, array $token) { $this->token = $token; parent::__construct($msg); } + /** + * @return array + */ public function getToken() { return $this->token; diff --git a/src/Mustache/Exception/UnknownFilterException.php b/src/Mustache/Exception/UnknownFilterException.php index 1a1f637..b9a315a 100644 --- a/src/Mustache/Exception/UnknownFilterException.php +++ b/src/Mustache/Exception/UnknownFilterException.php @@ -16,6 +16,9 @@ class Mustache_Exception_UnknownFilterException extends UnexpectedValueException { protected $filterName; + /** + * @param string $filterName + */ public function __construct($filterName) { $this->filterName = $filterName; diff --git a/src/Mustache/Exception/UnknownHelperException.php b/src/Mustache/Exception/UnknownHelperException.php index 8fc530e..226d774 100644 --- a/src/Mustache/Exception/UnknownHelperException.php +++ b/src/Mustache/Exception/UnknownHelperException.php @@ -16,6 +16,9 @@ class Mustache_Exception_UnknownHelperException extends InvalidArgumentException { protected $helperName; + /** + * @param string $helperName + */ public function __construct($helperName) { $this->helperName = $helperName; diff --git a/src/Mustache/Exception/UnknownTemplateException.php b/src/Mustache/Exception/UnknownTemplateException.php index 47ff4fa..5dafe89 100644 --- a/src/Mustache/Exception/UnknownTemplateException.php +++ b/src/Mustache/Exception/UnknownTemplateException.php @@ -16,6 +16,9 @@ class Mustache_Exception_UnknownTemplateException extends InvalidArgumentExcepti { protected $templateName; + /** + * @param string $templateName + */ public function __construct($templateName) { $this->templateName = $templateName; diff --git a/src/Mustache/LambdaHelper.php b/src/Mustache/LambdaHelper.php index f80c0fb..7cd8092 100644 --- a/src/Mustache/LambdaHelper.php +++ b/src/Mustache/LambdaHelper.php @@ -38,7 +38,7 @@ class Mustache_LambdaHelper * * @param string $string * - * @return Rendered template. + * @return string Rendered template. */ public function render($string) { diff --git a/src/Mustache/Loader/CascadingLoader.php b/src/Mustache/Loader/CascadingLoader.php index 204a38f..cfd74b3 100644 --- a/src/Mustache/Loader/CascadingLoader.php +++ b/src/Mustache/Loader/CascadingLoader.php @@ -25,7 +25,7 @@ class Mustache_Loader_CascadingLoader implements Mustache_Loader * new Mustache_Loader_FilesystemLoader(__DIR__.'/templates') * )); * - * @param array $loaders An array of Mustache Loader instances + * @param Mustache_Loader[] $loaders An array of Mustache Loader instances */ public function __construct(array $loaders = array()) { diff --git a/src/Mustache/Loader/MutableLoader.php b/src/Mustache/Loader/MutableLoader.php index 110aa31..f59f95d 100644 --- a/src/Mustache/Loader/MutableLoader.php +++ b/src/Mustache/Loader/MutableLoader.php @@ -19,6 +19,8 @@ interface Mustache_Loader_MutableLoader * Set an associative array of Template sources for this loader. * * @param array $templates + * + * @return void */ public function setTemplates(array $templates); @@ -27,6 +29,8 @@ interface Mustache_Loader_MutableLoader * * @param string $name * @param string $template Mustache Template source + * + * @return void */ public function setTemplate($name, $template); } diff --git a/src/Mustache/Logger/StreamLogger.php b/src/Mustache/Logger/StreamLogger.php index 470cf7c..aa47319 100644 --- a/src/Mustache/Logger/StreamLogger.php +++ b/src/Mustache/Logger/StreamLogger.php @@ -37,8 +37,8 @@ class Mustache_Logger_StreamLogger extends Mustache_Logger_AbstractLogger /** * @throws InvalidArgumentException if the logging level is unknown. * - * @param string $stream Resource instance or URL - * @param integer $level The minimum logging level at which this handler will be triggered + * @param resource|string $stream Resource instance or URL + * @param integer $level The minimum logging level at which this handler will be triggered */ public function __construct($stream, $level = Mustache_Logger::ERROR) { diff --git a/test/Mustache/Test/Cache/FilesystemCacheTest.php b/test/Mustache/Test/Cache/FilesystemCacheTest.php index 09dff65..e19c33b 100644 --- a/test/Mustache/Test/Cache/FilesystemCacheTest.php +++ b/test/Mustache/Test/Cache/FilesystemCacheTest.php @@ -44,6 +44,9 @@ class Mustache_Test_Cache_FilesystemCacheTest extends PHPUnit_Framework_TestCase $this->assertTrue($loaded); } + /** + * @param string $path + */ private static function rmdir($path) { $path = rtrim($path, '/').'/'; diff --git a/test/Mustache/Test/CompilerTest.php b/test/Mustache/Test/CompilerTest.php index 137811a..a9c7b3a 100644 --- a/test/Mustache/Test/CompilerTest.php +++ b/test/Mustache/Test/CompilerTest.php @@ -142,6 +142,9 @@ class Mustache_Test_CompilerTest extends PHPUnit_Framework_TestCase $compiler->compile('', array(array(Mustache_Tokenizer::TYPE => 'invalid')), 'SomeClass'); } + /** + * @param string $value + */ private function createTextToken($value) { return array( diff --git a/test/Mustache/Test/EngineTest.php b/test/Mustache/Test/EngineTest.php index b5679a3..af3fe1e 100644 --- a/test/Mustache/Test/EngineTest.php +++ b/test/Mustache/Test/EngineTest.php @@ -349,6 +349,9 @@ class Mustache_Test_EngineTest extends PHPUnit_Framework_TestCase $this->assertContains("WARNING: Partial not found: \"bar\"", $log); } + /** + * @param string $path + */ private static function rmdir($path) { $path = rtrim($path, '/').'/'; diff --git a/test/Mustache/Test/FiveThree/Functional/MustacheSpecTest.php b/test/Mustache/Test/FiveThree/Functional/MustacheSpecTest.php index d174a14..004ec21 100644 --- a/test/Mustache/Test/FiveThree/Functional/MustacheSpecTest.php +++ b/test/Mustache/Test/FiveThree/Functional/MustacheSpecTest.php @@ -78,7 +78,8 @@ class Mustache_Test_FiveThree_Functional_MustacheSpecTest extends PHPUnit_Framew * * Loads YAML files from the spec and converts them to PHPisms. * - * @access public + * @param string $name + * * @return array */ private function loadSpec($name) diff --git a/test/Mustache/Test/Functional/HigherOrderSectionsTest.php b/test/Mustache/Test/Functional/HigherOrderSectionsTest.php index 1e70423..5883e98 100644 --- a/test/Mustache/Test/Functional/HigherOrderSectionsTest.php +++ b/test/Mustache/Test/Functional/HigherOrderSectionsTest.php @@ -112,6 +112,9 @@ class Mustache_Test_Functional_Foo return sprintf('%s', $text); } + /** + * @param string $text + */ public function wrapWithStrong($text) { return sprintf('%s', $text); diff --git a/test/Mustache/Test/Functional/MustacheSpecTest.php b/test/Mustache/Test/Functional/MustacheSpecTest.php index fb6c156..e21efba 100644 --- a/test/Mustache/Test/Functional/MustacheSpecTest.php +++ b/test/Mustache/Test/Functional/MustacheSpecTest.php @@ -132,7 +132,8 @@ class Mustache_Test_Functional_MustacheSpecTest extends PHPUnit_Framework_TestCa * * Loads YAML files from the spec and converts them to PHPisms. * - * @access public + * @param string $name + * * @return array */ private function loadSpec($name)