Update to 5.0.0

Author: Dennis de Swart

README.md

@@ -7,37 +7,31 @@ PHP adapter for use with Stanford CoreNLP
 ## Features
 - Connect to Stanford University CoreNLP API online
 - Connect to Stanford CoreNLP 3.7.0 server
-- The package gets the following annotator data: tokenize,ssplit,parse,regexner,pos,depparse,lemma,ner,natlog,openie,mention
+- Annotators available: tokenize,ssplit,pos, parse, depparse, ner, regexner,lemma, mention, natlog, coref, openie, kbp
 - The package creates Part-Of-Speech Trees with depth, parent- and child ID
 
 
-## OpenIE (adapter version 4.0.0+, only on the Java version)
-
-OpenIE creates "subject-relation-object" tuples. This is similar (but not the same) as the "Subject-Verb-Object" concept of the English language.
-
-Notes:
-- OpenIE is only available on the Java offline version, not with the "online" mode. See the installation walkthrough below
-- OpenIE data is not always available. Sometimes the result array might show empty, this is not an error.
-
-```
-http://nlp.stanford.edu/software/openie.html
-https://en.wikipedia.org/wiki/Subject%E2%80%93verb%E2%80%93object
-```
-
 ## Requirements
-- PHP 5.3 or higher: it also works on PHP 7
+- PHP 5.5 or higher: it also works on PHP 7
 - Windows or Linux 64-bit, 8Gb memory or more recommended
-- Connection to Java server requires cURL.
-- Note: Connection to Stanford CoreNLP API online does NOT require cURL.
-
+- Either Guzzle HTTP Client (installed by default) or only cURL.
+- Composer for PHP
 ```
-  https://en.wikipedia.org/wiki/CURL
+    https://getcomposer.org/
 ```
 
 
+## Installation using ZIP files 
+
+- Install Stanford CoreNLP Server. See the installation walkthrough below. 
+- Download and unpack the files from this package.
+- Copy the files to your to your webserver directory. Usually "htdocs" or "var/www".
+- Run a Composer update
+
+
 ## Installation using Composer 
 
-You can install the adapter by putting the following line into your composer.json and running a composer update
+- Insert the following line into the "require" of your "composer.json" file. 
 
 ```
     {
@@ -47,20 +41,32 @@ You can install the adapter by putting the following line into your composer.jso
     }
 ```
 
+- Run a composer update
 
 
 # Using the Stanford CoreNLP online API service
 
 
-
 The adapter by default uses Stanford's online API service. This should work right after the composer update.
 Note that the online API is a public service. If you want to analyze large volumes of text or sensitive data,
 please install the Java server version.
 
 
+## OpenIE
 
-# Installation / Walkthrough for Java server version
+OpenIE creates "subject-relation-object" tuples. This is similar (but not the same) as the "Subject-Verb-Object" concept of the English language.
+
+Notes:
+- OpenIE is only available on the Java offline version, not with the "online" mode. See the installation walkthrough below
+- OpenIE data is not always available. Sometimes the result array might show empty, this is not an error.
 
+```
+http://nlp.stanford.edu/software/openie.html
+https://en.wikipedia.org/wiki/Subject-verb-object
+```
+
+
+# Installation / Walkthrough for Java server version
 
 
 

bootstrap.php

@@ -8,22 +8,36 @@
 
 /**
  * Use the online API?
+ * 
+ * TRUE : Connect to the Stanford CoreNLP server online 
+ * FALSE: Uses Java version
  */    
-    define('ONLINE_API', TRUE);  // Set to FALSE if you want to use the offline Java version
+    define('ONLINE_API', FALSE);  // since Adapter version 5.0.0 FALSE by default.
 
- /**
-  * Stanford API URL configuration
-  */
-    define('ONLINE_URL' , 'http://nlp.stanford.edu:8080/corenlp/process?outputFormat=json&Process=Submit&input='); // add url encoded text to the end
-        
+/**
+ * Stanford API URL configuration
+ */
+   define('ONLINE_URL' , 'http://nlp.stanford.edu:8080/corenlp/process?outputFormat=json&Process=Submit&input=');
+   
+/**
+ * Guzzle is used to make HTTP calls to the CoreNLP server.
+ * 
+ * If true: HTTP calls are used (recommended)
+ * If false: cURL command line is used
+ */    
+    define('USE_GUZZLE', TRUE);
+       
 /**
  * Java version configuration
  */
     define('CURLURL' , 'http://localhost:9000/');
-    define('CURLPROPERTIES' , '%22annotators%22%3A%22tokenize%2Cregexner%2Cparse%2Cpos%2Clemma%2Copenie%2Cner%22%2C%22prettyPrint%22%3A%22true%22');
 
-    // Note: coref removed from properties since 4.0.0, because it seems to cause problems starting the server
-
+    // used for CoreNLP version 3.7.0
+    define('CURLPROPERTIES' , '%22prettyPrint%22%3A%22true%22');
+    
+    // if you want specific annotators, you can do it like this:
+    // define('CURLPROPERTIES' , '%22annotators%22%3A%22tokenize%2Cregexner%2Cparse%2Cdepparse%2Cpos%2Clemma%2Cmention%2Copenie%2Cner%2Ccoref%2Ckbp%22%2C%22prettyPrint%22%3A%22true%22');
+    
 /**
  * Start composer autoloader
  */

composer.json

@@ -14,7 +14,8 @@
         }
     ],
     "require": {
-        "php": ">=5.3.0"
+        "php": ">=5.5",
+        "guzzlehttp/guzzle": "^6.2.0"
     },
     "autoload": {
     	"classmap": ["src/"]

src/CoreNLP/CorenlpAdapter.php

@@ -8,21 +8,20 @@ class CorenlpAdapter {
 
 /**
  * 
- * COMMAND LINE FUNCTIONS
+ * SERVER OUTPUT FUNCTIONS
  * 
  */
-    
     public $serverRawOutput = ''; // container for serveroutput
     public $serverOutput    = ''; // container for decoded data
     public $serverMemory    = ''; // keeps all the output
+    public $trees           = array(); // keeps parsed trees
 
+    
     /**
-     * function getOnlineOutput:
+     * function getServerOutputOnline
      * - sends request to online CoreNLP API
      * - returns JSON reply
      */
-
-     
     public function getServerOutputOnline(string $text){
 
         $doc = new DomDocument();
@@ -41,14 +40,22 @@ public function getServerOutputOnline(string $text){
 
     /**
      * function getServerOutput:
-     * - sends the server command
+     * - sends a request
      * - returns server output
      * 
      * @param string $text
      * @return type
      */
     public function getServerOutput(string $text){
-
+        
+       if(USE_GUZZLE){          
+            $this->getOutputGuzzle($text);
+        } else {         
+            $this->getOutputCurl($text);
+        }     
+    }
+    
+    public function getOutputCurl($text){
         // create a shell command
         $command = 'curl --data "'.$text.'" "'.CURLURL.'"?properties={"'.CURLPROPERTIES.'"}';
 
@@ -61,19 +68,24 @@ public function getServerOutput(string $text){
         }
 
         // get object with data
-        $this->serverOutput	= json_decode($this->serverRawOutput, true);	// note: decodes into an array, not an object
+        $this->serverOutput = json_decode($this->serverRawOutput, true);	// note: decodes into an array, not an object
 
         return;
     }
-	
-/**
- * 
- * SERVER OUTPUT FUNCTIONS
- * 
- */
+     
+    public function getOutputGuzzle($text){
+        
+        $client = new \GuzzleHttp\Client();
+        $res = $client->request('POST', CURLURL, [
+            'body' => $text
+        ]);
 
-    // keeps parsed trees
-    public $trees   = array();
+        $json =  $res->getBody();
+        $this->serverOutput = json_decode($json, true);
+        
+        return;
+    }
+    
 
     /**
      * function getOutput