PHP: Difference between revisions
No edit summary |
|||
| Line 1: | Line 1: | ||
[[Template:php_sprera]] | |||
Each of the purple diamonds represents PHP code that can be run and when. | Each of the purple diamonds represents PHP code that can be run and when. | ||
Revision as of 02:01, 31 July 2017
Template:php_sprera Each of the purple diamonds represents PHP code that can be run and when.
eg.
<source lang="php">
$s = "UPDATE stock SET sto_units = 99 WHERE stock_id = '#RECORD_ID#';"
nuRunQuery($s);
</source>
db_columns
$array = db_columns($string1)
Parameters
$string1 : Database table name.
Return Value
$array : Field names.
Description
Returns an array of field names from a database table.
Example
$a = db_columns('customer');
nuDebug($a);
[0] : Array
(
[0] => customer_id
[1] => cus_name
[2] => cus_phone
[3] => cus_address
)
Also See :
db_fetch_array, db_fetch_object, db_fetch_row, db_num_rows
db_fetch_object
$object = db_fetch_object($object1)
Parameters
$object1 : nuRunQuery() result.
Return Value
$object : PDO object
Description
A function for looping through the result of a SELECT query returned from nuRunQuery.
Example
$s = "SELECT * FROM customer";
$t = nuRunQuery($s);
while($r = db_fetch_object($t)){
nuDebug('His name is : ' . $r->cus_name);
}
[0]: His name is : Robert Paulson
Also See :
db_columns, db_fetch_array, db_fetch_row, db_num_rows, nuRunQuery
db_fetch_row
$object = db_fetch_row($object1)
Parameters
$object1 : nuRunQuery() result.
Return Value
$object : PDO object.
Description
A function for looping through the result of a SELECT query returned from nuRunQuery.
Example
$s = "SELECT * FROM customer";
$t = nuRunQuery($s);
while($r = db_fetch_row($t)){
nuDebug('His name is : ' . $r[4]);
}
[0]: His name is : Robert Paulson
Also See :
db_columns, db_fetch_array, db_fetch_object, db_num_rows, nuRunQuery
db_fetch_array
$object = db_fetch_array($object1)
Parameters
$object1 : nuRunQuery() result.
Return Value
$object : PDO object.
Description
A function for looping through the result of a SELECT query returned from nuRunQuery.
Example
$s = "SELECT * FROM customer";
$t = nuRunQuery($s);
while($r = db_fetch_array($t)){
nuDebug('His name is : ' . $r['cus_name']);
}
[0]: His name is : Robert Paulson
Also See :
db_columns, db_fetch_row, db_fetch_object, db_num_rows, nuRunQuery
db_num_rows
$integer = db_num_rows($object1)
Parameters
$object1 : PDO object.
Return Value
$integer : Number of records returned.
Description
The number of records in the result from nuRunQuery.
Example
$s = "SELECT * FROM customer"; $t = nuRunQuery($s); nuDebug(db_num_rows($t);
[0]: 3453
Also See :
db_columns, db_fetch_array, db_fetch_object, db_fetch_row, nuRunQuery
nuAddJavascript
nuAddJavascript($string1)
Parameters
$string1 : Javascript code.
Return Value
Description
Adds Javascript to a Form before it loads.
Example
$j = "console.log(1234); nuAddJavascript($j);
Also See :
Before Browse, Before Edit
nuDebug
nuDebug($anytype1, $anytype2..)
Parameters
$anytypes : string, object or array.
Return Value
Description
This function takes up to 10 parameters and creates a record in the Debug Form for testing purposes.
Example
$s = 'Hello world'; $a = [1,2,3,4]; $o = ['name' => 'Bob', 'phone' => '555 123456']; nuDebug($s, $a, $o); nuAddJavascript($j);
[0] : Hello world
[1] : Array
(
[0] => 1
[1] => 2
[2] => 3
[3] => 4
)
[2] : Array
(
[name] => Bob
[phone] => 555 123456
)
Also See :
Before Browse, Before Edit, Before Save,After Save, Before Delete, After Delete
nuDisplayError
nuDisplayError($string1)
Parameters
$string1 : error message.
Return Value
Description
This adds an error message that will stop the current event running and display the error message.
If any error messages are created in Before Save or Before Delete the current record will not be saved or be deleted.
eg.
- No messages = Continue to Save or Delete record.
- One or more messages = No not Save or Delete record.
(The green Yes or red No elements in the flowchart above.)
Example
nuDisplayError('That did not work!');
Also See :
Before Save, Before Delete
nuDisplayMessage
nuDisplayMessage($string1)
Parameters
$string1 : message.
Return Value
Description
This adds a message that will be displayed after the current event completes.
Example
nuDisplayMessage('That did work!');
Also See :
nuHash
$array = nuHash()
Parameters
Return Value
$array : list of Hash Variables.
Description
Returns a list of Hash Variables available to use in PHP.
Example
nuDebug(nuHash());
[0] : Array
(
[USER_ID] => globeadmin
[USER_GROUP_ID] =>
[HOME_ID] =>
[GLOBAL_ACCESS] => 1
[invoice_id] => s14919516899490
[inv_company_id] =>
[inv_number] => 53
[inv_total] => 215.3
[inv_date] => 2017-03-19 00:00:00
[record_id] => s14919516899490
[title] => Invoice
[call_type] => getlookupid
[iframe] => 0
[lookup_id] =>
[object_id] => s14967319482165
[page_number] => 0
[password] =>
[rows] => 20
[row_height] => 25
[session_id] => s15001161980910
[sort] => -1
[sort_direction] => desc
[subforms] => 0
[username] =>
[user_id] => globeadmin
[58a08a1abc4782c] => s14919516899490
[FORM_ID] => 58a08a1abc4782c
[PREVIOUS_RECORD_ID] => s14919516899490
[RECORD_ID] => s14919516899490
[form_id] => 58a08a1abc4782c
[redirect_form_id] => 58a08a1abc4782c
[browse_sql] =>
[browse_rows] =>
[pages] => 0
[prefix] =>
[primary_key] => 57295aa5660f48b
[inv_gst] => 0
[inv_gst2] => 0
[test] =>
[SUBFORM_ID] => s14967319482165
[ID] => 57295aa5660f48b
[CODE] =>
[nuFORMdata] =>
[TABLE_ID] => ___nu15969f4ed5b744___
[SESSION_ID] => s15001161980910
[data] =>
[LOOKUP_RECORD_ID] => 57295aa5660f48b
)
Also See :
nuHasNewRecordID
$boolean = nuHasNewRecordID()
Parameters
Return Value
$boolean : yes or no.
Description
Matches #PREVIOUS_RECORD_ID# with #RECORD_ID# and returns true or false.
So that the user can tell if a record is being cloned or saved for the first time.
Example
if(nuHasNewRecordID()){
nuUpdateCounter($r->zzzzsys_object_id);
}
Also See :
nuID
$string = nuID()
Parameters
Return Value
$string : random string.
Description
Creates a random string.
Example
nuDebug(nuID());
[0] : s14998774217939
Also See :
nuTT, nuID
Before Save,After Save
nuLookupRecord
$object = nuLookupRecord()
Parameters
Return Value
$object : every field from the selected record
Description
Returns all fields from a selected Lookup record.
Example
nuDebug(nuLookupRecord());
[0] : stdClass Object
(
[company_id] => 58ade54dac2128b
[com_code] => 777
[com_name] => 7 Up
[com_business_id] => 568a00c77f8f709
[com_company_id] =>
[com_color_id] => 568ef5a6968322b#nuSep#568ef920846a089
[com_age] => 3
[com_notes] =>
[com_test] =>
)
Also See :
After Browse, nuSetFormValue
nuRemoveNonCharacters
$string = nuRemoveNonCharacters($string1)
Parameters
$string1 : A string with non characters
Return Value
$string : A string with just characters
Description
Remove tabs, new lines, and carriage returns from a string.
Example
$s = "SELECT cus_name, cus_phone, cus_address FROM customer "; nuDebug(nuRemoveNonCharacters($s));
[0] : SELECT cus_name,cus_phone,cus_address FROM customer
Also See :
nuRunQuery
$object = nuRunQuery($string1);
Parameters
$string1 : SQL query.
Return Value
$object : PDO object.
Description
Runs an SQL query and returns an Object (for SELECT Statements).
This Object can be used by db_fetch_object, db_fetch_array, db_fetch_row, db_num_rows
Example
$s = "SELECT * FROM customer WHERE customer_id = '#LOOKUP_RECORD_ID#'
";
$t = nuRunQuery($s);
$r = db_fetch_object($t);
nuSetFormValue('inv_address', $r->cus_address);
Also See :
db_fetch_object, db_fetch_array, db_fetch_row, db_num_rows
nuSetFormValue
nuSetFormValue($string1, $string2);
Parameters
$string1 = id of nuBuilder Object on current Edit Form. $string2 = value used to update $string1's Object.
Return Value
Description
Updates an Object on an Edit Form After Browse after a Lookup value is chosen.
Example
nuSetFormValue('cus_name', nuLookupRecord()->com_name);
Also See :
After Browse, nuLookupRecord
nuSubformObject
$object = nuSubformObject($string1)
Parameters
$string1 : subform id.
Return Value
$object : subform properties
Description
Returns a PHP object that can be looped through.
Example
nuDebug(nuSubformObject('invoice_item_sf'));
[0] : stdClass Object
(
[id] => invoice_item
[foreign_key] => ite_invoice_id
[primary_key] => invoice_item_id
[object_id] => 58a09180222faae
[table] => invoice_item
[action] => save
[rows] => Array
(
[0] => Array
(
[0] => s14941671441215
[1] => 6
[2] => thing1
[3] => 3
[4] => 18
[5] => 0
)
[1] => Array
(
[0] => s14998769369058
[1] => 4
[2] => thing2
[3] => 2
[4] => 8
[5] => 0
)
[2] => Array
(
[0] => -1
[1] =>
[2] =>
[3] =>
[4] =>
[5] => 1
)
)
[edited] => Array
(
[0] => Array
(
[0] => 0
[1] => 0
[2] => 0
[3] => 0
[4] => 0
[5] => 0
)
[1] => Array
(
[0] => 0
[1] => 0
[2] => 0
[3] => 0
[4] => 0
[5] => 0
)
[2] => Array
(
[0] => 0
[1] => 0
[2] => 0
[3] => 0
[4] => 0
[5] => 0
)
)
[deleted] => Array
(
[0] => 0
[1] => 0
[2] => 1
)
[fields] => Array
(
[0] => ID
[1] => ite_units
[2] => ite_thing
[3] => ite_unit_price
[4] => ite_total
[5] => nuDelete
)
)
Also See :
nuSubformObject