Methods handling - Revision history

Gityerfix: Reverted edits by Agegeleruvy (Talk); changed back to last version by FrankTR

2010-11-30T05:25:11Z

Reverted edits by Agegeleruvy (Talk); changed back to last version by FrankTR

Agegeleruvy at 03:30, 24 November 2010

2010-11-24T03:30:03Z

FrankTR: reverting vandalism

2010-11-18T12:44:02Z

reverting vandalism

Agegeleruvy at 00:44, 18 November 2010

2010-11-18T00:44:39Z

Zjz: /* Parameters handling */

2008-09-19T07:29:02Z

‎Parameters handling

Gityerfix at 18:23, 16 September 2008

2008-09-16T18:23:26Z

Kowy: New page: NOTOC Category:Spel == Method calling == Methods can be called from triggers or using Send_wait function. Here is an example of trigger (call method ''conv...

2008-09-16T14:58:17Z

New page: __NOTOC__ Category:Spel == Method calling == Methods can be called from triggers or using Send_wait function. Here is an example of trigger (call method ''conv...

New page

__NOTOC__
[[Category:Spel]]
== Method calling ==
Methods can be called from [[Object_Triggers|triggers]] or using [[Send_wait]] function.

Here is an example of trigger (call method ''convert_request'' with one parameter):
<source lang="text">
POST_VALIDATE convert_request( persistent_id ) 96 FILTER(EVENT("INSERT"));
</source>

== Method definition ==
You can define new methods on every object. This definition must be in file with SPL extension in [[$NX_ROOT]]/site/mods/majic folder. In one file you can define more than one method and even for more than one class.

Here is the base structure of new method called '''newMethod''' on object '''cr''' with variable number of parameters:
<source lang="javascript">
void cr::newMethod (...)
{

}
</source>
Use method definition with ''(...)'' even if no parameters are expected.

=== Parameters handling ===
Parameters are passed into the method in '''argv''' array. Each parameters are in triplets. Here is the explanation of argv values:
*argv[0] - number of parameters
*argv[1] - name of the first parameter
*argv[2] - ''unknown''
*argv[3] - value of the first parameter
*argv[4] - name of the second parameter
*argv[5] - ''unknown''
*argv[6] - value of the second parameter
and so on

== Overriding methods ==
If you want to override some built-in method, simply define method with the same name (object::methodName) and write your new body.

@@ Line 1: / Line 1: @@
 __NOTOC__
 [[Category:Customizations]]
@@ Line 18: / Line 10: @@
 Here is an example of trigger (call method ''convert_request'' with one parameter):
-&lt;source lang=&quot;text&quot;&gt;
+<source lang="text">
-POST_VALIDATE convert_request( persistent_id ) 96 FILTER(EVENT(&quot;INSERT&quot;));
+POST_VALIDATE convert_request( persistent_id ) 96 FILTER(EVENT("INSERT"));
-&lt;/source&gt;
+</source>
 == Method definition ==
@@ Line 26: / Line 18: @@
 Here is the base structure of new method called '''newMethod''' on object '''cr''' with variable number of parameters:
-&lt;source lang=&quot;javascript&quot;&gt;
+<source lang="javascript">
 void cr::newMethod (...)
+{
+}
-&lt;/source&gt;
+</source>
 Use method definition with ''(...)'' even if no parameters are expected.

@@ Line 30: / Line 30: @@
 *argv[0] - number of parameters
 *argv[1] - name of the first parameter
-*argv[2] - ''unknown''
+*argv[2] - previous value of the first parameter
-*argv[3] - value of the first parameter
+*argv[3] - actual value of the first parameter
 *argv[4] - name of the second parameter
-*argv[5] - ''unknown''
+*argv[5] - previous value of the second parameter
-*argv[6] - value of the second parameter
+*argv[6] - actual value of the second parameter
 and so on
 == Overriding methods ==
 If you want to override some built-in method, simply define method with the same name (object::methodName) and write your new body.