Overview

Packages

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

Classes

  • PartnerAPIType
  • PartnerAPITypeAddEmailVerificationRequest
  • PartnerAPITypeAddEmailVerificationResponse
  • PartnerAPITypeAddSanVerificationRequest
  • PartnerAPITypeAddSanVerificationResponse
  • PartnerAPITypeAddSerialNumbers
  • PartnerAPITypeApproverEmailPrefixType
  • PartnerAPITypeAuthToken
  • PartnerAPITypeBusinessCategoryEnum
  • PartnerAPITypeCaBundle
  • PartnerAPITypeCancelOrderReponse
  • PartnerAPITypeCancelOrderRequest
  • PartnerAPITypeCancelParameters
  • PartnerAPITypeCertificateDetails
  • PartnerAPITypeCertificateStatusEnum
  • PartnerAPITypeCertificationRequestStateTypeEnum
  • PartnerAPITypeDocument
  • PartnerAPITypeDocuments
  • PartnerAPITypeDocumentTypeEnum
  • PartnerAPITypeDomainVerificationRequest
  • PartnerAPITypeEmailVerification
  • PartnerAPITypeError
  • PartnerAPITypeErrors
  • PartnerAPITypeExpiringCertificates
  • PartnerAPITypeFile
  • PartnerAPITypeFileName
  • PartnerAPITypeFiles
  • PartnerAPITypeFQDNs
  • PartnerAPITypeGetCertificateRequest
  • PartnerAPITypeGetCertificateResponse
  • PartnerAPITypeGetEmailVerificationRequest
  • PartnerAPITypeGetEmailVerificationResponse
  • PartnerAPITypeGetExpiringCertificatesRequest
  • PartnerAPITypeGetExpiringCertificatesResponse
  • PartnerAPITypeGetModifiedOrdersRequest
  • PartnerAPITypeGetOrderByOrderIDRequest
  • PartnerAPITypeGetOrdersByDateRangeRequest
  • PartnerAPITypeGetOrdersRequest
  • PartnerAPITypeGetOrdersResponse
  • PartnerAPITypeGetOrderStateRequest
  • PartnerAPITypeGetOrderStateResponse
  • PartnerAPITypeGetProductListRequest
  • PartnerAPITypeGetProductListResponse
  • PartnerAPITypeGetProductListResponse_Products
  • PartnerAPITypeGetSanVerificationStateRequest
  • PartnerAPITypeGetSanVerificationStateResponse
  • PartnerAPITypeHashAlgorithmEnum
  • PartnerAPITypeInvalidSerialNumbers
  • PartnerAPITypeModifySNICertificateRequest
  • PartnerAPITypeModifySNICertificateResponse
  • PartnerAPITypeOrder
  • PartnerAPITypeOrderDetails
  • PartnerAPITypeOrderOption
  • PartnerAPITypeOrderParameters
  • PartnerAPITypeOrderRequest
  • PartnerAPITypeOrders
  • PartnerAPITypeOrderSNICertificateRequest
  • PartnerAPITypeOrderSNICertificateResponse
  • PartnerAPITypeOrderSNIParameters
  • PartnerAPITypeOrderStatus
  • PartnerAPITypeOrderVerification
  • PartnerAPITypeOrderVerifications
  • PartnerAPITypeOrderVerificationStateEnum
  • PartnerAPITypeOrderVerificationTypeEnum
  • PartnerAPITypeOrganizationInfo
  • PartnerAPITypeParsedCsr
  • PartnerAPITypePerformSanVerificationResponse
  • PartnerAPITypeProduct
  • PartnerAPITypeProduct_SupportedHashAlgorithms
  • PartnerAPITypeQuickOrderRequest
  • PartnerAPITypeQuickOrderResponse
  • PartnerAPITypeReissueCertificateRequest
  • PartnerAPITypeReissueCertificateResponse
  • PartnerAPITypeRemoveSerialNumbers
  • PartnerAPITypeRenewCertificateRequest
  • PartnerAPITypeRenewCertificateResponse
  • PartnerAPITypeRequest
  • PartnerAPITypeRequestHeader
  • PartnerAPITypeRequestorInfo
  • PartnerAPITypeResponse
  • PartnerAPITypeResponseHeader
  • PartnerAPITypeRevocationReasonEnum
  • PartnerAPITypeRevokeCertificateParameters
  • PartnerAPITypeRevokeCertificateRequest
  • PartnerAPITypeRevokeCertificateResponse
  • PartnerAPITypeSanApprover
  • PartnerAPITypeSanEntries
  • PartnerAPITypeSanEntry
  • PartnerAPITypeSanVerification
  • PartnerAPITypeSanVerificationManualState
  • PartnerAPITypeSanVerificationState
  • PartnerAPITypeSanVerificationStateEnum
  • PartnerAPITypeSanVerificationStates
  • PartnerAPITypeSanVerificationSystemMethodEnum
  • PartnerAPITypeSanVerificationSystemState
  • PartnerAPITypeSerialNumbers
  • PartnerAPITypeValidateOrderParametersRequest
  • PartnerAPITypeValidateOrderParametersResponse
  • PartnerAPITypeVerificationMethodType
  • PartnerAPITypeVerifyOrderParameters
  • PartnerAPITypeVerifyOrderRequest
  • PartnerAPITypeVerifyOrderResponse
  • Overview
  • Package
  • Class
  • Tree

Class PartnerAPIType

This is a base class for implementations of WSDL types.

This class contains some common properties and methods for all types. It also implements "magic methods" like __call() and __get() to access WSDL elements. When overridden, the new class must implement the initData() method which should return an array containing all type elements.

Direct known subclasses

PartnerAPITypeAddSerialNumbers, PartnerAPITypeAuthToken, PartnerAPITypeExpiringCertificates, PartnerAPITypeFile, PartnerAPITypeFiles, PartnerAPITypeFQDNs, PartnerAPITypeGetProductListResponse_Products, PartnerAPITypeInvalidSerialNumbers, PartnerAPITypeOrder, PartnerAPITypeOrderDetails, PartnerAPITypeOrderOption, PartnerAPITypeOrderParameters, PartnerAPITypeCaBundle, PartnerAPITypeOrders, PartnerAPITypeOrderSNIParameters, PartnerAPITypeOrderStatus, PartnerAPITypeOrderVerification, PartnerAPITypeOrderVerifications, PartnerAPITypeOrganizationInfo, PartnerAPITypeParsedCsr, PartnerAPITypeProduct, PartnerAPITypeProduct_SupportedHashAlgorithms, PartnerAPITypeRemoveSerialNumbers, PartnerAPITypeCancelParameters, PartnerAPITypeRequest, PartnerAPITypeRequestHeader, PartnerAPITypeRequestorInfo, PartnerAPITypeResponse, PartnerAPITypeResponseHeader, PartnerAPITypeRevokeCertificateParameters, PartnerAPITypeSanApprover, PartnerAPITypeSanEntries, PartnerAPITypeSanEntry, PartnerAPITypeSanVerification, PartnerAPITypeCertificateDetails, PartnerAPITypeSanVerificationManualState, PartnerAPITypeSanVerificationState, PartnerAPITypeSanVerificationStates, PartnerAPITypeSanVerificationSystemState, PartnerAPITypeSerialNumbers, PartnerAPITypeVerifyOrderParameters, PartnerAPITypeDocument, PartnerAPITypeDocuments, PartnerAPITypeEmailVerification, PartnerAPITypeError, PartnerAPITypeErrors

Indirect known subclasses

PartnerAPITypeAddEmailVerificationRequest, PartnerAPITypeAddEmailVerificationResponse, PartnerAPITypeGetEmailVerificationResponse, PartnerAPITypeGetExpiringCertificatesRequest, PartnerAPITypeGetExpiringCertificatesResponse, PartnerAPITypeGetModifiedOrdersRequest, PartnerAPITypeGetOrderByOrderIDRequest, PartnerAPITypeGetOrdersByDateRangeRequest, PartnerAPITypeGetOrdersRequest, PartnerAPITypeGetOrdersResponse, PartnerAPITypeGetOrderStateRequest, PartnerAPITypeGetOrderStateResponse, PartnerAPITypeAddSanVerificationRequest, PartnerAPITypeGetProductListRequest, PartnerAPITypeGetProductListResponse, PartnerAPITypeGetSanVerificationStateRequest, PartnerAPITypeGetSanVerificationStateResponse, PartnerAPITypeModifySNICertificateRequest, PartnerAPITypeModifySNICertificateResponse, PartnerAPITypeOrderRequest, PartnerAPITypeOrderSNICertificateRequest, PartnerAPITypeOrderSNICertificateResponse, PartnerAPITypePerformSanVerificationResponse, PartnerAPITypeAddSanVerificationResponse, PartnerAPITypeQuickOrderRequest, PartnerAPITypeQuickOrderResponse, PartnerAPITypeReissueCertificateRequest, PartnerAPITypeReissueCertificateResponse, PartnerAPITypeRenewCertificateRequest, PartnerAPITypeRenewCertificateResponse, PartnerAPITypeRevokeCertificateRequest, PartnerAPITypeRevokeCertificateResponse, PartnerAPITypeValidateOrderParametersRequest, PartnerAPITypeValidateOrderParametersResponse, PartnerAPITypeCancelOrderReponse, PartnerAPITypeVerifyOrderRequest, PartnerAPITypeVerifyOrderResponse, PartnerAPITypeCancelOrderRequest, PartnerAPITypeDomainVerificationRequest, PartnerAPITypeGetCertificateRequest, PartnerAPITypeGetCertificateResponse, PartnerAPITypeGetEmailVerificationRequest
Abstract
Package: types
Copyright: Copyright (c) 2020 Asseco Data Systems SA
License: license.txt
Located at certumPartnerAPI/types/type.php
Methods summary
abstract protected array
# initData( )

This is an abstract method used to initialize type elements.

This is an abstract method used to initialize type elements.

When overriden, it must return an array containing all elements for a given type. The structure of this array is defined in the description of $elems variable. If a type is deriving from another type derived from PartnerAPIType then the implementations of this method must call the parent's initData() method and merge all elements.

Returns

array
A set of all type elements
public
# __construct( )

It is the constructor.

It is the constructor.

It just initialize data.

public
# resetData( )

This method resets object's data.

This method resets object's data.

It sets all elements to initial states.

public PartnerAPIType
# setData( array $data )

This method sets values of contained elements

This method sets values of contained elements

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 Data to be set as elements' values

Returns

PartnerAPIType

Throws

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

This method return all elements and their values as an array

This method return all elements and their values as an array

It builds a nested array of arrays or simple values depending on the structure of a type definition. Simple values are string, int, long, boolean and null. Each key is an element's name. A value can be a simple value or an array if an element's value is an array or an object.

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

Parameters

$omitNullValues
boolean
$omitNullValues

Returns

array
A set of all elements and they values
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 three kinds of calls:

  • a setting method which name must be formed like setXxx
  • a adding method which name must be formed like addXxx
  • a getting method which name must be formed like getXxx

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

When invoking a setXxx or addXxx method it gets one argument which is passed to this method in an array as the second argument $arguments. The passed arguments must be null, string, int, long, boolean or an object of a type derived from PartnerAPIType, depending on a type's WSDL definition.

Parameters

$name
string
$name A name of invoked method
$arguments
array
$arguments An array with a value to be set

Returns

PartnerAPIType

Throws

PartnerAPIException
protected PartnerAPIType
# setElement( string $element, array $arguments )

Sets an element's value.

Sets an element's value.

This method is called internally and by the __call() "magic" method. It is not recommended to invoke it directly.

This method sets the value of an element. The value is passed in an array as the second argument $arguments. The new value replaces the old value.

Parameters

$element
string
$element An element's name
$arguments
array
$arguments An array with a value to be set

Returns

PartnerAPIType

Throws

PartnerAPIException
protected PartnerAPIType
# addElement( string $element, array $arguments )

Adds a value to an element's set of values.

Adds a value to an element's set of values.

This method is called internally and by the __call() "magic" method. It is not recommended to invoke it directly.

This method adds the value to the set of an element' values. The new value is passed in an array as the second argument $arguments.

This methods can be invoked only for types which have the attribute 'max' set to NULL. If the 'max' attribute is not NULL then the setElement() method is invoked and the new value replaces the old value.

Parameters

$element
string
$element An element's name
$arguments
array
$arguments An array with a value to be set

Returns

PartnerAPIType

Throws

PartnerAPIException
protected string|integer|long|boolean|null|object
# getElement( string $element )

Gets an element's value.

Gets an element's value.

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

It just return the value of an element. It can be null, string, int, long, boolean or an object.

Parameters

$element
string
$element An element's name

Returns

string|integer|long|boolean|null|object
The value of an element
public string|integer|long|boolean|null|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 an element's name.

Parameters

$name
string
$name An element's name

Returns

string|integer|long|boolean|null|object
The value of an element

Throws

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

This method converts an element's name to a proper name.

This method converts an element's name to a proper name.

It tries to find if the given element'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 element'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 or the documentation for a type.

Parameters

$name
string
$name An element's name

Returns

string|null
An element's name or null
Properties summary
protected array $elems array()
#

This is an array containing all elements in a given type.

This is an array containing all elements in a given type.

The keys in this array are names of WSDL elements and values are arrays contaings the following keys and values: 'min' = 0 if attribute 'minOccurs' = 0 or 1 otherwise, 'max' = NULL if attribute maxOccurs = "unbounded" or 1 otherwise, 'value' = NULL if 'min' = 0 or a simple value of element's type, e.g. "" for string, 0 for int and long, FALSE for boolean and new "object" for a class, 'type' = name of element's type, it can be 'string', 'int', 'long', 'boolean' or a class name which must be derived from PartnerAPIType, 'nillable' => TRUE if attribute nillable = "true", or FALSE otherwise

API documentation generated by ApiGen 2.8.0