Overview

Packages

  • exceptions
  • messages
  • operations
  • PHP
  • service
  • types

Classes

  • PartnerAPIError
  • PartnerAPIOperation
  • PartnerAPIOperationAddEmailVerification
  • PartnerAPIOperationAddSanVerification
  • PartnerAPIOperationCancelOrder
  • PartnerAPIOperationGetCertificate
  • PartnerAPIOperationGetEmailVerification
  • PartnerAPIOperationGetExpiringCertificates
  • PartnerAPIOperationGetModifiedOrders
  • PartnerAPIOperationGetOrderByOrderID
  • PartnerAPIOperationGetOrdersByDateRange
  • PartnerAPIOperationGetOrderState
  • PartnerAPIOperationGetProductList
  • PartnerAPIOperationGetSanVerificationState
  • PartnerAPIOperationModifySNICertificate
  • PartnerAPIOperationOrderSNICertificate
  • PartnerAPIOperationPerformSanVerification
  • PartnerAPIOperationQuickOrder
  • PartnerAPIOperationReissueCertificate
  • PartnerAPIOperationRenewCertificate
  • PartnerAPIOperationRevokeCertificate
  • PartnerAPIOperationValidateOrderParameters
  • PartnerAPIOperationVerifyOrder
  • Overview
  • Package
  • Class
  • Tree

Class PartnerAPIOperation

A basic class for all operations.

This class contains some common methods and properties for all operations. All the public methods are a common interface which can be used when dealing with an actual operation.

A derived class has to redefine the $_operation protected field with an actual operation name. It also has to contain a constructor which assigns proper message objects to $_input an $_output protected fields.

The $_input field is not publicly accessible therefore a derived class should define methods for setting and adding input data.

Direct known subclasses

PartnerAPIOperationAddEmailVerification, PartnerAPIOperationAddSanVerification, PartnerAPIOperationGetProductList, PartnerAPIOperationGetSanVerificationState, PartnerAPIOperationModifySNICertificate, PartnerAPIOperationOrderSNICertificate, PartnerAPIOperationPerformSanVerification, PartnerAPIOperationQuickOrder, PartnerAPIOperationReissueCertificate, PartnerAPIOperationRenewCertificate, PartnerAPIOperationRevokeCertificate, PartnerAPIOperationValidateOrderParameters, PartnerAPIOperationCancelOrder, PartnerAPIOperationVerifyOrder, PartnerAPIOperationGetCertificate, PartnerAPIOperationGetEmailVerification, PartnerAPIOperationGetExpiringCertificates, PartnerAPIOperationGetModifiedOrders, PartnerAPIOperationGetOrderByOrderID, PartnerAPIOperationGetOrdersByDateRange, PartnerAPIOperationGetOrderState
Abstract
Package: operations
Copyright: Copyright (c) 2020 Asseco Data Systems SA
License: license.txt
Located at certumPartnerAPI/operations/operation.php
Methods summary
public
# setService( PartnerAPIService $service )

Sets a service object which is used for communication with Partner API WebService.

Sets a service object which is used for communication with Partner API WebService.

Each operation have to send its data to the Partner API WebService. To do it, the operation uses a service object which contains all the necessary functionality for communication.

Parameters

$service
PartnerAPIService
$service A service object
public PartnerAPIService
# getService( )

Returns the service set by the setService() method.

Returns the service set by the setService() method.

Returns

PartnerAPIService
public array
# getInputDataAsArray( boolean $omitNullValues = FALSE )

Returns all the data stored for the operation.

Returns all the data stored for the operation.

The returned data is the data which will be sent to the Partner API WebService. It is not necessary to call this method in any time unless you just want to check what data is beeing sent.

The argument $omitNullValues tells if elements which value is NULL will be omitted.

Parameters

$omitNullValues
boolean
$omitNullValues

Returns

array
All the operation data
public array
# getOutputDataAsArray( )

Returns all the data returned from the Partner API WebService for the operation.

Returns all the data returned from the Partner API WebService for the operation.

The returned array contains the data which was returned from the Partner API WebService.

Returns

array
All the operation's response data
public PartnerAPIMessage
# getResponseMessage( )

Returns a message containing response from a service.

Returns a message containing response from a service.

This is an object of type derived from PartnerAPIMessage and it contains all the response returned from a service.

Returns

PartnerAPIMessage
public PartnerAPITypeResponseHeader
# getResponseHeader( )

Returns an object representing the header part of a response.

Returns an object representing the header part of a response.

This is a helper method useful when accessing the response's header.

Returns

PartnerAPITypeResponseHeader
public boolean
# isSuccess( )

Tells if calling an operation was successful.

Tells if calling an operation was successful.

If not, the error part of the header have to be checked.

Returns

boolean
public PartnerAPITypeError[]
# getErrors( )

Returns all error of an operation.

Returns all error of an operation.

This method always returns an array. It can be empty or have one or more error objects.

Returns

PartnerAPITypeError[]
public string
# getResponseTimeLocal( )

Returns localized response time.

Returns localized response time.

The header part of a response contains date and time in GMT timezone. This method returns the date and time of the response converted to local timezone set for PHP interpreter.

Returns

string
Localized date and time of response
public boolean
# call( )

Sends the input data to a service.

Sends the input data to a service.

This method sends all input data, which has been previously set, to the service object. Then the output data are set with the data returned in a response. A bool value is returned and it indicates if the operation was successful.

Returns

boolean
Tells if calling an operation was successful
public array
# getErrorTexts( )

Returns an array with descriptions of errors that have occured.

Returns an array with descriptions of errors that have occured.

The returned array is an array of arrays containing the following keys: code, number, text, where code is a success code, number is a error number and text is a description of an error.

Returns

array
Properties summary
protected PartnerAPIService $_service NULL
#

An object for communication with the Partner API WebService

An object for communication with the Partner API WebService

protected PartnerAPIMessage $_input NULL
#

The input message according to WSDL file.

The input message according to WSDL file.

protected PartnerAPIMessage $_output NULL
#

The output message according to WSDL file.

The output message according to WSDL file.

protected string $_operation 'undefined'
#

The name of a operation.

The name of a operation.

This field must be redefined in an inheriting class and contain the name of operation.

API documentation generated by ApiGen 2.8.0