hiqdev\yii2\modules\pages\Module

Complexity

Total Complexity

19

Size/Duplication

Total Lines	104
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

0%

Importance

Changes	4
Bugs	1	Features	2

10 Methods

Rating	Name	Duplication	Size	Complexity
A	findPageClass()	0	8	2
A	getInstance()	0	4	1
A	getViewPath()	0	4	1
C	find()	0	24	7
A	isDir()	0	10	2
A	getMetadata()	0	4	1
A	readArray()	0	5	1
A	getLocalPath()	0	6	1
A	setStorage()	0	4	1
A	getStorage()	0	8	2

<?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 Yii;
use yii\base\InvalidConfigException;

class Module extends \yii\base\Module
{
    protected $_storage;

    public $pageClasses = [
        'md'    => \hiqdev\yii2\modules\pages\models\MarkdownPage::class,
        'php'   => \hiqdev\yii2\modules\pages\models\PhpPage::class,
        'twig'  => \hiqdev\yii2\modules\pages\models\TwigPage::class,
    ];

    public function findPageClass($extension)
    {
        if (!isset($this->pageClasses[$extension])) {
            throw new InvalidConfigException('not handled extension:' . $extension);
        }

        return $this->pageClasses[$extension];
    }

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

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

    public function find($page)
    {
        if ($this->isDir($page)) {
            foreach (['index', 'README'] as $name) {
                $index = $this->find($page . '/' . $name);
                if ($index) {
                    return $index;
                }
            }
        }

        if ($this->getStorage()->has($page)) {
            return $page;
        }

        foreach (array_keys($this->pageClasses) as $extension) {
            $path = $page . '.' . $extension;
            if ($this->getStorage()->has($path)) {
                return $path;
            }
        }

        return null;
    }

    public function isDir($page)
    {

        if (!$this->getStorage()->has($page)) {
            return null;
        }
        $meta = $this->getMetadata($page);

        return $meta['type'] === 'dir';
    }

    public function getMetadata($page)
    {
        return $this->getStorage()->getMetadata($page);
    }

    /**
     * Reads given path as array of already rtrimmed lines.
     */
    public function readArray($path)
    {
        /// XXX: performance
        return preg_split("/((\r?\n)|(\r\n?))/", $this->getStorage()->read($path));
    }

    public function getLocalPath($path)
    {
        /// XXX: works for Local Filesystem only
        /// TODO: implement copying for others
        return $this->getStorage()->path . '/' . $path;
    }

    public function setStorage($value)
    {
        $this->_storage = $value;
    }

    public function getStorage()
    {
        if (!is_object($this->_storage)) {
            $this->_storage = Yii::createObject($this->_storage);
        }

        return $this->_storage;
    }
}