Additional documentation about MCVE/Monetra's PHP API can be found at » http://www.mainstreetsoftworks.com/documentation.html. Main Street's documentation is complete and should be the primary reference for functions.

m_checkstatus

Check to see if a transaction has completed

说明

int m_checkstatus ( resource $conn , int $identifier )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

identifier

返回值

m_completeauthorizations

Number of complete authorizations in queue, returning an array of their identifiers

说明

int m_completeauthorizations ( resource $conn , int &$array )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

array
Its description

返回值

What the function returns, first on success, then on failure. See also the &return.success; entity

m_connect

Establish the connection to MCVE

说明

int m_connect ( resource $conn )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

返回值

m_connectionerror

Get a textual representation of why a connection failed

说明

string m_connectionerror ( resource $conn )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

返回值

m_deletetrans

Delete specified transaction from MCVE_CONN structure

说明

bool m_deletetrans ( resource $conn , int $identifier )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

identifier

返回值

m_destroyconn

Destroy the connection and MCVE_CONN structure

说明

bool m_destroyconn ( resource $conn )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

返回值

Returns TRUE.

参见

  • m_initconn

m_destroyengine

Free memory associated with IP/SSL connectivity

说明

void m_destroyengine ( void )

Warning

本函数还未编写文档,仅有参数列表。

参数

返回值

没有返回值。

m_getcell

Get a specific cell from a comma delimited response by column name

说明

string m_getcell ( resource $conn , int $identifier , string $column , int $row )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

identifier

column

row

返回值

m_getcellbynum

Get a specific cell from a comma delimited response by column number

说明

string m_getcellbynum ( resource $conn , int $identifier , int $column , int $row )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

identifier

column

row

返回值

m_getcommadelimited

Get the RAW comma delimited data returned from MCVE

说明

string m_getcommadelimited ( resource $conn , int $identifier )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

identifier

返回值

m_getheader

Get the name of the column in a comma-delimited response

说明

string m_getheader ( resource $conn , int $identifier , int $column_num )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

identifier

column_num

返回值

m_initconn

Create and initialize an MCVE_CONN structure

说明

resource m_initconn ( void )

Warning

本函数还未编写文档,仅有参数列表。

返回值

Returns an MCVE_CONN resource.

参见

  • m_destroyconn

m_initengine

Ready the client for IP/SSL Communication

说明

int m_initengine ( string $location )

Warning

本函数还未编写文档,仅有参数列表。

参数

location

返回值

m_iscommadelimited

Checks to see if response is comma delimited

说明

int m_iscommadelimited ( resource $conn , int $identifier )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

identifier

返回值

m_maxconntimeout

The maximum amount of time the API will attempt a connection to MCVE

说明

bool m_maxconntimeout ( resource $conn , int $secs )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

secs

返回值

m_monitor

Perform communication with MCVE (send/receive data) Non-blocking

说明

int m_monitor ( resource $conn )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

返回值

m_numcolumns

Number of columns returned in a comma delimited response

说明

int m_numcolumns ( resource $conn , int $identifier )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

identifier

返回值

m_numrows

Number of rows returned in a comma delimited response

说明

int m_numrows ( resource $conn , int $identifier )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

identifier

返回值

m_parsecommadelimited

Parse the comma delimited response so m_getcell, etc will work

说明

int m_parsecommadelimited ( resource $conn , int $identifier )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

identifier

返回值

m_responsekeys

Returns array of strings which represents the keys that can be used for response parameters on this transaction

说明

array m_responsekeys ( resource $conn , int $identifier )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

identifier

返回值

m_responseparam

Get a custom response parameter

说明

string m_responseparam ( resource $conn , int $identifier , string $key )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

identifier

key

返回值

m_returnstatus

Check to see if the transaction was successful

说明

int m_returnstatus ( resource $conn , int $identifier )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

identifier

返回值

m_setblocking

Set blocking/non-blocking mode for connection

说明

int m_setblocking ( resource $conn , int $tf )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

tf

返回值

m_setdropfile

Set the connection method to Drop-File

说明

int m_setdropfile ( resource $conn , string $directory )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

directory

返回值

m_setip

Set the connection method to IP

说明

int m_setip ( resource $conn , string $host , int $port )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

host

port

返回值

m_setssl_cafile

Set SSL CA (Certificate Authority) file for verification of server certificate

说明

int m_setssl_cafile ( resource $conn , string $cafile )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

cafile

返回值

m_setssl_files

Set certificate key files and certificates if server requires client certificate verification

说明

int m_setssl_files ( resource $conn , string $sslkeyfile , string $sslcertfile )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

sslkeyfile

sslcertfile

返回值

m_setssl

Set the connection method to SSL

说明

int m_setssl ( resource $conn , string $host , int $port )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

host

port

返回值

m_settimeout

Set maximum transaction time (per trans)

说明

int m_settimeout ( resource $conn , int $seconds )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

seconds

返回值

m_sslcert_gen_hash

Generate hash for SSL client certificate verification

说明

string m_sslcert_gen_hash ( string $filename )

Warning

本函数还未编写文档,仅有参数列表。

参数

filename

返回值

m_transactionssent

Check to see if outgoing buffer is clear

说明

int m_transactionssent ( resource $conn )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

返回值

m_transinqueue

Number of transactions in client-queue

说明

int m_transinqueue ( resource $conn )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

返回值

m_transkeyval

Add key/value pair to a transaction. Replaces deprecated transparam()

说明

int m_transkeyval ( resource $conn , int $identifier , string $key , string $value )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

identifier

key

value

返回值

m_transnew

Start a new transaction

说明

int m_transnew ( resource $conn )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

返回值

m_transsend

Finalize and send the transaction

说明

int m_transsend ( resource $conn , int $identifier )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

identifier

返回值

m_uwait

Wait x microsecs

说明

int m_uwait ( int $microsecs )

Warning

本函数还未编写文档,仅有参数列表。

参数

microsecs

返回值

m_validateidentifier

Whether or not to validate the passed identifier on any transaction it is passed to

说明

int m_validateidentifier ( resource $conn , int $tf )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

tf

返回值

m_verifyconnection

Set whether or not to PING upon connect to verify connection

说明

bool m_verifyconnection ( resource $conn , int $tf )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

tf

返回值

m_verifysslcert

Set whether or not to verify the server ssl certificate

说明

bool m_verifysslcert ( resource $conn , int $tf )

Warning

本函数还未编写文档,仅有参数列表。

参数

conn
m_initengine 返回的 MCVE_CONN 资源。

tf

返回值

目录

  • m_checkstatus — Check to see if a transaction has completed
  • m_completeauthorizations — Number of complete authorizations in queue, returning an array of their identifiers
  • m_connect — Establish the connection to MCVE
  • m_connectionerror — Get a textual representation of why a connection failed
  • m_deletetrans — Delete specified transaction from MCVE_CONN structure
  • m_destroyconn — Destroy the connection and MCVE_CONN structure
  • m_destroyengine — Free memory associated with IP/SSL connectivity
  • m_getcell — Get a specific cell from a comma delimited response by column name
  • m_getcellbynum — Get a specific cell from a comma delimited response by column number
  • m_getcommadelimited — Get the RAW comma delimited data returned from MCVE
  • m_getheader — Get the name of the column in a comma-delimited response
  • m_initconn — Create and initialize an MCVE_CONN structure
  • m_initengine — Ready the client for IP/SSL Communication
  • m_iscommadelimited — Checks to see if response is comma delimited
  • m_maxconntimeout — The maximum amount of time the API will attempt a connection to MCVE
  • m_monitor — Perform communication with MCVE (send/receive data) Non-blocking
  • m_numcolumns — Number of columns returned in a comma delimited response
  • m_numrows — Number of rows returned in a comma delimited response
  • m_parsecommadelimited — Parse the comma delimited response so m_getcell, etc will work
  • m_responsekeys — Returns array of strings which represents the keys that can be used for response parameters on this transaction
  • m_responseparam — Get a custom response parameter
  • m_returnstatus — Check to see if the transaction was successful
  • m_setblocking — Set blocking/non-blocking mode for connection
  • m_setdropfile — Set the connection method to Drop-File
  • m_setip — Set the connection method to IP
  • m_setssl_cafile — Set SSL CA (Certificate Authority) file for verification of server certificate
  • m_setssl_files — Set certificate key files and certificates if server requires client certificate verification
  • m_setssl — Set the connection method to SSL
  • m_settimeout — Set maximum transaction time (per trans)
  • m_sslcert_gen_hash — Generate hash for SSL client certificate verification
  • m_transactionssent — Check to see if outgoing buffer is clear
  • m_transinqueue — Number of transactions in client-queue
  • m_transkeyval — Add key/value pair to a transaction. Replaces deprecated transparam()
  • m_transnew — Start a new transaction
  • m_transsend — Finalize and send the transaction
  • m_uwait — Wait x microsecs
  • m_validateidentifier — Whether or not to validate the passed identifier on any transaction it is passed to
  • m_verifyconnection — Set whether or not to PING upon connect to verify connection
  • m_verifysslcert — Set whether or not to verify the server ssl certificate