Merge pull request #47 from thybag/experimental

thybag · thybag · commit eb4446709ae8 · 2014-01-28T13:12:35.000-08:00
Roll experimental to live
diff --git a/SharePointAPI.php b/SharePointAPI.php
@@ -5,7 +5,7 @@
  *
  * Simple PHP API for reading/writing and modifying SharePoint list items.
  *
- * @version 0.6.1
+ * @version 0.6.2
  * @licence MIT License
  * @source: http://github.com/thybag/PHP-SharePoint-Lists-API
  *
diff --git a/composer.json b/composer.json
@@ -1,19 +1,19 @@
 {
-    "name": "thybag/php-sharepoint-lists-api",
-    "version": "0.6.1",
-    "type": "library",
-    "description": "A simple PHP API to make working with SharePoint lists easy.",
-    "homepage": "https://github.com/thybag/PHP-SharePoint-Lists-API",
-    "license": "MIT",
-    "authors": [
-        {
-            "name": "Carl Saggs",
-            "email": "carl@userbag.co.uk"
-        }
-    ],
-    "autoload": {
+	"name": "thybag/php-sharepoint-lists-api",
+	"version": "0.6.2",
+	"type": "library",
+	"description": "A simple PHP API to make working with SharePoint lists easy.",
+	"homepage": "https://github.com/thybag/PHP-SharePoint-Lists-API",
+	"license": "MIT",
+	"authors": [
+		{
+			"name": "Carl Saggs",
+			"email": "carl@userbag.co.uk"
+		}
+	],
+	"autoload": {
 		"psr-0": {
 			"Thybag" : "src/"
 		}
-    }
+	}
 }
diff --git a/readme.md b/readme.md
@@ -102,6 +102,14 @@ or
     $sp->query('<list_name>')->where('surname', '=', 'smith')->limit(10)->sort('age','DESC')->get();
 
 
+###### To return the first 5 items, including the columns "favroite_cake" and "favorite animal"
+
+    $sp->read('<list_name>', 5, NULL, array("favroite_cake", "favorite_animal")); 
+
+or
+
+    $sp->query('<list_name>')->fields(array("favroite_cake", "favorite_animal")->limit(5)->get();
+
 
 By default list item's are returned as arrays with lower case index's. If you would prefer the results to return as object's, before invoking any read operations use:
 
@@ -111,6 +119,7 @@ Automatically making the attribute names lowercase can also be deactivated by us
 
     $sp->lowercaseIndexs(FALSE);
 
+
 #### Querying a list
 The query method can be used when you need to specify a query that is to complex to be easily defined using the read methods. Queries are constructed using a number of (hopefully expressive) pseudo SQL methods.
 
@@ -122,6 +131,10 @@ If you wanted to get the first 10 pets that were either cats or hamsters you cou
 
     $sp->query('list of pets')->where('type','=','cat')->or_where('type','=','hamster')->limit(10)->get();
 
+If you need to return 5 items, but including all fields contained in a list, you can use. (pass false to all_fields to include hidden fields).
+
+    $sp->query('list of pets')->all_fields()->get();
+
 If you have a set of CAML for a specific advanced query you would like to run, you can pass it to the query object using:
 
     $sp->query('list of pets')->raw_where('<Eq><FieldRef Name="Title" /><Value Type="Text">Hello World</Value></Eq>')->limit(10)->get();
@@ -206,7 +219,7 @@ Files can be attached to SharePoint list items using:
 
 The PHP SharePoint API contains a number of helper methods to make it easier to ensure certain values are in the correct format for some of SharePoints special data types.
 
-#### dateTime
+###### dateTime
 
 The dataTime method can either be passed a text based date
 
@@ -218,7 +231,7 @@ Or a unix timestamp
 
 And will return a value which can be stored in to SharePoints DateTime fields without issue.
 
-#### Lookup
+###### Lookup
 
 The lookup data type in SharePoint is for fields that reference a row in another list. In order to correctly populate these values you will need to know the ID of the row the value needs to reference.
 
@@ -228,7 +241,7 @@ If you do not know the name/title of the value you are storing the method will w
     
     $value = \Thybag\SharepointApi::lookup('3');
 
-#### Magic Lookup
+###### Magic Lookup
 
 If you are attempting to store a value in a "lookup" data type but for some reason only know the title/name of the item, not its ID, you can use the MagicLookup method to quickly look this value up and return it for you. This method will need to be passed both the items title & the list it is contained within.
 
diff --git a/src/Thybag/Auth/SharePointOnlineAuth.php b/src/Thybag/Auth/SharePointOnlineAuth.php
@@ -5,7 +5,7 @@
  * SharePointOnlineAuth
  * Clone of the PHP SoapClient class, modified in order to allow transparent communication with
  * the SharePoint Online Web services.
- * 
+ *
  * @package Thybag\Auth
  */
 class SharePointOnlineAuth extends \SoapClient {
@@ -15,60 +15,60 @@ class SharePointOnlineAuth extends \SoapClient {
 
 	// Override do request method
 	public function __doRequest($request, $location, $action, $version, $one_way = false) {
-		
+
 		// Authenticate with SP online in order to get required authentication cookies
 		if (!$this->authCookies) $this->configureAuthCookies($location);
-		
+
 		// Set base headers
 		$headers = array();
 		$headers[] = "Content-Type: text/xml;";
 
-        $curl = curl_init($location);
+		$curl = curl_init($location);
+
+		curl_setopt($curl, CURLOPT_RETURNTRANSFER, TRUE);
+		curl_setopt($curl, CURLOPT_POST, TRUE);
 
-        curl_setopt($curl, CURLOPT_RETURNTRANSFER, TRUE);
-        curl_setopt($curl, CURLOPT_POST, TRUE);
+		// Send request and auth cookies.
+		curl_setopt($curl, CURLOPT_POSTFIELDS, $request);
+		curl_setopt($curl, CURLOPT_COOKIE, $this->authCookies);
 
-        // Send request and auth cookies.
-        curl_setopt($curl, CURLOPT_POSTFIELDS, $request);
-        curl_setopt($curl, CURLOPT_COOKIE, $this->authCookies); 
-     
-     	// Connection requires CURLOPT_SSLVERSION set to 3
-        curl_setopt($curl, CURLOPT_TIMEOUT, 10);
-        curl_setopt($curl, CURLOPT_SSLVERSION, 3);
-        curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, FALSE);
+ 		// Connection requires CURLOPT_SSLVERSION set to 3
+		curl_setopt($curl, CURLOPT_TIMEOUT, 10);
+		curl_setopt($curl, CURLOPT_SSLVERSION, 3);
+		curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, FALSE);
 
-        // Useful for debugging
+		// Useful for debugging
 		curl_setopt($curl, CURLOPT_VERBOSE,FALSE);
-        curl_setopt($curl, CURLOPT_HEADER, FALSE);
-        
-        // SharePoint Online requires the SOAPAction header set for ADD/EDIT and DELETE Operations.
-        // Failure to have this will result in a "Security Validation exception"
-        // @see http://weblogs.asp.net/jan/archive/2009/05/25/quot-the-security-validation-for-this-page-is-invalid-quot-when-calling-the-sharepoint-web-services.aspx
-        if( strpos($request, 'UpdateListItems') !== FALSE ) {
-    		$headers[] =	'SOAPAction: "http://schemas.microsoft.com/sharepoint/soap/UpdateListItems"';
-        }
-
-        // Add headers
-        curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
-
-        // Init the cURL
-        $response = curl_exec($curl);
-        
-        // Throw exceptions if there are any issues
-        if (curl_errno($curl)) throw new \SoapFault(curl_error($curl));
-		if ($response == '') throw new \SoapFault("No XML returned");
-     
+		curl_setopt($curl, CURLOPT_HEADER, FALSE);
+
+		// SharePoint Online requires the SOAPAction header set for ADD/EDIT and DELETE Operations.
+		// Failure to have this will result in a "Security Validation exception"
+		// @see http://weblogs.asp.net/jan/archive/2009/05/25/quot-the-security-validation-for-this-page-is-invalid-quot-when-calling-the-sharepoint-web-services.aspx
+		if( strpos($request, 'UpdateListItems') !== FALSE ) {
+		  $headers[] =	'SOAPAction: "http://schemas.microsoft.com/sharepoint/soap/UpdateListItems"';
+		}
+
+		// Add headers
+		curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
+
+		// Init the cURL
+		$response = curl_exec($curl);
+
+		// Throw exceptions if there are any issues
+		if (curl_errno($curl)) throw new \SoapFault('Receiver', curl_error($curl));
+		if ($response == '') throw new \SoapFault('Receiver', "No XML returned");
+
 		// Close CURL
-        curl_close($curl);
-        
-        // Return?
-        if (!$one_way) return ($response);
+		curl_close($curl);
+
+		// Return?
+		if (!$one_way) return ($response);
 	}
 
 	/**
 	 * ConfigureAuthCookies
 	 * Authenticate with sharepoint online in order to get valid authentication cookies
-	 * 
+	 *
 	 * @param $location - Url of sharepoint list
 	 *
 	 * More info on method:
@@ -93,59 +93,59 @@ protected function configureAuthCookies($location) {
 
 		// Extract security token from XML
 		$xml = new \DOMDocument();
-	    $xml->loadXML($result);
-	    $xpath = new \DOMXPath($xml);
-	    $nodelist = $xpath->query("//wsse:BinarySecurityToken");
-	    foreach ($nodelist as $n){
-	        $token = $n->nodeValue;
-	        break;
-	    }
-
-	    // Send token to SharePoint online in order to gain authentication cookies
-	    $result = $this->authCurl($endpoint."/_forms/default.aspx?wa=wsignin1.0", $token, true);
-
-	    // Extract Authentication cookies from response & set them in to AuthCookies var
-	    $this->authCookies = $this->extractAuthCookies($result);
+		$xml->loadXML($result);
+		$xpath = new \DOMXPath($xml);
+		$nodelist = $xpath->query("//wsse:BinarySecurityToken");
+		foreach ($nodelist as $n){
+			$token = $n->nodeValue;
+			break;
+		}
+
+		// Send token to SharePoint online in order to gain authentication cookies
+		$result = $this->authCurl($endpoint."/_forms/default.aspx?wa=wsignin1.0", $token, true);
+
+		// Extract Authentication cookies from response & set them in to AuthCookies var
+		$this->authCookies = $this->extractAuthCookies($result);
 	}
 
 	/**
 	 * extractAuthCookies
 	 * Extract Authentication cookies from SP response & format in to usable cookie string
 	 *
-	 * @param $result cURL Response 
+	 * @param $result cURL Response
 	 * @return $cookie_payload string containing cookie data.
 	 */
 	protected function extractAuthCookies($result){
-		
-	    $authCookies = array();
-	    $cookie_payload = '';
-
-	    $header_array = explode("\r\n", $result);
-
-	    // Get the two auth cookies
-	    foreach($header_array as $header) {
-	        $loop = explode(":",$header);
-	        if($loop[0] == 'Set-Cookie') {
-	            $authCookies[] = $loop[1];
-	        }
-	    }
-	    unset($authCookies[0]); // No need for first cookie   
-
-	    // Extract cookie name & payload and format in to cURL compatible string
-	    foreach($authCookies as $payload){
-	    	$e = strpos($payload, "=");
-	    	// Get name
-	    	$name = substr($payload, 0, $e);
-	    	// Get token
-	    	$content = substr($payload, $e+1);
-	    	$content = substr($content, 0, strpos($content, ";"));
-
-	    	// If not first cookie, add cookie seperator
-	    	if($cookie_payload !== '') $cookie_payload .= '; ';
-
-	    	// Add cookie to string
-	    	$cookie_payload .= $name.'='.$content;
-	    }
+
+		$authCookies = array();
+		$cookie_payload = '';
+
+		$header_array = explode("\r\n", $result);
+
+		// Get the two auth cookies
+		foreach($header_array as $header) {
+			$loop = explode(":",$header);
+			if($loop[0] == 'Set-Cookie') {
+				$authCookies[] = $loop[1];
+			}
+		}
+		unset($authCookies[0]); // No need for first cookie
+
+		// Extract cookie name & payload and format in to cURL compatible string
+		foreach($authCookies as $payload){
+			$e = strpos($payload, "=");
+			// Get name
+			$name = substr($payload, 0, $e);
+			// Get token
+			$content = substr($payload, $e+1);
+			$content = substr($content, 0, strpos($content, ";"));
+
+			// If not first cookie, add cookie seperator
+			if($cookie_payload !== '') $cookie_payload .= '; ';
+
+			// Add cookie to string
+			$cookie_payload .= $name.'='.$content;
+		}
 
 	  	return $cookie_payload;
 	}
@@ -161,39 +161,39 @@ protected function extractAuthCookies($result){
 	 */
 	protected function authCurl($url, $payload, $header = false){
 		$ch = curl_init();
-	    curl_setopt($ch,CURLOPT_URL,$url);
-	    curl_setopt($ch,CURLOPT_POST,1);
-	    curl_setopt($ch,CURLOPT_POSTFIELDS,  $payload);   
-	    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
-	  	
+		curl_setopt($ch,CURLOPT_URL,$url);
+		curl_setopt($ch,CURLOPT_POST,1);
+		curl_setopt($ch,CURLOPT_POSTFIELDS,  $payload);
+		curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
+
 	  	curl_setopt($ch, CURLOPT_SSLVERSION, 3);
-	    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
-	    curl_setopt($ch, CURLOPT_TIMEOUT, 10);
-	    
-	    if($header)  curl_setopt($ch, CURLOPT_HEADER, true); 
+		curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
+		curl_setopt($ch, CURLOPT_TIMEOUT, 10);
+
+		if($header)  curl_setopt($ch, CURLOPT_HEADER, true);
 
-	    $result = curl_exec($ch);
+		$result = curl_exec($ch);
 
-	    // catch error
-	    if($result === false) {
-	        throw new \SoapFault('Curl error: ' . curl_error($ch));
-	    }
-	    
-	    curl_close($ch);
+		// catch error
+		if($result === false) {
+			throw new \SoapFault('Sender', 'Curl error: ' . curl_error($ch));
+		}
 
-	    return $result;
+		curl_close($ch);
+
+		return $result;
 	}
 
 	/**
 	 * Get the XML to request the security token
-	 * 
+	 *
 	 * @param string $username
 	 * @param string $password
 	 * @param string $endpoint
 	 * @return type string
 	 */
 	protected function generateSecurityToken($username, $password, $endpoint) {
-    return <<<TOKEN
+	return <<<TOKEN
     <s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope"
       xmlns:a="http://www.w3.org/2005/08/addressing"
       xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
diff --git a/src/Thybag/Service/QueryObjectService.php b/src/Thybag/Service/QueryObjectService.php
diff --git a/src/Thybag/SharePointAPI.php b/src/Thybag/SharePointAPI.php

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`*`
`6`	`6`	`* Simple PHP API for reading/writing and modifying SharePoint list items.`
`7`	`7`	`*`
`8`		`- * @version 0.6.1`
	`8`	`+ * @version 0.6.2`
`9`	`9`	`* @licence MIT License`
`10`	`10`	`* @source: http://github.com/thybag/PHP-SharePoint-Lists-API`
`11`	`11`	`*`