Merge pull request #6 from matasarei/citation-count

Citation Count API

Author: AntoninoBonanno

src/Scopus/Response/CitationCount.php

@@ -0,0 +1,74 @@
+<?php
+
+namespace Scopus\Response;
+
+class CitationCount
+{
+    const STATUS_FOUND = 'found';
+    const STATUS_NOT_FOUND = 'not_found';
+
+    /**
+     * @var array
+     */
+    protected $data;
+
+    /**
+     * @var CitationCountLinks
+     */
+    protected $links;
+
+    public function __construct(array $data)
+    {
+        $this->data = $data;
+    }
+
+    public function getStatus(): bool
+    {
+        return $this->data['@status'];
+    }
+
+    public function getIdentifier()
+    {
+        return $this->data['dc:identifier'];
+    }
+
+    public function getUrl()
+    {
+        return isset($this->data['prism:url']) ? $this->data['prism:url'] : null;
+    }
+
+    public function getDoi()
+    {
+        return isset($this->data['prism:doi']) ? $this->data['prism:doi'] : null;
+    }
+
+    public function getPii()
+    {
+        return isset($this->data['pii']) ? $this->data['pii'] : null;
+    }
+
+    public function getPumbedId()
+    {
+        return isset($this->data['pubmed_id']) ? $this->data['pubmed_id'] : null;
+    }
+
+    public function getEID()
+    {
+        return isset($this->data['eid']) ? $this->data['eid'] : null;
+    }
+
+    public function getArticleNumber()
+    {
+        return isset($this->data['article-number']) ? $this->data['article-number'] : null;
+    }
+
+    public function getCitationCount()
+    {
+        return isset($this->data['citation-count']) ? $this->data['citation-count'] : null;
+    }
+
+    public function getLinks()
+    {
+        return $this->links ?: $this->links = new CitationCountLinks($this->data['link']);
+    }
+}

src/Scopus/Response/CitationCountLinks.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Scopus\Response;
+
+class CitationCountLinks
+{
+    /**
+     * @var array
+     */
+    protected $links;
+
+    public function __construct(array $links)
+    {
+        $this->links = [];
+
+        foreach ($links as $link) {
+            $this->links[$link['@rel']] = [
+                'href' => $link['@href'],
+                'fa' => $link['@_fa'],
+            ];
+        }
+    }
+}

src/Scopus/ScopusApi.php

@@ -8,6 +8,7 @@
 use Scopus\Exception\XmlException;
 use Scopus\Response\Abstracts;
 use Scopus\Response\Author;
+use Scopus\Response\CitationCount;
 use Scopus\Response\SearchResults;
 use Scopus\Response\AbstractCitations;
 use Scopus\Util\XmlUtil;
@@ -20,6 +21,7 @@ class ScopusApi
     const AFFILIATION_URI = 'https://api.elsevier.com/content/affiliation/affiliation_id/';
     const SEARCH_AUTHOR_URI = 'https://api.elsevier.com/content/search/author';
     const CITATION_OVERVIEW_URI = 'https://api.elsevier.com/content/abstract/citations';
+    const CITATION_COUNT_URI = 'https://api.elsevier.com/content/abstract/citation-count';
     const TIMEOUT = 40.0;
 
     protected $apiKey;
@@ -68,7 +70,7 @@ private function query($query)
     /**
      * @param string $uri
      * @param array $options
-     * @return array|Abstracts|Author|SearchResults
+     * @return array|Abstracts|Author|SearchResults|CitationCount[]
      * @throws Exception
      */
     private function retrieve($uri, array $options = [])
@@ -112,6 +114,12 @@ private function retrieve($uri, array $options = [])
                     }, $json['author-retrieval-response-list']['author-retrieval-response']);
                 case 'abstract-citations-response':
                     return new AbstractCitations($json['abstract-citations-response']);
+                case 'citation-count-response':
+                    $document = $json['citation-count-response']['document'];
+
+                    return array_map(function ($data) {
+                        return new CitationCount($data);
+                    }, isset($document['@status']) ? [$document] : $document);
                 default:
                     throw new Exception(sprintf('Unsupported response type: "%s" for "%s"', $type, $uri));
             }
@@ -190,6 +198,31 @@ public function overviewCitation($documentId, String $startYear = null, String $
         return $responses;
     }
 
+    /**
+     * @param string|string[] $scopusId
+     * @param array $options
+     *
+     * @return CitationCount[]
+     *
+     * @throws Exception
+     */
+    public function retrieveCitationCount($scopusId, array $options = [])
+    {
+        if (is_array($scopusId)) {
+            $scopusId = implode(',', $scopusId);
+        }
+
+        if (count(explode(',', $scopusId)) > 25) {
+            throw new Exception("The maximum number of 25 document id's exceeded!");
+        }
+
+        $options['scopus_id'] = $scopusId;
+
+        return $this->retrieve(self::CITATION_COUNT_URI, [
+            'query' => $options
+        ]);
+    }
+
     /**
      * @param $scopusId
      * @param array $options