Typed properties and bump to PHP 7.4 (#261) @Art4

* bump min PHP version tp 7.4 so we can use typed properties

* Use typed properties in Psr18Client

* Use typed properties in Client

* Fix line ending test on windows machine

* Improve AbstractApi

* Update CHANGELOG.md

* Update README.md

* Fix date in CHANGELOG.md

Author: Art4

.travis.yml

@@ -1,7 +1,6 @@
 language: php
 
 php:
-   - 7.3
    - 7.4
    - 8.0
 

CHANGELOG.md

@@ -11,6 +11,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - This `CHANGELOG.md` file
 
+### Changed
+
+- Better type checking thanks to typed properties
+- Move `example.php` into new `docs` folder
+
+### Removed
+
+- Drop support for PHP 7.3
+
+### Fixed
+
+- `Redmine\Client::getCheckSslHost()` always returns as boolean
+
 ## [v1.7.0](https://github.com/kbsali/php-redmine-api/compare/v1.6.0...v1.7.0) - 2021-03-22
 
 ### Added
@@ -49,7 +62,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Removed support for PHP 5.6, 7.0, 7.1 and 7.2
 
-## [v1.5.22](https://github.com/kbsali/php-redmine-api/compare/v1.5.21...v1.5.22) - 2021-01-02
+## [v1.5.22](https://github.com/kbsali/php-redmine-api/compare/v1.5.21...v1.5.22) - 2020-08-07
 
 ### Added
 

README.md

@@ -45,7 +45,7 @@ A possible solution to this would be to create an extra APIs implementing the mi
 
 ## Requirements
 
-* PHP ^7.3 || ^8.0
+* PHP ^7.4 || ^8.0
 * The PHP [cURL](http://php.net/manual/en/book.curl.php) extension
 * The PHP [SimpleXML](http://php.net/manual/en/book.simplexml.php) extension
 * The PHP [JSON](http://php.net/manual/en/book.json.php) extension

composer.json

@@ -16,7 +16,7 @@
         }
     ],
     "require": {
-        "php": "^7.3 || ^8.0",
+        "php": "^7.4 || ^8.0",
         "ext-curl": "*",
         "ext-simplexml": "*",
         "ext-json": "*",

src/Redmine/Api/AbstractApi.php

@@ -49,13 +49,14 @@ protected function get($path, $decodeIfJson = true)
         $this->client->requestGet($path);
 
         $body = $this->client->getLastResponseBody();
+        $contentType = $this->client->getLastResponseContentType();
 
         // if response is XML, return a SimpleXMLElement object
-        if ($body !== '' && 0 === strpos($this->client->getLastResponseContentType(), 'application/xml')) {
+        if ($body !== '' && 0 === strpos($contentType, 'application/xml')) {
             return new SimpleXMLElement($body);
         }
 
-        if ($decodeIfJson === true && $body !== '' && 0 === strpos($this->client->getLastResponseContentType(), 'application/json')) {
+        if ($decodeIfJson === true && $body !== '' && 0 === strpos($contentType, 'application/json')) {
             try {
                 return json_decode($body, true, 512, \JSON_THROW_ON_ERROR);
             } catch (JsonException $e) {

src/Redmine/Client.php

@@ -42,53 +42,23 @@ class Client implements ClientInterface
      */
     const SSL_VERIFYHOST = 2;
 
-    /**
-     * @var array
-     */
-    private static $defaultPorts = [
+    private static array $defaultPorts = [
         'http' => 80,
         'https' => 443,
     ];
 
-    /**
-     * @var int
-     */
-    private $port;
-
-    /**
-     * @var string
-     */
-    private $url;
-
-    /**
-     * @var string
-     */
-    private $apikeyOrUsername;
-
-    /**
-     * @var string|null
-     */
-    private $pass;
-
-    /**
-     * @var bool
-     */
-    private $checkSslCertificate = false;
-
-    /**
-     * @var bool
-     */
-    private $checkSslHost = false;
-
-    /**
-     * @var int
-     */
-    private $sslVersion = 0;
-
-    /**
-     * @var bool Flag to determine authentication method
-     */
-    private $useHttpAuth = true;
+    private ?int $port = null;
+    private string $url;
+    private string $apikeyOrUsername;
+    private ?string $pass;
+    private bool $checkSslCertificate = false;
+    private bool $checkSslHost = false;
+    private int $sslVersion = 0;
+    private bool $useHttpAuth = true;
+    private int $responseCode = 0;
+    private string $responseContentType = '';
+    private string $responseBody = '';
+    private array $curlOptions = [];
 
     /**
      * @var string|null username for impersonating API calls
@@ -100,30 +70,10 @@ class Client implements ClientInterface
      */
     protected $customHost = null;
 
-    /**
-     * @var int|null Redmine response code, null if request is not still completed
-     */
-    private $responseCode = null;
-
-    /**
-     * @var string Redmine response content type
-     */
-    private $responseContentType = '';
-
-    /**
-     * @var string Redmine response body
-     */
-    private $responseBody = '';
-
-    /**
-     * @var array cURL options
-     */
-    private $curlOptions = [];
-
     /**
      * Error strings if json is invalid.
      */
-    private static $jsonErrors = [
+    private static array $jsonErrors = [
         JSON_ERROR_NONE => 'No error has occurred',
         JSON_ERROR_DEPTH => 'The maximum stack depth has been exceeded',
         JSON_ERROR_CTRL_CHAR => 'Control character error, possibly incorrectly encoded',
@@ -142,7 +92,7 @@ public function __construct($url, $apikeyOrUsername, $pass = null)
     {
         $this->url = $url;
         $this->getPort();
-        $this->apikeyOrUsername = $apikeyOrUsername;
+        $this->apikeyOrUsername = strval($apikeyOrUsername);
         $this->pass = $pass;
     }
 
@@ -364,12 +314,7 @@ public function getCheckSslCertificate()
      */
     public function setCheckSslHost($check = false)
     {
-        // Make sure verify value is set to "2" for boolean argument
-        // @see http://curl.haxx.se/libcurl/c/CURLOPT_SSL_VERIFYHOST.html
-        if (true === $check) {
-            $check = self::SSL_VERIFYHOST;
-        }
-        $this->checkSslHost = $check;
+        $this->checkSslHost = (bool) $check;
 
         return $this;
     }
@@ -599,7 +544,7 @@ public function getCurlOptions()
      */
     public function prepareRequest($path, $method = 'GET', $data = '')
     {
-        $this->responseCode = null;
+        $this->responseCode = 0;
         $this->responseContentType = '';
         $this->responseBody = '';
         $curl = curl_init();
@@ -624,7 +569,9 @@ public function prepareRequest($path, $method = 'GET', $data = '')
         $this->setCurlOption(CURLOPT_PORT, $this->getPort());
         if (80 !== $this->getPort()) {
             $this->setCurlOption(CURLOPT_SSL_VERIFYPEER, (int) $this->checkSslCertificate);
-            $this->setCurlOption(CURLOPT_SSL_VERIFYHOST, (int) $this->checkSslHost);
+            // Make sure verify value is set to "2" for boolean argument
+            // @see http://curl.haxx.se/libcurl/c/CURLOPT_SSL_VERIFYHOST.html
+            $this->setCurlOption(CURLOPT_SSL_VERIFYHOST, ($this->checkSslHost === true) ? self::SSL_VERIFYHOST : 0);
             $this->setCurlOption(CURLOPT_SSLVERSION, $this->sslVersion);
         }
 

src/Redmine/Client/Client.php

@@ -11,7 +11,7 @@
 interface Client
 {
     /**
-     * @throws InvalidArgumentException
+     * @throws InvalidArgumentException if $name is not a valid api name
      */
     public function getApi(string $name): Api;
 

src/Redmine/Client/ClientApiTrait.php

@@ -12,12 +12,9 @@
  */
 trait ClientApiTrait
 {
-    /**
-     * @var array Api[]
-     */
-    private $apiInstances = [];
+    private array $apiInstances = [];
 
-    private $apiClassnames = [
+    private array $apiClassnames = [
         'attachment' => 'Attachment',
         'group' => 'Group',
         'custom_fields' => 'CustomField',

src/Redmine/Client/Psr18Client.php

@@ -19,64 +19,33 @@ final class Psr18Client implements Client
 {
     use ClientApiTrait;
 
-    /**
-     * @var string
-     */
-    private $url;
-
-    /**
-     * @var string
-     */
-    private $apikeyOrUsername;
-
-    /**
-     * @var string|null
-     */
-    private $pass;
-
-    /**
-     * @var string|null
-     */
-    private $impersonateUser;
-
-    /**
-     * @var ClientInterface
-     */
-    private $httpClient;
-
-    /**
-     * @var ServerRequestFactoryInterface
-     */
-    private $requestFactory;
-
-    /**
-     * @var StreamFactoryInterface
-     */
-    private $streamFactory;
-
-    /**
-     * @var ResponseInterface|null
-     */
-    private $lastResponse;
+    private string $url;
+    private string $apikeyOrUsername;
+    private ?string $password;
+    private ?string $impersonateUser = null;
+    private ClientInterface $httpClient;
+    private ServerRequestFactoryInterface $requestFactory;
+    private StreamFactoryInterface $streamFactory;
+    private ?ResponseInterface $lastResponse = null;
 
     /**
      * $apikeyOrUsername should be your ApiKey, but it could also be your username.
-     * $pass needs to be set if a username is given (not recommended).
+     * $password needs to be set if a username is given (not recommended).
      */
     public function __construct(
         ClientInterface $httpClient,
         ServerRequestFactoryInterface $requestFactory,
         StreamFactoryInterface $streamFactory,
         string $url,
         string $apikeyOrUsername,
-        string $pass = null
+        string $password = null
     ) {
         $this->httpClient = $httpClient;
         $this->requestFactory = $requestFactory;
         $this->streamFactory = $streamFactory;
         $this->url = $url;
         $this->apikeyOrUsername = $apikeyOrUsername;
-        $this->pass = $pass;
+        $this->password = $password;
     }
 
     /**
@@ -195,10 +164,10 @@ private function createRequest(string $method, string $path, string $body = ''):
 
         // Set Authentication header
         // @see https://www.redmine.org/projects/redmine/wiki/Rest_api#Authentication
-        if ($this->pass !== null) {
+        if ($this->password !== null) {
             $request = $request->withHeader(
                 'Authorization',
-                'Basic ' . base64_encode($this->apikeyOrUsername . ':' . $this->pass)
+                'Basic ' . base64_encode($this->apikeyOrUsername . ':' . $this->password)
             );
         } else {
             $request = $request->withHeader('X-Redmine-API-Key', $this->apikeyOrUsername);

tests/Integration/Psr18ClientRequestGenerationTest.php

@@ -172,8 +172,8 @@ public function createdGetRequestsData()
                 'X-Redmine-API-Key: access_token'.\PHP_EOL.
                 'Content-Type: application/octet-stream'.\PHP_EOL.
                 \PHP_EOL.
-                'This is a test file.'.\PHP_EOL.
-                'It will be needed for testing file uploads.'.\PHP_EOL
+                'This is a test file.'."\n".
+                'It will be needed for testing file uploads.'."\n"
             ],
             [
                 // Test fileupload with file path to image