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
SoapClientThe 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[]
|
#
getWebhostingDomainNames( )
Get all domain names that have a webhosting package attached to them.
Get all domain names that have a webhosting package attached to them.
Returns
string[]
List of domain names that have a webhosting package
|
public static
Transip_WebhostingPackage[]
|
|
public static
Transip_WebHost
|
#
getInfo( string $domainName )
Get information about existing webhosting on a domain.
Get information about existing webhosting on a domain.
Please be aware that the information returned is outdated when a modifying
function in Transip_WebhostingService is called (e.g. createCronjob()).
Call this function again to refresh the info.
Parameters
- $domainName
string
$domainName The domain name of the webhosting package to get the info for. Must
be owned by this user Returns
Transip_WebHostWebHost object with all info about the requested webhosting package
|
public static
|
#
order( string $domainName, Transip_WebhostingPackage $webhostingPackage )
Order webhosting for a domain name
Order webhosting for a domain name
Parameters
- $domainName
string
$domainName The domain name to order the webhosting for. Must be owned by this
user- $webhostingPackage
Transip_WebhostingPackage
$webhostingPackage The webhosting Package to order, one of the packages returned
by Transip_WebhostingService::getAvailablePackages() Throws
ApiException
on error
|
public static
Transip_WebhostingPackage[]
|
#
getAvailableUpgrades( string $domainName )
Get available upgrades packages for a domain name with webhosting. Only those
packages will be returned to which the given domain name can be upgraded to.
Get available upgrades packages for a domain name with webhosting. Only those
packages will be returned to which the given domain name can be upgraded to.
Parameters
- $domainName
string
$domainName Domain to get upgrades for. Must be owned by the current user. Returns
Throws
ApiException
Throwns an Exception ig the domain is not found in the requester account
|
public static
|
#
upgrade( string $domainName, string $newWebhostingPackage )
Upgrade the webhosting of a domain name to a new webhosting package to a
given new package.
Upgrade the webhosting of a domain name to a new webhosting package to a
given new package.
Parameters
- $domainName
string
$domainName The domain to upgrade webhosting for. Must be owned by the current
user.- $newWebhostingPackage
string
$newWebhostingPackage The new webhosting package, must be one of the packages
returned getAvailableUpgrades() for the given domain name Throws
ApiException
Throws an exception when the domain name does not belong to the requester (or is
not found) or the package can't be upgraded
|
public static
|
#
cancel( string $domainName, string $endTime )
Cancel webhosting for a domain
Cancel webhosting for a domain
Parameters
- $domainName
string
$domainName The domain to cancel the webhosting for- $endTime
string
$endTime the time to cancel the domain (WebhostingService::CANCELLATIONTIME_END
(end of contract) or WebhostingService::CANCELLATIONTIME_IMMEDIATELY (as soon as
possible)) Throws
ApiException
Throws an exception when the domain name does not belong to the requester (or is
not found).
|
public static
|
#
setFtpPassword( string $domainName, string $newPassword )
Set a new FTP password for a webhosting package
Set a new FTP password for a webhosting package
Parameters
- $domainName
string
$domainName Domain to set webhosting FTP password for- $newPassword
string
$newPassword The new FTP password for the webhosting package Throws
ApiException
When the new password is empty
|
public static
|
#
createCronjob( string $domainName, Transip_Cronjob $cronjob )
Create a cronjob
Parameters
- $domainName
string
$domainName the domain name of the webhosting package to create cronjob for- $cronjob
Transip_Cronjob
$cronjob the cronjob to create. All fields must be valid. Throws
ApiException
When the new URL is either invalid or the URL is not a URL linking to the domain
the CronJob is for.
|
public static
|
#
deleteCronjob( string $domainName, Transip_Cronjob $cronjob )
Delete a cronjob from a webhosting package. Note, all completely matching
cronjobs will be removed
Delete a cronjob from a webhosting package. Note, all completely matching
cronjobs will be removed
Parameters
- $domainName
string
$domainName the domain name of the webhosting package to delete a cronjob- $cronjob
Transip_Cronjob
$cronjob Cronjob the cronjob to delete. Be aware that all matching cronjobs will
be removed. Throws
ApiException
When the CronJob that needs to be deleted is not found.
|
public static
|
#
createMailBox( string $domainName, Transip_MailBox $mailBox )
Creates a MailBox for a webhosting package. The address field of the MailBox
object must be unique.
Creates a MailBox for a webhosting package. The address field of the MailBox
object must be unique.
Parameters
- $domainName
string
$domainName the domain name of the webhosting package to create the mailbox for- $mailBox
Transip_MailBox
$mailBox MailBox object to create
|
public static
|
#
modifyMailBox( string $domainName, Transip_MailBox $mailBox )
Modifies MailBox settings
Modifies MailBox settings
Parameters
- $domainName
string
$domainName the domain name of the webhosting package to modify the mailbox for- $mailBox
Transip_MailBox
$mailBox the MailBox to modify Throws
ApiException
When the MailBox that needs to be modified is not found.
|
public static
|
#
setMailBoxPassword( string $domainName, Transip_MailBox $mailBox, string $newPassword )
Sets a new password for a MailBox
Sets a new password for a MailBox
Parameters
- $domainName
string
$domainName the domain name of the webhosting package to set the mailbox
password for- $mailBox
Transip_MailBox
$mailBox the MailBox to set the password for- $newPassword
string
$newPassword the new password for the MailBox, cannot be empty. Throws
ApiException
When the MailBox that needs to be modified is not found.
|
public static
|
#
deleteMailBox( string $domainName, Transip_MailBox $mailBox )
Deletes a MailBox from a webhosting package
Deletes a MailBox from a webhosting package
Parameters
- $domainName
string
$domainName the domain name of the webhosting package to remove the MailBox from- $mailBox
Transip_MailBox
$mailBox the mailbox object to remove Throws
ApiException
When the MailBox that needs to be deleted is not found.
|
public static
|
#
createMailForward( string $domainName, Transip_MailForward $mailForward )
Creates a MailForward for a webhosting package
Creates a MailForward for a webhosting package
Parameters
- $domainName
string
$domainName the domain name of the webhosting package to add the MailForward to- $mailForward
Transip_MailForward
$mailForward The MailForward object to create
|
public static
|
#
modifyMailForward( string $domainName, Transip_MailForward $mailForward )
Changes an active MailForward object
Changes an active MailForward object
Parameters
- $domainName
string
$domainName the domain name of the webhosting package to modify the MailForward
from- $mailForward
Transip_MailForward
$mailForward the MailForward to modify Throws
ApiException
When the MailForward that needs to be modified is not found.
|
public static
|
#
deleteMailForward( string $domainName, Transip_MailForward $mailForward )
Deletes an active MailForward object
Deletes an active MailForward object
Parameters
- $domainName
string
$domainName the domain name of the webhosting package to delete the MailForward
from- $mailForward
Transip_MailForward
$mailForward the MailForward to delete
|
public static
|
#
createDatabase( string $domainName, Transip_Db $db )
Creates a new database
Parameters
- $domainName
string
$domainName the domain name of the webhosting package to create the Db for- $db
Transip_Db
$db Db object to create
|
public static
|
#
modifyDatabase( string $domainName, Transip_Db $db )
Changes a Db object
Parameters
- $domainName
string
$domainName the domain name of the webhosting package to change the Db for- $db
Transip_Db
$db The db object to modify
|
public static
|
#
setDatabasePassword( string $domainName, Transip_Db $db, string $newPassword )
Sets A database password for a Db
Sets A database password for a Db
Parameters
- $domainName
string
$domainName the domain name of the webhosting package of the Db to change the
password for- $db
Transip_Db
$db Modified database object to save- $newPassword
string
$newPassword New password for the database
|
public static
|
#
deleteDatabase( string $domainName, Transip_Db $db )
Deletes a Db object
Parameters
- $domainName
string
$domainName the domain name of the webhosting package to delete the Db for- $db
Transip_Db
$db Db object to remove Throws
ApiException
When the Database that needs to be deleted is not found.
|
public static
|
#
createSubdomain( string $domainName, Transip_SubDomain $subDomain )
Creates a SubDomain
Parameters
- $domainName
string
$domainName the domain name of the webhosting package to create the SubDomain
for- $subDomain
Transip_SubDomain
$subDomain SubDomain object to create
|
public static
|
#
deleteSubdomain( string $domainName, Transip_SubDomain $subDomain )
Deletes a SubDomain
Parameters
- $domainName
string
$domainName the domain name of the webhosting package to delete the SubDomain
for- $subDomain
Transip_SubDomain
$subDomain SubDomain object to delete Throws
ApiException
When the Subdomain that needs to be deleted is not found.
|