YetiForceCompany/YetiForceCRM

<?php
/* +***********************************************************************************
 * The contents of this file are subject to the vtiger CRM Public License Version 1.0
 * ("License"); You may not use this file except in compliance with the License
 * The Original Code is:  vtiger CRM Open Source
 * The Initial Developer of the Original Code is vtiger.
 * Portions created by vtiger are Copyright (C) vtiger.
 * All Rights Reserved.
 * *********************************************************************************** */

/**
 * Vtiger Record Structure Model.
 */
class Vtiger_RecordStructure_Model extends \App\Base
{
    protected $record = false;
    protected $module = false;
    protected $structuredValues = [];

    const RECORD_STRUCTURE_MODE_DEFAULT = '';
    const RECORD_STRUCTURE_MODE_DETAIL = 'Detail';
    const RECORD_STRUCTURE_MODE_EDIT = 'Edit';
    const RECORD_STRUCTURE_MODE_QUICKCREATE = 'QuickCreate';
    const RECORD_STRUCTURE_MODE_MASSEDIT = 'MassEdit';
    const RECORD_STRUCTURE_MODE_SUMMARY = 'Summary';

    /**
     * Function to set the record Model.
     *
     * @param <type> $record - record instance
     *
     * @return Vtiger_RecordStructure_Model
     */
    public function setRecord($record)
    {
        $this->record = $record;
        return $this;
    }

    /**
     * Function to get the record.
     *
     * @return Vtiger_Record_Model
     */
    public function getRecord()
    {
        return $this->record;
    }

    public function getRecordName()
    {
        return $this->record->getName();
    }

    /**
     * Function to get the module.
     *
     * @return Vtiger_Module_Model
     */
    public function getModule()
    {
        return $this->module;
    }

    /**
     * Function to set the module.
     *
     * @param <type> $module - module model
     *
     * @return Vtiger_RecordStructure_Model
     */
    public function setModule($module)
    {
        $this->module = $module;

        return $this;
    }

    /**
     * Function to get the values in stuctured format.
     *
     * @return array - values in structure array('block'=>array(fieldinfo));
     */
    public function getStructure()
    {
        if (!empty($this->structuredValues)) {
            return $this->structuredValues;
        }
        $recordModel = $this->getRecord();
        $recordExists = !empty($recordModel);
        $moduleModel = $this->getModule();
        $blockModelList = $moduleModel->getBlocks();
        foreach ($blockModelList as $blockLabel => $blockModel) {
            $fieldModelList = $blockModel->getFields();
            if (!empty($fieldModelList)) {
                $this->structuredValues[$blockLabel] = [];
                foreach ($fieldModelList as $fieldName => $fieldModel) {
                    if ($fieldModel->isViewable()) {
                        if ($recordExists) {
                            $fieldModel->set('fieldvalue', $recordModel->get($fieldName));
                        }
                        $this->structuredValues[$blockLabel][$fieldName] = $fieldModel;
                    }
                }
            }
        }
        return $this->structuredValues;
    }

    /**
     * Function to retieve the instance from record model.
     *
     * @param Vtiger_Record_Model $recordModel - record instance
     * @param mixed               $mode
     *
     * @return Vtiger_RecordStructure_Model
     */
    public static function getInstanceFromRecordModel($recordModel, $mode = self::RECORD_STRUCTURE_MODE_DEFAULT)
    {
        $moduleModel = $recordModel->getModule();
        $className = Vtiger_Loader::getComponentClassName('Model', $mode . 'RecordStructure', $moduleModel->getName(true));
        $instance = new $className();
        $instance->setModule($moduleModel)->setRecord($recordModel);

        return $instance;
    }

    /**
     * Function to retieve the instance from module model.
     *
     * @param Vtiger_Module_Model $moduleModel - module instance
     * @param mixed               $mode
     *
     * @return Vtiger_RecordStructure_Model
     */
    public static function getInstanceForModule($moduleModel, $mode = self::RECORD_STRUCTURE_MODE_DEFAULT)
    {
        $className = Vtiger_Loader::getComponentClassName('Model', $mode . 'RecordStructure', $moduleModel->get('name'));
        $instance = new $className();
        $instance->setModule($moduleModel);

        return $instance;
    }
}