hiqdev\yii2\modules\pages\Module

Complexity

Total Complexity

9

Size/Duplication

Total Lines	85
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	3

Test Coverage

Coverage

0%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getInstance()	0	4	1
A	getViewPath()	0	4	1
A	find()	0	6	1
A	findList()	0	6	1
A	setStorage()	0	4	1
A	getStorage()	0	8	2
A	setPageSize()	0	4	1
A	getPageSize()	0	4	1

<?php
/**
 * Yii2 Pages Module
 *
 * @link      https://github.com/hiqdev/yii2-module-pages
 * @package   yii2-module-pages
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2016-2017, HiQDev (http://hiqdev.com/)
 */

namespace hiqdev\yii2\modules\pages;

use hiqdev\yii2\modules\pages\interfaces\PageInterface;
use hiqdev\yii2\modules\pages\models\AbstractPage;
use hiqdev\yii2\modules\pages\models\PagesList;
use hiqdev\yii2\modules\pages\interfaces\StorageInterface;
use Yii;

class Module extends \yii\base\Module
{
    /** @var array|StorageInterface */
    protected $_storage;

    /** @var int */
    private $pageSize;

    const DEFAULT_PAGE_SIZE = 5;

    public static function getInstance(): Module
    {
        return Yii::$app->getModule('pages');
    }

    /**
     * This to use standard app pathes for views and layouts.
     * @return string
     */
    public function getViewPath()
    {
        return Yii::$app->getViewPath();
    }

    /**
     * @param string $pageName
     * @return AbstractPage|null
     * @throws \yii\base\InvalidConfigException
     */
    public function find(string $pageName): ?PageInterface
    {
        $page = $this->getStorage()->getPage($pageName);

        return $page;
    }

    /**
     * @param string|null $id
     * @return PagesList|null
     * @throws \yii\base\InvalidConfigException
     */
    public function findList(string $id = null): ?PagesList
    {
        $list = $this->getStorage()->getList($id);

        return $list;
    }

    /**
     * @param array $storageConfig
     */
    public function setStorage($storageConfig): void
    {
        $this->_storage = $storageConfig;
    }

    /**
     * @return StorageInterface
     * @throws \yii\base\InvalidConfigException
     */
    public function getStorage(): StorageInterface
    {
        if (!is_object($this->_storage)) {
            $this->_storage = Yii::createObject($this->_storage);
        }

        return $this->_storage;
    }

    /**
     * @param int $pageSize
     */
    public function setPageSize(int $pageSize): void
    {
        $this->pageSize = $pageSize;
    }

    /**
     * @return int
     */
    public function getPageSize(): int
    {
        return $this->pageSize ?? self::DEFAULT_PAGE_SIZE;
    }
}