Docs For Class SoapClientFactory

SoapClientFactory __construct(
AdsUser
$user, string
$version, string
$server, string
$productName, [
$headerOverrides = NULL])

The constructor called by any sub-class.

Tags:

access:

protected

Overridden in child classes as:

AdWordsSoapClientFactory::__construct(): The constructor for the AdWords API SOAP client factory.

Parameters:

AdsUser	$user	the user which the client will use for credentials
string	$version	the version to generate clients for
string	$server	the server to generate clients for
string	$productName	the product name (i.e. adwords)
	$headerOverrides

[ Top ]

void DoRequireOnce(
string
$serviceName, [string
$serviceGroup = NULL])

Initiates a require_once for the service.

Tags:

abstract:
access:	protected

Overridden in child classes as:

AdWordsSoapClientFactory::DoRequireOnce(): Initiates a require_once for the service.

Parameters:

string	$serviceName	the service to instantiate
string	$serviceGroup	the service group to use. Can be `NULL` if the product has not implemented service groups yet

[ Top ]

AdsSoapClient GenerateServiceClient(
string
$serviceName, [
$serviceGroup = NULL], string
$serviceGroupo)

Generates the SOAP service client without the proper headers set yet.

Tags:

return:	the SOAP service client
access:	protected

Parameters:

string	$serviceName	the service to create a client for
string	$serviceGroupo	the group of the service
	$serviceGroup

[ Top ]

AdsSoapClient GenerateSoapClient(
string
$serviceName, [string
$serviceGroup = NULL], [string
$serviceGroupUrlOverride = NULL], [string
$serviceGroupHeaderNamespaceOverride = NULL])

Generates a SOAP client for the given service name. Generates a user level error if this instalation of PHP does not have the extension for SOAP installed.

Tags:

return:	an instantiated SOAP client
access:	public

Parameters:

string	$serviceName	the name of the service to generate a client for
string	$serviceGroup	the name of the service group. Can be `NULL` if the product has not implemented service groups yet
string	$serviceGroupUrlOverride	the name of the service group to be used in the location url
string	$serviceGroupHeaderNamespaceOverride	the name of the service group to use in the header namespace

[ Top ]

AdsUser GetAdsUser(
)

Gets the user associated with this factory.

Tags:

return:	the user associated with this factory
access:	public

[ Top ]

string GetProductName(
)

Gets the product name associated with this factory.

Tags:

return:	the product name associated with this factory
access:	public

[ Top ]

string GetServer(
)

Gets the server associated with this factory.

Tags:

return:	the server associated with this factory
access:	public

[ Top ]

string GetServiceLocation(
string
$serviceName, [string
$serviceGroup = NULL])

Gets the end-point location of the service.

Tags:

return:	the end-point location of the service.
access:	protected

Parameters:

string	$serviceName	the service to instantiate
string	$serviceGroup	the service group to use. Can be `NULL` if the product has not implemented service groups yet

[ Top ]

string GetVersion(
)

Gets the version associated with this factory.

Tags:

return:	the version associated with this factory
access:	public

[ Top ]

Class: SoapClientFactory

Class Overview

Author(s):

Methods

Child classes:

Class Details

Tags:

Class Methods

constructor __construct [line 52]

Tags:

Parameters:

method DoRequireOnce [line 68]

Tags:

Parameters:

method GenerateServiceClient [line 106]

Tags:

Parameters:

method GenerateSoapClient [line 83]

Tags:

Parameters:

method GetAdsUser [line 192]

Tags:

method GetProductName [line 216]

Tags:

method GetServer [line 208]

Tags:

method GetServiceLocation [line 182]

Tags:

Parameters:

method GetVersion [line 200]

Tags: