Modernizing the codebase for use with PHP namespaces and Composer

autoload.php

@@ -0,0 +1,12 @@
+<?php
+
+/*
+ * This file is part of the RNCryptor package.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+require __DIR__.'/lib/PHPInsight/Autoloader.php';
+
+PHPInsight\Autoloader::register();

composer.json

@@ -0,0 +1,20 @@
+{
+	"name": "jwhennessey/phpinsight",
+    "type": "library",
+    "description": "Sentiment analysis tool for PHP",
+    "keywords": ["sentiment", "insight", "phpinsight"],
+    "homepage": "https://github.com/JWHennessey/phpInsight",
+    "license": "GPLv3 or later",
+    "authors": [
+        {
+            "name": "James Hennessey"
+        }
+    ],
+    "require": {
+        "php": ">=5.3.0",
+    },
+    "autoload": {
+        "psr-0": {"PHPInsight": "lib/"}
+    }
+}
+

examples/demo.php

@@ -0,0 +1,30 @@
+<?php
+if (PHP_SAPI != 'cli') {
+	echo "<pre>";
+}
+
+$strings = array(
+	1 => 'Weather today is rubbish',
+	2 => 'This cake looks amazing',
+	3 => 'His skills are mediocre',
+	4 => 'He is very talented',
+	5 => 'She is seemingly very agressive',
+	6 => 'Marie was enthusiastic about the upcoming trip. Her brother was also passionate about her leaving - he would finally have the house for himself.',
+	7 => 'To be or not to be?',
+);
+
+require_once __DIR__ . '/../autoload.php';
+$sentiment = new \PHPInsight\Sentiment();
+
+foreach ($strings as $string) {
+
+	// calculations:
+	$scores = $sentiment->score($string);
+	$class = $sentiment->categorise($string);
+
+	// output:
+	echo "String: $string\n";
+	echo "Dominant: $class, scores: ";
+	print_r($scores);
+	echo "\n";
+}

lib/PHPInsight/Autoloader.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace PHPInsight;
+
+class Autoloader
+{
+    private $directory;
+    private $prefix;
+    private $prefixLength;
+
+    /**
+     * @param string $baseDirectory Base directory where the source files are located.
+     */
+    public function __construct($baseDirectory = __DIR__)
+    {
+        $this->directory = $baseDirectory;
+        $this->prefix = __NAMESPACE__ . '\\';
+        $this->prefixLength = strlen($this->prefix);
+    }
+
+    /**
+     * Registers the autoloader class with the PHP SPL autoloader.
+     *
+     * @param bool $prepend Prepend the autoloader on the stack instead of appending it.
+     */
+    public static function register($prepend = false)
+    {
+        spl_autoload_register(array(new self, 'autoload'), true, $prepend);
+    }
+
+    /**
+     * Loads a class from a file using its fully qualified name.
+     *
+     * @param string $className Fully qualified name of a class.
+     */
+    public function autoload($className)
+    {
+        if (0 === strpos($className, $this->prefix)) {
+            $parts = explode('\\', substr($className, $this->prefixLength));
+            $filepath = $this->directory.DIRECTORY_SEPARATOR.implode(DIRECTORY_SEPARATOR, $parts).'.php';
+
+            if (is_file($filepath)) {
+                require($filepath);
+            }
+        }
+    }
+}

sentiment.class.php → lib/PHPInsight/Sentiment.php

@@ -1,4 +1,5 @@
 <?php
+namespace PHPInsight;
 
 /*
   phpInsight is a Naive Bayes classifier to calculate sentiment. The program
@@ -114,7 +115,7 @@ class Sentiment {
 	 */
 	public function __construct() {
 
-		$this->dataFolder = dirname(__FILE__) . '/data/';
+		$this->dataFolder = __DIR__ . '/data/';
 
 		// Load and cache dictionaries
 		foreach ($this->classes as $class) {
@@ -275,7 +276,7 @@ public function setDictionary($class) {
 	 * @param str $string	String being broken up
 	 * @return array An array of tokens
 	 */
-	public function _getTokens($string) {
+	private function _getTokens($string) {
 
 		// Replace line endings with spaces
 		$string = str_replace("\r\n", " ", $string);
@@ -332,7 +333,7 @@ public function getList($type) {
 	 * @param str $string
 	 * @return str
 	 */
-	public function _cleanString($string) {
+	private function _cleanString($string) {
 
 		$diac =
 				/* A */ chr(192) . chr(193) . chr(194) . chr(195) . chr(196) . chr(197) .
@@ -353,4 +354,4 @@ public function _cleanString($string) {
 
 }
 
-?>
+?>

lib/bootstrap.php

@@ -0,0 +1,4 @@
+<?php
+
+require __DIR__ . '/PHPInsight/Autoloader.php';
+PHPInsight_Autoloader::register();