\Blackpulp\MinistryPlatformStoredProcedureResult

__construct()

__construct(\SimpleXMLElement  $result) 

Initialize the object

Parameters

getTableCount()

getTableCount() : integer

Get the number of tables in the current stored procedure result.

Returns

getTables()

getTables() 

Retrieve the tables returned by the Stored Procedure.

getTable()

getTable(integer  $key) : array

Retrieve a single table.

Parameters

Returns

getTableKeyValuePair()

getTableKeyValuePair(integer  $key) : array

Associative array of values from a Stored Procedure Table.

When a stored procedure table returns an array of arrays, this can be helpful in retrieving only the first two fields of data as a key value pair.

For example, an array that contains a Prefix_ID and Prefix_Name would ideally provide an a value of $prefixes[Prefix_ID] => Prefix_Name. This is precisely what this method will do. Please note that it will ignore and discard any additional fields that may be in the array.

Parameters

Returns

A $key->$value array.

getRaw()

getRaw() : \SimpleXMLElement

Get the Raw response object.

Returns

getSchema()

getSchema() : \SimpleXMLElement

Get the Schema object.

Returns

setTableCount()

setTableCount() 

Set the table count.

setTables()

setTables() 

Parse the XML into a series of arrays.

processTableContents()

processTableContents(\SimpleXMLElement  $contents) : array

Digest the table contents.

Convert XML Element contents into one or more arrays of data.

Parameters

Returns

processXMLElement()

processXMLElement(\SimpleXMLElement  $element) : array

Process a single Element into an array of elements.

Also detects nested elements and processes those, and handles some data type detection.

Parameters

Returns

checkForErrors()

checkForErrors() 

Error handling for Stored Procedure API calls.

Check to see if the API call returned an error. If so, throw an exception and prevent things form continuing on.