added PHP 7.1 scalar and return type hints

Author: dg

src/Bridges/HttpTracy/SessionPanel.php

@@ -22,9 +22,8 @@ class SessionPanel implements Tracy\IBarPanel
 
 	/**
 	 * Renders tab.
-	 * @return string
 	 */
-	public function getTab()
+	public function getTab(): string
 	{
 		ob_start(function () {});
 		require __DIR__ . '/templates/SessionPanel.tab.phtml';
@@ -34,9 +33,8 @@ public function getTab()
 
 	/**
 	 * Renders panel.
-	 * @return string
 	 */
-	public function getPanel()
+	public function getPanel(): string
 	{
 		ob_start(function () {});
 		require __DIR__ . '/templates/SessionPanel.panel.phtml';

src/Http/Context.php

@@ -36,10 +36,8 @@ public function __construct(IRequest $request, IResponse $response)
 	/**
 	 * Attempts to cache the sent entity by its last modification date.
 	 * @param  string|int|\DateTimeInterface  last modified time
-	 * @param  string  strong entity tag validator
-	 * @return bool
 	 */
-	public function isModified($lastModified = NULL, $etag = NULL)
+	public function isModified($lastModified = NULL, string $etag = NULL): bool
 	{
 		if ($lastModified) {
 			$this->response->setHeader('Last-Modified', Helpers::formatDate($lastModified));
@@ -83,19 +81,13 @@ public function isModified($lastModified = NULL, $etag = NULL)
 	}
 
 
-	/**
-	 * @return IRequest
-	 */
-	public function getRequest()
+	public function getRequest(): IRequest
 	{
 		return $this->request;
 	}
 
 
-	/**
-	 * @return IResponse
-	 */
-	public function getResponse()
+	public function getResponse(): IResponse
 	{
 		return $this->response;
 	}

src/Http/FileUpload.php

@@ -61,29 +61,26 @@ public function __construct($value)
 
 	/**
 	 * Returns the file name.
-	 * @return string
 	 */
-	public function getName()
+	public function getName(): string
 	{
 		return $this->name;
 	}
 
 
 	/**
 	 * Returns the sanitized file name.
-	 * @return string
 	 */
-	public function getSanitizedName()
+	public function getSanitizedName(): string
 	{
 		return trim(Nette\Utils\Strings::webalize($this->name, '.', FALSE), '.-');
 	}
 
 
 	/**
 	 * Returns the MIME content type of an uploaded file.
-	 * @return string|NULL
 	 */
-	public function getContentType()
+	public function getContentType(): ?string
 	{
 		if ($this->isOk() && $this->type === NULL) {
 			$this->type = finfo_file(finfo_open(FILEINFO_MIME_TYPE), $this->tmpName);
@@ -94,69 +91,60 @@ public function getContentType()
 
 	/**
 	 * Returns the size of an uploaded file.
-	 * @return int
 	 */
-	public function getSize()
+	public function getSize(): int
 	{
 		return $this->size;
 	}
 
 
 	/**
 	 * Returns the path to an uploaded file.
-	 * @return string
 	 */
-	public function getTemporaryFile()
+	public function getTemporaryFile(): string
 	{
 		return $this->tmpName;
 	}
 
 
 	/**
 	 * Returns the path to an uploaded file.
-	 * @return string
 	 */
-	public function __toString()
+	public function __toString(): string
 	{
 		return (string) $this->tmpName;
 	}
 
 
 	/**
 	 * Returns the error code. {@link http://php.net/manual/en/features.file-upload.errors.php}
-	 * @return int
 	 */
-	public function getError()
+	public function getError(): int
 	{
 		return $this->error;
 	}
 
 
 	/**
 	 * Is there any error?
-	 * @return bool
 	 */
-	public function isOk()
+	public function isOk(): bool
 	{
 		return $this->error === UPLOAD_ERR_OK;
 	}
 
 
-	/**
-	 * @return bool
-	 */
-	public function hasFile()
+	public function hasFile(): bool
 	{
 		return $this->error !== UPLOAD_ERR_NO_FILE;
 	}
 
 
 	/**
 	 * Move uploaded file to new location.
-	 * @param  string
 	 * @return static
 	 */
-	public function move($dest)
+	public function move(string $dest)
 	{
 		$dir = dirname($dest);
 		@mkdir($dir, 0777, TRUE); // @ - dir may already exist
@@ -179,40 +167,36 @@ function ($message) use ($dest) {
 
 	/**
 	 * Is uploaded file GIF, PNG or JPEG?
-	 * @return bool
 	 */
-	public function isImage()
+	public function isImage(): bool
 	{
 		return in_array($this->getContentType(), ['image/gif', 'image/png', 'image/jpeg'], TRUE);
 	}
 
 
 	/**
 	 * Returns the image.
-	 * @return Nette\Utils\Image
 	 * @throws Nette\Utils\ImageException
 	 */
-	public function toImage()
+	public function toImage(): Nette\Utils\Image
 	{
 		return Nette\Utils\Image::fromFile($this->tmpName);
 	}
 
 
 	/**
 	 * Returns the dimensions of an uploaded image as array.
-	 * @return array|NULL
 	 */
-	public function getImageSize()
+	public function getImageSize(): ?array
 	{
 		return $this->isOk() ? @getimagesize($this->tmpName) : NULL; // @ - files smaller than 12 bytes causes read error
 	}
 
 
 	/**
 	 * Get file contents.
-	 * @return string|NULL
 	 */
-	public function getContents()
+	public function getContents(): ?string
 	{
 		// future implementation can try to work around safe_mode and open_basedir limitations
 		return $this->isOk() ? file_get_contents($this->tmpName) : NULL;

src/Http/Helpers.php

@@ -23,9 +23,8 @@ class Helpers
 	/**
 	 * Returns HTTP valid date format.
 	 * @param  string|int|\DateTimeInterface
-	 * @return string
 	 */
-	public static function formatDate($time)
+	public static function formatDate($time): string
 	{
 		$time = DateTime::from($time);
 		$time->setTimezone(new \DateTimeZone('GMT'));
@@ -35,9 +34,8 @@ public static function formatDate($time)
 
 	/**
 	 * Is IP address in CIDR block?
-	 * @return bool
 	 */
-	public static function ipMatch($ip, $mask)
+	public static function ipMatch($ip, $mask): bool
 	{
 		[$mask, $size] = explode('/', $mask . '/');
 		$tmp = function ($n) { return sprintf('%032b', $n); };
@@ -53,10 +51,9 @@ public static function ipMatch($ip, $mask)
 
 	/**
 	 * Removes duplicate cookies from response.
-	 * @return void
 	 * @internal
 	 */
-	public static function removeDuplicateCookies()
+	public static function removeDuplicateCookies(): void
 	{
 		if (headers_sent($file, $line) || ini_get('suhosin.cookie.encrypt')) {
 			return;

src/Http/IRequest.php

@@ -27,111 +27,93 @@ interface IRequest
 
 	/**
 	 * Returns URL object.
-	 * @return UrlScript
 	 */
-	function getUrl();
+	function getUrl(): UrlScript;
 
 	/********************* query, post, files & cookies ****************d*g**/
 
 	/**
 	 * Returns variable provided to the script via URL query ($_GET).
 	 * If no key is passed, returns the entire array.
-	 * @param  string key
 	 * @return mixed
 	 */
-	function getQuery($key = NULL);
+	function getQuery(string $key = NULL);
 
 	/**
 	 * Returns variable provided to the script via POST method ($_POST).
 	 * If no key is passed, returns the entire array.
-	 * @param  string key
 	 * @return mixed
 	 */
-	function getPost($key = NULL);
+	function getPost(string $key = NULL);
 
 	/**
 	 * Returns uploaded file.
-	 * @param  string key
 	 * @return FileUpload|array|NULL
 	 */
-	function getFile($key);
+	function getFile(string $key);
 
 	/**
 	 * Returns uploaded files.
-	 * @return array
 	 */
-	function getFiles();
+	function getFiles(): array;
 
 	/**
 	 * Returns variable provided to the script via HTTP cookies.
-	 * @param  string key
 	 * @return mixed
 	 */
-	function getCookie($key);
+	function getCookie(string $key);
 
 	/**
 	 * Returns variables provided to the script via HTTP cookies.
-	 * @return array
 	 */
-	function getCookies();
+	function getCookies(): array;
 
 	/********************* method & headers ****************d*g**/
 
 	/**
 	 * Returns HTTP request method (GET, POST, HEAD, PUT, ...). The method is case-sensitive.
-	 * @return string
 	 */
-	function getMethod();
+	function getMethod(): string;
 
 	/**
 	 * Checks HTTP request method.
-	 * @param  string
-	 * @return bool
 	 */
-	function isMethod($method);
+	function isMethod(string $method): bool;
 
 	/**
 	 * Return the value of the HTTP header. Pass the header name as the
 	 * plain, HTTP-specified header name (e.g. 'Accept-Encoding').
-	 * @param  string
-	 * @return string|NULL
 	 */
-	function getHeader($header);
+	function getHeader(string $header): ?string;
 
 	/**
 	 * Returns all HTTP headers.
-	 * @return array
 	 */
-	function getHeaders();
+	function getHeaders(): array;
 
 	/**
 	 * Is the request is sent via secure channel (https).
-	 * @return bool
 	 */
-	function isSecured();
+	function isSecured(): bool;
 
 	/**
 	 * Is AJAX request?
-	 * @return bool
 	 */
-	function isAjax();
+	function isAjax(): bool;
 
 	/**
 	 * Returns the IP address of the remote client.
-	 * @return string|NULL
 	 */
-	function getRemoteAddress();
+	function getRemoteAddress(): ?string;
 
 	/**
 	 * Returns the host of the remote client.
-	 * @return string|NULL
 	 */
-	function getRemoteHost();
+	function getRemoteHost(): ?string;
 
 	/**
 	 * Returns raw content of HTTP request body.
-	 * @return string|NULL
 	 */
-	function getRawBody();
+	function getRawBody(): ?string;
 
 }