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

SugarCRM

昨日に引き続き、displayParamsで指定可能なパラメータのまとめ

required

  • 説明
    • 対象フィールドを必須フィールドとして扱う。この時、画面上にはフィールドラベル名の横に"LBL_REQUIRED_SYMBOL（デフォルトでは赤色の*)"が表示される。また、未入力のまま保存した場合に、ヴァリデーションエラーのメッセージを表示する。
    • 対象フィールドがvardef内ですでに"required=>true"で宣言されている場合、本パラメータを指定しなくても自動的に必須フィールドとなる。ただし、vardef内で"required=>true"が宣言されているにもかかわらず、本パラメータをfalseに指定すると、必須フィールド扱いが無効となる（おそらく障害）。
  • 定義例
    • modules/Accounts/metadate/editviewdefs.php
  • 利用/実装しているテンプレート
    • include/EditView/EditView.tpl
    • include/SugarFields/Fields/Address/EditView.tpl
    • include/SugarFields/Fields/Address/en_us.EditView.tpl
    • include/TemplateHandler/TemplateHandler.php
    • include/EditView/EditView2.php

link

  • 説明
    • fileフィールドに対して、DetailViewで表示する時の表示名となる。fileフィールドを画面上に表示する際には、このパラメータは必須となる。指定はフィールド名で行う。指定したフィールド名が存在しない場合には画面上に何も表示されない。
  • 定義例
    • modules/Notes/metadata/detailview.php
    • include/SugarObjects/templates/file/metadata/detailviewdefs.php
  • 利用しているテンプレート
    • include/SugarFields/Fields/Image/DetailView.tpl
    • include/SugarFields/Fields/File/SugarFieldFile.php

id

  • 説明
    • fileフィールドに対して、DetailViewで表示したリンクアドレスで指定されるidとなる。標準のファイルアップロードロジックを利用する限り、 id => 'id'を指定する。fileフィールドを画面上に表示する際には、このパラメータは必須となる。
  • 定義例
    • modules/Notes/metadata/detailview.php
    • include/SugarObjects/templates/file/metadata/detailviewdefs.php
  • 利用しているテンプレート
    • include/SugarFields/Fields/File/SugarFieldFile.php

showFormats

  • 説明
    • datetime(combo)型のフィールド表示時に、ユーザ設定で指定された日付フォーマット(例:yyyy-mm-dd)を表示する。指定はtrue/falseで記述する。
  • 定義例
    • modules/Tasks/metadata/editviewdefs.php
    • modules/Campaigns/metadata/editviewdefs.php
    • modules/Campaigns/metadata/searchdefs.php
  • 利用しているテンプレート
    • include/SugarFields/Fields/Datetime/SugarFieldDatetime.php
    • include/SugarFields/Fields/Datetime/EditView.tpl
    • include/SugarFields/Fields/Datetimecombo/EditView.tpl
    • include/SugarFields/Fields/Datetimecombo/SugarFieldDatetimecombo.php

showNoneCheckbox

  • 説明
    • datetime(combo)型のフィールド表示時に、Noneチェック用のチェックボックスを配置する。チェックボックスが有効になった場合、該当フィールドの時/分ドロップダウンにreadOnlyが設定される。指定はtrue/falseで記述する。
  • 定義例
    • modules/Tasks/metadata/editviewdefs.php
  • 利用しているテンプレート
    • include/SugarFields/Fields/Datetime/SugarFieldDatetime.php
    • include/SugarFields/Fields/Datetimecombo/EditView.tpl
    • include/SugarFields/Fields/Datetimecombo/SugarFieldDatetimecombo.php

splitDateTime

  • 説明
    • datetimecombo型のフィールド表示時に、日付入力フィールドの後ろに
      を追加する。指定はtrue/falseで記述する。
  • 定義例
    • modules/Calls/metadata/sidecreateviewdefs.php
    • modules/Meetings/metadata/sidecreateviewdefs.php
  • 利用しているテンプレート
    • include/SugarFields/Fields/Datetimecombo/EditView.tpl

hiddeCallendar*1

  • 説明
    • datetime型のフィールド表示時にカポップアップレンダー非表示にする。指定はtrue/falseで記述する。
  • 定義例
    • なし(基本モジュールでは利用されていない)
  • 利用しているテンプレート
    • include/SugarFields/Fields/Datetime/SugarFieldDatetime.php
    • include/SugarFields/Fields/Datetime/SugarFieldDatetime.php
    • include/SugarFields/Fields/Datetime/EditView.tpl
    • include/SugarFields/Fields/Datetime/EditView.tpl

[未実装]showHoursDropdown/showMinutesDropdown

  • 説明

datetime(combo)型のフィールド表示時に、それぞれ時/分のドロップダウンを非表示にする。指定はtrue/falseで記述する。フラグの受け渡しのみ実装されていて、テンプレートの表示ロジックが未実装。非表示処理を入れたい場合には、以下のファイル内で該当パラメータのチェックを行うようにカスタマイズする。

    • include/SugarFields/Fields/Datetime/EditView.tpl
    • include/SugarFields/Fields/Datetimecombo/EditView.tpl
  • 利用しているテンプレート
    • include/SugarFields/Fields/Datetime/SugarFieldDatetime.php
    • include/SugarFields/Fields/Datetimecombo/SugarFieldDatetimecombo.php

*1:残念ながらtypoじゃないんです。。。