mikopbx/ModuleQualityAssessment

App/Controllers/ModuleQualityAssessmentController.php
383 строки13 KB
Nikolay Beketov
Update for PHP 8.3 and Phalcon 5.8
01 окт 2024, 11:52
01 окт 2024, 11:5265ad6bf
<?php
/*
 * MikoPBX - free phone system for small business
 * Copyright © 2017-2023 Alexey Portnov and Nikolay Beketov
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with this program.
 * If not, see <https://www.gnu.org/licenses/>.
 */

namespace Modules\ModuleQualityAssessment\App\Controllers;
use MikoPBX\AdminCabinet\Controllers\BaseController;
use MikoPBX\Common\Models\SoundFiles;
use MikoPBX\Core\System\Util;
use MikoPBX\Modules\PbxExtensionUtils;
use Modules\ModuleQualityAssessment\App\Forms\ModuleQualityAssessmentForm;
use Modules\ModuleQualityAssessment\Models\ModuleQualityAssessment;
use MikoPBX\Common\Models\Providers;
use Modules\ModuleQualityAssessment\Models\QuestionsList;

class ModuleQualityAssessmentController extends BaseController
{
    private $moduleUniqueID = 'ModuleQualityAssessment';
    private $moduleDir;

    /**
     * Basic initial class
     */
    public function initialize(): void
    {
        $this->moduleDir = PbxExtensionUtils::getModuleDir($this->moduleUniqueID);
        $this->view->logoImagePath = "{$this->url->get()}assets/img/cache/{$this->moduleUniqueID}/logo.svg";
        $this->view->submitMode = null;
        parent::initialize();
    }

    /**
     * Retrieves the description of tables and assigns it to the view data.
     *
     * @return void
     */
    public function getTablesDescriptionAction(): void
    {
        $this->view->data = $this->getTablesDescription();
    }

    /**
     * Retrieves the new records for a given table and assigns them to the view data.
     *
     * @return void
     */
    public function getNewRecordsAction(): void
    {
        // Assign current page to the view
        $currentPage                 = $this->request->getPost('draw');
        $table                       = $this->request->get('table');
        $this->view->draw            = $currentPage;
        $this->view->recordsTotal    = 0;
        $this->view->recordsFiltered = 0;
        $this->view->data            = [];

        // Retrieve the description of tables
        $descriptions = $this->getTablesDescription();

        // If the table description does not exist, return
        if(!isset($descriptions[$table])){
            return;
        }
        $className = $this->getClassName($table);

        // If the class name is not empty, retrieve the records
        if(!empty($className)){
            $filter = [];

            // Apply sorting based on priority column if it exists
            if(isset($descriptions[$table]['cols']['priority'])){
                $filter = ['order' => 'priority'];
            }

            // Retrieve all records and convert them to an array
            $allRecords = $className::find($filter)->toArray();
            $records    = [];
            $emptyRow   = [
                'rowIcon'  =>  $descriptions[$table]['cols']['rowIcon']['icon']??'',
                'DT_RowId' => 'TEMPLATE'
            ];

            // Add empty values for each column except rowIcon
            foreach ($descriptions[$table]['cols'] as $key => $metadata) {
                if('rowIcon' !== $key){
                    $emptyRow[$key] = '';
                }
            }
            $records[] = $emptyRow;

            // Iterate through each record and populate the data array
            foreach ($allRecords as $rowData){
                $tmpData = [];
                $tmpData['DT_RowId'] =  $rowData['id'];
                foreach ($descriptions[$table]['cols'] as $key => $metadata){
                    if('rowIcon' === $key){
                        $tmpData[$key] = $metadata['icon']??'';
                    }elseif('delButton' === $key){
                        $tmpData[$key] = '';
                    }else{
                        $tmpData[$key] =  $rowData[$key]??'';
                    }
                }
                $records[] = $tmpData;
            }

            // Assign the populated records to the view data
            $this->view->data      = $records;
        }
    }

    /**
     * Renders the index page for the module.
     *
     * @return void
     */
    public function indexAction(): void
    {
        // Add JavaScript files to the footer collection
        $footerCollection = $this->assets->collection('footerJS');
        $footerCollection->addJs('js/pbx/main/form.js', true);
        $footerCollection->addJs('js/vendor/datatable/dataTables.semanticui.js', true);
        $footerCollection->addJs("js/cache/{$this->moduleUniqueID}/module-quality-assessment-index.js", true);
        $footerCollection->addJs('js/vendor/jquery.tablednd.min.js', true);

        // Add CSS files to the header collection
        $headerCollectionCSS = $this->assets->collection('headerCSS');
        $headerCollectionCSS->addCss("css/cache/{$this->moduleUniqueID}/module-quality-assessment.css", true);
        $headerCollectionCSS->addCss('css/vendor/datatable/dataTables.semanticui.min.css', true);

        // Retrieve or create new module settings
        $settings = ModuleQualityAssessment::findFirst();
        if ($settings === null) {
            $settings = new ModuleQualityAssessment();
        }

        // Create options array for form
        $options = [];

        // Retrieve providers list for form
        $providers = Providers::find();
        $providersList = [];
        foreach ($providers as $provider){
            $providersList[ $provider->uniqid ] = $provider->getRepresent();
        }
        $options['providers']=$providersList;

        // Assign the form and view template
        $this->view->form = new ModuleQualityAssessmentForm($settings, $options);
        $this->view->pick("{$this->moduleDir}/App/Views/index");

        // Retrieve queues and users for selection lists
        $this->view->sounds = SoundFiles::find(['columns' => ['id', 'name']]);

        $this->view->roles = [
            (object)['id' => QuestionsList::ROLE_START, 'name' => Util::translate('module_quality_ROLE_START')],
            (object)['id' => QuestionsList::ROLE_QUESTION, 'name' => Util::translate('module_quality_ROLE_QUESTION')],
            (object)['id' => QuestionsList::ROLE_END, 'name' => Util::translate('module_quality_ROLE_END')],
        ];

    }

    /**
     * Saves the form data to the database.
     *
     * @return void
     */
    public function saveAction() :void
    {
        $data       = $this->request->getPost();
        $record = ModuleQualityAssessment::findFirst();
        if ($record === null) {
            $record = new ModuleQualityAssessment();
        }
        $this->db->begin();

        // Iterate through each field in the record and update its value
        foreach ($record as $key => $value) {
            switch ($key) {
                case 'id':
                    break;
                case 'useTts':
                    // Handle checkbox and toggle fields
                    if (array_key_exists($key, $data)) {
                        $record->$key = ($data[$key] === 'on') ? '1' : '0';
                    } else {
                        $record->$key = '0';
                    }
                    break;
                default:
                    // Handle other fields
                    if (array_key_exists($key, $data)) {
                        $record->$key = $data[$key];
                    } else {
                        $record->$key = '';
                    }
            }
        }

        // Save the record to the database
        if ($record->save() === FALSE) {
            $errors = $record->getMessages();
            $this->flash->error(implode('<br>', $errors));
            $this->view->success = false;
            $this->db->rollback();
            return;
        }

        // Commit the transaction and display success message
        $this->flash->success($this->translation->_('ms_SuccessfulSaved'));
        $this->view->success = true;
        $this->db->commit();
    }

    /**
     * Deletes a record from the specified table.
     *
     * @return void
     */
    public function deleteAction(): void
    {
        $table     = $this->request->get('table');
        $className = $this->getClassName($table);
        // If the class name is empty, return
        if(empty($className)) {
            $this->view->success = false;
            return;
        }
        $id     = $this->request->get('id');
        $record = $className::findFirstById($id);

        // If the record exists and deletion fails, display error message
        if ($record !== null && ! $record->delete()) {
            $this->flash->error(implode('<br>', $record->getMessages()));
            $this->view->success = false;
            return;
        }

        // Set success flag to true
        $this->view->success = true;
    }

    /**

    Retrieves the description of tables.

    @return array The table descriptions.
     */
    private function getTablesDescription():array
    {
        $description['QuestionsList'] = [
            'cols' => [
                'rowIcon'        => ['header' => '',                                                  'class' => 'collapsing', 'icon' => 'user'],
                'priority'       => ['header' => '',                                                  'class' => 'collapsing'],
                'textQuestions'  => ['header' => Util::translate('module_quality_TextQuestion'), 'class' => 'ten wide'],
                'soundFileId'    => ['header' => Util::translate('module_quality_SoundFile'),    'class' => 'collapsing', 'select' => 'sound-list'],
                'role'           => ['header' => Util::translate('module_quality_Role'),         'class' => 'collapsing', 'select' => 'role-list'],
                'delButton'      => ['header' => '',                                                  'class' => 'collapsing']
            ],
            'ajaxUrl' => '/getNewRecords',
            'icon' => 'user',
            'needDelButton' => true
        ];
        return $description;
    }

    /**
     * Saves the data of a table row to the database.
     *
     * @return void
     */
    public function saveTableDataAction():void
    {
        $data       = $this->request->getPost();
        $tableName  = $data['pbx-table-id']??'';

        $className = $this->getClassName($tableName);

        // If the class name is empty, return
        if(empty($className)){
            return;
        }
        $rowId      = $data['pbx-row-id']??'';

        // If the row ID is empty, set success flag to false and return
        if(empty($rowId)){
            $this->view->success = false;
            return;
        }
        $this->db->begin();
        $rowData = $className::findFirst('id="'.$rowId.'"');
        if(!$rowData){
            $rowData = new $className();
        }

        // Update each field of the row data
        foreach ($rowData as $key => $value) {
            if($key === 'id'){
                continue;
            }
            if (array_key_exists($key, $data)) {
                $rowData->writeAttribute($key, $data[$key]);
            }
        }
        // Save the row data
        if ($rowData->save() === FALSE) {
            $errors = $rowData->getMessages();
            $this->flash->error(implode('<br>', $errors));
            $this->view->success = false;
            $this->db->rollback();
            return;
        }

        // Set the data and success flag for the view
        $this->view->data = ['pbx-row-id'=>$rowId, 'newId'=>$rowData->id, 'pbx-table-id' => $data['pbx-table-id']];
        $this->view->success = true;
        $this->db->commit();

    }

    /**
     * Retrieves the class name for the given table name.
     *
     * @param string $tableName The name of the table.
     * @return string The class name for the table.
     */
    private function getClassName($tableName):string
    {
        if(empty($tableName)){
            return '';
        }
        $className = "Modules\ModuleQualityAssessment\Models\\$tableName";
        if(!class_exists($className)){
            $className = '';
        }
        return $className;
    }

    /**
     * Updates the priority values for the records in a table.
     *
     * @return void
     */
    public function changePriorityAction(): void
    {
        $this->view->disable();
        $result = true;

        if ( ! $this->request->isPost()) {
            return;
        }
        $priorityTable = $this->request->getPost();
        $tableName     = $this->request->get('table');
        $className = $this->getClassName($tableName);
        // If the class name is empty, display error message and return
        if(empty($className)){
            echo "Table not found: $tableName";
            return;
        }
        $rules = $className::find();
        foreach ($rules as $rule){
            if (array_key_exists ( $rule->id, $priorityTable)){
                $rule->priority = $priorityTable[$rule->id];
                $result         .= $rule->update();
            }
        }
        echo json_encode($result);
    }
}