SugarCRM - 自分で作ったフィールドでAutocompleteを使う

SugarCRMネタ。

Relateフィールドでは、Autocompleteが効いてリレート先のデータをサクッと指定する事ができます。今回はこのAutocompleteを自分で書いたHTMLにも適用する方法をメモ。

SugarCRMのAutocomplete

SugarのAutocompleteは、グローバル変数sqs_objectにその設定が書いてあります。
中身を見るとなにやら面倒くさい感じのオブジェクトになってますね。。

sqs_objects

そしてEditViewやListViewのロード時にenableQS関数が実行されることで、Autocompleteが有効化されます。enableQSの中で、sqs_objectsを参照してなんやかんややっております。

HTML(Smarty)

何はともあれ実装してみます。

1
2
<input type="text" name="hoge_name" id="hoge_name" class="sqsEnabled" value="">
<input type="hidden" name="hoge_id" id="hoge_id" value="">

ポイントは、class属性にsqsEnabledを指定すること。
これをやっておかないとenableQSの中でスルーされます。

JavaScript

特別なことをするでもなく。。。

1
2
3
$(function() {
enableQS();
});

もちろんこのままでは動きません!
大事な大事なsqs_objectsを生成します。

sqs_objectsを生成する

見よう見まねでオブジェクトを書くのは面倒くさいので、Sugarに組み込まれているクラスを利用します。
※JSON文字列をJavaScriptのsqs_objectsに展開するところが非常に雑ですが、例のため簡略化させて下さい。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
<?php
require_once 'include/QuickSearchDefaults.php';
$form_name = 'search_form';
$name_field = 'hoge_name';
$id_field = 'hoge_id';
$module = 'Hoge';
$sqs_objects = array();
$qsd = QuickSearchDefaults::getQuickSearchDefaults(array());
// form 名をセット
$qsd->setFormName($form_name);
// 配列のキーは、`form 名`_`オートコンプリートしたい input 名` とする
$key = $form_name . '_' . $name_field;
// sqs_objects の元となる配列を取得
$sqs_objects[$key] = $qsd->getQSParent($module);
$sqs_objects[$key]['populate_list'] = array($name_field, $id_field);
$json = getJSONobj();
echo '<script type="text/javascript">';
echo 'sqs_objects = ' . $json->encode($sqs_objects);
echo '</script>';

これで動くと思います。
sqs_objectsのJSONをHTMLに渡すときは、「SmartyからJavaScriptに値を渡す」で書いたdata属性を使ってやりとりをするとよさげです。

まぁAutocompleteできるならばやりたくないよね…