Class Transip_ForwardService

This is the API endpoint for the ForwardService

Package: Transip
Author: TransIP (support@transip.nl)
Class: ForwardService
Located at ForwardService.php

Methods summary
`public static SoapClient`	# `_getSoapClient( mixed $parameters = array() )` Gets the singleton SoapClient which is used to connect to the TransIP Api. Gets the singleton SoapClient which is used to connect to the TransIP Api. Parameters `$parameters` `mixed` $parameters Parameters. Returns `SoapClient` The SoapClient object to which we can connect to the TransIP API
`protected static string`	# `_sign( mixed $parameters )` Calculates the hash to sign our request with based on the given parameters. Calculates the hash to sign our request with based on the given parameters. Parameters `$parameters` `mixed` $parameters The parameters to sign. Returns `string` Base64 encoded signing hash.
`protected static string`	# `_sha512Asn1( string $data )` Creates a digest of the given data, with an asn1 header. Creates a digest of the given data, with an asn1 header. Parameters `$data` `string` $data The data to create a digest of. Returns `string` The digest of the data, with asn1 header.
`protected static string`	# `_encodeParameters( mixed $parameters, string $keyPrefix = null )` Encodes the given paramaters into a url encoded string based upon RFC 3986. Encodes the given paramaters into a url encoded string based upon RFC 3986. Parameters `$parameters` `mixed` $parameters The parameters to encode. `$keyPrefix` `string` $keyPrefix Key prefix. Returns `string` The given parameters encoded according to RFC 3986.
`protected static string`	# `_urlencode( string $string )` Our own function to encode a string according to RFC 3986 since. PHP < 5.3.0 encodes the ~ character which is not allowed. Our own function to encode a string according to RFC 3986 since. PHP < 5.3.0 encodes the ~ character which is not allowed. Parameters `$string` `string` $string The string to encode. Returns `string` The encoded string according to RFC 3986.
`public static string[]`	# `getForwardDomainNames( )` Gets a list of all domains which have the Forward option enabled. Gets a list of all domains which have the Forward option enabled. Returns `string[]` A list of all forwards enabled domains for the user
`public static Transip_Forward`	# `getInfo( string $forwardDomainName )` Gets information about a forwarded domain Gets information about a forwarded domain Parameters `$forwardDomainName` `string` $forwardDomainName The domain to get the info for Returns `Transip_Forward` Forward object with all info if found, an exception otherwise
`public static`	# `order( Transip_Forward $forward )` Order webhosting for a domain name Order webhosting for a domain name Parameters `$forward` `Transip_Forward` $forward info about the forward to order. Mandatory fields are $domainName. Other fields are optional.
`public static`	# `cancel( string $forwardDomainName, string $endTime )` Cancel webhosting for a domain Cancel webhosting for a domain Parameters `$forwardDomainName` `string` $forwardDomainName The domain name of the forward to cancel the forwarding service for `$endTime` `string` $endTime the time to cancel the domain (ForwardService::CANCELLATIONTIME_END (end of contract) or ForwardService::CANCELLATIONTIME_IMMEDIATELY (as soon as possible))
`public static`	# `modify( Transip_Forward $forward )` Modify the options of a Forward. All fields set in the Forward object will be changed. Modify the options of a Forward. All fields set in the Forward object will be changed. Parameters `$forward` `Transip_Forward` $forward The forward to modify

Constants summary
`string`	`SERVICE`	`'ForwardService'`	# The SOAP service that corresponds with this class. The SOAP service that corresponds with this class.
`string`	`API_VERSION`	`'5.23'`	# The API version. The API version.
`string`	`CANCELLATIONTIME_END`	`'end'`	#
`string`	`CANCELLATIONTIME_IMMEDIATELY`	`'immediately'`	#
`string`	`TRACK_ENDPOINT_NAME`	`'Forward'`	#

Properties summary
`protected static SoapClient`	`$_soapClient`	`null`	# The SoapClient used to perform the SOAP calls. The SoapClient used to perform the SOAP calls.