App\Controller\HistoryController

Complexity

Total Complexity

6

Size/Duplication

Total Lines	98
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	info()	0	10	1
A	clone()	0	5	1
A	objects()	0	13	1
A	initialize()	0	6	1
A	setHistory()	0	9	1
A	restore()	0	5	1

<?php
declare(strict_types=1);

namespace App\Controller;

use BEdita\WebTools\Utility\ApiTools;
use Cake\Http\Response;

/**
 * History Controller
 *
 * @property \App\Controller\Component\HistoryComponent $History
 * @property \App\Controller\Component\SchemaComponent $Schema
 */
class HistoryController extends AppController
{
    /**
     * {@inheritDoc}
     * {@codeCoverageIgnore}
     */
    public function initialize(): void
    {
        parent::initialize();

        $this->loadComponent('History');
        $this->loadComponent('Schema');
    }

    /**
     * Get objects list: id, title, uname only / no relationships, no links.
     *
     * @return void
     */
    public function objects(): void
    {
        $this->viewBuilder()->setClassName('Json');
        $this->getRequest()->allowMethod('get');
        $query = array_merge(
            $this->getRequest()->getQueryParams(),
            ['fields' => 'id,title,uname']
        );
        $response = ApiTools::cleanResponse((array)$this->apiClient->get('objects', $query));
        $data = $response['data'];
        $meta = $response['meta'];
        $this->set(compact('data', 'meta'));
        $this->setSerialize(['data', 'meta']);
    }

    /**
     * Get history data by ID
     *
     * @param string|int $id Object ID.
     * @param int $page Page number.
     * @return void
     */
    public function info($id, int $page): void
    {
        $this->viewBuilder()->setClassName('Json');
        $this->getRequest()->allowMethod('get');
        $schema = (array)$this->Schema->getSchema($this->getRequest()->getParam('object_type'));
        $response = $this->History->fetch($id, $schema, compact('page'));
        $data = $response['data'];
        $meta = $response['meta'];
        $this->set(compact('data', 'meta'));
        $this->setSerialize(['data', 'meta']);
    }

    /**
     * Clone an object from a specific point of the history.
     *
     * @param string|int $id Object ID.
     * @param string|int $historyId History object ID.
     * @return \Cake\Http\Response|null
     */
    public function clone($id, $historyId): ?Response
    {
        $this->setHistory($id, $historyId, false);

        return $this->redirect(['_name' => 'modules:clone', 'object_type' => $this->getRequest()->getParam('object_type')] + compact('id'));
    }

    /**
     * Restore an object from a specific point of the history.
     *
     * @param string|int $id Object ID.
     * @param string|int $historyId History object ID.
     * @return \Cake\Http\Response|null
     */
    public function restore($id, $historyId): ?Response
    {
        $this->setHistory($id, $historyId, true);

        return $this->redirect(['_name' => 'modules:view', 'object_type' => $this->getRequest()->getParam('object_type')] + compact('id'));
    }

    /**
     * Load history data and write into session by ID.
     *
     * @param string|int $id The object type.
     * @param string|int $historyId Object ID.
     * @param bool $keepUname Keep previous uname.
     * @return void
     */
    protected function setHistory($id, $historyId, $keepUname): void
    {
        $objectType = $this->getRequest()->getParam('object_type');
        $options = compact('objectType', 'id', 'historyId', 'keepUname') + [
            'ApiClient' => $this->apiClient,
            'Request' => $this->getRequest(),
            'Schema' => $this->Schema,
        ];
        $this->History->write($options);
    }
}