Developing related modules: Page 2 - OLD Forum of Users and Developers of Epesi BIM

Developing related modules

ajb

Netbeans is easy to use and you should find a lot of tutorials how to use it.
http://netbeans.org/kb/trails/php.html

erwin

I wonder why the display_callback function I wrote does't display the calculated data on the screen everytime.

The field definition:

			array('name'=>'Unit',

				'type'=>'calculated',

				'param'=>Utils_RecordBrowserCommon::actual_db_type('text',4), 

				'required'=>true,

				'visible'=>true,

				'extra'=>false,

				'display_callback'=>array('Premium_OrdersCommon', 'display_unit'))

The display methods:

 	public static function get_product_id($v, $nolink=false) {

		return Utils_RecordBrowserCommon::get_id('crm_Products','product name', $v['product_name']);

		

	}

	public static function display_unit($v, $nolink=false){

		$id = self::get_product_id($v['product_name']);

		$record = Utils_RecordBrowserCommon::get_record('crm_Products', $id);

		return $record['unit'];

Sometimes the correct 'unit' is displayed when the user press the Save button. I want the unit and the price to be displayed imediately after the user select a product name from the product list, not when save the record. Also, I want to display the sale price and after the user input the quantity, the calculated value to be displayed, before the saving action.

I need to understand what are the RB equivalent and how to write specific methods for the events: init, while and valid. Also, I want to know how the key fields are linked to the functions, I saw sometimes array, sometimes values, sometimes key name. Why inside the function there are used different variables or arrays instead key field names?

Thanks again,
Regards,
Tavi.

ajb

Hi!

Display callback is function that is called when RecordBrowser shows value of certain field. In your case it's 'Unit'. It's used to display value when you are in table view. There is also QFfield callback which is called when RB uses QuickForm to show data. It's in case of add/edit and also single record view mode. By default for view mode display callback is called for every field. If you define your own QFfield callback for field you have control over QuickForm.

Your code for Unit field retrieves some data from DB, but it happens only once, when user opens record. And for adding record $v['product name'] may be null. When you edit record $v['product name'] may has some value, but after page load no php code gets executed. You have to define some ajax callback for onchange event of 'product name' select, or set that whole form gets refreshed.

To achieve the second solution you can use this code in Qffield callback (because you need $form), where $field should be your select field for 'product name':

eval_js('Event.observe("'.$field.'", "change", function(event) {' . $form->get_submit_form_js(false) . '});');

I assume that you're fimiliar with our RB documentation. You can read also our wiki about most recent feature to simplify using of RB with object wrapper.

Best regards,
Adam

erwin

Thank you, Adam. As I said, I'm learning everyday. I don't know nothing about java script or Ajax yet. My previous experience was only in Foxpro DOS, no windows, no OOP. I'm still trying to get the big picture of the Epesi framework. For the moment, cause I should finish soon the modules, I must use the old RB as I am familiar with it.

I don't understand what your code do? I must change something or write other functions?

Best regards,
Tavi

ajb

I assumed that your product_name field is select field. When you select some product, you want to get units from product description. So my code adds javascript to execute in epesi (eval_js function). Inside is prototype library code that adds event handler. Here event is `change`. It's like `onchange="<some js>"` property in html. So if selected value of product_name field has changed fire function that will refresh site.

I have to write some background for get_submit_form_js function. It returns javascript that called will cause submitting form. But when you call this function with `false` as parameter(like I did), form page will get refresh, but you will be still editing values. But all values set in fields will be set as defaults now.

You should define QFfield callback for Unit field. Here obtain product_name and unit to display. Also here register onchange event for product_name field.

public static function QFfield_unit(&$form, $field, $label, $mode, $default, $desc, $rb_obj) {

    $el = $form->addElement('text', $field, $label);

    $el->freeze();

    $product = $form->exportValue('product_name');

    if (is_numeric($product)) { // I assumed that this is id of product - not name

        $record = Utils_RecordBrowserCommon::get_record('crm_Products', $product);

        $form->setDefaults(array($field => $record['unit']));

    }

    eval_js('Event.observe("product_name", "change", function(event) {' . $form->get_submit_form_js(false) . '});');

}

I didn't test this code, but it should be ok. Now on every change of product name your page should refresh and unit field will get freezed(non editable) text field filled with unit from product.

Best regards,
Adam

erwin

Thanks again. The code worked allmost OK. The page refresh cause the quantity field not yet completed to display the error "field required". Could I avoid that?

At the saleprice QFfield_callback with the same approach, the field get a bad format, even if used the Utils_CurrencyCommon::format() method:

   public static function QFfield_price(&$form, $field, $label, $mode, $default, $desc, $rb_obj) {

        $el = $form->addElement('text', $field, $label);

        $el->freeze();

        $product_id = $form->exportValue('product_name');

        if (is_numeric($product_id)) { // I assumed that this is id of product - not name

            $record = Utils_RecordBrowserCommon::get_record('crm_Products', $product_id);

            $form->setDefaults(array($field => Utils_CurrencyFieldCommon::format($record['saleprice'])));

        }

        eval_js('Event.observe("product_name", "change", function(event) {' . $form->get_submit_form_js(false) . '});');

    }

example of a saleprice displayed on the form:

1,8&nbsp; Lei

and the calculated value ignore the mantissa part of the number.
After the user press the Save button both "unit" and "saleprice" fields are not displayed in the form, but they appear correctly on the browse.

In the mobile version this error appear when the add button is clicked:

Fatal error: Call to undefined method HTML_QuickForm::get_submit_form_js() in /home/burginfa/public_html/atena/modules/Premium/Orders/OrdersCommon_0.php on line 97

There is a strong require to work on mobile so I need to solve this soon.

Best regards,
Tavi

ajb

Because I've used text field - it does not interpret html entities like nbsp;
Value is not displayed in view mode because i've forgot about this in qffield callback.

In case of mobile RB edit I see that QFfield callback gets pure QuickForm object, so we cannot use get_submit_form_js, because it's our extension... I suggest to complicate this a little bit more and use ajax request to obtain value - not submit form.

Improved version of callback

public static function QFfield_unit(&$form, $field, $label, $mode, $default, $desc, $rb_obj) {

    $el = $form->addElement('text', $field, $label);

    $el->freeze();

    $form->setDefaults(array($field => $default));

    if ($mode != 'view') {

        load_js('modules/Premium/Orders/scripts.js');

        eval_js('Event.observe("product_name", "change", pname_change);

    }

}

scripts.js



function pname_change(event) {

    // obtain selected value

    // use Ajax.Request and pass selected value as parameter to some php file, onSuccess update value of hidden field and display text

    // http://prototypejs.org/doc/latest/ajax/Ajax/Request/index.html

}

and implement mentioned php file. e.g. ajaxunit.php



include("../../../include.php"); // include EPESI

ModuleManager::load_modules();

if (!Base_AclCommon::is_user()) exit();

$item = $_REQUEST['product']; // parameter passed by Ajax.Request

print Utils_RecordBrowserCommon::get_value('crm_Products', $item, 'unit');

erwin

Thanks, but I'm afraid I don't know anything about Ajax and what to write in the script.js. There must be a simple way to show the values of the "unit" and "saleprice" requested by selecting a product name. I'm sure that you already used something like that in your Inventory Management module. Is there any example in the CRM or Premium modules?

I had a different picture of what a form supposed to be in the display, add or edit modes. Any object on the screen representing a field on a database table must have the required properties I asked before: init = a default value to be displayed, when = to get the focus on some criteria and valid = to execute some code after the user imput data to validate data or calculate something. It will be very usefull at least to me if the RB has something equivalent.

I see in the EPESI modules there are functions with the Form variable "mode" switch. In the Edit mode or Add mode of the original SalesOpportunitiesCommon which my module is based, I couldn't put any code because errors appeared. I want to init some values when Add or calculate something in Edit mode.

Please help me to complete this function of the new module.

Best regards,
Tavi

ajb

Hi,

unfortunately Ajax is best solution here 🙂

There is an option to obtain all possible products with units, and encode this array into javascript, but for a lot of products it's inefficient. For simple example of ajax request and handler please have a look into modules/Base/Box/check_for_new_version.php and js file.

About init, when, valid. I think that such functionality is already in EPESI. At first have a look at processing callback. Second option to set default values is to call code right before display with set_defaults method.

public function assets_addon($arg) {

        $rb = $this->init_module('Utils/RecordBrowser','crm_assets','crm_assets_addon');

        $rb->set_defaults(array('company'=>$arg['id']));

        $this->display_module($rb, array(array('company'=>array($arg['id'])), array('company'=>false, 'active'=>true), array('asset_name'=>'ASC')), 'show_data');

    }

All "when" triggers like focus on field, select changed have to be linked with JS to some action. All actions that are not dynamic but related to view (e.g. when you display record if unit is kg, then show units in red) should be handled by QFfield or display callbacks. All actions related to data and not related to view should be handled by processing callback. Example processing callback you can find in CRM/AssetsCommon_0.php lines 87-100.

So to init some values use processing callback or QFfield callback or set_defaults. Which is better? It depends on specific situation. If you don't have to change view of any field or assign some dynamic (JS based) events, don't play with QFfield callbacks. If you need to calculate some specific field just before display probably processing callback is the best solution.

Best regards
Adam

erwin

Hi!
Thank you very much for your answer!

Meanwhile, I've solved the previous formatting error: the "saleprice" (string) is converted to float value, then the calculated "value" of the products get correct value. However, the "saleprice" don't get the currency format:

 $record = Utils_RecordBrowserCommon::get_record('crm_Products', $product_id);

            $saleprice=floatval(strip_tags($record['saleprice']));

            $form->setDefaults(array($field => $saleprice));

If calling the Utils_CurrencyCommon::format() method another error appeared.

I will try your suggestions this weekend and I hope to solve the mobile version error.

Best regards!
Tavi

ajb

I've never encountered any problems with currency field... Is your salesprice field of type currency? Cash amount with currency is stored in format <val>__<currency id>. e.g 12.34__1. Such strings should be formatted well by Utils_CurrencyFieldCommon::format.

Best regards,
Adam

erwin

Sorry, we encountered an error while displaying this content. If you're a user, please try again later. If you're an administrator, take a look in your Flarum log files for more information.

erwin

I still need help to write the Ajax code for selecting the "unit" and "saleprice" from the product table. The mobile version must work very soon. I cannot figure out how to use your example: check_for_new_version.php&js with my records.

I'm a little bit confused, cause the Record Browser did not work as I expected. I have try to put some code to calculate values in the submit_order (a processing callback) method but annoying errors appeared.

Tonight I've try to set a default value for the tax rate using your example. The empty ("---") value appear instead. I don't know how to set it to 24% - the default tax rate in Romania.

Please help.
Best regards,
Tavi

P.S.
When I try your code for the ajax version an unexpected effect appeared: the select "customer" field in the edit mode got 2 lines, one empty, no arrow button and the customer name list does not appear. The QFfield_callback of one field must avoid other fields side effects, otherwise this approach is entirely wrong, I guess.

ajb

I'm little bit confused about what you're going to achieve and after a lot of posts i'm lost in what you've done and what is not working.

I suggested some solutions with code examples and references to other modules and I don't want replace you in coding. You write that you need help to write the Ajax code, but I don't see any code that you've written so far.

My suggestion is that you can place here your custom modules that are related to your problem and I'll try to fix them. I don't want to do this out of public, because I think that somebody may find this code examples useful. If you want to hold your code private, then you have to cope with this at your own.

Best regards,
Adam

erwin

I wrote no ajax code yet. I suppose that the scripts.js do nothing for the moment, I expect that the QFfield_callback return eventualy an error, but I don't expect that will cause strange behaviour at other fields not linked.

Here we are:

public static function QFfield_unit(&$form, $field, $label, $mode, $default, $desc, $rb_obj) {

        $el = $form->addElement('text', $field, $label);

        $el->freeze();

        $form->setDefaults(array($field => $default));

        if ($mode != 'view') {

            load_js('modules/Premium/Orders/scripts.js');

            eval_js('Event.observe("product_name", "change", pname_change)');

        }

    }

scripts.js:

// scripts.js 

function pname_change(event) {

    // obtain selected value

    // use Ajax.Request and pass selected value as parameter to some php file, onSuccess update value of hidden field and display text

    // http://prototypejs.org/doc/latest/ajax/Ajax/Request/index.html

}

pnamechange.php:

// pname_change 

    include("../../../include.php"); // include EPESI

    ModuleManager::load_modules();

    if (!Base_AclCommon::is_user()) exit();

    $item = $_REQUEST['product']; // parameter passed by Ajax.Request

    print Utils_RecordBrowserCommon::get_value('crm_Products', $item, 'unit');

Sorry about misunderstanding. I've put many questions about many other problems. The most important is that the module should work on mobile.
The modules are too long to post. I don't wrote much custom code, most of it is based on Assets and Sales Opportunities modules, changed the names and fields accordingly to my needs. So, is not private. Attached in a zip.
Thank you and best regards.
Tavi

ajb

At first. Product Install.

1.
Translations are copied from old modules. You don't have to install_translations.

Utils_CommonDataCommon::new_array('crm_Products_tax_rate', array('24', '9', '5', '0'));

means

array(0 => '24', 1 => '9', 2 => '5', 3 => '0')

in DB stored is key of this array. Not value. There is no such thing as 'default' in field definition - use processing callback, QFfield callback or before set defaults before module display.

Same about products categories. You will get integer as value, because keys in this array are integers.

3.
You've set addon to company with function `Products_addon` from Products_0, but in that function



        $rb = $this->init_module('Utils/RecordBrowser','crm_Products','crm_Products_addon');

        $rb->set_header_properties(array(

                'product_id'=>array('width'=>10),

                'category'=>array('width'=>10),

                'product_name'=>array('width'=>15),

                'active'=>array('width'=>7)

            ));

        $rb->set_defaults(array('crm_products'=>$arg['id'],'tax_rate'=>24));

        $this->display_module($rb, array(array('crm_products'=>array($arg['id'])), array('crm_products'=>false, 'active'=>false), array('product name'=>'ASC')

you refer `crm_products` column from your products recordset, but there is no such column. Be aware that your argument $arg holds company record. So you're trying to display your records where your column `crm_products` (that doesn't exist) is set to some company id. In our Assets module is column named `company`. So in addon we choose only assets that are assigned to specific company.

You're setting tax_rate here to wrong value. Refer 2. If you leave your install as it is you should call set_defaults(array('tax_rate' => 0)) to have tax rate set to 24.

About orders i'll write tomorrow, because i'm out of time now.

Best regards,
Adam

erwin

Thank you very much, Adam! I will try tonite to solve the Products issues.

I don't need the Products to be linked with Companies, only with Orders. The product_addon is useless maybe?
Instead, I want to display a little window with product's info when the user hoover the mouse over the product_name in the Orders browse, like the customer info. Is this window display with applet_info or another method? Where is the code for that windows?

Best regards!
Tavi

erwin

I read about Ajax and understand that the Ajax.Request can change the content of a form on the page, dinamicaly, without reload the page.

// script.js 

function pname_change(event) {

    // obtain selected value

   new Ajax.Request("modules/Premium/Orders/pnameunit.php", {

		method: "post",

			parameters:{

				product: crm_Product.product_name

			},

			onSuccess:function(t) {

				$("product_name").innerHTML = t.responseText;

			}

		});

    // use Ajax.Request and pass selected value as parameter to some php file, onSuccess update value of hidden field and display text

    // http://prototypejs.org/doc/latest/ajax/Ajax/Request/index.html

}

The script does nothing, the unit does not appear on the screen. How to obtain the value of the "unit" coresponding to the selected "product_name" field?
I had try to put "unit" instead "product_name" in the t.response.Text statement but nothing happened, no error and no field "unit" printed on the screen. Not yet understand this approach of the callback. Please write down a complete example with explanation, variables and functions.

Best regards,
Tavi

ajb

The key here is onSuccess JS callback. You've requested to change innerHTML of some element with ID = product_name. Is there such element? Does your browser report any JS error? Also note that you have to set some `input` element value, because only such elements are passed as values when you click Save. Setting innerHTML should show something, but probably it won't pass it as value on form submit.

erwin

As I said, there is no error message. The elements of the form are not the same key as the fields in the table? What statement should I use to get the propper value of the product after the user select a product name? Instantly, not when the Save button is activated?

« Previous Page Next Page »

Epesi ENS | Epesi Academy | epesi.cloud PaaS | GitHub

Help Me! | Download from SourceForge