\XmlDataHandler
Handler for XML Data
- Author: SOFORT AG (integration@sofort.com)
- Copyright: 2010-2014 SOFORT AG
- License: Released under the GNU LESSER GENERAL PUBLIC LICENSE (Version 3)
Synopsis
class XmlDataHandler
extends AbstractDataHandler
{
- // Inherited members from AbstractDataHandler
- protected string $_apiKey;
- protected string $_configKey;
- protected $_Connection;
- protected $_Logger;
- protected string $_projectId;
- protected string $_rawRequest;
- protected string $_rawResponse;
- protected array $_request;
- protected array $_response;
- protected string $_userId;
- // methods
- public XmlDataHandler __construct()
- public void handle()
- public string sendMessage()
- // Inherited methods from AbstractDataHandler
- public AbstractDataHandler __construct()
- public string getApiKey()
- public Connection getConnection()
- public string getProjectId()
- public string getRawRequest()
- public string getRawResponse()
- public mixed getRequest()
- public mixed getResponse()
- public string getUserId()
- public abstract void handle()
- public abstract void sendMessage()
- public AbstractDataHandler setApiKey()
- public AbstractDataHandler setConfigKey()
- public AbstractDataHandler setConnection()
- public AbstractDataHandler setProjectId()
- public AbstractDataHandler setUserId()
Hierarchy
Extends
Members
protected
- $_Connection
—
Object for the type of the connection, HTTP, others might follow - $_Logger
—
Object for the Logging. - $_apiKey
—
string
Api Key as provided in User Account on sofort.com - $_configKey
—
string
Complete Config Key as provided in User Account on sofort.com - $_projectId
—
string
Project ID from sofort.com - $_rawRequest
—
array
Contains the Raw Request Data - $_rawResponse
—
array
Provides the naked response returned by the API or (if no answer was received an Error Code). - $_request
—
array
Contains the request Data, that has been sent to the API - $_response
—
array
Provides the parsed response. - $_userId
—
string
User ID from sofort.com
Methods
public
- __construct() — Should be moved to somewhere else (where it fits better)
- handle() — Preparing data and parsing result received
- sendMessage() — Sending Data to connection and returning results
Inherited from AbstractDataHandler
public
- getApiKey() — Getter for the ApiKey
- getConnection() — Returns the connection, normally a http instance
- getProjectId() — Getter for the ProjectId
- getRawRequest() — Getter for the raw Request Data
- getRawResponse() — Getter for the raw Response Data
- getRequest() — Getter for the Request
- getResponse() — Getter for the Response
- getUserId() — Getter for the userId
- handle()
- sendMessage()
- setApiKey() — Setter for the ApiKey
- setConfigKey() — Setting the configKey and extracting userId, projectId and apiKey from configKey
- setConnection() — Setting the connection (standard: http instance) and the configkey
- setProjectId() — Setter for the projectId
- setUserId() — Setter for the userId