Skip to content

Commit

Permalink
Modify ServiceClient to use custom WSDL
Browse files Browse the repository at this point in the history
  • Loading branch information
Валерий Маслеников committed Sep 28, 2017
1 parent f166dee commit 0762b58
Showing 1 changed file with 110 additions and 169 deletions.
279 changes: 110 additions & 169 deletions src/Auth/ServiceClient.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,140 +2,84 @@

namespace Microsoft\BingAds\Auth;

use Microsoft\BingAds\V11\AdInsight\AdInsightServiceSettings as AdInsightServiceSettingsVersion11;
use Microsoft\BingAds\V11\Bulk\BulkServiceSettings as BulkServiceSettingsVersion11;
use Microsoft\BingAds\V11\CampaignManagement\CampaignManagementServiceSettings as CampaignManagementServiceSettingsVersion11;
use Microsoft\BingAds\V11\CustomerBilling\CustomerBillingServiceSettings as CustomerBillingServiceSettingsVersion11;
use Microsoft\BingAds\V11\CustomerManagement\CustomerManagementServiceSettings as CustomerManagementServiceSettingsVersion11;
use Microsoft\BingAds\V11\Reporting\ReportingServiceSettings as ReportingServiceSettingsVersion11;

use Microsoft\BingAds\V10\AdInsight\AdInsightServiceSettings as AdInsightServiceSettingsVersion10;
use Microsoft\BingAds\V10\Bulk\BulkServiceSettings as BulkServiceSettingsVersion10;
use Microsoft\BingAds\V10\CampaignManagement\CampaignManagementServiceSettings as CampaignManagementServiceSettingsVersion10;
use Microsoft\BingAds\V9\CustomerBilling\CustomerBillingServiceSettings as CustomerBillingServiceSettingsVersion9;
use Microsoft\BingAds\V9\CustomerManagement\CustomerManagementServiceSettings as CustomerManagementServiceSettingsVersion9;
use Microsoft\BingAds\V9\Reporting\ReportingServiceSettings as ReportingServiceSettingsVersion9;

use \DOMDocument;
use \DOMXPath;
use \SoapHeader;
use \SoapClient;
use \Exception;
/**

/**
* Define the proxy class for the provided Bing Ads service.
*/
class ServiceClient
{
private $authenticationToken;
private $username;
private $password;
private $password;
private $developerToken;
private $wsdlUrl;
private $accountId;
private $customerId;
private $service;
private $namespace;
private $apiEnvironment;

private $sandboxServiceClientEndpoints = array(
ServiceClientType::AdInsightVersion11 => AdInsightServiceSettingsVersion11::SandboxEndpoint,
ServiceClientType::BulkVersion11 => BulkServiceSettingsVersion11::SandboxEndpoint,
ServiceClientType::CampaignManagementVersion11 => CampaignManagementServiceSettingsVersion11::SandboxEndpoint,
ServiceClientType::CustomerBillingVersion11 => CustomerBillingServiceSettingsVersion11::SandboxEndpoint,
ServiceClientType::CustomerManagementVersion11 => CustomerManagementServiceSettingsVersion11::SandboxEndpoint,
ServiceClientType::ReportingVersion11 => ReportingServiceSettingsVersion11::SandboxEndpoint,

ServiceClientType::AdInsightVersion10 => AdInsightServiceSettingsVersion10::SandboxEndpoint,
ServiceClientType::BulkVersion10 => BulkServiceSettingsVersion10::SandboxEndpoint,
ServiceClientType::CampaignManagementVersion10 => CampaignManagementServiceSettingsVersion10::SandboxEndpoint,
ServiceClientType::CustomerBillingVersion9 => CustomerBillingServiceSettingsVersion9::SandboxEndpoint,
ServiceClientType::CustomerManagementVersion9 => CustomerManagementServiceSettingsVersion9::SandboxEndpoint,
ServiceClientType::ReportingVersion9 => ReportingServiceSettingsVersion9::SandboxEndpoint,
);

private $productionServiceClientEndpoints = array(
ServiceClientType::AdInsightVersion11 => AdInsightServiceSettingsVersion11::ProductionEndpoint,
ServiceClientType::BulkVersion11 => BulkServiceSettingsVersion11::ProductionEndpoint,
ServiceClientType::CampaignManagementVersion11 => CampaignManagementServiceSettingsVersion11::ProductionEndpoint,
ServiceClientType::CustomerBillingVersion11 => CustomerBillingServiceSettingsVersion11::ProductionEndpoint,
ServiceClientType::CustomerManagementVersion11 => CustomerManagementServiceSettingsVersion11::ProductionEndpoint,
ServiceClientType::ReportingVersion11 => ReportingServiceSettingsVersion11::ProductionEndpoint,

ServiceClientType::AdInsightVersion10 => AdInsightServiceSettingsVersion10::ProductionEndpoint,
ServiceClientType::BulkVersion10 => BulkServiceSettingsVersion10::ProductionEndpoint,
ServiceClientType::CampaignManagementVersion10 => CampaignManagementServiceSettingsVersion10::ProductionEndpoint,
ServiceClientType::CustomerBillingVersion9 => CustomerBillingServiceSettingsVersion9::ProductionEndpoint,
ServiceClientType::CustomerManagementVersion9 => CustomerManagementServiceSettingsVersion9::ProductionEndpoint,
ServiceClientType::ReportingVersion9 => ReportingServiceSettingsVersion9::ProductionEndpoint,
);

private $serviceClientNamespaces = array(
ServiceClientType::AdInsightVersion11 => AdInsightServiceSettingsVersion11::ServiceNamespace,
ServiceClientType::BulkVersion11 => BulkServiceSettingsVersion11::ServiceNamespace,
ServiceClientType::CampaignManagementVersion11 => CampaignManagementServiceSettingsVersion11::ServiceNamespace,
ServiceClientType::CustomerBillingVersion11 => CustomerBillingServiceSettingsVersion11::ServiceNamespace,
ServiceClientType::CustomerManagementVersion11 => CustomerManagementServiceSettingsVersion11::ServiceNamespace,
ServiceClientType::ReportingVersion11 => ReportingServiceSettingsVersion11::ServiceNamespace,

ServiceClientType::AdInsightVersion10 => AdInsightServiceSettingsVersion10::ServiceNamespace,
ServiceClientType::BulkVersion10 => BulkServiceSettingsVersion10::ServiceNamespace,
ServiceClientType::CampaignManagementVersion10 => CampaignManagementServiceSettingsVersion10::ServiceNamespace,
ServiceClientType::CustomerBillingVersion9 => CustomerBillingServiceSettingsVersion9::ServiceNamespace,
ServiceClientType::CustomerManagementVersion9 => CustomerManagementServiceSettingsVersion9::ServiceNamespace,
ServiceClientType::ReportingVersion9 => ReportingServiceSettingsVersion9::ServiceNamespace,
);

/**
* Converts long types found in SOAP responses to string types in PHP.
*/

/**
* Converts long types found in SOAP responses to string types in PHP.
*/
private function from_long_xml($xmlFragmentString)
{
return (string)strip_tags($xmlFragmentString);
}
/**
* Converts PHP string types to long types in SOAP requests.
*/

/**
* Converts PHP string types to long types in SOAP requests.
*/
private function to_long_xml($longVal)
{
return '<long>' . $longVal . '</long>';
}

public function __construct($serviceClientType, $authorizationData, $apiEnvironment)
/**
* Необходимо инкапсулировать явную передачу wsdlUrl в этот класс. Для этого необходимо реализовать кеширование этого WSDL
* с использование PSR-16 и отправить pull-request на bing
* @param $wsdlUrl
* @param $authorizationData
*/
public function __construct($wsdlUrl, $authorizationData)
{
// The sandbox environment is used unless the Production environment is explicitly set.

if($apiEnvironment === ApiEnvironment::Production and array_key_exists($serviceClientType, $this->productionServiceClientEndpoints))
{
$this->wsdlUrl = $this->productionServiceClientEndpoints[$serviceClientType] . "?singleWsdl";
}
else if (array_key_exists($serviceClientType, $this->sandboxServiceClientEndpoints))
{
$this->wsdlUrl = $this->sandboxServiceClientEndpoints[$serviceClientType] . "?singleWsdl";
}
else
{
throw new Exception(sprintf("%s is not a valid service client type.", $serviceClientType));
}

$this->apiEnvironment = $apiEnvironment;
$this->namespace = $this->serviceClientNamespaces[$serviceClientType];

$this->wsdlUrl = $wsdlUrl;
$this->SetAuthorizationData($authorizationData);
}

public function GetAccountId() { return $this->accountId; }
public function GetCustomerId() { return $this->customerId; }
public function GetService() { return $this->service; }
public function GetNamespace() { return $this->namespace; }
public function GetWsdl() { return $this->wsdlUrl; }
public function GetApiEnvironment() { return $this->apiEnvironment; }
public function GetAccountId()
{
return $this->accountId;
}

/**
* This function gets the namespace from the WSDL, so you do
public function GetCustomerId()
{
return $this->customerId;
}

public function GetService()
{
return $this->service;
}

public function GetNamespace()
{
return $this->namespace;
}

public function GetWsdl()
{
return $this->wsdlUrl;
}

/**
* This function gets the namespace from the WSDL, so you do
* not have to hardcode it in the client.
*/
*/
private function GetServiceNamespace($url)
{
$doc = new DOMDocument;
Expand All @@ -146,118 +90,115 @@ private function GetServiceNamespace($url)

$attrs = $xpath->query($query);

/**
* The query will return only one node in the node list.
*/
foreach($attrs as $attr)
{
/**
* The query will return only one node in the node list.
*/
foreach ($attrs as $attr) {
$namespace = $attr->value;
}

return $namespace;
}

/**
* Set the authentication headers that should be used in calls to the Bing Ads web services.
*/
public function SetAuthorizationData($authorizationData) {
if(!isset($authorizationData))
{
/**
* Set the authentication headers that should be used in calls to the Bing Ads web services.
*/
public function SetAuthorizationData($authorizationData)
{
if (!isset($authorizationData)) {
throw new Exception("AuthorizationData is not set.");
}

if(isset($authorizationData->Authentication) && isset($authorizationData->Authentication->Type))
{
if($authorizationData->Authentication->Type == "PasswordAuthentication")
{

if (isset($authorizationData->Authentication) && isset($authorizationData->Authentication->Type)) {
if ($authorizationData->Authentication->Type == "PasswordAuthentication") {
$this->username = $authorizationData->Authentication->UserName;
$this->password = $authorizationData->Authentication->Password;
}
elseif($authorizationData->Authentication->Type == "OAuthWebAuthCodeGrant" ||
$authorizationData->Authentication->Type == "OAuthDesktopMobileAuthCodeGrant" ||
$authorizationData->Authentication->Type == "OAuthDesktopMobileImplicitGrant")
{
} elseif ($authorizationData->Authentication->Type == "OAuthWebAuthCodeGrant" ||
$authorizationData->Authentication->Type == "OAuthDesktopMobileAuthCodeGrant" ||
$authorizationData->Authentication->Type == "OAuthDesktopMobileImplicitGrant") {
$this->authenticationToken = $authorizationData->Authentication->OAuthTokens->AccessToken;
}
}
else
{
} else {
throw new Exception("Invalid Authentication Type.");
}


$this->developerToken = $authorizationData->DeveloperToken;
$this->accountId = $authorizationData->AccountId;
$this->accountId = $authorizationData->AccountId;
$this->customerId = $authorizationData->CustomerId;

$this->RefreshServiceProxy();
}

private function RefreshServiceProxy()
{
/**
* Define the SOAP headers.
*/
$this->namespace = $this->GetServiceNamespace($this->wsdlUrl);
/**
* Define the SOAP headers.
*/
$headers = array();

$headers[] = new SoapHeader(
$this->namespace,
'CustomerAccountId',
$this->accountId
$this->namespace,
'CustomerAccountId',
$this->accountId
);

$headers[] = new SoapHeader(
$this->namespace,
'CustomerId',
$this->customerId
$this->namespace,
'CustomerId',
$this->customerId
);

$headers[] = new SoapHeader(
$this->namespace,
'DeveloperToken',
$this->developerToken
$this->namespace,
'DeveloperToken',
$this->developerToken
);

$headers[] = new SoapHeader(
$this->namespace,
'UserName',
$this->username
$this->namespace,
'UserName',
$this->username
);

$headers[] = new SoapHeader(
$this->namespace,
'Password',
$this->password
$this->namespace,
'Password',
$this->password
);

$headers[] = new SoapHeader(
$this->namespace,
'AuthenticationToken',
$this->authenticationToken
$headers[] = new SoapHeader(
$this->namespace,
'AuthenticationToken',
$this->authenticationToken
);

/**
* By default, PHP does not return single item arrays as an array type.
/**
* By default, PHP does not return single item arrays as an array type.
* To force PHP to always return an array for an array type in the
* response, specify the SOAP_SINGLE_ELEMENT_ARRAYS feature.
*/
*/
$options = array(
'trace' => TRUE,
'exceptions' => TRUE,
'features' => SOAP_SINGLE_ELEMENT_ARRAYS,

/**
* Map long type to string type. For details, see
* from_long_xml and to_long_xml callbacks.
*/
'typemap' => array(
array(
'type_ns' => 'http://www.w3.org/2001/XMLSchema',
'type_name' => 'xs:long',
'to_xml' => 'to_long_xml',
'from_xml' => 'from_long_xml'
),
)
'trace' => TRUE,
'exceptions' => TRUE,
'features' => SOAP_SINGLE_ELEMENT_ARRAYS,
'cache_wsdl' => WSDL_CACHE_NONE,

/**
* Map long type to string type. For details, see
* from_long_xml and to_long_xml callbacks.
*/
'typemap' => array(
array(
'type_ns' => 'http://www.w3.org/2001/XMLSchema',
'type_name' => 'xs:long',
'to_xml' => 'to_long_xml',
'from_xml' => 'from_long_xml'
),

),
'compression' => SOAP_COMPRESSION_ACCEPT | SOAP_COMPRESSION_GZIP,
);

$proxy = @new SOAPClient($this->wsdlUrl, $options);
Expand Down

0 comments on commit 0762b58

Please sign in to comment.