- update phpstan 's run level to 3

lesstif · lesstif · commit 8f0d1ce81057 · 2020-05-31T22:55:11.000+09:00
- fixed #332 phpstan warning
diff --git a/.travis.yml b/.travis.yml
@@ -24,3 +24,11 @@ jobs:
       env: TYPE=phpstan
       script:
         - vendor/bin/phpstan analyse
+    - php: 7.2
+      env: TYPE=phpstan
+      script:
+        - vendor/bin/phpstan analyse
+    - php: 7.3
+      env: TYPE=phpstan
+      script:
+        - vendor/bin/phpstan analyse
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -1,11 +1,31 @@
 parameters:
-	ignoreErrors:
-		-
-			message: "#^Static method Dotenv\\\\Dotenv\\:\\:create\\(\\) invoked with 1 parameter, 2\\-4 required\\.$#"
-			count: 1
-			path: src/Configuration/DotEnvConfiguration.php
+    ignoreErrors:
+        -
+            message: "#^Static method Dotenv\\\\Dotenv\\:\\:create\\(\\) invoked with 1 parameter, 2\\-4 required\\.$#"
+            count: 1
+            path: src/Configuration/DotEnvConfiguration.php
 
-		-
-			message: "#^Class Dotenv\\\\Dotenv constructor invoked with 1 parameter, 3 required\\.$#"
-			count: 1
-			path: src/Configuration/DotEnvConfiguration.php
+        -
+            message: "#^Class Dotenv\\\\Dotenv constructor invoked with 1 parameter, 3 required\\.$#"
+            count: 1
+            path: src/Configuration/DotEnvConfiguration.php
+        -
+            message: "#^Call to an undefined method Monolog\\\\Logger::addInfo\\(\\)\\.$#"
+            count: 2
+            path: src/Issue/IssueService.php
+        -
+            message: "#^Property JiraRestApi\\\\Issue\\\\IssueField::\\$duedate \\(DateTimeInterface|null\\) does not accept string\\.$#"
+            count: 1
+            path: src/Issue/IssueField.php
+        -
+            message: "#^Cannot access offset 'key' on JiraRestApi\\\\Issue\\\\Issue\\.$#"
+            count: 2
+            path: src/IssueLink/IssueLink.php
+        -
+            message: "#^Property JiraRestApi\\\\Issue\\\\Version::\\$releaseDate \\(DateTimeInterface|null\\) does not accept string\\.$#"
+            count: 1
+            path: src/Version/VersionService.php
+        -
+            message: "#^Property JiraRestApi\\\\JiraClient::\\$log \\(Monolog\\\\Logger\\) does not accept Psr\\\\Log\\\\LoggerInterface\\.$#"
+            count: 1
+            path: src/JiraClient.php
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -2,7 +2,7 @@ includes:
     - phpstan-baseline.neon
 
 parameters:
-	level: 1
+	level: 3
 	paths:
 		- src
 	excludes_analyse:
diff --git a/src/Attachment/AttachmentService.php b/src/Attachment/AttachmentService.php
@@ -14,7 +14,7 @@ class AttachmentService extends \JiraRestApi\JiraClient
     /**
      * Returns the meta-data for an attachment, including the URI of the actual attached file.
      *
-     * @param $id string|int attachment Id
+     * @param string|int $id attachment Id
      * @outDir string downloads the content and store into outDir
      * @overwrite boolean determines whether to overwrite the file if it already exists.
      * @mode int outDir creation mode.
@@ -60,11 +60,11 @@ public function get($id, $outDir = null, $overwrite = false, $mode = 0777, $recu
     /**
      * Remove an attachment from an issue.
      *
-     * @param $id string|int attachment id
+     * @param string|int $id attachment id
      *
      * @throws \JiraRestApi\JiraException
      *
-     * @return bool
+     * @return string
      */
     public function remove($id)
     {
diff --git a/src/Auth/AuthService.php b/src/Auth/AuthService.php
@@ -12,12 +12,12 @@ class AuthService extends \JiraRestApi\JiraClient
     private $uri = 'session';
 
     /**
-     * @var string
+     * @var string|null
      */
     private $_sessionCookieName;
 
     /**
-     * @var string
+     * @var string|null
      */
     private $_sessionCookieValue;
 
diff --git a/src/Component/Component.php b/src/Component/Component.php
@@ -23,6 +23,9 @@ class Component implements \JsonSerializable
      */
     public $self;
 
+    /** @var string */
+    public $id;
+
     /**
      * @var string
      */
diff --git a/src/Component/ComponentService.php b/src/Component/ComponentService.php
@@ -35,7 +35,7 @@ public function create($component)
     /**
      * get component.
      *
-     * @param $id component id
+     * @param string|int $id component id
      *
      * @return Component
      */
@@ -79,7 +79,7 @@ public function update(Component $component)
      *
      * @throws JiraException
      *
-     * @return bool
+     * @return string
      */
     public function delete(Component $component, $moveIssuesTo = false)
     {
diff --git a/src/Configuration/AbstractConfiguration.php b/src/Configuration/AbstractConfiguration.php
@@ -133,6 +133,18 @@ abstract class AbstractConfiguration implements ConfigurationInterface
      */
     protected $useV3RestApi;
 
+    /** @var string */
+    protected $curlOptSslCert;
+
+    /** @var string */
+    protected $curlOptSslCertPassword;
+
+    /** @var string */
+    protected $curlOptSslKey;
+
+    /** @var string */
+    protected $curlOptSslKeyPassword;
+
     /**
      * @return string
      */
@@ -256,7 +268,7 @@ public function getOAuthAccessToken()
     }
 
     /**
-     * @return string
+     * @return bool
      */
     public function isCookieAuthorizationEnabled()
     {
diff --git a/src/Configuration/DotEnvConfiguration.php b/src/Configuration/DotEnvConfiguration.php
@@ -125,11 +125,11 @@ public function endsWith($haystack, $needles)
     /**
      * load dotenv.
      *
-     * @param $path
+     * @param string $path
      *
      * @throws JiraException
      */
-    private function loadDotEnv($path)
+    private function loadDotEnv(string $path)
     {
         $requireParam = [
             'JIRA_HOST', 'JIRA_USER', 'JIRA_PASS',
diff --git a/src/Field/Field.php b/src/Field/Field.php
@@ -47,11 +47,11 @@ public function setDescription($description)
      *
      * @see https://confluence.atlassian.com/jira064/changing-custom-field-types-720415917.html
      *
-     * @param $type
+     * @param string $type
      *
      * @return $this
      */
-    public function setType($type)
+    public function setType(string $type)
     {
         $this->type = $type;
 
@@ -61,11 +61,11 @@ public function setType($type)
     /**
      * atlassian supplied poor documentation.
      *
-     * @param $searcherKey
+     * @param string $searcherKey
      *
      * @return $this
      */
-    public function setSearcherKey($searcherKey)
+    public function setSearcherKey(string $searcherKey)
     {
         $this->searcherKey = $searcherKey;
 
@@ -96,6 +96,7 @@ public function setSearcherKey($searcherKey)
     /* @var boolean */
     public $searchable;
 
+    /** @var string */
     public $searcherKey;
 
     /**
diff --git a/src/Group/GroupService.php b/src/Group/GroupService.php
@@ -62,14 +62,14 @@ public function getMembers($paramArray)
     /**
      * Creates a group by given group parameter.
      *
-     * @param $group \JiraRestApi\Group\Group
+     * @param \JiraRestApi\Group\Group $group
      *
      * @throws \JiraRestApi\JiraException
      * @throws \JsonMapper_Exception
      *
      * @return Group|object
      */
-    public function createGroup($group)
+    public function createGroup(Group $group)
     {
         $data = json_encode($group);
 
@@ -96,7 +96,7 @@ public function createGroup($group)
      *
      * @return Group|object Returns the current state of the group.
      */
-    public function addUserToGroup($groupName, $userName)
+    public function addUserToGroup(string $groupName, string $userName)
     {
         $data = json_encode(['name' => $userName]);
 
@@ -115,14 +115,14 @@ public function addUserToGroup($groupName, $userName)
     /**
      * Removes given user from a group.
      *
-     * @param $groupName
-     * @param $userName
+     * @param string $groupName
+     * @param string $userName
      *
      * @throws \JiraRestApi\JiraException
      *
-     * @return null Returns no content
+     * @return string|null Returns no content
      */
-    public function removeUserFromGroup($groupName, $userName)
+    public function removeUserFromGroup(string $groupName, string $userName)
     {
         $param = http_build_query(['groupname' => $groupName, 'username' => $userName]);
 
diff --git a/src/Issue/IssueField.php b/src/Issue/IssueField.php
@@ -329,20 +329,20 @@ public function setDescription($description)
     /**
      * add a Affects version.
      *
-     * @param mixed string or array $name
+     * @param string|array $version mixed string or array
      *
      * @return $this
      */
-    public function addVersion($name)
+    public function addVersion($version)
     {
         if (is_null($this->versions)) {
             $this->versions = [];
         }
 
-        if (is_string($name)) {
-            array_push($this->versions, new Version($name));
-        } elseif (is_array($name)) {
-            foreach ($name as $v) {
+        if (is_string($version)) {
+            array_push($this->versions, new Version($version));
+        } elseif (is_array($version)) {
+            foreach ($version as $v) {
                 array_push($this->versions, new Version($v));
             }
         }
@@ -371,20 +371,20 @@ public function addLabel($label)
     /**
      * set issue type.
      *
-     * @param mixed IssueType or string $name
+     * @param IssueType $issueType mixed IssueType or string
      *
      * @return $this
      */
-    public function setIssueType($name)
+    public function setIssueType($issueType)
     {
-        if (is_string($name)) {
+        if (is_string($issueType)) {
             if (is_null($this->issuetype)) {
                 $this->issuetype = new IssueType();
             }
 
-            $this->issuetype->name = $name;
+            $this->issuetype->name = $issueType;
         } else {
-            $this->issuetype = $name;
+            $this->issuetype = $issueType;
         }
 
         return $this;
@@ -419,7 +419,7 @@ public function setParent(Issue $parent)
     /**
      * add issue component.
      *
-     * @param mixed string or array $component
+     * @param string|array $component mixed string or array
      *
      * @return $this
      */
diff --git a/src/Issue/IssueService.php b/src/Issue/IssueService.php
@@ -10,7 +10,7 @@ class IssueService extends \JiraRestApi\JiraClient
     private $uri = '/issue';
 
     /**
-     * @param $json
+     * @param object $json
      *
      * @throws \JsonMapper_Exception
      *
@@ -823,13 +823,13 @@ public function getCustomFields($priorityId)
     /**
      * get watchers.
      *
-     * @param $issueIdOrKey
-     *
-     * @throws JiraException
+     * @param string $issueIdOrKey
      *
      * @return Reporter[]
+     * @throws JiraException
+     * @throws \JsonMapper_Exception
      */
-    public function getWatchers($issueIdOrKey)
+    public function getWatchers(string $issueIdOrKey)
     {
         $this->log->info("getWatchers=\n");
 
@@ -1147,7 +1147,7 @@ public function getIssueSecuritySchemes($securityId)
      *
      * @throws JiraException
      *
-     * @return Issue|object class
+     * @return bool
      */
     public function updateLabels($issueIdOrKey, $addLablesParam, $removeLabelsParam, $notifyUsers = true)
     {
@@ -1185,7 +1185,7 @@ public function updateLabels($issueIdOrKey, $addLablesParam, $removeLabelsParam,
      *
      * @throws JiraException
      *
-     * @return Issue|object class
+     * @return bool
      */
     public function updateFixVersions($issueIdOrKey, $addFixVersionsParam, $removeFixVersionsParam, $notifyUsers = true)
     {
diff --git a/src/Issue/JqlFunction.php b/src/Issue/JqlFunction.php
@@ -229,11 +229,11 @@ public static function lastLogin()
      * @see https://confluence.atlassian.com/jiracoreserver073/advanced-searching-functions-reference-861257222.html#Advancedsearching-functionsreference-latestReleasedVersionlatestReleasedVersion()
      *      jql function reference
      *
-     * @param $project
+     * @param string $project
      *
      * @return JqlFunction
      */
-    public static function latestReleasedVersion($project)
+    public static function latestReleasedVersion(string $project)
     {
         return new self("latestReleasedVersion($project)");
     }
diff --git a/src/Issue/Notify.php b/src/Issue/Notify.php
@@ -10,7 +10,7 @@ class Notify implements \JsonSerializable
     /** @var string */
     public $textBody;
 
-    /** @var */
+    /** @var string */
     public $htmlBody;
 
     /** @var array|null */
diff --git a/src/Issue/RemoteIssueLink.php b/src/Issue/RemoteIssueLink.php
@@ -27,10 +27,14 @@ public function jsonSerialize()
         return array_filter(get_object_vars($this));
     }
 
-    public function setUrl($url)
+    /**
+     * @param string $url
+     * @return $this
+     */
+    public function setUrl(string $url)
     {
         if (is_null($this->object)) {
-            $this->object = new self();
+            $this->object = new RemoteIssueLinkObject();
         }
 
         $this->object->url = $url;
diff --git a/src/Issue/Reporter.php b/src/Issue/Reporter.php
diff --git a/src/JiraClient.php b/src/JiraClient.php
diff --git a/src/Priority/PriorityService.php b/src/Priority/PriorityService.php
diff --git a/src/Project/ProjectService.php b/src/Project/ProjectService.php
diff --git a/src/Sprint/SprintService.php b/src/Sprint/SprintService.php
diff --git a/src/User/UserService.php b/src/User/UserService.php
diff --git a/src/Version/VersionService.php b/src/Version/VersionService.php
diff --git a/tests/groupTest.php b/tests/groupTest.php

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ class AttachmentService extends \JiraRestApi\JiraClient`
`14`	`14`	`/**`
`15`	`15`	`* Returns the meta-data for an attachment, including the URI of the actual attached file.`
`16`	`16`	`*`
`17`		`- * @param $id string\|int attachment Id`
	`17`	`+ * @param string\|int $id attachment Id`
`18`	`18`	`* @outDir string downloads the content and store into outDir`
`19`	`19`	`* @overwrite boolean determines whether to overwrite the file if it already exists.`
`20`	`20`	`* @mode int outDir creation mode.`
`@@ -60,11 +60,11 @@ public function get($id, $outDir = null, $overwrite = false, $mode = 0777, $recu`
`60`	`60`	`/**`
`61`	`61`	`* Remove an attachment from an issue.`
`62`	`62`	`*`
`63`		`- * @param $id string\|int attachment id`
	`63`	`+ * @param string\|int $id attachment id`
`64`	`64`	`*`
`65`	`65`	`* @throws \JiraRestApi\JiraException`
`66`	`66`	`*`
`67`		`- * @return bool`
	`67`	`+ * @return string`
`68`	`68`	`*/`
`69`	`69`	`public function remove($id)`
`70`	`70`	`{`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ public function create($component)`
`35`	`35`	`/**`
`36`	`36`	`* get component.`
`37`	`37`	`*`
`38`		`- * @param $id component id`
	`38`	`+ * @param string\|int $id component id`
`39`	`39`	`*`
`40`	`40`	`* @return Component`
`41`	`41`	`*/`
`@@ -79,7 +79,7 @@ public function update(Component $component)`
`79`	`79`	`*`
`80`	`80`	`* @throws JiraException`
`81`	`81`	`*`
`82`		`- * @return bool`
	`82`	`+ * @return string`
`83`	`83`	`*/`
`84`	`84`	`public function delete(Component $component, $moveIssuesTo = false)`
`85`	`85`	`{`
Original file line number	Diff line number	Diff line change
`@@ -125,11 +125,11 @@ public function endsWith($haystack, $needles)`
`125`	`125`	`/**`
`126`	`126`	`* load dotenv.`
`127`	`127`	`*`
`128`		`- * @param $path`
	`128`	`+ * @param string $path`
`129`	`129`	`*`
`130`	`130`	`* @throws JiraException`
`131`	`131`	`*/`
`132`		`- private function loadDotEnv($path)`
	`132`	`+ private function loadDotEnv(string $path)`
`133`	`133`	`{`
`134`	`134`	`$requireParam = [`
`135`	`135`	`'JIRA_HOST', 'JIRA_USER', 'JIRA_PASS',`
Original file line number	Diff line number	Diff line change
`@@ -47,11 +47,11 @@ public function setDescription($description)`
`47`	`47`	`*`
`48`	`48`	`* @see https://confluence.atlassian.com/jira064/changing-custom-field-types-720415917.html`
`49`	`49`	`*`
`50`		`- * @param $type`
	`50`	`+ * @param string $type`
`51`	`51`	`*`
`52`	`52`	`* @return $this`
`53`	`53`	`*/`
`54`		`- public function setType($type)`
	`54`	`+ public function setType(string $type)`
`55`	`55`	`{`
`56`	`56`	`$this->type = $type;`
`57`	`57`
`@@ -61,11 +61,11 @@ public function setType($type)`
`61`	`61`	`/**`
`62`	`62`	`* atlassian supplied poor documentation.`
`63`	`63`	`*`
`64`		`- * @param $searcherKey`
	`64`	`+ * @param string $searcherKey`
`65`	`65`	`*`
`66`	`66`	`* @return $this`
`67`	`67`	`*/`
`68`		`- public function setSearcherKey($searcherKey)`
	`68`	`+ public function setSearcherKey(string $searcherKey)`
`69`	`69`	`{`
`70`	`70`	`$this->searcherKey = $searcherKey;`
`71`	`71`
`@@ -96,6 +96,7 @@ public function setSearcherKey($searcherKey)`
`96`	`96`	`/* @var boolean */`
`97`	`97`	`public $searchable;`
`98`	`98`
	`99`	`+ /** @var string */`
`99`	`100`	`public $searcherKey;`
`100`	`101`
`101`	`102`	`/**`