csphere\core\themes\Checks

Complexity

Total Complexity

12

Size/Duplication

Total Lines	154
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	1
A	_validate()	0	13	2
A	setTemplate()	0	10	1
A	existance()	0	22	3
A	dirname()	0	7	1
A	result()	0	16	4

<?php

/**
 * Contains some tools to check themes with
 *
 * PHP Version 5
 *
 * @category  Core
 * @package   Themes
 * @author    Hans-Joachim Piepereit <contact@csphere.eu>
 * @copyright 2013 cSphere Team
 * @license   http://opensource.org/licenses/bsd-license Simplified BSD License
 * @link      http://www.csphere.eu
 **/

namespace csphere\core\themes;

/**
 * Contains some tools to check themes with
 *
 * @category  Core
 * @package   Themes
 * @author    Hans-Joachim Piepereit <contact@csphere.eu>
 * @copyright 2013 cSphere Team
 * @license   http://opensource.org/licenses/bsd-license Simplified BSD License
 * @link      http://www.csphere.eu
 **/

class Checks
{
    /**
     * Theme that will be used
     **/
    private $_theme = '';

    /**
     * Local path
     **/
    private $_path = '';

    /**
     * File that will be used
     **/
    private $_file = '';

    /**
     * Remember positive existance checks
     **/
    private $_existance = false;

    /**
     * Get theme to see if it exists
     *
     * @param string $theme Name of theme
     *
     * @return \csphere\core\themes\Checks
     **/

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

There must be no blank lines after the function comment

    public function __construct($theme)
    {
        $this->_path = \csphere\core\init\path();

        $this->_theme = $theme;

        // Check theme details
        $this->_validate();

        $this->_file = 'csphere/themes/' . $this->_theme . '/index.htm';
    }

    /**
     * Check if plugin is valid
     *
     * @throws \Exception
     *
     * @return void
    **/

There must be no blank lines after the function comment

    private function _validate()
    {
        $meta = new \csphere\core\themes\Metadata();

        $exists = $meta->exists($this->_theme);

        if ($exists == false) {

It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

            $msg = 'Theme not found: "' . $this->_theme . '"';

            throw new \Exception($msg);
        }
    }

    /**
     * Set target for template files
     *
     * @param string $target Name of target
     * @param string $plugin Name of plugin
     *
     * @return void
     **/

There must be no blank lines after the function comment

    public function setTemplate($target, $plugin)
    {

        $metadata=new \csphere\core\plugins\metadata();
        $type=$metadata->templateType($plugin, $target);

        $this->_file = 'csphere/themes/' . $this->_theme
                     . '/templates/' . $plugin . '/' . $type. '/' . $target . '.tpl';

    }

    /**
     * Checks if the target file exists
     *
     * @return boolean
     **/

There must be no blank lines after the function comment

    public function existance()
    {
        $result = false;

        // Check for file existance if not done already
        if ($this->_existance == true) {

It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

            $result = true;
        } else {

            $target = $this->_path . $this->_file;

            // File must set before
            if (file_exists($target)) {

                $this->_existance = true;
                $result           = true;
            }
        }

        return $result;
    }

    /**
     * Dirname for external theme path
     *
     * @return string
     **/

There must be no blank lines after the function comment

    public function dirname()
    {
        $target = \csphere\core\http\Request::get('dirname')
                . 'csphere/themes/' . $this->_theme . '/';

        return $target;
    }

    /**
     * Replies with the target file
     *
     * @param boolean $path Append local path which defaults to true
     *
     * @throws \Exception
     *
     * @return string
     **/

There must be no blank lines after the function comment

    public function result($path = true)
    {
        $exists = $this->existance();

        // File must be there to return its origin
        if ($exists == false) {

It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

            throw new \Exception('Theme target not found: "' . $this->_file . '"');

        } else {

            $place = ($path == true) ? $this->_path . $this->_file :  $this->_file;

It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

        }

        return isset($place) ? $place : '';
    }
}