- Changed API endpoint to use api.zenfolio.com as requested by Zenfolio

- Changed default API version to 1.6
- Added ability to perform ALL API requests over HTTPS (Fixes Ticket #4)

Author: lildude

README.txt

@@ -1,4 +1,4 @@
-phpZenfolio 1.1 - PHP Wrapper for the Zenfolio API
+phpZenfolio 1.2 - PHP Wrapper for the Zenfolio API
 ==================================================
 
 Written by Colin Seymour
@@ -105,23 +105,23 @@ The constructor takes two arguments, one obligatory and one optional:
      application in the event of a problem.
 
    * `APIVer' - Optional
-     Default: 1.4
+     Default: 1.6
 
-     Use this to set the endpoint you wish to use.  The default is 1.4 as this
+     Use this to set the endpoint you wish to use.  The default is 1.6 as this
      is the latest endpoint provided by Zenfolio.
 
 As the constructor is a phpZenfolio specific method, it can be instantiated
 using one of the following methods:
 
 Arguments as strings:
 
-     $f = new phpZenfolio("AppName=My Cool App/1.0 (http://app.com)", "APIVer=1.4");
+     $f = new phpZenfolio("AppName=My Cool App/1.0 (http://app.com)", "APIVer=1.6");
 
 Arguments as an associative array:
 
      $f = new phpZenfolio( array(
      	"AppName" => "My Cool App/1.0 (http://app.com)",
-     	"APIVer" => "1.4")
+     	"APIVer" => "1.6")
      	);
 
 Naturally, you can predefine the array before instantiating the object and just
@@ -369,6 +369,10 @@ Other Notes
 
      Valid arguments are "curl" (default) and "socket".
 
+   * phpZenfolio implements Zenfolio objects
+     (http://www.zenfolio.com/zf/help/api/ref/objects) as arrays.  This makes
+     implementation and usage easier.
+
    * Some people will need to use phpZenfolio from behind a proxy server.  You
      can use the `setProxy()' method to set the appropriate proxy settings.
 
@@ -458,6 +462,15 @@ This document is also available online at `http://phpzenfolio.com/docs'.
 Change History
 ==============
 
+   * 1.2 - 10 June '12
+
+
+        * Changed API endpoint to use api.zenfolio.com as requested by Zenfolio
+
+        * Changed default API version to 1.6
+
+        * Added ability to perform ALL API requests over HTTPS (Ticket #4)
+
    * 1.1 - 28 Mar '11
 
 

phpZenfolio.php

@@ -6,7 +6,7 @@
  *			     without having to worry about the finer details of the API.
  *
  * @author Colin Seymour <[email protected]>
- * @version 1.1
+ * @version 1.2
  * @package phpZenfolio
  * @license GNU General Public License version 3 {@link http://www.gnu.org/licenses/gpl.html}
  * @copyright Copyright (c) 2010 Colin Seymour
@@ -54,27 +54,28 @@ class PhpZenfolioException extends Exception {}
  * @package phpZenfolio
  **/
 class phpZenfolio {
-	static $version = '1.1';
+	static $version = '1.2';
 	private $cacheType = FALSE;
 	private $cache_expire = 3600;
 	private $keyring;
 	private $id;
 	protected $authToken;
 	private $adapter = 'curl';
+	private $secure = FALSE;
 
 	/**
-     * When your database cache table hits this many rows, a cleanup
-     * will occur to get rid of all of the old rows and cleanup the
-     * garbage in the table.  For most personal apps, 1000 rows should
-     * be more than enough.  If your site gets hit by a lot of traffic
-     * or you have a lot of disk space to spare, bump this number up.
-     * You should try to set it high enough that the cleanup only
-     * happens every once in a while, so this will depend on the growth
-     * of your table.
-     * 
-     * @var integer
-     **/
-    var $max_cache_rows = 1000;
+	 * When your database cache table hits this many rows, a cleanup
+	 * will occur to get rid of all of the old rows and cleanup the
+	 * garbage in the table.  For most personal apps, 1000 rows should
+	 * be more than enough.  If your site gets hit by a lot of traffic
+	 * or you have a lot of disk space to spare, bump this number up.
+	 * You should try to set it high enough that the cleanup only
+	 * happens every once in a while, so this will depend on the growth
+	 * of your table.
+	 * 
+	 * @var integer
+	 **/
+	var $max_cache_rows = 1000;
 
 	/**
 	 * Constructor to set up a phpZenfolio instance.
@@ -94,13 +95,13 @@ class phpZenfolio {
 	 *					in the form "AppName/version (URI)"
 	 *					e.g. "My Cool App/1.0 (http://my.url.com)".
 	 * @param string	$APIVer (Optional) API endpoint you wish to use.
-	 *					Defaults to 1.4
+	 *					Defaults to 1.6
 	 * @return void
 	 **/
 	public function __construct()
 	{
 		$args = phpZenfolio::processArgs( func_get_args() );
-		$this->APIVer = ( array_key_exists( 'APIVer', $args ) ) ? $args['APIVer'] : '1.4';
+		$this->APIVer = ( array_key_exists( 'APIVer', $args ) ) ? $args['APIVer'] : '1.6';
 		// Set the Application Name
 		if ( ! isset( $args['AppName'] ) ) {
 			throw new PhpZenfolioException( 'Application name missing.', -10001 );
@@ -306,6 +307,7 @@ private function cache( $request, $response )
 	 **/
     public function clearCache( $delete = FALSE )
 	{
+		$result = TRUE;
    		if ( $this->cacheType == 'db' ) {
 			if ( $delete ) {
 				$result = $this->cache_db->exec( 'DROP TABLE ' . $this->cache_table );
@@ -343,13 +345,13 @@ public function clearCache( $delete = FALSE )
 	 **/
 	private function request( $command, $args = array() )
 	{
-		if ( $command == 'AuthenticatePlain' ) {
+		if ( $command == 'AuthenticatePlain' || $this->secure === TRUE ) {
 			$proto = "https";
 		} else {
 			$proto = "http";
 		}
 
-		$this->req->setURL( "$proto://www.zenfolio.com/api/{$this->APIVer}/zfapi.asmx" );
+		$this->req->setURL( "$proto://api.zenfolio.com/api/{$this->APIVer}/zfapi.asmx" );
 
 		if ( ! is_null( $this->authToken ) ) {
 			$this->req->setHeader( 'X-Zenfolio-Token', $this->authToken );
@@ -420,6 +422,21 @@ public function setProxy()
 									  'proxy_auth_scheme' => $this->proxy['auth_scheme'] ) );
     }
 
+	/**
+	 * Force phpZenfolio to use HTTPS for ALL requests, not just authentication
+	 * requests.
+	 * 
+	 * NOTE: This may have an adverse effect on performance if used for ALL requests.
+	 * Use with caution.
+	 * 
+	 * @access public
+	 * @return void
+	 **/	
+	public function setSecureOnly()
+	{
+		$this->secure = TRUE;
+	}
+	
 	/**
 	 * Single login function for all login methods.
 	 * 
@@ -526,7 +543,7 @@ public function upload()
 				$photoset = $this->LoadPhotoSet( $args['PhotoSetId'] );
 				$UploadUrl = 'http://up.zenfolio.com' . $photoset['UploadUrl'];
 			} else {
-				$photoset = ( $this->APIVer == '1.4' ) ? $this->LoadPhotoSet( $args['PhotoSetId'], 'Level1', FALSE ) : $this->LoadPhotoSet( $args['PhotoSetId'] );
+				$photoset = ( $this->APIVer == '1.4' || $this->APIVer == '1.6' ) ? $this->LoadPhotoSet( $args['PhotoSetId'], 'Level1', FALSE ) : $this->LoadPhotoSet( $args['PhotoSetId'] );
 				$UploadUrl = $photoset['UploadUrl'];
 			}
 		}
@@ -1353,4 +1370,4 @@ private function _unchunk( $body )
 	}
 }
 
-?>
+?>