Helper methods return the client object.

SoftLayer · SoftLayer · commit f5434da1cf6c · 2010-07-05T15:35:31.000-05:00
This will let you chain client methods together for clever one-
liners if you wish.
diff --git a/SoftLayer/SoapClient.class.php b/SoftLayer/SoapClient.class.php
@@ -283,10 +283,12 @@ public static function getClient($serviceName, $id = null, $username = null, $ap
      * @see removeHeader()
      * @param string $name The name of the header you wish to set
      * @param object $value The object you wish to set in this header
+     * @return SoftLayer_SoapClient
      */
     public function addHeader($name, $value)
     {
         $this->_headers[$name] = new SoapHeader($this->_endpointUrl, $name, $value);
+        return $this;
     }
 
     /**
@@ -296,10 +298,12 @@ public function addHeader($name, $value)
      *
      * @see addHeader()
      * @param string $name The name of the header you wish to remove
+     * @return SoftLayer_SoapClient
      */
     public function removeHeader($name)
     {
         unset($this->_headers[$name]);
+        return $this;
     }
 
     /**
@@ -311,6 +315,7 @@ public function removeHeader($name)
      * @link https://manage.softlayer.com/Administrative/apiKeychain API key management in the SoftLayer customer portal
      * @param string $username
      * @param string $apiKey
+     * @return SoftLayer_SoapClient
      */
     public function setAuthentication($username, $apiKey)
     {
@@ -330,6 +335,7 @@ public function setAuthentication($username, $apiKey)
         $header->apiKey   = $apiKey;
 
         $this->addHeader('authenticate', $header);
+        return $this;
     }
 
 
@@ -344,6 +350,7 @@ public function setAuthentication($username, $apiKey)
      *
      * @link http://sldn.softlayer.com/wiki/index.php/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
      */
     public function setInitParameter($id)
     {
@@ -354,6 +361,8 @@ public function setInitParameter($id)
             $initParameters->id = $id;
             $this->addHeader($this->_serviceName . 'InitParameters', $initParameters);
         }
+
+        return $this;
     }
 
     /**
@@ -367,6 +376,7 @@ public function setInitParameter($id)
      * @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
      * @param object $mask The object mask you wish to define
+     * @return SoftLayer_SoapClient
      */
     public function setObjectMask($mask)
     {
@@ -380,6 +390,8 @@ public function setObjectMask($mask)
 
             $this->addHeader($this->_serviceName . 'ObjectMask', $objectMask);
         }
+
+        return $this;
     }
 
     /**
@@ -393,6 +405,7 @@ public function setObjectMask($mask)
      * @link http://sldn.softlayer.com/wiki/index.php/Category:API_methods_that_can_use_result_limits API methods that can use result limits
      * @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
      */
     public function setResultLimit($limit, $offset = 0)
     {
@@ -401,6 +414,7 @@ public function setResultLimit($limit, $offset = 0)
         $resultLimit->offset = intval($offset);
 
         $this->addHeader('resultLimit', $resultLimit);
+        return $this;
     }
 
     /**
diff --git a/SoftLayer/XmlrpcClient.class.php b/SoftLayer/XmlrpcClient.class.php
@@ -234,6 +234,7 @@ public static function getClient($serviceName, $id = null, $username = null, $ap
      * @see removeHeader()
      * @param string $name The name of the header you wish to set
      * @param object $value The object you wish to set in this header
+     * @return SoftLayer_XmlrpcClient
      */
     public function addHeader($name, $value)
     {
@@ -242,6 +243,7 @@ public function addHeader($name, $value)
         }
 
         $this->_headers[$name] = $value;
+        return $this;
     }
 
     /**
@@ -251,10 +253,12 @@ public function addHeader($name, $value)
      *
      * @see addHeader()
      * @param string $name The name of the header you wish to remove
+     * @return SoftLayer_XmlrpcClient
      */
     public function removeHeader($name)
     {
         unset($this->_headers[$name]);
+        return $this;
     }
 
     /**
@@ -266,6 +270,7 @@ public function removeHeader($name)
      * @link https://manage.softlayer.com/Administrative/apiKeychain API key management in the SoftLayer customer portal
      * @param string $username
      * @param string $apiKey
+     * @return SoftLayer_XmlrpcClient
      */
     public function setAuthentication($username, $apiKey)
     {
@@ -285,9 +290,9 @@ public function setAuthentication($username, $apiKey)
         $header->apiKey   = $apiKey;
 
         $this->addHeader('authenticate', $header);
+        return $this;
     }
 
-
     /**
      * Set an initialization parameter header on a SoftLayer API call
      *
@@ -299,6 +304,7 @@ public function setAuthentication($username, $apiKey)
      *
      * @link http://sldn.softlayer.com/wiki/index.php/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
      */
     public function setInitParameter($id)
     {
@@ -309,6 +315,8 @@ public function setInitParameter($id)
             $initParameters->id = $id;
             $this->addHeader($this->_serviceName . 'InitParameters', $initParameters);
         }
+
+        return $this;
     }
 
     /**
@@ -322,6 +330,7 @@ public function setInitParameter($id)
      * @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
      * @param object $mask The object mask you wish to define
+     * @return SoftLayer_XmlrpcClient
      */
     public function setObjectMask($mask)
     {
@@ -335,6 +344,8 @@ public function setObjectMask($mask)
 
             $this->addHeader($this->_serviceName . 'ObjectMask', $objectMask);
         }
+
+        return $this;
     }
 
     /**
@@ -348,6 +359,7 @@ public function setObjectMask($mask)
      * @link http://sldn.softlayer.com/wiki/index.php/Category:API_methods_that_can_use_result_limits API methods that can use result limits
      * @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
      */
     public function setResultLimit($limit, $offset = 0)
     {
@@ -356,6 +368,7 @@ public function setResultLimit($limit, $offset = 0)
         $resultLimit->offset = intval($offset);
 
         $this->addHeader('resultLimit', $resultLimit);
+        return $this;
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -283,10 +283,12 @@ public static function getClient($serviceName, $id = null, $username = null, $ap`
`283`	`283`	`* @see removeHeader()`
`284`	`284`	`* @param string $name The name of the header you wish to set`
`285`	`285`	`* @param object $value The object you wish to set in this header`
	`286`	`+ * @return SoftLayer_SoapClient`
`286`	`287`	`*/`
`287`	`288`	`public function addHeader($name, $value)`
`288`	`289`	`{`
`289`	`290`	`$this->_headers[$name] = new SoapHeader($this->_endpointUrl, $name, $value);`
	`291`	`+ return $this;`
`290`	`292`	`}`
`291`	`293`
`292`	`294`	`/**`
`@@ -296,10 +298,12 @@ public function addHeader($name, $value)`
`296`	`298`	`*`
`297`	`299`	`* @see addHeader()`
`298`	`300`	`* @param string $name The name of the header you wish to remove`
	`301`	`+ * @return SoftLayer_SoapClient`
`299`	`302`	`*/`
`300`	`303`	`public function removeHeader($name)`
`301`	`304`	`{`
`302`	`305`	`unset($this->_headers[$name]);`
	`306`	`+ return $this;`
`303`	`307`	`}`
`304`	`308`
`305`	`309`	`/**`
`@@ -311,6 +315,7 @@ public function removeHeader($name)`
`311`	`315`	`* @link https://manage.softlayer.com/Administrative/apiKeychain API key management in the SoftLayer customer portal`
`312`	`316`	`* @param string $username`
`313`	`317`	`* @param string $apiKey`
	`318`	`+ * @return SoftLayer_SoapClient`
`314`	`319`	`*/`
`315`	`320`	`public function setAuthentication($username, $apiKey)`
`316`	`321`	`{`
`@@ -330,6 +335,7 @@ public function setAuthentication($username, $apiKey)`
`330`	`335`	`$header->apiKey = $apiKey;`
`331`	`336`
`332`	`337`	`$this->addHeader('authenticate', $header);`
	`338`	`+ return $this;`
`333`	`339`	`}`
`334`	`340`
`335`	`341`
`@@ -344,6 +350,7 @@ public function setAuthentication($username, $apiKey)`
`344`	`350`	`*`
`345`	`351`	`* @link http://sldn.softlayer.com/wiki/index.php/Using_Initialization_Parameters_in_the_SoftLayer_API Using Initialization Parameters in the SoftLayer API`
`346`	`352`	`* @param int $id The ID number of the SoftLayer API object you wish to instantiate.`
	`353`	`+ * @return SoftLayer_SoapClient`
`347`	`354`	`*/`
`348`	`355`	`public function setInitParameter($id)`
`349`	`356`	`{`
`@@ -354,6 +361,8 @@ public function setInitParameter($id)`
`354`	`361`	`$initParameters->id = $id;`
`355`	`362`	`$this->addHeader($this->_serviceName . 'InitParameters', $initParameters);`
`356`	`363`	`}`
	`364`	`+`
	`365`	`+ return $this;`
`357`	`366`	`}`
`358`	`367`
`359`	`368`	`/**`
`@@ -367,6 +376,7 @@ public function setInitParameter($id)`
`367`	`376`	`* @link http://sldn.softlayer.com/wiki/index.php/Using_Object_Masks_in_the_SoftLayer_API Using object masks in the SoftLayer API`
`368`	`377`	`* @link http://sldn.softlayer.com/wiki/index.php/Category:API_methods_that_can_use_object_masks API methods that can use object masks`
`369`	`378`	`* @param object $mask The object mask you wish to define`
	`379`	`+ * @return SoftLayer_SoapClient`
`370`	`380`	`*/`
`371`	`381`	`public function setObjectMask($mask)`
`372`	`382`	`{`
`@@ -380,6 +390,8 @@ public function setObjectMask($mask)`
`380`	`390`
`381`	`391`	`$this->addHeader($this->_serviceName . 'ObjectMask', $objectMask);`
`382`	`392`	`}`
	`393`	`+`
	`394`	`+ return $this;`
`383`	`395`	`}`
`384`	`396`
`385`	`397`	`/**`
`@@ -393,6 +405,7 @@ public function setObjectMask($mask)`
`393`	`405`	`* @link http://sldn.softlayer.com/wiki/index.php/Category:API_methods_that_can_use_result_limits API methods that can use result limits`
`394`	`406`	`* @param int $limit The number of results to limit your SoftLayer API call to.`
`395`	`407`	`* @param int $offset An optional offset to begin your SoftLayer API call's returned result set at.`
	`408`	`+ * @return SoftLayer_SoapClient`
`396`	`409`	`*/`
`397`	`410`	`public function setResultLimit($limit, $offset = 0)`
`398`	`411`	`{`
`@@ -401,6 +414,7 @@ public function setResultLimit($limit, $offset = 0)`
`401`	`414`	`$resultLimit->offset = intval($offset);`
`402`	`415`
`403`	`416`	`$this->addHeader('resultLimit', $resultLimit);`
	`417`	`+ return $this;`
`404`	`418`	`}`
`405`	`419`
`406`	`420`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -234,6 +234,7 @@ public static function getClient($serviceName, $id = null, $username = null, $ap`
`234`	`234`	`* @see removeHeader()`
`235`	`235`	`* @param string $name The name of the header you wish to set`
`236`	`236`	`* @param object $value The object you wish to set in this header`
	`237`	`+ * @return SoftLayer_XmlrpcClient`
`237`	`238`	`*/`
`238`	`239`	`public function addHeader($name, $value)`
`239`	`240`	`{`
`@@ -242,6 +243,7 @@ public function addHeader($name, $value)`
`242`	`243`	`}`
`243`	`244`
`244`	`245`	`$this->_headers[$name] = $value;`
	`246`	`+ return $this;`
`245`	`247`	`}`
`246`	`248`
`247`	`249`	`/**`
`@@ -251,10 +253,12 @@ public function addHeader($name, $value)`
`251`	`253`	`*`
`252`	`254`	`* @see addHeader()`
`253`	`255`	`* @param string $name The name of the header you wish to remove`
	`256`	`+ * @return SoftLayer_XmlrpcClient`
`254`	`257`	`*/`
`255`	`258`	`public function removeHeader($name)`
`256`	`259`	`{`
`257`	`260`	`unset($this->_headers[$name]);`
	`261`	`+ return $this;`
`258`	`262`	`}`
`259`	`263`
`260`	`264`	`/**`
`@@ -266,6 +270,7 @@ public function removeHeader($name)`
`266`	`270`	`* @link https://manage.softlayer.com/Administrative/apiKeychain API key management in the SoftLayer customer portal`
`267`	`271`	`* @param string $username`
`268`	`272`	`* @param string $apiKey`
	`273`	`+ * @return SoftLayer_XmlrpcClient`
`269`	`274`	`*/`
`270`	`275`	`public function setAuthentication($username, $apiKey)`
`271`	`276`	`{`
`@@ -285,9 +290,9 @@ public function setAuthentication($username, $apiKey)`
`285`	`290`	`$header->apiKey = $apiKey;`
`286`	`291`
`287`	`292`	`$this->addHeader('authenticate', $header);`
	`293`	`+ return $this;`
`288`	`294`	`}`
`289`	`295`
`290`		`-`
`291`	`296`	`/**`
`292`	`297`	`* Set an initialization parameter header on a SoftLayer API call`
`293`	`298`	`*`
`@@ -299,6 +304,7 @@ public function setAuthentication($username, $apiKey)`
`299`	`304`	`*`
`300`	`305`	`* @link http://sldn.softlayer.com/wiki/index.php/Using_Initialization_Parameters_in_the_SoftLayer_API Using Initialization Parameters in the SoftLayer API`
`301`	`306`	`* @param int $id The ID number of the SoftLayer API object you wish to instantiate.`
	`307`	`+ * @return SoftLayer_XmlrpcClient`
`302`	`308`	`*/`
`303`	`309`	`public function setInitParameter($id)`
`304`	`310`	`{`
`@@ -309,6 +315,8 @@ public function setInitParameter($id)`
`309`	`315`	`$initParameters->id = $id;`
`310`	`316`	`$this->addHeader($this->_serviceName . 'InitParameters', $initParameters);`
`311`	`317`	`}`
	`318`	`+`
	`319`	`+ return $this;`
`312`	`320`	`}`
`313`	`321`
`314`	`322`	`/**`
`@@ -322,6 +330,7 @@ public function setInitParameter($id)`
`322`	`330`	`* @link http://sldn.softlayer.com/wiki/index.php/Using_Object_Masks_in_the_SoftLayer_API Using object masks in the SoftLayer API`
`323`	`331`	`* @link http://sldn.softlayer.com/wiki/index.php/Category:API_methods_that_can_use_object_masks API methods that can use object masks`
`324`	`332`	`* @param object $mask The object mask you wish to define`
	`333`	`+ * @return SoftLayer_XmlrpcClient`
`325`	`334`	`*/`
`326`	`335`	`public function setObjectMask($mask)`
`327`	`336`	`{`
`@@ -335,6 +344,8 @@ public function setObjectMask($mask)`
`335`	`344`
`336`	`345`	`$this->addHeader($this->_serviceName . 'ObjectMask', $objectMask);`
`337`	`346`	`}`
	`347`	`+`
	`348`	`+ return $this;`
`338`	`349`	`}`
`339`	`350`
`340`	`351`	`/**`
`@@ -348,6 +359,7 @@ public function setObjectMask($mask)`
`348`	`359`	`* @link http://sldn.softlayer.com/wiki/index.php/Category:API_methods_that_can_use_result_limits API methods that can use result limits`
`349`	`360`	`* @param int $limit The number of results to limit your SoftLayer API call to.`
`350`	`361`	`* @param int $offset An optional offset to begin your SoftLayer API call's returned result set at.`
	`362`	`+ * @return SoftLayer_XmlrpcClient`
`351`	`363`	`*/`
`352`	`364`	`public function setResultLimit($limit, $offset = 0)`
`353`	`365`	`{`
`@@ -356,6 +368,7 @@ public function setResultLimit($limit, $offset = 0)`
`356`	`368`	`$resultLimit->offset = intval($offset);`
`357`	`369`
`358`	`370`	`$this->addHeader('resultLimit', $resultLimit);`
	`371`	`+ return $this;`
`359`	`372`	`}`
`360`	`373`
`361`	`374`	`/**`