Overview

Packages

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

Classes

  • PartnerAPIMessage
  • PartnerAPIMessageAddEmailVerification
  • PartnerAPIMessageAddEmailVerificationResponse
  • PartnerAPIMessageAddSanVerification
  • PartnerAPIMessageAddSanVerificationResponse
  • PartnerAPIMessageCancelOrder
  • PartnerAPIMessageCancelOrderResponse
  • PartnerAPIMessageGetCertificate
  • PartnerAPIMessageGetCertificateResponse
  • PartnerAPIMessageGetEmailVerification
  • PartnerAPIMessageGetEmailVerificationResponse
  • PartnerAPIMessageGetExpiringCertificates
  • PartnerAPIMessageGetExpiringCertificatesResponse
  • PartnerAPIMessageGetModifiedOrders
  • PartnerAPIMessageGetModifiedOrdersResponse
  • PartnerAPIMessageGetOrderByOrderID
  • PartnerAPIMessageGetOrderByOrderIDResponse
  • PartnerAPIMessageGetOrdersByDateRange
  • PartnerAPIMessageGetOrdersByDateRangeResponse
  • PartnerAPIMessageGetOrderState
  • PartnerAPIMessageGetOrderStateResponse
  • PartnerAPIMessageGetProductList
  • PartnerAPIMessageGetProductListResponse
  • PartnerAPIMessageGetSanVerificationState
  • PartnerAPIMessageGetSanVerificationStateResponse
  • PartnerAPIMessageModifySNICertificate
  • PartnerAPIMessageModifySNICertificateResponse
  • PartnerAPIMessageOrderSNICertificate
  • PartnerAPIMessageOrderSNICertificateResponse
  • PartnerAPIMessagePerformSanVerification
  • PartnerAPIMessagePerformSanVerificationResponse
  • PartnerAPIMessageQuickOrder
  • PartnerAPIMessageQuickOrderResponse
  • PartnerAPIMessageReissueCertificate
  • PartnerAPIMessageReissueCertificateResponse
  • PartnerAPIMessageRenewCertificate
  • PartnerAPIMessageRenewCertificateResponse
  • PartnerAPIMessageRevokeCertificate
  • PartnerAPIMessageRevokeCertificateResponse
  • PartnerAPIMessageValidateOrderParameters
  • PartnerAPIMessageValidateOrderParametersResponse
  • PartnerAPIMessageVerifyOrder
  • PartnerAPIMessageVerifyOrderResponse
  • Overview
  • Package
  • Class
  • Tree

Class PartnerAPIMessage

This is a base class for implementations of WSDL messages.

This class contains some common properties and methods for all messages. It also implements "magic methods" like __call() and __get() to access messages' parts. When overridden, the new class must implement the initParts() method which should return an array containing all message's parts.

Direct known subclasses

PartnerAPIMessageAddEmailVerification, PartnerAPIMessageAddEmailVerificationResponse, PartnerAPIMessageGetExpiringCertificates, PartnerAPIMessageGetExpiringCertificatesResponse, PartnerAPIMessageGetModifiedOrders, PartnerAPIMessageGetModifiedOrdersResponse, PartnerAPIMessageGetOrderByOrderID, PartnerAPIMessageGetOrderByOrderIDResponse, PartnerAPIMessageGetOrdersByDateRange, PartnerAPIMessageGetOrdersByDateRangeResponse, PartnerAPIMessageGetOrderState, PartnerAPIMessageGetOrderStateResponse, PartnerAPIMessageAddSanVerification, PartnerAPIMessageGetProductList, PartnerAPIMessageGetProductListResponse, PartnerAPIMessageGetSanVerificationState, PartnerAPIMessageGetSanVerificationStateResponse, PartnerAPIMessageModifySNICertificate, PartnerAPIMessageModifySNICertificateResponse, PartnerAPIMessageOrderSNICertificate, PartnerAPIMessageOrderSNICertificateResponse, PartnerAPIMessagePerformSanVerification, PartnerAPIMessagePerformSanVerificationResponse, PartnerAPIMessageAddSanVerificationResponse, PartnerAPIMessageQuickOrder, PartnerAPIMessageQuickOrderResponse, PartnerAPIMessageReissueCertificate, PartnerAPIMessageReissueCertificateResponse, PartnerAPIMessageRenewCertificate, PartnerAPIMessageRenewCertificateResponse, PartnerAPIMessageRevokeCertificate, PartnerAPIMessageRevokeCertificateResponse, PartnerAPIMessageValidateOrderParameters, PartnerAPIMessageValidateOrderParametersResponse, PartnerAPIMessageCancelOrder, PartnerAPIMessageVerifyOrder, PartnerAPIMessageVerifyOrderResponse, PartnerAPIMessageCancelOrderResponse, PartnerAPIMessageGetCertificate, PartnerAPIMessageGetCertificateResponse, PartnerAPIMessageGetEmailVerification, PartnerAPIMessageGetEmailVerificationResponse
Abstract
Package: messages
Copyright: Copyright (c) 2020 Asseco Data Systems SA
License: license.txt
Located at certumPartnerAPI/messages/message.php
Methods summary
public
# __construct( )

The constructor.

The constructor.

Initiates a message's parts.

abstract protected array
# initParts( )

This method returns initial data for a message's parts.

This method returns initial data for a message's parts.

This method must be redefined in overriding classes and return an array containing all parts of a message. The array keys are names of parts and the array values are objects of type according to the WSDL file. The objects must derive from the PartnerAPIType class. Example: array( 'partName' => PartnerAPITypeSomeType() )

Returns

array
A set of a message's parts
public PartnerAPIMessage
# setCredentials( string $userName, string $password )

Sets the credentials data.

Sets the credentials data.

Every request message have to contain credentials data so that the request could be authenticated. This method can be used to set the credentials. An exception of the type PartnerAPIException can be raised when the part with credentials data defined in a derived class does not exist.

Parameters

$userName
string
$userName A user name
$password
string
$password A password

Returns

PartnerAPIMessage

Throws

PartnerAPIException
public PartnerAPITypeResponseHeader
# getResponseHeader( )

Returns the responseHeader element from a service's response

Returns the responseHeader element from a service's response

Returns

PartnerAPITypeResponseHeader
public array
# getDataAsArray( boolean $omitNullValues = FALSE )

Returns an array with all parts and its elements

Returns an array with all parts and its elements

The keys in this array are parts' names and values are arrays with elements belonging to a given part.

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

Parameters

$omitNullValues
boolean
$omitNullValues

Returns

array
public PartnerAPIMessage
# setData( array $data )

This method sets values of a message's parts.

This method sets values of a message's parts.

The structure of the data argument must be the same as the structure of data returned when calling an operation on an object of SoapClient class.

This method, although public, is not intended to be called directly. It is rather used internally.

Parameters

$data
array
$data

Returns

PartnerAPIMessage

Throws

PartnerAPIException
public PartnerAPIType
# __call( string $name, array $arguments )

This is a "magic" method invoked when an inaccessible method is called

This is a "magic" method invoked when an inaccessible method is called

This method supports one kind of calls:

  • a getting method which name must be formed like getXxx

and the Xxx part of a method's name is a part name.

Parameters

$name
string
$name A name of invoked method
$arguments
array
$arguments Unsed argument but required by PHP

Returns

PartnerAPIType
Actually it is an object of a type derived from the PartnerAPIType type

Throws

PartnerAPIException
protected object
# getPart( string $partname )

Gets a part's object.

Gets a part's object.

This method is called by "magic" methods. It is not recommended to invoke it directly.

It just return an indicated part which is an object of a type derived from PartnerAPIType.

Parameters

$partname
string
$partname A part name

Returns

object
An object representing a message's part
public object
# __get( string $name )

This is a "magic" method invoked when an inaccessible property is accessed.

This is a "magic" method invoked when an inaccessible property is accessed.

The argument $name is an accessed property and it must be a message's part name. If it does not exists an PartnerAPIException exception is raised.

Parameters

$name
string
$name A part name

Returns

object
An object representing a message's part

Throws

PartnerAPIException
protected string|null
# findPartName( string $name )

This method converts a part's name to a proper name.

This method converts a part's name to a proper name.

It tries to find if the given part's name exists. It checks the name as it has been given, and with the first letter uppercased and lowercased. If the proper name has been found it is returned, otherwise NULL is returned.

It is used by "magic" methods, so it is not so important whether an part's name is given with the first letter uppercased or lowercased. But always try to use it exactly as it is defined in WSDL file.

Parameters

$name
string
$name A part's name

Returns

string|null
A proper part's name or null
public boolean
# __isset( string $name )

This is a "magic" method triggered by calling isset() or empty() on inaccessible properties.

This is a "magic" method triggered by calling isset() or empty() on inaccessible properties.

The argument $name is a property name and it must be a message's part name.

Parameters

$name
string
$name A part name

Returns

boolean
Indicates if a property exists
Properties summary
protected string $partWithCredentials NULL
#

This field defines a part name with credentials data.

This field defines a part name with credentials data.

protected string $partWithResponseHeader NULL
#

This field defines a part name with a response header.

This field defines a part name with a response header.

protected array $parts array()
#

This field contains all parts of a message.

This field contains all parts of a message.

This is an array where keys are names of a message's parts and values are objects of certain types according to the WSDL file.

API documentation generated by ApiGen 2.8.0