YetiForceCompany/YetiForceCRM

View on GitHub
modules/Approvals/Approvals.php

Summary

Maintainability
B
6 hrs
Test Coverage
A
100%
<?php
/**
 * Main module file.
 *
 * @package CRMEntity
 *
 * @copyright YetiForce S.A.
 * @license   YetiForce Public License 6.5 (licenses/LicenseEN.txt or yetiforce.com)
 * @author    Radosław Skrzypczak <r.skrzypczak@yetiforce.com>
 */
include_once 'modules/Vtiger/CRMEntity.php';

/**
 * Approvals class.
 */
class Approvals extends Vtiger_CRMEntity
{
    public $table_name = 'u_yf_approvals';
    public $table_index = 'approvalsid';

    /**
     * Mandatory table for supporting custom fields.
     */
    public $customFieldTable = [];

    /**
     * Mandatory for Saving, Include tables related to this module.
     */
    public $tab_name = ['vtiger_crmentity', 'u_yf_approvals'];

    /**
     * Mandatory for Saving, Include tablename and tablekey columnname here.
     */
    public $tab_name_index = [
        'vtiger_crmentity' => 'crmid',
        'u_yf_approvals' => 'approvalsid'
    ];

    public $list_fields_name = [
        // Format: Field Label => fieldname
        'FL_NAME' => 'name',
        'Assigned To' => 'assigned_user_id',
    ];
    // For Popup listview and UI type support
    public $search_fields = [
        // Format: Field Label => Array(tablename, columnname)
        'FL_NAME' => ['approvals', 'name'],
        'Assigned To' => ['vtiger_crmentity', 'assigned_user_id'],
    ];
    public $search_fields_name = [];
    // For Popup window record selection
    public $popup_fields = ['name'];
    // For Alphabetical search
    public $def_basicsearch_col = 'name';
    // Column value to use on detail view record text display
    public $def_detailview_recname = 'name';
    // Used when enabling/disabling the mandatory fields for the module.
    // Refers to vtiger_field.fieldname values.
    public $mandatory_fields = ['name', 'assigned_user_id'];
    public $default_order_by = '';
    public $default_sort_order = 'ASC';

    /**
     * Invoked when special actions are performed on the module.
     *
     * @param string $moduleName
     * @param string $eventType
     */
    public function moduleHandler($moduleName, $eventType)
    {
        if ('module.postinstall' === $eventType) {
        } elseif ('module.disabled' === $eventType) {
        } elseif ('module.preuninstall' === $eventType) {
        } elseif ('module.preupdate' === $eventType) {
        } elseif ('module.postupdate' === $eventType) {
        }
    }
}