gplcart\modules\backup\Main

Complexity

Total Complexity

14

Size/Duplication

Total Lines	159
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	1

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	hookModuleInstallBefore()	0	13	3
A	hookModuleUninstallAfter()	0	4	1
A	hookUserRolePermissions()	0	6	1
A	hookRouteList()	0	12	1
A	backup()	0	4	1
A	restore()	0	4	1
A	getHandlers()	0	4	1
A	exists()	0	4	1
A	getModel()	0	6	1
A	getTranslationModel()	0	6	1
A	getDbScheme()	0	17	1

<?php

/**
 * @package Backup
 * @author Iurii Makukh <gplcart.software@gmail.com>
 * @copyright Copyright (c) 2017, Iurii Makukh <gplcart.software@gmail.com>
 * @license https://www.gnu.org/licenses/gpl-3.0.en.html GPL-3.0+
 */

namespace gplcart\modules\backup;

use Exception;
use gplcart\core\Config;
use gplcart\core\Container;

/**
 * Main class for Backup module
 */
class Main
{

    /**
     * Database class instance
     * @var \gplcart\core\Database $db
     */
    protected $db;

    /**
     * @param Config $config
     */
    public function __construct(Config $config)
    {
        $this->db = $config->getDb();
        $this->db->addScheme($this->getDbScheme());
    }

    /**
     * Implements hook "module.install.before"
     * @param null|string $result
     */
    public function hookModuleInstallBefore(&$result)
    {
        if (!class_exists('ZipArchive')) {
            $result = $this->getTranslationModel()->text('Class ZipArchive does not exist');
        } else {

            try {
                $this->db->importScheme('backup', $this->getDbScheme());
            } catch (Exception $ex) {
                $result = $ex->getMessage();
            }
        }
    }

    /**
     * Implements hook "module.uninstall.after"
     */
    public function hookModuleUninstallAfter()
    {
        $this->db->deleteTable('backup');
    }

    /**
     * Implements hook "user.role.permissions"
     * @param array $permissions
     */
    public function hookUserRolePermissions(array &$permissions)
    {
        $permissions['backup'] = 'Backup: access'; // @text
        $permissions['backup_delete'] = 'Backup: delete'; // @text
        $permissions['backup_download'] = 'Backup: download'; // @text
    }

    /**
     * Implements hook "route.list"
     * @param array $routes
     */
    public function hookRouteList(array &$routes)
    {
        $routes['admin/report/backup'] = array(
            'access' => 'backup',
            'menu' => array(
                'admin' => 'Backups' // @text
            ),
            'handlers' => array(
                'controller' => array('gplcart\\modules\\backup\\controllers\\Backup', 'listBackup')
            )
        );
    }

    /**
     * Performs backup operation
     * @param string $handler_id
     * @param array $data
     * @return boolean|string
     */
    public function backup($handler_id, array $data)
    {
        return $this->getModel()->backup($handler_id, $data);
    }

    /**
     * Performs restore operation
     * @param string $handler_id
     * @param array $data
     * @return boolean|string
     */
    public function restore($handler_id, array $data)
    {
        return $this->getModel()->restore($handler_id, $data);
    }

    /**
     * Returns an array of defined handlers
     * @return array
     */
    public function getHandlers()
    {
        return $this->getModel()->getHandlers();
    }

    /**
     * Whether a backup already exists
     * @param string $id
     * @param null|string $version
     * @return bool
     */
    public function exists($id, $version = null)
    {
        return $this->getModel()->exists($id, $version);
    }

    /**
     * Returns backup model
     * @return \gplcart\modules\backup\models\Backup
     */
    protected function getModel()
    {
        /** @var \gplcart\modules\backup\models\Backup $instance */
        $instance = Container::get('gplcart\\modules\\backup\\models\\Backup');
        return $instance;
    }

    /**
     * Translation UI model instance
     * @return \gplcart\core\models\Translation
     */
    protected function getTranslationModel()
    {
        /** @var \gplcart\core\models\Translation $instance */
        $instance = Container::get('gplcart\\core\\models\\Translation');
        return $instance;
    }

    /**
     * Returns an array of database scheme
     * @return array
     */
    protected function getDbScheme()
    {
        return array(
            'backup' => array(
                'fields' => array(
                    'backup_id' => array('type' => 'int', 'length' => 10, 'auto_increment' => true, 'primary' => true),
                    'created' => array('type' => 'int', 'length' => 10, 'not_null' => true),
                    'name' => array('type' => 'varchar', 'length' => 255, 'not_null' => true),
                    'path' => array('type' => 'varchar', 'length' => 255, 'not_null' => true),
                    'user_id' => array('type' => 'int', 'length' => 10, 'not_null' => true, 'default' => 0),
                    'type' => array('type' => 'varchar', 'length' => 50, 'not_null' => true, 'default' => ''),
                    'version' => array('type' => 'varchar', 'length' => 50, 'not_null' => true, 'default' => ''),
                    'id' => array('type' => 'varchar', 'length' => 50, 'not_null' => true, 'default' => '')
                )
            )
        );
    }

}