PHP: Difference between revisions

From nuBuilderForte
Jump to navigation Jump to search
No edit summary
Line 16: Line 16:
</pre>|description=<!-- DESCRIPTION -->
</pre>|description=<!-- DESCRIPTION -->
Returns an array of field names from a database table.
Returns an array of field names from a database table.
|example=<!-- EXAMPLE --><pre style="background-color:#F2EBFF">
|example=<!-- EXAMPLE --><pre style="background-color:#b9bcd6">
$a = db_columns('customer');
$a = db_columns('customer');
nuDebug($a);
nuDebug($a);
Line 46: Line 46:
</pre>|description=<!-- DESCRIPTION -->
</pre>|description=<!-- DESCRIPTION -->
A function for looping through the result of a SELECT query returned from [[PHP#nuRunQuery|nuRunQuery]].
A function for looping through the result of a SELECT query returned from [[PHP#nuRunQuery|nuRunQuery]].
|example=<!-- EXAMPLE --><pre style="background-color:#F2EBFF">
|example=<!-- EXAMPLE --><pre style="background-color:#b9bcd6">


$s = "SELECT * FROM customer";
$s = "SELECT * FROM customer";
Line 76: Line 76:
$object  : PDO object.  
$object  : PDO object.  
</pre>|description=<!-- DESCRIPTION -->
</pre>|description=<!-- DESCRIPTION -->
A function for looping through the result of a SELECT query returned from [[PHP#nuRunQuery|nuRunQuery]].|example=<!-- EXAMPLE --><pre style="background-color:#F2EBFF">
A function for looping through the result of a SELECT query returned from [[PHP#nuRunQuery|nuRunQuery]].|example=<!-- EXAMPLE --><pre style="background-color:#b9bcd6">


$s = "SELECT * FROM customer";
$s = "SELECT * FROM customer";
Line 107: Line 107:
$object  : PDO object.  
$object  : PDO object.  
</pre>|description=<!-- DESCRIPTION -->
</pre>|description=<!-- DESCRIPTION -->
A function for looping through the result of a SELECT query returned from [[PHP#nuRunQuery|nuRunQuery]].|example=<!-- EXAMPLE --><pre style="background-color:#F2EBFF">
A function for looping through the result of a SELECT query returned from [[PHP#nuRunQuery|nuRunQuery]].|example=<!-- EXAMPLE --><pre style="background-color:#b9bcd6">


$s = "SELECT * FROM customer";
$s = "SELECT * FROM customer";
Line 139: Line 139:
</pre>|description=<!-- DESCRIPTION -->
</pre>|description=<!-- DESCRIPTION -->
The number of records in the result from  [[PHP#nurunquery|nuRunQuery]].
The number of records in the result from  [[PHP#nurunquery|nuRunQuery]].
|example=<!-- EXAMPLE --><pre style="background-color:#F2EBFF">
|example=<!-- EXAMPLE --><pre style="background-color:#b9bcd6">


$s = "SELECT * FROM customer";
$s = "SELECT * FROM customer";
Line 166: Line 166:
</pre>|description=<!-- DESCRIPTION -->
</pre>|description=<!-- DESCRIPTION -->
Adds Javascript to a Form before it loads.
Adds Javascript to a Form before it loads.
|example=<!-- EXAMPLE --><pre style="background-color:#F2EBFF">
|example=<!-- EXAMPLE --><pre style="background-color:#b9bcd6">


$j = "console.log(1234);
$j = "console.log(1234);
Line 192: Line 192:
</pre>|description=<!-- DESCRIPTION -->
</pre>|description=<!-- DESCRIPTION -->
This function takes up to 10 parameters and creates a record in the '''Debug''' Form for testing purposes.
This function takes up to 10 parameters and creates a record in the '''Debug''' Form for testing purposes.
|example=<!-- EXAMPLE --><pre style="background-color:#F2EBFF">
|example=<!-- EXAMPLE --><pre style="background-color:#b9bcd6">


$s = 'Hello world';
$s = 'Hello world';
Line 238: Line 238:
</pre>|description=<!-- DESCRIPTION -->
</pre>|description=<!-- DESCRIPTION -->
This adds an error that will stop the current event running and display the error message.
This adds an error that will stop the current event running and display the error message.
|example=          <!-- EXAMPLE --><pre style="background-color:#F2EBFF">
|example=          <!-- EXAMPLE --><pre style="background-color:#b9bcd6">
nuDisplayError('That did not work!');
nuDisplayError('That did not work!');
</pre>|result=    <!-- RESULT --><pre>
</pre>|result=    <!-- RESULT --><pre>
Line 261: Line 261:
</pre>|description=<!-- DESCRIPTION -->
</pre>|description=<!-- DESCRIPTION -->
This adds a message that will be displayed after the current event completes.
This adds a message that will be displayed after the current event completes.
|example=          <!-- EXAMPLE --><pre style="background-color:#F2EBFF">
|example=          <!-- EXAMPLE --><pre style="background-color:#b9bcd6">
nuDisplayMessage('That did work!');
nuDisplayMessage('That did work!');
</pre>|result=    <!-- RESULT --><pre>
</pre>|result=    <!-- RESULT --><pre>
Line 284: Line 284:
</pre>|description=<!-- DESCRIPTION -->
</pre>|description=<!-- DESCRIPTION -->
Returns a list of [[Hash Variables]] available to use in PHP.
Returns a list of [[Hash Variables]] available to use in PHP.
|example=          <!-- EXAMPLE --><pre style="background-color:#F2EBFF">
|example=          <!-- EXAMPLE --><pre style="background-color:#b9bcd6">
nuDebug(nuHash());
nuDebug(nuHash());
</pre>|result=    <!-- RESULT --><pre>
</pre>|result=    <!-- RESULT --><pre>
Line 360: Line 360:


So that the user can tell if a record is being cloned or saved for the first time.
So that the user can tell if a record is being cloned or saved for the first time.
|example=<!-- EXAMPLE --><pre style="background-color:#F2EBFF">
|example=<!-- EXAMPLE --><pre style="background-color:#b9bcd6">
if(nuHasNewRecordID()){
if(nuHasNewRecordID()){
     nuUpdateCounter($r->zzzzsys_object_id);
     nuUpdateCounter($r->zzzzsys_object_id);
Line 381: Line 381:
</pre>|description=<!-- DESCRIPTION -->
</pre>|description=<!-- DESCRIPTION -->
Creates a random string.
Creates a random string.
|example=<!-- EXAMPLE --><pre style="background-color:#F2EBFF">
|example=<!-- EXAMPLE --><pre style="background-color:#b9bcd6">
nuDebug(nuID());
nuDebug(nuID());
</pre>|result=<!-- RESULT --><pre>
</pre>|result=<!-- RESULT --><pre>
Line 404: Line 404:
</pre>|description=<!-- DESCRIPTION -->
</pre>|description=<!-- DESCRIPTION -->
Returns all fields from a selected [[Objects#Lookup|Lookup]] record.
Returns all fields from a selected [[Objects#Lookup|Lookup]] record.
|example=<!-- EXAMPLE --><pre style="background-color:#F2EBFF">
|example=<!-- EXAMPLE --><pre style="background-color:#b9bcd6">
nuDebug(nuLookupRecord());
nuDebug(nuLookupRecord());
</pre>|result=<!-- RESULT --><pre>
</pre>|result=<!-- RESULT --><pre>
Line 438: Line 438:
</pre>|description=<!-- DESCRIPTION -->
</pre>|description=<!-- DESCRIPTION -->
Remove tabs, new lines, and carriage returns from a string.
Remove tabs, new lines, and carriage returns from a string.
|example=<!-- EXAMPLE --><pre style="background-color:#F2EBFF">
|example=<!-- EXAMPLE --><pre style="background-color:#b9bcd6">


$s = "SELECT cus_name,
$s = "SELECT cus_name,
Line 471: Line 471:
This Object can be used by [[PHP#db_fetch_object|db_fetch_object]], [[PHP#db_fetch_array|db_fetch_array]], [[PHP#db_fetch_row|db_fetch_row]], [[PHP#db_num_rows|db_num_rows]]
This Object can be used by [[PHP#db_fetch_object|db_fetch_object]], [[PHP#db_fetch_array|db_fetch_array]], [[PHP#db_fetch_row|db_fetch_row]], [[PHP#db_num_rows|db_num_rows]]


|example=          <!-- EXAMPLE --><pre style="background-color:#F2EBFF">
|example=          <!-- EXAMPLE --><pre style="background-color:#b9bcd6">


$s  = "SELECT * FROM customer WHERE customer_id = '#LOOKUP_RECORD_ID#'
$s  = "SELECT * FROM customer WHERE customer_id = '#LOOKUP_RECORD_ID#'
Line 504: Line 504:
</pre>|description=<!-- DESCRIPTION -->
</pre>|description=<!-- DESCRIPTION -->
Updates an Object on an Edit Form [[Procedures#After_Browse|After Browse]] after a Lookup value is chosen.
Updates an Object on an Edit Form [[Procedures#After_Browse|After Browse]] after a Lookup value is chosen.
|example=          <!-- EXAMPLE --><pre style="background-color:#F2EBFF">
|example=          <!-- EXAMPLE --><pre style="background-color:#b9bcd6">


nuSetFormValue('cus_name', nuLookupRecord()->com_name);
nuSetFormValue('cus_name', nuLookupRecord()->com_name);
Line 527: Line 527:
</pre>|description=<!-- DESCRIPTION -->
</pre>|description=<!-- DESCRIPTION -->
Returns a PHP object that can be looped through.
Returns a PHP object that can be looped through.
|example=<!-- EXAMPLE --><pre style="background-color:#F2EBFF">
|example=<!-- EXAMPLE --><pre style="background-color:#b9bcd6">
nuDebug(nuSubformObject('invoice_item_sf'));
nuDebug(nuSubformObject('invoice_item_sf'));
</pre>|result=<!-- RESULT --><pre>
</pre>|result=<!-- RESULT --><pre>
Line 645: Line 645:
Creates a unique ID starting with '''__nu'''.
Creates a unique ID starting with '''__nu'''.


|example=          <!-- EXAMPLE --><pre style="background-color:#F2EBFF">
|example=          <!-- EXAMPLE --><pre style="background-color:#b9bcd6">
$tmp = nuTT();
$tmp = nuTT();



Revision as of 03:45, 16 July 2017

Template:function_header

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);

nuDebug()

[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);

}

nuDebug()

[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]);

}

nuDebug()

[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']);

}

nuDebug()

[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);

nuDebug()

[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);

nuDebug()



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);

nuDebug()

[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 that will stop the current event running and display the error message.

Example

nuDisplayError('That did not work!');

nuDebug()



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!');

nuDebug()



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());

nuDebug()

[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());

nuDebug()

[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_addressFROM 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);

nuDebug()



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);

nuDebug()



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


nuTT

$string = nuTT()

Parameters


Return Value

$string  : name for temp table.

Description

Creates a unique ID starting with __nu.

Example

$tmp = nuTT();

$s   = "CREATE TABLE $t SELECT * FROM customer";

nuRunQuery($tmp);

nuDebug()



Also See : nuID