Merge pull request #41 from biblibre/NCSU_Propose_API_merged_repo

Add an API to Coral (Issue #7)

resources/README

@@ -6,6 +6,7 @@ and follow instructions
 
 For the manual install, refer to the Technical Documentation available on http://erm.library.nd.edu
 
+For setting up the API, please see the README in resources/api/
 
 **************************
 License / Copyright notices

resources/admin/classes/domain/Fund.php

@@ -57,6 +57,12 @@ public function getNumberOfChildren(){
 		return $result['childCount'];
 	}
 
+    public function getFundIDFromFundCode($fundCode) {
+        $query = "SELECT fundID FROM Fund WHERE fundCode = '" . $fundCode . "';";
+        $result = $this->db->processQuery($query, 'assoc');
+        return isset($result['fundID']) ? $result['fundID'] : null;
+    }
+
 	//returns array of archived objects
 		public function getUnArchivedFunds(){
 

resources/admin/classes/domain/NoteType.php

@@ -63,6 +63,16 @@ public function getInitialNoteTypeID() {
 		}
 	}
 
+    public function getNoteTypeIDByName($name) {
+        $query = "SELECT * FROM NoteType WHERE shortName='$name' LIMIT 0,1";
+        $result = $this->db->processQuery($query, 'assoc');
+
+        if (isset($result['noteTypeID'])){
+            return $result['noteTypeID'];
+        }else{
+            return null;
+        }
+    }
 
 	//returns number of children for this particular contact role
 	public function getNumberOfChildren(){
@@ -79,4 +89,4 @@ public function getNumberOfChildren(){
 
 }
 
-?>
+?>

resources/admin/classes/domain/Resource.php

@@ -2101,14 +2101,17 @@ public function enterNewWorkflow($workflowID = null){
 				$resourceStep->stepID 				= $step->stepID;
 				$resourceStep->priorStepID			= $step->priorStepID;
 				$resourceStep->stepName				= $step->stepName;
+                $resourceStep->stepStartDate        = '';
+                $resourceStep->stepEndDate          = '';
+                $resourceStep->archivingDate        = '';
+                $resourceStep->endLoginID           = '';
 				$resourceStep->userGroupID			= $step->userGroupID;
 				$resourceStep->displayOrderSequence	= $step->displayOrderSequence;
 
 				$resourceStep->save();
 
 			}
 
-
 			//Start the first step
 			//this handles updating the db and sending notifications for approval groups
 			foreach ($this->getFirstSteps() as $resourceStep) {

resources/api/.htaccess

@@ -0,0 +1,4 @@
+RewriteEngine On
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteCond %{REQUEST_FILENAME} !-d
+RewriteRule ^(.*)$ index.php [QSA,L]

resources/api/INSTALL

@@ -0,0 +1,4 @@
+The API uses Flight, a fast, simple, extensible framework for PHP.
+Just install Flight in this directory, so Flight.php is available like this: resources/api/Flight/flight/Flight.php
+
+http://flightphp.com/

resources/api/README

@@ -0,0 +1,15 @@
+Edit resources/admin/configuration.ini and fill apiAuthorizedIP in the [settings] section with the IP address of the client accessing the API:
+apiAuthorizedIP="192.168.1.1"
+
+You can set multiple IPs (comma-separated):
+apiAuthorizedIP="192.168.1.1,192.168.2"
+
+You can also set incomplete IPs so the whole range will be allowed:
+apiAuthorizedIP="192.168.1"
+(will authorize all IPs from 192.168.1.1 to 192.168.1.255)
+
+If you are trying to access the API from the machine it is installed on, you can use the loopback interface (127.0.0.1).
+
+Hint: if you don't know which IP address will be requesting the API, just leave apiAuthorizedIP blank (apiAuthorizedIP="") and access the example form with your browser ( http://yourcoral.tld/resources/api_client/ ), you will get an error like this:
+You are not authorized to use this service.
+Unauthorized IP: 127.0.0.1