fixed #54 to fix the "Link Issue" and "Remote Issue link" functionality work.

Author: lesstif

README.md

@@ -1576,7 +1576,7 @@ try {
 
 ##### get remote issue link
 
-* [See Jira API reference](https://docs.atlassian.com/software/jira/docs/api/REST/latest/#api/2/issue-getRemoteIssueLinks)
+* [See Jira API reference](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-remote-links/#api-rest-api-3-issue-issueidorkey-remotelink-get)
 
 ```php
 <?php
@@ -1602,7 +1602,7 @@ try {
 
 ##### create remote issue link
 
-* [See Jira API reference](https://docs.atlassian.com/software/jira/docs/api/REST/latest/#api/2/issue-getRemoteIssueLinks)
+* [See Jira API reference](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-remote-links/#api-rest-api-3-issue-issueidorkey-remotelink-post)
 
 ```php
 <?php
@@ -1928,7 +1928,7 @@ try {
 ```
 #### Create Issue Link
 
-[See Jira API reference](https://docs.atlassian.com/software/jira/docs/api/REST/latest/#api/2/issueLink-linkIssues)
+[See Jira API reference](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-links/#api-rest-api-3-issuelink-post)
 
 The Link Issue Resource provides functionality to manage issue links.
 
@@ -1941,25 +1941,43 @@ use JiraCloud\IssueLink\IssueLinkService;
 use JiraCloud\JiraException;
 
 try {
+    $doc = (new Document())
+                ->heading(1)            // header level 1, can have child blocks (needs to be closed with `->end()`)
+                    ->text('h1')        // simple unstyled text, cannot have child blocks (no `->end()` needed)
+                ->end()                 // closes `heading` node
+                ->paragraph()           // paragraph, can have child blocks (needs to be closed with `->end()`)
+                    ->text('Issue Link ')    // simple unstyled text
+                    ->strong('By ') // text node embedding a `strong` mark
+                    ->text(' REST ')         // simple unstyled text
+                    ->em('API')
+                ->end()                 // closes `paragraph` node
+             ;
+
+    $comment = new AtlassianDocumentFormat($doc);
+
     $il = new IssueLink();
 
-    $il->setInwardIssue('TEST-258')
-        ->setOutwardIssue('TEST-249')
-        ->setLinkTypeName('Relates' )
-        ->setComment('Linked related issue via REST API.');
-            
+    $inwardKey = 'TEST-162';
+    $outwardKey = 'ST-3';
+    
+    $il->setInwardIssueByKey($inwardKey)
+        ->setOutwardIssueByKey($outwardKey)
+        ->setLinkTypeName('Duplicate' )
+        ->setCommentAsADF($comment)
+    ;
+
     $ils = new IssueLinkService();
 
     $ret = $ils->addIssueLink($il);
-
+    
 } catch (JiraCloud\JiraException $e) {
     print('Error Occurred! ' . $e->getMessage());
 }
 ```
 
 #### Get Issue LinkType
 
-[See Jira API reference](https://docs.atlassian.com/software/jira/docs/api/REST/latest/#api/2/issueLinkType-getIssueLinkTypes)
+[See Jira API reference](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-link-types/#api-group-issue-link-types)
 
 Rest resource to retrieve a list of issue link types.
 

src/Issue/RemoteIssueLink.php

@@ -4,61 +4,51 @@
 
 class RemoteIssueLink implements \JsonSerializable
 {
-    /** @var int */
-    public $id;
+    public int $id;
 
-    /** @var string */
-    public $self;
+    public string $self;
 
-    /** @var string */
-    public $globalId;
+    public string $globalId;
 
-    /** @var array|null */
-    public $application;
+    public ?array $application;
 
-    /** @var string|null */
-    public $relationship;
+    public ?string $relationship;
 
-    /** @var \JiraCloud\Issue\RemoteIssueLinkObject|null */
-    public $object;
+    public ?RemoteObject $object;
 
     #[\ReturnTypeWillChange]
     public function jsonSerialize()
     {
         return array_filter(get_object_vars($this));
     }
 
-    /**
-     * @param string $url
-     *
-     * @return $this
-     */
-    public function setUrl(string $url)
-    {
-        if (is_null($this->object)) {
-            $this->object = new self();
-        }
+    function __construct() {
+        $this->object = new RemoteObject();
+    }
 
+    public function setUrl(string $url): static
+    {
+        $this->globalId = $url;
         $this->object->url = $url;
 
         return $this;
     }
 
-    public function setTitle($title)
+    public function setTitle($title): static
     {
         $this->object->title = $title;
 
         return $this;
     }
 
-    public function setSummary($summary)
+    public function setSummary($summary): static
     {
         $this->object->summary = $summary;
 
         return $this;
     }
 
-    public function setRelationship($relationship)
+    public function setRelationship($relationship): static
     {
         $this->relationship = $relationship;
 

src/Issue/RemoteIssueLinkObject.php src/Issue/RemoteObject.phpsrc/Issue/RemoteIssueLinkObject.php renamed to src/Issue/RemoteObject.php

@@ -2,19 +2,15 @@
 
 namespace JiraCloud\Issue;
 
-class RemoteIssueLinkObject
+class RemoteObject
 {
-    /** @var string */
-    public $url;
+    public string $url;
 
-    /** @var string */
-    public $title;
+    public string $title;
 
-    /** @var string|null */
-    public $summary;
+    public ?string $summary;
 
-    /** @var array|null */
-    public $icon;
+    public ?array $icon;
 
     /**
      * @var array|null
@@ -30,5 +26,5 @@ class RemoteIssueLinkObject
      *  }
      * ```
      */
-    public $status;
+    public ?array $status;
 }

src/IssueLink/IssueLink.php

@@ -2,21 +2,23 @@
 
 namespace JiraCloud\IssueLink;
 
+use JiraCloud\ADF\AtlassianDocumentFormat;
 use JiraCloud\ClassSerialize;
-use JiraCloud\Issue\Comment;
-use JiraCloud\Issue\Issue;
 
 class IssueLink implements \JsonSerializable
 {
     use ClassSerialize;
 
+    public string $id;
+    public string $self;
+
     public array $type;
 
-    public Issue $inwardIssue;
+    public ?LinkedIssue $inwardIssue = null;
 
-    public Issue $outwardIssue;
+    public ?LinkedIssue $outwardIssue = null;
 
-    public Comment $comment;
+    public array $comment = [];
 
     #[\ReturnTypeWillChange]
     public function jsonSerialize(): array
@@ -39,41 +41,45 @@ public function setLinkTypeName($typeName)
     }
 
     /**
-     * @param string|int $issueKey inward issue key or id
+     * @param string $issueKey inward issue key or id
      *
      * @return $this
      */
-    public function setInwardIssue(string $issueKey): static
+    public function setInwardIssueByKey(string $issueKey): static
     {
-        $this->inwardIssue['key'] = $issueKey;
+        if ($this->inwardIssue === null) {
+            $this->inwardIssue = new LinkedIssue();
+        }
+        $this->inwardIssue->key= $issueKey;
 
         return $this;
     }
 
     /**
-     * @param string|int $issueKey out ward issue key or id
+     * @param string $issueKey out ward issue key or id
      *
      * @return $this
      */
-    public function setOutwardIssue(string $issueKey): static
+    public function setOutwardIssueByKey(string $issueKey): static
     {
-        $this->outwardIssue['key'] = $issueKey;
+        if ($this->outwardIssue === null) {
+            $this->outwardIssue = new LinkedIssue();
+        }
+
+        $this->outwardIssue->key = $issueKey;
 
         return $this;
     }
 
     /**
-     * @param string|Comment $comment string or \JiraCloud\Issue\Comment instance
+     * @param AtlassianDocumentFormat $comment string or \JiraCloud\Issue\Comment instance
      *
      * @return $this
      */
-    public function setComment(string|Comment $comment): static
+    public function setCommentAsADF(?AtlassianDocumentFormat $comment): static
     {
-        if (is_string($comment)) {
-            $this->comment = new Comment();
-            $this->comment->setBody($comment);
-        } elseif ($comment instanceof Comment) {
-            $this->comment = $comment;
+        if (!empty($comment)) {
+            $this->comment['body'] = $comment;
         }
 
         return $this;

src/IssueLink/IssueLinkService.php

@@ -2,6 +2,8 @@
 
 namespace JiraCloud\IssueLink;
 
+use ArrayObject;
+
 class IssueLinkService extends \JiraCloud\JiraClient
 {
     private $uri = '';
@@ -13,7 +15,7 @@ class IssueLinkService extends \JiraCloud\JiraClient
      *
      * @return bool
      */
-    public function addIssueLink($issueLink)
+    public function addIssueLink(IssueLink $issueLink): bool
     {
         $this->log->info("addIssueLink=\n");
 
@@ -24,15 +26,17 @@ public function addIssueLink($issueLink)
         $url = $this->uri.'/issueLink';
         $type = 'POST';
 
-        return $this->exec($url, $data, $type);
+        $ret = $this->exec($url, $data, $type);
+
+        return $ret;
     }
 
     /**
      * @throws \JiraCloud\JiraException
      *
      * @return IssueLinkType[]
      */
-    public function getIssueLinkTypes()
+    public function getIssueLinkTypes(): ArrayObject
     {
         $this->log->info("getIssueLinkTYpes=\n");
 
@@ -45,9 +49,41 @@ public function getIssueLinkTypes()
         $linkTypes = $this->json_mapper->mapArray(
             json_decode($data, false),
             new \ArrayObject(),
-            '\JiraCloud\IssueLink\IssueLinkType'
+            \JiraCloud\IssueLink\IssueLinkType::class
         );
 
         return $linkTypes;
     }
+
+    /**
+     * @param string $linkId
+     * @return IssueLink
+     * @throws \JiraCloud\JiraException
+     * @throws \JsonMapper_Exception
+     */
+    public function getIssueLink(string $linkId): IssueLink
+    {
+        $this->log->info("getIssueLink=\n");
+
+        $url = $this->uri.'/issueLink/'.$linkId;
+
+        $ret = $this->exec($url);
+
+        return $this->json_mapper->map(
+            json_decode($ret),
+            new IssueLink()
+        );
+    }
+
+    public function deleteIssueLink(string $linkId) : bool
+    {
+        $this->log->info("deleteIssueLink=\n");
+
+        $url = $this->uri.'/issueLink/'.$linkId;
+
+        $ret = $this->exec($url, '', 'DELETE');
+
+        return $ret;
+    }
+
 }

src/IssueLink/LinkedIssue.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace JiraCloud\IssueLink;
+
+class LinkedIssue implements \JsonSerializable
+{
+    public string $self;
+
+    public string $id;
+    public string $key;
+
+    public array $fields;
+
+    #[\ReturnTypeWillChange]
+    public function jsonSerialize()
+    {
+        return array_filter(get_object_vars($this));
+    }
+}