[Summary view] [Print] [Text view]

   1  <?php
   2  /*+**********************************************************************************
   3   * The contents of this file are subject to the vtiger CRM Public License Version 1.0
   4   * ("License"); You may not use this file except in compliance with the License
   5   * The Original Code is:  vtiger CRM Open Source
   6   * The Initial Developer of the Original Code is vtiger.
   7   * Portions created by vtiger are Copyright (C) vtiger.
   8   * All Rights Reserved.
   9   ************************************************************************************/
  10  
  11  include_once  'modules/Vtiger/CRMEntity.php';
  12  
  13  class ModuleName extends Vtiger_CRMEntity {
  14      var $table_name = 'vtiger_<modulename>';
  15      var $table_index= '<modulename>id';
  16  
  17      /**
  18       * Mandatory table for supporting custom fields.
  19       */
  20      var $customFieldTable = Array('vtiger_<modulename>cf', '<modulename>id');
  21  
  22      /**
  23       * Mandatory for Saving, Include tables related to this module.
  24       */
  25      var $tab_name = Array('vtiger_crmentity', 'vtiger_<modulename>', 'vtiger_<modulename>cf');
  26  
  27      /**
  28       * Mandatory for Saving, Include tablename and tablekey columnname here.
  29       */
  30      var $tab_name_index = Array(
  31          'vtiger_crmentity' => 'crmid',
  32          'vtiger_<modulename>' => '<modulename>id',
  33          'vtiger_<modulename>cf'=>'<modulename>id');
  34  
  35      /**
  36       * Mandatory for Listing (Related listview)
  37       */
  38      var $list_fields = Array (
  39          /* Format: Field Label => Array(tablename, columnname) */
  40          // tablename should not have prefix 'vtiger_'
  41          '<entityfieldlabel>' => Array('<modulename>', '<entitycolumn>'),
  42          'Assigned To' => Array('crmentity','smownerid')
  43      );
  44      var $list_fields_name = Array (
  45          /* Format: Field Label => fieldname */
  46          '<entityfieldlabel>' => '<entityfieldname>',
  47          'Assigned To' => 'assigned_user_id',
  48      );
  49  
  50      // Make the field link to detail view
  51      var $list_link_field = '<entityfieldname>';
  52  
  53      // For Popup listview and UI type support
  54      var $search_fields = Array(
  55          /* Format: Field Label => Array(tablename, columnname) */
  56          // tablename should not have prefix 'vtiger_'
  57          '<entityfieldlabel>' => Array('<modulename>', '<entitycolumn>'),
  58          'Assigned To' => Array('vtiger_crmentity','assigned_user_id'),
  59      );
  60      var $search_fields_name = Array (
  61          /* Format: Field Label => fieldname */
  62          '<entityfieldlabel>' => '<entityfieldname>',
  63          'Assigned To' => 'assigned_user_id',
  64      );
  65  
  66      // For Popup window record selection
  67      var $popup_fields = Array ('<entityfieldname>');
  68  
  69      // For Alphabetical search
  70      var $def_basicsearch_col = '<entityfieldname>';
  71  
  72      // Column value to use on detail view record text display
  73      var $def_detailview_recname = '<entityfieldname>';
  74  
  75      // Used when enabling/disabling the mandatory fields for the module.
  76      // Refers to vtiger_field.fieldname values.
  77      var $mandatory_fields = Array('<entityfieldname>','assigned_user_id');
  78  
  79      var $default_order_by = '<entityfieldname>';
  80      var $default_sort_order='ASC';
  81  
  82      /**
  83      * Invoked when special actions are performed on the module.
  84      * @param String Module name
  85      * @param String Event Type
  86      */
  87  	function vtlib_handler($moduleName, $eventType) {
  88          global $adb;
  89           if($eventType == 'module.postinstall') {
  90              // TODO Handle actions after this module is installed.
  91          } else if($eventType == 'module.disabled') {
  92              // TODO Handle actions before this module is being uninstalled.
  93          } else if($eventType == 'module.preuninstall') {
  94              // TODO Handle actions when this module is about to be deleted.
  95          } else if($eventType == 'module.preupdate') {
  96              // TODO Handle actions before this module is updated.
  97          } else if($eventType == 'module.postupdate') {
  98              // TODO Handle actions after this module is updated.
  99          }
 100       }
 101  }