class Login extends SlimCD implements Login

Class Login.

Properties

string $transactionUrl Transaction URL. from SlimCD
string $statsURL Stats URL. from SlimCD
bool $debug Whether or not debug mode is on. Default is off. from SlimCD
protected $send Data to send. from SlimCD
protected $receive Data that is received. from SlimCD
protected int $defaultTimeout Curl timeout. from SlimCD
protected bool $verifyPeer Curl Verify Peer. from SlimCD

Methods

object
buildError($url, $errorMessage)

Create an error using the URL and error message.

from SlimCD
mixed|object
httpPost($urlString, $timeout, $nameValueArray)

Use curl to POST the request to SlimCd.

from SlimCD
int
getTimeout($timeout)

Get current timeout value from property.

from SlimCD
string
getVersion()

Get the current version of the client.

from SlimCD
setVerifyPeer($verifyPeer)

You can disable verify peer, but it is not recommended.

from SlimCD
mixed
getUserSettings(GetUserSettingsRequest $request, bool $timeout = false)

Get settings for a specific username/password.

mixed
getUserClients(GetUserClientsRequest $request, bool $timeout = false)

List all clients in the system for the specified username/password.

mixed
getUserClientSite(GetUserClientSiteRequest $request, bool $timeout = false)

Gets specific sitename, businesstype, industrycode info for a username/ password or clientid/siteid.

Details

in SlimCD at line 73
protected object buildError($url, $errorMessage)

Create an error using the URL and error message.

Parameters

$url
$errorMessage

Return Value

object

in SlimCD at line 100
protected mixed|object httpPost($urlString, $timeout, $nameValueArray)

Use curl to POST the request to SlimCd.

Parameters

$urlString
$timeout
$nameValueArray

Return Value

mixed|object

Exceptions

Exception

in SlimCD at line 181
protected int getTimeout($timeout)

Get current timeout value from property.

Parameters

$timeout

Return Value

int

in SlimCD at line 197
string getVersion()

Get the current version of the client.

Return Value

string

in SlimCD at line 207
setVerifyPeer($verifyPeer)

You can disable verify peer, but it is not recommended.

Parameters

$verifyPeer

at line 27
mixed getUserSettings(GetUserSettingsRequest $request, bool $timeout = false)

Get settings for a specific username/password.

Retrieves a list of settings for the username/password, including transaction type permissions and any messages to be displayed to the user . Message blocks contain 5 rows. Multiple message blocks can be returned as multiple settings.

Parameters

GetUserSettingsRequest $request
bool $timeout

Return Value

mixed

Exceptions

Exception

at line 48
mixed getUserClients(GetUserClientsRequest $request, bool $timeout = false)

List all clients in the system for the specified username/password.

Generates a list of all accessible client ids and the name of the client. The list represents client ids available for a particular username/ password in the user hierarchy.

Parameters

GetUserClientsRequest $request
bool $timeout

Return Value

mixed

Exceptions

Exception

at line 71
mixed getUserClientSite(GetUserClientSiteRequest $request, bool $timeout = false)

Gets specific sitename, businesstype, industrycode info for a username/ password or clientid/siteid.

Retrieves a list of clients and sites for the specified username/password , or a list of sites for the specified clientid, or the details on a specified clientid/siteid. The information returned shows details on the site’s setup.

Parameters

GetUserClientSiteRequest $request
bool $timeout

Return Value

mixed

Exceptions

Exception