added PHP 7.1 scalar and return type hints

Author: dg

src/Bridges/CacheDI/CacheExtension.php

@@ -54,7 +54,7 @@ public function afterCompile(Nette\PhpGenerator\ClassType $class)
 	}
 
 
-	private function checkTempDir($dir)
+	private function checkTempDir($dir): bool
 	{
 		@mkdir($dir); // @ - directory may exists
 

src/Bridges/CacheLatte/CacheMacro.php

@@ -79,10 +79,7 @@ public function nodeClosed(Latte\MacroNode $node)
 	/********************* run-time helpers ****************d*g**/
 
 
-	/**
-	 * @return void
-	 */
-	public static function initRuntime(Latte\Runtime\Template $template)
+	public static function initRuntime(Latte\Runtime\Template $template): void
 	{
 		if (!empty($template->global->cacheStack)) {
 			$file = (new \ReflectionClass($template))->getFileName();
@@ -95,13 +92,9 @@ public static function initRuntime(Latte\Runtime\Template $template)
 
 	/**
 	 * Starts the output cache. Returns Nette\Caching\OutputHelper object if buffering was started.
-	 * @param  Nette\Caching\IStorage
-	 * @param  string
-	 * @param  Nette\Caching\OutputHelper[]
-	 * @param  array
 	 * @return Nette\Caching\OutputHelper|\stdClass
 	 */
-	public static function createCache(Nette\Caching\IStorage $cacheStorage, $key, &$parents, array $args = NULL)
+	public static function createCache(Nette\Caching\IStorage $cacheStorage, string $key, ?array &$parents, array $args = NULL)
 	{
 		if ($args) {
 			if (array_key_exists('if', $args) && !$args['if']) {
@@ -124,9 +117,8 @@ public static function createCache(Nette\Caching\IStorage $cacheStorage, $key, &
 	/**
 	 * Ends the output cache.
 	 * @param  Nette\Caching\OutputHelper[]
-	 * @return void
 	 */
-	public static function endCache(&$parents, array $args = NULL)
+	public static function endCache(array &$parents, array $args = NULL): void
 	{
 		$helper = array_pop($parents);
 		if ($helper instanceof Nette\Caching\OutputHelper) {

src/Caching/Cache.php

@@ -51,30 +51,27 @@ public function __construct(IStorage $storage, $namespace = NULL)
 
 	/**
 	 * Returns cache storage.
-	 * @return IStorage
 	 */
-	public function getStorage()
+	public function getStorage(): IStorage
 	{
 		return $this->storage;
 	}
 
 
 	/**
 	 * Returns cache namespace.
-	 * @return string
 	 */
-	public function getNamespace()
+	public function getNamespace(): string
 	{
 		return (string) substr($this->namespace, 0, -1);
 	}
 
 
 	/**
 	 * Returns new nested cache object.
-	 * @param  string
 	 * @return static
 	 */
-	public function derive($namespace)
+	public function derive(string $namespace)
 	{
 		$derived = new static($this->storage, $this->namespace . $namespace);
 		return $derived;
@@ -84,10 +81,9 @@ public function derive($namespace)
 	/**
 	 * Reads the specified item from the cache or generate it.
 	 * @param  mixed
-	 * @param  callable
 	 * @return mixed
 	 */
-	public function load($key, $fallback = NULL)
+	public function load($key, callable $fallback = NULL)
 	{
 		$data = $this->storage->read($this->generateKey($key));
 		if ($data === NULL && $fallback) {
@@ -101,11 +97,8 @@ public function load($key, $fallback = NULL)
 
 	/**
 	 * Reads multiple items from the cache.
-	 * @param  array
-	 * @param  callable
-	 * @return array
 	 */
-	public function bulkLoad(array $keys, $fallback = NULL)
+	public function bulkLoad(array $keys, callable $fallback = NULL): array
 	{
 		if (count($keys) === 0) {
 			return [];
@@ -192,7 +185,7 @@ public function save($key, $data, array $dependencies = NULL)
 	}
 
 
-	private function completeDependencies($dp)
+	private function completeDependencies(?array $dp): array
 	{
 		// convert expire into relative amount of seconds
 		if (isset($dp[self::EXPIRATION])) {
@@ -235,9 +228,8 @@ private function completeDependencies($dp)
 	/**
 	 * Removes item from the cache.
 	 * @param  mixed
-	 * @return void
 	 */
-	public function remove($key)
+	public function remove($key): void
 	{
 		$this->save($key, NULL);
 	}
@@ -249,9 +241,8 @@ public function remove($key)
 	 * - Cache::PRIORITY => (int) priority
 	 * - Cache::TAGS => (array) tags
 	 * - Cache::ALL => TRUE
-	 * @return void
 	 */
-	public function clean(array $conditions = NULL)
+	public function clean(array $conditions = NULL): void
 	{
 		$conditions = (array) $conditions;
 		if (isset($conditions[self::TAGS])) {
@@ -281,9 +272,8 @@ public function call($function)
 	/**
 	 * Caches results of function/method calls.
 	 * @param  mixed
-	 * @return \Closure
 	 */
-	public function wrap($function, array $dependencies = NULL)
+	public function wrap($function, array $dependencies = NULL): \Closure
 	{
 		return function () use ($function, $dependencies) {
 			$key = [$function, func_get_args()];
@@ -302,24 +292,22 @@ public function wrap($function, array $dependencies = NULL)
 	/**
 	 * Starts the output cache.
 	 * @param  mixed
-	 * @return OutputHelper|NULL
 	 */
-	public function start($key)
+	public function start($key): ?OutputHelper
 	{
 		$data = $this->load($key);
 		if ($data === NULL) {
 			return new OutputHelper($this, $key);
 		}
 		echo $data;
+		return NULL;
 	}
 
 
 	/**
 	 * Generates internal cache key.
-	 * @param  mixed
-	 * @return string
 	 */
-	protected function generateKey($key)
+	protected function generateKey($key): string
 	{
 		return $this->namespace . md5(is_scalar($key) ? (string) $key : serialize($key));
 	}
@@ -330,10 +318,8 @@ protected function generateKey($key)
 
 	/**
 	 * Checks CALLBACKS dependencies.
-	 * @param  array
-	 * @return bool
 	 */
-	public static function checkCallbacks($callbacks)
+	public static function checkCallbacks(array $callbacks): bool
 	{
 		foreach ($callbacks as $callback) {
 			if (!array_shift($callback)(...$callback)) {
@@ -346,23 +332,17 @@ public static function checkCallbacks($callbacks)
 
 	/**
 	 * Checks CONSTS dependency.
-	 * @param  string
-	 * @param  mixed
-	 * @return bool
 	 */
-	private static function checkConst($const, $value)
+	private static function checkConst(string $const, $value): bool
 	{
 		return defined($const) && constant($const) === $value;
 	}
 
 
 	/**
 	 * Checks FILES dependency.
-	 * @param  string
-	 * @param  int|NULL
-	 * @return bool
 	 */
-	private static function checkFile($file, $time)
+	private static function checkFile(string $file, ?int $time): bool
 	{
 		return @filemtime($file) == $time; // @ - stat may fail
 	}

src/Caching/IBulkReader.php

@@ -18,9 +18,8 @@ interface IBulkReader
 
 	/**
 	 * Reads from cache in bulk.
-	 * @param  string
 	 * @return array key => value pairs, missing items are omitted
 	 */
-	function bulkRead(array $keys);
+	function bulkRead(array $keys): array;
 
 }

src/Caching/IStorage.php

@@ -18,38 +18,28 @@ interface IStorage
 
 	/**
 	 * Read from cache.
-	 * @param  string
 	 * @return mixed
 	 */
-	function read($key);
+	function read(string $key);
 
 	/**
 	 * Prevents item reading and writing. Lock is released by write() or remove().
-	 * @param  string
-	 * @return void
 	 */
-	function lock($key);
+	function lock(string $key): void;
 
 	/**
 	 * Writes item into the cache.
-	 * @param  string
-	 * @param  mixed
-	 * @return void
 	 */
-	function write($key, $data, array $dependencies);
+	function write(string $key, $data, array $dependencies): void;
 
 	/**
 	 * Removes item from the cache.
-	 * @param  string
-	 * @return void
 	 */
-	function remove($key);
+	function remove(string $key): void;
 
 	/**
 	 * Removes items from the cache by conditions.
-	 * @param  array  conditions
-	 * @return void
 	 */
-	function clean(array $conditions);
+	function clean(array $conditions): void;
 
 }

src/Caching/OutputHelper.php

@@ -39,9 +39,8 @@ public function __construct(Cache $cache, $key)
 
 	/**
 	 * Stops and saves the cache.
-	 * @return void
 	 */
-	public function end(array $dependencies = NULL)
+	public function end(array $dependencies = NULL): void
 	{
 		if ($this->cache === NULL) {
 			throw new Nette\InvalidStateException('Output cache has already been saved.');

src/Caching/Storages/DevNullStorage.php

@@ -21,51 +21,41 @@ class DevNullStorage implements Nette\Caching\IStorage
 
 	/**
 	 * Read from cache.
-	 * @param  string
 	 * @return mixed
 	 */
-	public function read($key)
+	public function read(string $key)
 	{
 	}
 
 
 	/**
 	 * Prevents item reading and writing. Lock is released by write() or remove().
-	 * @param  string
-	 * @return void
 	 */
-	public function lock($key)
+	public function lock(string $key): void
 	{
 	}
 
 
 	/**
 	 * Writes item into the cache.
-	 * @param  string
-	 * @param  mixed
-	 * @return void
 	 */
-	public function write($key, $data, array $dependencies)
+	public function write(string $key, $data, array $dependencies): void
 	{
 	}
 
 
 	/**
 	 * Removes item from the cache.
-	 * @param  string
-	 * @return void
 	 */
-	public function remove($key)
+	public function remove(string $key): void
 	{
 	}
 
 
 	/**
 	 * Removes items from the cache by conditions & garbage collector.
-	 * @param  array  conditions
-	 * @return void
 	 */
-	public function clean(array $conditions)
+	public function clean(array $conditions): void
 	{
 	}