Methods summary
public
|
#
__construct( )
The constructor.
It initializes input and output data.
|
public
PartnerAPIOperationValidateOrderParameters
|
#
setCSR( string $csr )
Sets a CSR for the request.
Sets a CSR for the request.
Setting this value is required.
Parameters
Returns
|
public
PartnerAPIOperationValidateOrderParameters
|
#
setCustomer( string $customer )
Sets a customer name.
Setting this value is required.
Parameters
- $customer
string $customer
Returns
|
public
PartnerAPIOperationValidateOrderParameters
|
#
setLanguage( string $lang )
Sets a language to be used for e-mails.
Sets a language to be used for e-mails.
Default is 'pl'. Also acceptable are 'en' and 'ru'.
Parameters
Returns
|
public
PartnerAPIOperationValidateOrderParameters
|
#
setOrderID( string $id )
Sets an order identificator.
Sets an order identificator.
If not set it will be generated automatically by the system. This
identificator have to be unique and it is used to refer to the request.
Parameters
Returns
|
public
PartnerAPIOperationValidateOrderParameters
|
#
setProductCode( string $code )
Sets a three-letter product code.
Sets a three-letter product code.
Setting this value is required.
Parameters
Returns
|
public
PartnerAPIOperationValidateOrderParameters
|
#
setUserAgent( string $userAgent )
Sets a string identifying web browser and operating system.
Sets a string identifying web browser and operating system.
Parameters
- $userAgent
string $userAgent
Returns
|
public
PartnerAPIOperationValidateOrderParameters
|
#
setHashAlgorithm( string $hashAlgorithm )
Sets a hash algorithm for a certificate.
Sets a hash algorithm for a certificate.
Parameters
- $hashAlgorithm
string $hashAlgorithm
Returns
|
public
PartnerAPIOperationValidateOrderParameters
|
#
setEmail( string $email )
Sets an email for a SSL certificate.
Sets an email for a SSL certificate.
Parameters
Returns
|
public
PartnerAPIOperationValidateOrderParameters
|
#
setRequestorInfo( string $firstName, string $lastName, string $email, string $phone )
Sets all the contact data of a requestor.
Sets all the contact data of a requestor.
All arguments are required apart from the last which can be NULL.
Parameters
- $firstName
string $firstName
- $lastName
string $lastName
- $email
string $email
- $phone
string $phone
Returns
|
public
PartnerAPIOperationValidateOrderParameters
|
#
setOrganizationInfo( string $name, mixed $taxNumber )
Sets an organization information.
Sets an organization information.
It is not required to set organization information but if you need or have to
set it all the arguments are required.
Parameters
- $name
string $taxNumber The tax identification number
- $taxNumber
Returns
|
public
PartnerAPIOperationValidateOrderParameters
|
#
setCommonName( string $commonName )
Sets an overrided CSR commonName.
Sets an overrided CSR commonName.
It is not required to set this but if you need to override a commonName from
CSR then you have to change this as same as SAN entries and approvers.
Parameters
- $commonName
string $commonName The commonName to override CN given in CSR
Returns
|
public
PartnerAPIOperationValidateOrderParameters
|
#
setOrganization( string $organization )
Sets an overrided CSR organization.
Sets an overrided CSR organization.
It is not required to set this but if you need to override a organization
from CSR use this method.
Parameters
- $organization
string $organization The organization to override O given in CSR
Returns
|
public
PartnerAPIOperationValidateOrderParameters
|
#
setOrganizationalUnit( string $organizationalUnit )
Sets an overrided CSR organizational unit.
Sets an overrided CSR organizational unit.
It is not required to set this but if you need to override a organizational
unit from CSR use this method.
Parameters
- $organizationalUnit
string $organizationalUnit The Organizational Unit to override OU given in CSR
Returns
|
public
PartnerAPIOperationValidateOrderParameters
|
#
setLocality( string $locality )
Sets an overrided CSR locality.
Sets an overrided CSR locality.
It is not required to set this but if you need to override a locality from
CSR use this method.
Parameters
- $locality
string $locality The locality to override L given in CSR
Returns
|
public
PartnerAPIOperationValidateOrderParameters
|
#
setCountry( string $country )
Sets an overrided CSR country.
Sets an overrided CSR country.
It is not required to set this but if you need to override a country from CSR
use this method.
Parameters
- $country
string $country The country to override C given in CSR
Returns
|
public
PartnerAPIOperationValidateOrderParameters
|
#
setState( string $state )
Sets an overrided CSR state.
Sets an overrided CSR state.
It is not required to set this but if you need to override a state from CSR
use this method.
Parameters
- $state
string $state The state to override state given in CSR
Returns
|
public
PartnerAPIOperationValidateOrderParameters
|
#
setSerialNumber( string $serialNumber )
Sets an overrided CSR serialNumber.
Sets an overrided CSR serialNumber.
It is not required to set this but if you need to override a serialNumber
from CSR use this method.
Parameters
- $serialNumber
string $serialNumber The serialNumber to override serialNumber given in CSR
Returns
|
public
PartnerAPIOperationValidateOrderParameters
|
#
setBusinessCategory( string $businessCategory )
Sets an overrided CSR businessCategory.
Sets an overrided CSR businessCategory.
It is not required to set this but if you need to override a businessCategory
from CSR use this method.
Parameters
- $businessCategory
string $businessCategory The businessCategory to override businessCategory given in CSR
Returns
|
public
PartnerAPIOperationValidateOrderParameters
|
#
setStreetAddress( string $streetAddress )
Sets an overrided CSR streetAddress.
Sets an overrided CSR streetAddress.
It is not required to set this but if you need to override a streetAddress
from CSR use this method.
Parameters
- $streetAddress
string $streetAddress The streetAddress to override streetAddress given in CSR
Returns
|
public
PartnerAPIOperationValidateOrderParameters
|
#
setPostalCode( string $postalCode )
Sets an overrided CSR postalCode.
Sets an overrided CSR postalCode.
It is not required to set this but if you need to override a postalCode from
CSR use this method.
Parameters
- $postalCode
string $postalCode The postalCode to override postalCode given in CSR
Returns
|
public
PartnerAPIOperationValidateOrderParameters
|
#
setJoiln( string $joiln )
Sets an overrided CSR joiln.
Sets an overrided CSR joiln.
It is not required to set this but if you need to override a joiln from CSR
use this method.
Parameters
- $joiln
string $joiln The joiln to override joiln given in CSR
Returns
|
public
PartnerAPIOperationValidateOrderParameters
|
#
setJoisopn( string $joisopn )
Sets an overrided CSR joisopn.
Sets an overrided CSR joisopn.
It is not required to set this but if you need to override a joisopn from CSR
use this method.
Parameters
- $joisopn
string $joisopn The joisopn to override joisopn given in CSR
Returns
|
public
PartnerAPIOperationValidateOrderParameters
|
#
setJoisocn( string $joisocn )
Sets an overrided CSR joisocn.
Sets an overrided CSR joisocn.
It is not required to set this but if you need to override a joisocn from CSR
use this method.
Parameters
- $joisocn
string $joisocn The joisocn to override joisocn given in CSR
Returns
|
public
PartnerAPIOperationValidateOrderParameters
|
#
addSANEntry( string|string[] $domain )
Adds a domain name as a SAN entry in a certificate.
Adds a domain name as a SAN entry in a certificate.
SAN entries are optional. If given, the $domain argument must be a correct
domain name or an array of such domain names.
Parameters
- $domain
string|string[] $domain
Returns
|
public
PartnerAPIOperationValidateOrderParameters
|
#
setApproverMethod( string $approverMethod )
Sets the approverMethod option for SANApprover.
Sets the approverMethod option for SANApprover.
This option determines which approve method will be used for domain
verification.
Parameters
- $approverMethod
string $approverMethod
Returns
|
public
PartnerAPIOperationValidateOrderParameters
|
#
setApproverEmail( string $approverEmail )
Sets the approverEmail option for SANApprover.
Sets the approverEmail option for SANApprover.
This option determines where will be sent e-mail with instructions for FILE
or DNS approve method. This method cannot be used with EMAIL approve method.
Parameters
- $approverEmail
string $approverEmail
Returns
|
public
PartnerAPIOperationValidateOrderParameters
|
#
setApproverEmailPrefix( string $approverEmailPrefix )
Sets the approverEmailPrefix option for SANApprover.
Sets the approverEmailPrefix option for SANApprover.
This option determines which e-mail prefix will be used for EMAIL approve
method. This method cannot be used with FILE or DNS approve method.
Parameters
- $approverEmailPrefix
string $approverEmailPrefix
Returns
|
public
PartnerAPIOperationValidateOrderParameters
|
#
setVerificationNotificationEnabled( boolean $yes_or_no )
Sets the verificationNotificationEnabled option for SANApprover.
Sets the verificationNotificationEnabled option for SANApprover.
This option determines if verification e-mails for all approvers will be sent
or not.
Parameters
- $yes_or_no
boolean $yes_or_no
Returns
|
public
PartnerAPITypeParsedCsr
|
#
getParsedCSR( )
Gets parsed CSR returned as a response.
Gets parsed CSR returned as a response.
The returned value can be an object of PartnerAPITypeParsedCsr class or
null.
Returns
|
public
PartnerAPIOperationQuickOrder
|
#
prepareQuickOrderOperation( )
Prepares an object representing the quick order operation.
Prepares an object representing the quick order operation.
This method is intended to improve coding and to avoid passing the same data
twice. A new object of type PartnerAPIOperationQuickOrder is created and set up
with the data set for validation in the
PartnerAPIOperationValidateOrderParameters object. It means, all the data which
have been set are copied to a new quick order object.
Returns
|