displayParamsで指定可能なパラメータ(4)

SugarCRM

displayParamsのまとめその(4)です。とりあえずこれですべてかな（ただし5.5で新規に追加されたCollectionフィールドは除く）。Collectionフィールドについては、用途なども含めて後日まとめようと思います。

それでは、いつものように一覧を挙げます。

readOnly

  • 説明
    • relateフィールドに対して"readonly"属性を追加する。指定はtrue/falseで記述する。
    • editviewdefs.phpでのみ指定可能。
  • 定義例
    • なし
  • 利用/実装しているテンプレート
    • include/SugarFields/Fields/Image/DetailView.tpl
    • include/SugarFields/Fields/Relate/SugarFieldRelate.php
    • include/SugarFields/Fields/Relate/EditView.tpl

link_target

  • 説明
    • linkフィールドに対してアンカータグのtarget属性を追加する。指定は文字列で記述する。
    • detailviewdefs.phpのみで指定可能
  • 定義例
  • modules/Accounts/metadata/detailviewdefs.php
  • 利用/実装しているテンプレート
    • include/SugarFields/Fields/Link/DetailView.tpl

title

  • 説明
    • linkフィールドに対してアンカー表示用の文字列を指定する。指定は文字列で記述する。
    • デフォルト(未指定時）では入力されたURLがそのまま表示される。
    • detailviewdefs.phpのみで指定可能
  • 定義例
  • なし
  • 利用/実装しているテンプレート
    • include/SugarFields/Fields/Link/DetailView.tpl
link_target, titleの例

linkフィールドに対して「表示名:外部サイト、表示ウィンドウ：現在のウィンドウ」と指定したい場合には、
displayParams('link_target' => '_self', 'title' => '外部サイト')
と指定する。

image

  • 説明
    • 画面表示時、対象フィールドコンポーネントの後ろにimgタグを追加する。指定はimgタグの属性を連想配列で記述する。
    • 例) 'img' => array('src' => 'path/to/image', 'border' => 0, ....)
  • 定義例
    • なし
  • 利用/実装しているテンプレート
    • include/SugarFields/Fields/Base/SugarFieldBase.php

button

  • 説明
    • 画面表示時、対象フィールドコンポーネントの後ろにbuttonタグを追加する。指定はbuttonタグの属性を連想配列で記述する。ただし、'type'と'class'は指定することができない。
    • 例) 'button' => array('type' => 'reset', 'value' => 'cancel', ....)
  • 定義例
    • なし
  • 利用/実装しているテンプレート
    • include/SugarFields/Fields/Base/SugarFieldBase.php

buttons

  • 説明
    • 画面表示時、対象フィールドコンポーネントの後ろに複数のbuttonタグを追加する。指定は作成するボタンをkeyとしたbuttonタグの属性を連想配列で記述する。ただし、'type'と'class'は指定することができない。
    • 例) 'buttons'=> array('button1' => array('type' => 'reset', 'value' => 'cancel', ....), 'button2' => array( ...
  • 定義例
    • なし
  • 利用/実装しているテンプレート
    • include/SugarFields/Fields/Base/SugarFieldBase.php

updateCallback

  • 説明
    • datetimecomboe型のフィールドに対して、値(年月日/時/分)の変更時に呼び出すコールバック関数を指定する。
  • 定義例
    • modules/Calls/metadata/editviewdefs.php
    • modules/Meetings/metadata/editviewdefs.php
  • 利用/実装しているテンプレート
    • include/SugarFields/Fields/Datetimecombo/EditView.tpl



以下のパラメータは指定可能だが内部的には必ずtrueとなるので実質的に指定不可。

nl2br

  • 説明
    • textフィールド、addressフィールド以外で値表示時に、改行を
      に変換して出力する。値はtrue/falseで指定する。
    • 本パラメータはDetailViewでのみ利用可能。
    • textフィールドに対しては、強制的に"nl2br"で変換されるため'false'は指定不可（出力に影響しない）。
  • 定義例
    • modules/Opportunities/metadata/detailviewdefs.php
  • 利用/実装しているテンプレート
    • include/Smarty/plugins/function.sugarvar.php

url2html

  • 説明
    • textフィールド以外で値表示時に、外部リンク文字列(xxx://yyy.zz等)がある場合にリンクタグを出力する。値はtrue/falseで指定する。
    • textフィールドに対しては、強制的に"url2html"で変換されるため'false'は指定不可（出力に影響しない）。
  • 定義例
    • なし
  • 利用/実装しているテンプレート
    • include/Smarty/plugins/function.sugarvar.php
    • url2html()の実装:include/utils.php