Updates to support php8.1.12

Author: allmightyspiff

README.md

@@ -7,31 +7,37 @@ The latest version 1.x is not backwards-compatible.
 It is necessary to update scripts to function properly with the new version.
 ```
 
+Use [v1.2.0](https://github.com/softlayer/softlayer-api-php-client/releases/tag/v1.2) for older PHP versions. [v2.0.0](https://github.com/softlayer/softlayer-api-php-client/releases/tag/v2.0.0) for php 8.1 or higher.
+
+[PHP 8.0 removed XMLRPC](https://php.watch/versions/8.0/xmlrpc) as a built in extension. As such, it is no longer required as part of the composer file in this project. The XmlRpcClient still exists here if you need it, but we assume most users are using the SoapClient. If there are any issues with this [Let us know on github](https://github.com/softlayer/softlayer-api-php-client/issues)
+
 ## Overview
 
 The SoftLayer API PHP client classes provide a simple method for connecting to and making calls from the SoftLayer API and provides support for many of the SoftLayer API's features. Method calls and client management are handled by the PHP SOAP and XML-RPC extensions.
 
-Making API calls using the `\SoftLayer\SoapClient` or `\SoftLayer\XmlRpcClient` classes is done in the following steps:
+Making API calls using the `\SoftLayer\SoapClient` is done in the following steps:
 
-1. Instantiate a new `\SoftLayer\SoapClient` or `\SoftLayer\XmlRpcClient` object using the `\SoftLayer\SoapClient::getClient()` or `\SoftLayer\XmlRpcClient::getClient()` methods. Provide the name of the service that you wish to query, an optional id number of the object that you wish to instantiate, your SoftLayer API username, your SoftLayer API key, and an optional API endpoint base URL. The client classes default to connect over the public Internet. Enter `\SoftLayer\SoapClient::API_PRIVATE_ENDPOINT` or `\SoftLayer\XmlRpcClient::API_PRIVATE_ENDPOINT` to connect to the API over SoftLayer's private network. The system making API calls must be connected to SoftLayer's private network (eg. purchased from SoftLayer or connected via VPN) in order to use the private network API endpoints.
-2. Define and add optional headers to the client, such as object masks and result limits.
-3. Call the API method you wish to call as if it were local to your client object. This class throws exceptions if it's unable to execute a query, so it's best to place API method calls in try / catch statements for proper error handling.
+1. Instantiate a new `\SoftLayer\SoapClient` object using the `\SoftLayer\SoapClient::getClient()` method. Provide the name of the service that you wish to query, an optional id number of the object that you wish to instantiate, your SoftLayer API username, your SoftLayer API key, and an optional API endpoint base URL. The client classes default to connect over the public Internet. 
+2. Use `\SoftLayer\SoapClient::API_PRIVATE_ENDPOINT` to connect to the API over SoftLayer's private network. The system making API calls must be connected to SoftLayer's private network (eg. purchased from SoftLayer or connected via VPN) in order to use the private network API endpoints.
+3. Define and add optional headers to the client, such as object masks and result limits.
+4. Call the API method you wish to call as if it were local to your client object. This class throws exceptions if it's unable to execute a query, so it's best to place API method calls in try / catch statements for proper error handling.
 
 Once your method is executed you may continue using the same client if you need to connect to the same service or define another client object if you wish to work with multiple services at once.
 
-The most up to date version of this library can be found on the SoftLayer github public repositories: [http://github.com/softlayer/](http://github.com/softlayer/) . Please post to the SoftLayer forums [Stack Overflow](https://stackoverflow.com) or open a support ticket in the SoftLayer customer portal if you have any questions regarding use of this library. If you use Stack Overflow please tag your posts with “SoftLayer” so our team can easily find your post. 
+The most up to date version of this library can be found on the SoftLayer github public repositories: [https://github.com/softlayer/softlayer-api-php-client](https://github.com/softlayer/softlayer-api-php-client) . Any issues using this library, please open a [Github Issue](https://github.com/softlayer/softlayer-api-php-client/issues)
 
 ## System Requirements
 
-The `\SoftLayer\SoapClient` class requires at least PHP 5.3.0 and the PHP SOAP enxtension installed. The `\SoftLayer\XmlRpcClient` class requires PHP at least PHP 5 and the PHP XML-RPC extension installed.
+The `\SoftLayer\SoapClient` class requires at least PHP 8.0.0 and the PHP SOAP enxtension installed and enabled (`extension=soap` in the php.ini file). 
+Since [php 8.0 has removed xmlrpc extension](https://php.watch/versions/8.0/xmlrpc) you will need to manually install this library to use the `\SoftLayer\XmlRpcClient`. If you are using an earlier version of php that still includes ext-xml, please use v1.2.0 of this library.
 
-A valid API username and key are required to call the SoftLayer API. A connection to the SoftLayer private network is required to connect to SoftLayer's private network API endpopints.
+A valid API username and key are required to call the SoftLayer API. A connection to the SoftLayer private network is required to connect to SoftLayer's private network API endpopints. See [Authenticating to the SoftLayer API](https://sldn.softlayer.com/article/authenticating-softlayer-api/) for how to get these API keys.
 
 ## Installation
 
 Install the SoftLayer API client using [Composer](https://getcomposer.org/).
 ```bash
-composer require softlayer/softlayer-api-php-client:~1.0@dev
+composer require softlayer/softlayer-api-php-client:~2.0.0@master
 ```
 
 ## Usage
@@ -105,4 +111,4 @@ This software is written by the SoftLayer Development Team <[[email protected]]
 
 ## Copyright
 
-This software is Copyright &copy; 2009 – 2010 [SoftLayer Technologies, Inc](http://www.softlayer.com/). See the bundled LICENSE.textile file for more information.
+This software is Copyright &copy; 2009 – 2022 [SoftLayer Technologies, Inc](http://www.softlayer.com/). See the bundled LICENSE.textile file for more information.

composer.json

@@ -11,8 +11,7 @@
         }
     ],
     "require": {
-        "php": ">=5.3",
-        "ext-xmlrpc": "*",
+        "php": ">=8.0",
         "ext-soap": "*"
     },
     "autoload": {
@@ -22,7 +21,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "1.0-dev"
+            "dev-master": "2.0.0"
         }
     }
 }

composer.lock

@@ -65,12 +65,11 @@
 }
 
 /**
- * It's possible to define your SoftLayer API username and key diredtly in the
- * class file, but it's far easier to define them before creating your API
- * client.
+ * It's possible to define your SoftLayer API username and key directly in the
+ * class file, but it's far easier to define them before creating your API client.
  */
-$apiUsername = 'set me';
-$apiKey = 'set me too';
+$apiUsername = getenv('SL_USER');
+$apiKey = getenv('SL_APIKEY');
 
 /**
  * Usage:
@@ -84,6 +83,8 @@
  * API key:     Your SoftLayer API key,
  */
 $client = SoapClient::getClient('SoftLayer_Account', null, $apiUsername, $apiKey);
+$objectMask = "mask[id,companyName]";
+$client->setObjectMask($objectMask);
 
 /**
  * Once your client object is created you can call API methods for that service
@@ -95,45 +96,36 @@
  * It retrieves basic account information, and is a great way to test your API
  * account and connectivity.
  */
+
 try {
-    print_r($client->getObject());
+    $result = $client->getObject();
+    print_r($result);
 } catch (\Exception $e) {
     die($e->getMessage());
 }
 
 /**
- * For a more complex example we’ll retrieve a support ticket with id 123456
- * along with the ticket’s updates, the user it’s assigned to, the servers
- * attached to it, and the datacenter those servers are in. We’ll retrieve our
- * extra information using a nested object mask. After we have the ticket we’ll
- * update it with the text ‘Hello!’.
+ * In this example we will get all of the VirtualGuests on our account. And for each guest we will print out
+ * some basic information about them, along with make another API call to get its primaryIpAddress.
  */
 
 // Declare an API client to connect to the SoftLayer_Ticket API service.
-$client = SoapClient::getClient('SoftLayer_Ticket', 123456, $apiUsername, $apiKey);
+$client = SoapClient::getClient('SoftLayer_Account', null, $apiUsername, $apiKey);
+
 
 // Assign an object mask to our API client:
-$objectMask = new ObjectMask();
-$objectMask->updates;
-$objectMask->assignedUser;
-$objectMask->attachedHardware->datacenter;
+$objectMask = "mask[id, hostname, datacenter[longName]]";
 $client->setObjectMask($objectMask);
 
-// Retrieve the ticket record.
 try {
-    $ticket = $client->getObject();
-    print_r($ticket);
-} catch (\Exception $e) {
-    die('Unable to retrieve ticket record: ' . $e->getMessage());
-}
-
-// Now update the ticket.
-$update = new \stdClass();
-$update->entry = 'Hello!';
-
-try {
-    $update = $client->addUpdate($update);
-    echo "Updated ticket 123456. The new update's id is " . $update[0]->id . '.';
+    $virtualGuests = $client->getVirtualGuests();
+    print("Id, Hostname, Datacenter, Ip Address\n");
+    foreach ($virtualGuests as $guest) {
+        $guestClient = SoapClient::getClient('SoftLayer_Virtual_Guest', $guest->id, $apiUsername, $apiKey);
+        $ipAddress = $guestClient->getPrimaryIpAddress();
+        print($guest->id . ", " . $guest->hostname . ", " . $guest->datacenter->longName . ", " . $ipAddress . "\n");
+        break;
+    }
 } catch (\Exception $e) {
-    die('Unable to update ticket: ' . $e->getMessage());
+    die('Unable to retrieve virtual guests: ' . $e->getMessage());
 }

example.php

@@ -56,16 +56,13 @@
  * making your SoftLayer API calls.
  *
  * For more on object mask usage in the SoftLayer API please see
- * http://sldn.softlayer.com/article/Using_Object_Masks_in_the_SoftLayer_API .
+ * https://sldn.softlayer.com/article/object-masks/ .
  *
  * 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
- * the SoftLayer forums <http://forums.softlayer.com/> or open a support ticket
- * in the SoftLayer customer portal if you have any questions regarding use of
- * this library.
+ * github public repositories: http://github.com/softlayer/ . 
  *
  * @author      SoftLayer Technologies, Inc. <[email protected]>
- * @copyright   Copyright (c) 2009 - 2010, Softlayer Technologies, Inc
+ * @copyright   Copyright (c) 2009 - 2022, Softlayer Technologies, Inc
  * @license     http://sldn.softlayer.com/article/License
  * @see         SoapClient::setObjectMask()
  * @see         XmlRpcClient::setObjectMask()

src/Common/ObjectMask.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2009 - 2010, SoftLayer Technologies, Inc. All rights reserved.
+ * Copyright (c) 2009 - 2022, SoftLayer Technologies, Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
@@ -35,24 +35,20 @@
 /**
  * A SoftLayer API SOAP Client
  *
- * Please see the bundled README.textile file for more details and usage
- * information.
+ * Please see the bundled README file for more details and usage information.
  *
- * This client supports sending multiple calls in parallel to the SoftLayer
- * API. Please see the documentation in the
- * AsynchronousAction class in
+ * This client supports sending multiple calls in parallel to the SoftLaye API. 
+ * Please see the documentation in the AsynchronousAction class in
  * SoapClient/AsynchronousAction.php for details.
  *
  * 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
- * the SoftLayer forums <http://forums.softlayer.com/> or open a support ticket
- * in the SoftLayer customer portal if you have any questions regarding use of
- * this library.
+ * github public repositories: https://github.com/softlayer/softlayer-api-php-client .
+ * For any issues with this library, please open a github issue
  *
  * @author      SoftLayer Technologies, Inc. <[email protected]>
- * @copyright   Copyright (c) 2009 - 2010, Softlayer Technologies, Inc
+ * @copyright   Copyright (c) 2009 - 2022, Softlayer Technologies, Inc
  * @license     http://sldn.softlayer.com/article/License
- * @link        http://sldn.softlayer.com/article/The_SoftLayer_API The SoftLayer API
+ * @link        https://sldn.softlayer.com/article/php/ The SoftLayer API
  * @see         AsynchronousAction
  */
 class SoapClient extends \SoapClient
@@ -69,7 +65,7 @@ class SoapClient extends \SoapClient
      * Your SoftLayer API user's authentication key. You may overide this value
      * when calling getClient().
      *
-     * @link https://manage.softlayer.com/Administrative/apiKeychain API key management in the SoftLayer customer portal
+     * @link https://sldn.softlayer.com/article/authenticating-softlayer-api/ API key management in the SoftLayer customer portal
      * @var string
      */
     const API_KEY = 'set me';
@@ -80,22 +76,22 @@ class SoapClient extends \SoapClient
      *
      * @var string
      */
-    const API_PUBLIC_ENDPOINT = 'https://api.softlayer.com/soap/v3/';
+    const API_PUBLIC_ENDPOINT = 'https://api.softlayer.com/soap/v3.1/';
 
     /**
      * The base URL of the SoftLayer SOAP API's WSDL files over SoftLayer's
      * private network.
      *
      * @var string
      */
-    const API_PRIVATE_ENDPOINT = 'http://api.service.softlayer.com/soap/v3/';
+    const API_PRIVATE_ENDPOINT = 'http://api.service.softlayer.com/soap/v3.1/';
 
     /**
      * The namespace to use for calls to the API
      *
      * $var string
      */
-    const DEFAULT_NAMESPACE = 'http://api.service.softlayer.com/soap/v3/';
+    const DEFAULT_NAMESPACE = 'http://api.service.softlayer.com/soap/v3.1/';
 
 
     /**
@@ -175,6 +171,7 @@ class SoapClient extends \SoapClient
      */
     public $oneWay;
 
+
     /**
      * Execute a SoftLayer API method
      *
@@ -197,7 +194,7 @@ public function __call($functionName, $arguments = null)
         }
 
         try {
-            $result = parent::__call($functionName, $arguments, null, $this->_headers, null);
+            $result = parent::__soapCall($functionName, $arguments, null, $this->_headers);
         } catch (SoapFault $e) {
             throw new \Exception('There was an error querying the SoftLayer API: ' . $e->getMessage());
         }
@@ -225,9 +222,10 @@ public function __call($functionName, $arguments = null)
      * @param string $username An optional API username if you wish to bypass SoapClient's built-in username.
      * @param string $username An optional API key if you wish to bypass SoapClient's built-in API key.
      * @param string $endpointUrl The API endpoint base URL you wish to connect to. Set this to SoapClient::API_PRIVATE_ENDPOINT to connect via SoftLayer's private network.
+     * @param bool $trace Enabled SOAP trace in the client object.
      * @return SoapClient
      */
-    public static function getClient($serviceName, $id = null, $username = null, $apiKey = null, $endpointUrl = null)
+    public static function getClient($serviceName, $id = null, $username = null, $apiKey = null, $endpointUrl = null, $trace=false)
     {
         $serviceName = trim($serviceName);
 
@@ -252,12 +250,14 @@ public static function getClient($serviceName, $id = null, $username = null, $ap
             $endpointUrl = self::API_PUBLIC_ENDPOINT;
         }
 
-        if (is_null(self::SOAP_TIMEOUT)) {
-            $soapClient = new self($endpointUrl . $serviceName . '?wsdl');
-        } else {
-            $soapClient = new self($endpointUrl . $serviceName . '?wsdl', array('connection_timeout' => self::SOAP_TIMEOUT));
+        $soapOptions = ['trace' => $trace];
+        if (is_null(self::SOAP_TIMEOUT) == false) {
+            $soapOptions['connection_timeout'] = self::SOAP_TIMEOUT;
         }
 
+        $soapClient = new self($endpointUrl . $serviceName . '?wsdl', $soapOptions);
+
+
         $soapClient->_serviceName = $serviceName;
         $soapClient->_endpointUrl = $endpointUrl;
 
@@ -350,7 +350,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/article/Using_Initialization_Parameters_in_the_SoftLayer_API Using Initialization Parameters in the SoftLayer API
+     * @link https://sldn.softlayer.com/article/using-initialization-parameters-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 SoapClient
      */
@@ -421,7 +421,7 @@ public function setObjectFilter($objectFilter)
      * 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/article/Using_Result_Limits_in_the_SoftLayer_API Using Result Limits in the SoftLayer API
+     * @link https://sldn.softlayer.com/article/using-result-limits-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 SoapClient

src/SoapClient.php

@@ -139,7 +139,7 @@ class AsynchronousAction
     protected $_socket;
 
     /**
-     * Perform an asynchgronous SoftLayer SOAP call
+     * Perform an asynchronous SoftLayer SOAP call
      *
      * Create a raw socket connection to the URL specified by the
      * SoapClient class and send SOAP HTTP headers and request XML to