Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
outlinetrue
stylenone

Each of the different types of Custom Logic: Custom Events, Custom API, Custom Validation, and Custom Reports share these common syntaxes and available functions.

Parameters

$sql The query string. All data inside the query should be bound with named bind variables or properly escaped.
$bind_parameters An array of key value pairs with elements that are bound parameters in the SQL statement being executed. Array key names match the named bind variables in the SQL statement.

Return Values

Returns FALSE on failure. For successful queries, query() will return an array of data.

listGetByCode

Lookup the RECID(s) for the List determined by the type and the code(s).

Code Block
languagephp
mixed $this->listGetByCode ( string $list_type, mixed $list_code );
Parameters

$list_type The List Type specification of the desired record.
$list_code A string or array specifying the one or more List Codes belonging to the specified List Type. Only RECIDs for valid Codes will be returned. An array of three codes where one is invalid will return an array of two valid RECIDs.

Return Values

Returns a List RECID or array of List RECIDs if records were found. Returns NULL if nothing is found.

listFindValue

Lookup the List value for given List RECID.

Code Block
languagephp
string $this->listGetByCode ( int $recid );
Parameters

$recid The List Recid to find in the LISTS table.

Return Values

List Value of the specified record. Returns NULL if nothing is found.

listFindCode

Lookup the List code for given List RECID.

Code Block
languagephp
string $this->listGetByCode ( int $recid );
Parameters

$recid The List Recid to find in the LISTS table.

Return Values

List Code of the specified record. Returns NULL if nothing is found.

Include Page
isMissingRequiredParameterstrue

...

Child pages (Children Display)
allChildrentrue