Merge pull request #5 from SLphil/master

XML-RPC string object mask

Author: The SoftLayer Developer Network

README.textile

@@ -28,7 +28,7 @@ h2. Usage
 
 These examples use the SoftLayer_SoapClient class. If you wish to use the XML-RPC API then replace mentions of SoapClient.class.php with XmlrpcClient.class.php and SoftLayer_SoapClient with SoftLayer_XmlrpcClient.
 
-Here's a simple usage example that retrieves account information by calling the "getObject()":http://sldn.softlayer.com/wiki/index.php/SoftLayer_Account::getObject method in the "SoftLayer_Account":http://sldn.softlayer.com/wiki/index.php/SoftLayer_Account service:
+Here's a simple usage example that retrieves account information by calling the "getObject()":http://sldn.softlayer.com/reference/services/SoftLayer_Account/getObject method in the "SoftLayer_Account":http://sldn.softlayer.com/reference/services/SoftLayer_Account service:
 
 <pre><code>
 <?php

SoftLayer/Common/ObjectMask.class.php

@@ -54,7 +54,7 @@
  * making your SoftLayer API calls.
  *
  * For more on object mask usage in the SoftLayer API please see
- * http://sldn.softlayer.com/wiki/index.php/Using_Object_Masks_in_the_SoftLayer_API .
+ * http://sldn.softlayer.com/article/Using_Object_Masks_in_the_SoftLayer_API .
  *
  * The most up to date version of this library can be found on the SoftLayer
  * github public repositories: http://github.com/softlayer/ . Please post to
@@ -64,7 +64,7 @@
  *
  * @author      SoftLayer Technologies, Inc. <[email protected]>
  * @copyright   Copyright (c) 2009 - 2010, Softlayer Technologies, Inc
- * @license     http://sldn.softlayer.com/wiki/index.php/License
+ * @license     http://sldn.softlayer.com/article/License
  * @see         SoftLayer_SoapClient::setObjectMask()
  * @see         SoftLayer_XmlrpcClient::setObjectMask()
  */

SoftLayer/SoapClient.class.php

@@ -57,8 +57,8 @@
  *
  * @author      SoftLayer Technologies, Inc. <[email protected]>
  * @copyright   Copyright (c) 2009 - 2010, Softlayer Technologies, Inc
- * @license     http://sldn.softlayer.com/wiki/index.php/License
- * @link        http://sldn.softlayer.com/wiki/index.php/The_SoftLayer_API The SoftLayer API
+ * @license     http://sldn.softlayer.com/article/License
+ * @link        http://sldn.softlayer.com/article/The_SoftLayer_API The SoftLayer API
  * @see         SoftLayer_SoapClient_AsynchronousAction
  */
 class Softlayer_SoapClient extends SoapClient
@@ -129,7 +129,7 @@ class Softlayer_SoapClient extends SoapClient
     /**
      * The name of the SoftLayer API service you wish to query.
      *
-     * @link http://sldn.softlayer.com/wiki/index.php/Category:API_Services A list of SoftLayer API services
+     * @link http://sldn.softlayer.com/reference/services A list of SoftLayer API services
      * @var string
      */
     protected $_serviceName;
@@ -356,7 +356,7 @@ public function setAuthentication($username, $apiKey)
      * 1234 in the SoftLayer_Hardware_Server Service instructs the API to act on
      * server record 1234 in your method calls.
      *
-     * @link http://sldn.softlayer.com/wiki/index.php/Using_Initialization_Parameters_in_the_SoftLayer_API Using Initialization Parameters in the SoftLayer API
+     * @link http://sldn.softlayer.com/article/Using_Initialization_Parameters_in_the_SoftLayer_API Using Initialization Parameters in the SoftLayer API
      * @param int $id The ID number of the SoftLayer API object you wish to instantiate.
      * @return SoftLayer_SoapClient
      */
@@ -409,8 +409,7 @@ public function setObjectMask($mask)
      * support a way to limit the number of results retrieved from the SoftLayer
      * API in a way akin to an SQL LIMIT statement.
      *
-     * @link http://sldn.softlayer.com/wiki/index.php/Using_Result_Limits_in_the_SoftLayer_API Using Result Limits in the SoftLayer API
-     * @link http://sldn.softlayer.com/wiki/index.php/Category:API_methods_that_can_use_result_limits API methods that can use result limits
+     * @link http://sldn.softlayer.com/article/Using_Result_Limits_in_the_SoftLayer_API Using Result Limits in the SoftLayer API
      * @param int $limit The number of results to limit your SoftLayer API call to.
      * @param int $offset An optional offset to begin your SoftLayer API call's returned result set at.
      * @return SoftLayer_SoapClient

SoftLayer/SoapClient/AsynchronousAction.class.php

@@ -108,7 +108,7 @@
  *
  * @author      SoftLayer Technologies, Inc. <[email protected]>
  * @copyright   Copyright (c) 2009 - 2010, Softlayer Technologies, Inc
- * @license     http://sldn.softlayer.com/wiki/index.php/License
+ * @license     http://sldn.softlayer.com/article/License
  * @see         SoftLayer_SoapClient
  */
 class SoftLayer_SoapClient_AsynchronousAction

SoftLayer/XmlrpcClient.class.php

@@ -51,8 +51,8 @@
  *
  * @author      SoftLayer Technologies, Inc. <[email protected]>
  * @copyright   Copyright (c) 2009 - 2010, Softlayer Technologies, Inc
- * @license     http://sldn.softlayer.com/wiki/index.php/License
- * @link        http://sldn.softlayer.com/wiki/index.php/The_SoftLayer_API The SoftLayer API
+ * @license     http://sldn.softlayer.com/article/License
+ * @link        http://sldn.softlayer.com/article/The_SoftLayer_API The SoftLayer API
  */
 class Softlayer_XmlrpcClient
 {
@@ -104,7 +104,7 @@ class Softlayer_XmlrpcClient
     /**
      * The name of the SoftLayer API service you wish to query.
      *
-     * @link http://sldn.softlayer.com/wiki/index.php/Category:API_Services A list of SoftLayer API services
+     * @link http://sldn.softlayer.com/reference/services A list of SoftLayer API services
      * @var string
      */
     protected $_serviceName;
@@ -302,7 +302,7 @@ public function setAuthentication($username, $apiKey)
      * 1234 in the SoftLayer_Hardware_Server Service instructs the API to act on
      * server record 1234 in your method calls.
      *
-     * @link http://sldn.softlayer.com/wiki/index.php/Using_Initialization_Parameters_in_the_SoftLayer_API Using Initialization Parameters in the SoftLayer API
+     * @link http://sldn.softlayer.com/article/Using_Initialization_Parameters_in_the_SoftLayer_API Using Initialization Parameters in the SoftLayer API
      * @param int $id The ID number of the SoftLayer API object you wish to instantiate.
      * @return SoftLayer_XmlrpcClient
      */
@@ -323,26 +323,26 @@ public function setInitParameter($id)
      * Set an object mask to a SoftLayer API call
      *
      * Use an object mask to retrieve data related your API call's result.
-     * Object masks are skeleton objects that define nested relational
+     * Object masks are skeleton objects or strings that define nested relational
      * properties to retrieve along with an object's local properties.
      *
      * @see SoftLayer_ObjectMask
-     * @link http://sldn.softlayer.com/wiki/index.php/Using_Object_Masks_in_the_SoftLayer_API Using object masks in the SoftLayer API
-     * @link http://sldn.softlayer.com/wiki/index.php/Category:API_methods_that_can_use_object_masks API methods that can use object masks
+     * @link http://sldn.softlayer.com/article/Using-Object-Masks-SoftLayer-API Using object masks in the SoftLayer API
      * @param object $mask The object mask you wish to define
-     * @return SoftLayer_XmlrpcClient
+     * @return SoftLayer_SoapClient
      */
     public function setObjectMask($mask)
     {
         if (!is_null($mask)) {
-            if (!($mask instanceof SoftLayer_ObjectMask)) {
-                throw new Exception('Please provide a SoftLayer_ObjectMask to define an object mask.');
+             $header = 'SoftLayer_ObjectMask';
+
+            if ($mask instanceof SoftLayer_ObjectMask) {
+                $header = sprintf('%sObjectMask', $this->_serviceName);
             }
 
             $objectMask = new stdClass();
             $objectMask->mask = $mask;
-
-            $this->addHeader($this->_serviceName . 'ObjectMask', $objectMask);
+            $this->addHeader($header, $objectMask);
         }
 
         return $this;
@@ -355,8 +355,7 @@ public function setObjectMask($mask)
      * support a way to limit the number of results retrieved from the SoftLayer
      * API in a way akin to an SQL LIMIT statement.
      *
-     * @link http://sldn.softlayer.com/wiki/index.php/Using_Result_Limits_in_the_SoftLayer_API Using Result Limits in the SoftLayer API
-     * @link http://sldn.softlayer.com/wiki/index.php/Category:API_methods_that_can_use_result_limits API methods that can use result limits
+     * @link http://sldn.softlayer.com/article/Using_Result_Limits_in_the_SoftLayer_API Using Result Limits in the SoftLayer API
      * @param int $limit The number of results to limit your SoftLayer API call to.
      * @param int $offset An optional offset to begin your SoftLayer API call's returned result set at.
      * @return SoftLayer_XmlrpcClient

example.php

@@ -65,7 +65,7 @@
  * so it's best to try your call and catch exceptions.
  *
  * This example calls the getObject() method in the SoftLayer_Account API
- * service. <http://sldn.softlayer.com/wiki/index.php/SoftLayer_Account::getObject>
+ * service. <http://sldn.softlayer.com/reference/services/SoftLayer_Account/getObject>
  * It retrieves basic account information, and is a great way to test your API
  * account and connectivity.
  */