gplcart\modules\backup\controllers\Backup

Complexity

Total Complexity

16

Size/Duplication

Total Lines	148
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	1
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	setTitleListBackup()	0	4	1
A	setBreadcrumbListBackup()	0	4	1
A	outputListBackup()	0	4	1
A	__construct()	0	6	1
A	listBackup()	0	16	1
A	setFilterListBackup()	0	7	1
A	downloadListBackup()	0	16	3
B	actionListBackup()	0	16	5
A	getListBackup()	0	6	1
A	setPagerListBackup()	0	12	1

<?php

/**
 * @package Backup
 * @author Iurii Makukh <gplcart.software@gmail.com>
 * @copyright Copyright (c) 2015, Iurii Makukh
 * @license https://www.gnu.org/licenses/gpl.html GNU/GPLv3
 */

namespace gplcart\modules\backup\controllers;

use gplcart\modules\backup\models\Backup as ModuleBackupModel;
use gplcart\core\controllers\backend\Controller as BackendController;

/**
 * Handles incoming requests and outputs data related to Backup module
 */
class Backup extends BackendController
{

    /**
     * @var \gplcart\modules\backup\models\Backup $backup
     */
    protected $backup;

    /**
     * Pager limit
     * @var array
     */
    protected $data_limit;

    /**
     * @param ModuleBackupModel $backup
     */
    public function __construct(ModuleBackupModel $backup)
    {
        parent::__construct();

        $this->backup = $backup;
    }

    /**
     * Displays the backup overview page
     */
    public function listBackup()
    {
        $this->downloadListBackup();
        $this->actionListBackup();

        $this->setTitleListBackup();
        $this->setBreadcrumbListBackup();

        $this->setFilterListBackup();
        $this->setPagerListBackup();

        $this->setData('backups', $this->getListBackup());
        $this->setData('handlers', $this->backup->getHandlers());

        $this->outputListBackup();
    }

    /**
     * Sets filter parameters
     */
    protected function setFilterListBackup()
    {
        $allowed = array('created', 'name', 'user_id', 'type',
            'version', 'id', 'backup_id');

        $this->setFilter($allowed);
    }

    /**
     * Downloads a backup
     */
    protected function downloadListBackup()
    {
        $backup_id = $this->getQuery('download');

        if (empty($backup_id)) {
            return null;
        }

        $this->controlAccess('backup_download');

        $backup = $this->backup->get($backup_id);

        if (!empty($backup['path'])) {
            $this->download(gplcart_file_absolute($backup['path']));
        }
    }

    /**
     * Applies an action to the selected backups
     */
    protected function actionListBackup()
    {
        list($selected, $action) = $this->getPostedAction();

        $deleted = 0;
        foreach ($selected as $id) {
            if ($action === 'delete' && $this->access('backup_delete')) {
                $deleted += (int) $this->backup->delete($id);
            }
        }

        if ($deleted > 0) {
            $message = $this->text('Deleted %num item(s)', array('%num' => $deleted));
            $this->setMessage($message, 'success');
        }
    }

    /**
     * Sets title on the backup overview page
     */
    protected function setTitleListBackup()
    {
        $this->setTitle($this->text('Backups'));
    }

    /**
     * Sets breadcrumbs on the backup overview page
     */
    protected function setBreadcrumbListBackup()
    {
        $this->setBreadcrumbHome();
    }

    /**
     * Render and output the backup overview page
     */
    protected function outputListBackup()
    {
        $this->output('backup|list');
    }

    /**
     * Returns an array of backups
     * @return array
     */
    protected function getListBackup()
    {
        $options = $this->query_filter;
        $options['limit'] = $this->data_limit;
        return $this->backup->getList($options);
    }

    /**
     * Sets pager
     * @return array
     */
    protected function setPagerListBackup()
    {
        $options = $this->query_filter;
        $options['count'] = true;

        $pager = array(
            'query' => $this->query_filter,
            'total' => (int) $this->backup->getList($options)
        );

        return $this->data_limit = $this->setPager($pager);
    }

}