Theme::getArray() - Code Metrics - KSST/KF - Measure and Improve Code Quality continuously with Scrutinizer

Theme::getArray() A
last analyzed 2017-04-11 14:32 UTC

↳ Parent: Theme

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
c	0
b	0
f	0
nc	1
nop	0
dl	0
loc	4
rs	10

<?php

/**
 * Koch Framework
 * Jens-André Koch © 2005 - onwards.
 *
 * This file is part of "Koch Framework".
 *
 * License: GNU/GPL v2 or any later version, see LICENSE file.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

namespace Koch\View\Helper;

use Koch\View\AbstractRenderer;

/**
 * Koch Framework - Class for handling of Themes.
 *
 * This class provides abstracted (object) access to a theme's theme_info.xml file.
 */
class Theme
{
    public $theme      = '';
    public $theme_info = [];


    /**
     * Constructor, or what ;).
     *
     * @param string $theme Name of the Theme.
     *
     * @return \Koch\View\Helper\Theme

     */
    public function __construct($theme)
    {
        $this->setThemeName($theme);

        $this->getInfoArray($theme);

        return $this;

    }

    /**
     * @param string $theme
     */
    public function setThemeName($theme)
    {
        if ($theme === null) {
            throw new \InvalidArgumentException('Please  provide a theme name.');
        }

        $this->theme = $theme;
    }

    /**
     * Getter for the "theme_info.xml" file of the currently activated theme.
     *
     * @return string Filepath to "theme_info.xml" of the currently activated theme.

     */
    public function getCurrentThemeInfoFile()
    {
        // get array for frontend or backend theme
        $paths = AbstractRenderer::getThemeTemplatePaths();


        foreach ($paths as $path) {
            $file = $path . DIRECTORY_SEPARATOR . 'theme_info.xml';

            if (is_file($file)) {
                return $file;
            }
        }
    }

    /**
     * Looks for the requested theme in the frontend and backend theme folder
     * and returns the theme path.
     *
     * @param string $theme Theme name.

     *
     * @return string Path to theme.

     */
    public function getPath($theme = null)
    {
        if ($theme === null) {
            $theme = $this->getName();
        }

        if (is_dir(APPLICATION_PATH . 'Themes') === false) {
            throw new \RuntimeException('The application themes folder was not found.');
        }

        $frontend = APPLICATION_PATH . 'Themes/frontend/' . $theme . DIRECTORY_SEPARATOR;
        if (is_dir($frontend)) {
            return $frontend;
        }

        $backend = APPLICATION_PATH . 'Themes/backend/' . $theme . DIRECTORY_SEPARATOR;
        if (is_dir($backend)) {
            return $backend;
        }

        return false;
    }

    /**
     * Looks for the requested theme in the frontend and backend theme folder
     * and returns the web path of the theme.
     *
     * @param string $theme Theme name.

     *
     * @return string Webpath of theme (for usage in templates).

     */
    public function getWebPath($theme = null)
    {
        if ($theme === null) {
            $theme = $this->getName();
        }

        // check absolute, return www
        if (is_dir(APPLICATION_PATH . 'Themes/frontend/' . $theme)) {
            return WWW_ROOT_THEMES_FRONTEND . $theme . '/';
        }

        // check absolute, return www
        if (is_dir(APPLICATION_PATH . 'Themes/backend/' . $theme)) {
            return WWW_ROOT_THEMES_BACKEND . $theme . '/';
        }
    }

    /**
     * Returns "theme_info.xml" for the requested theme.
     *
     * @param string $theme Theme name.
     *
     * @return string File path to "theme_info.xml" file.
     *
     * @throws \Koch\Exception\Exception
     */
    public function getThemeInfoFile($theme)
    {
        $file = $this->getPath($theme) . 'theme_info.xml';

        if (is_file($file)) {
            return $file;
        }

        throw new \Exception('The Theme "' . $theme . '" has no "theme_info.xml" file.');
    }

    /**
     * Returns Theme Infos as array.
     *
     * @param string $theme Name of the Theme.

     *
     * @return array Theme_Info.xml as Array.
     */
    public function getInfoArray($theme = null)
    {
        $file = $this->getThemeInfoFile($theme);

        $array = \Koch\Config\Adapter\XML::read($file);

        // when setting array as object property remove the inner theme array
        $this->theme_info = $array['theme'];

        return $this->theme_info;
    }

    /**
     * --------------------------------------------------------------------------------------------
     *  GETTERS
     * --------------------------------------------------------------------------------------------.
     */

    /**
     * Gets shortname or folder name.
     *
     * @return string short name / folder name.
     */
    public function getName()
    {
        return $this->theme;
    }

    public function getFullName()

    {
        return $this->theme_info['name'];
    }

    public function getAuthor()

    {
        return $this->theme_info['authors'];
    }

    public function getVersion()

    {
        return $this->theme_info['theme_version'];
    }

    public function getRequiredVersion()

    {
        return $this->theme_info['required_version'];
    }

    public function getDate()

    {
        return $this->theme_info['date'];
    }

    public function getLayout()

    {
        return $this->theme_info['layout'];
    }

    public function getCss()

    {
        return $this->theme_info['css'];
    }

    public function getLayoutFile()

    {
        if ($this->theme_info['layout']['mainfile'] !== null) {
            #return $this->getPath() . $this->theme_info['layout']['mainfile'];


            return $this->theme_info['layout']['mainfile'];
        } elseif (false === isset($this->theme_info['layout']['mainfile'])) {
            // maybe we have a main template css file named after the theme
            // $layout_file = $this->getPath() . $this->getName() . '.tpl';

            $layout_file = $this->getName() . '.tpl';


            if (is_file($layout_file)) {

                return $layout_file;

            }
        } else { // no main layout found !
            throw new \Exception('No Layout File defined. Check ThemeInfo File of ' . $this->getName(), 9090);
        }
    }

    public function getRenderEngine()

    {
        return $this->theme_info['renderengine'];
    }

    public function isBackendTheme()
    {
        return (bool) $this->theme_info['backendtheme'];
    }

    public function isFrontendTheme()
    {
        return (bool) $this->theme_info['backendtheme'] === true ? false : true;
    }

    public function getArray()
    {
        return $this->theme_info;
    }

    public static function getThemeDirectories()
    {
        return array_merge(
            self::iterateDir(APPLICATION_PATH . 'themes/frontend/', 'frontend'),
            self::iterateDir(APPLICATION_PATH . 'themes/backend/', 'backend')
        );
    }

    /**
     * Iterates over a theme dir (backend / frontend) and fetches some data.
     *
     * @param string $dir             APPLICATION_FRONTEND_THEMES_PATH, APPLICATION_BACKEND_THEMES_PATH
     * @param string $type            'frontend' or 'backend'
     * @param bool   $only_index_name
     *
     * @return string

     */
    protected static function iterateDir($dir, $type, $only_index_name = true)

    {
        $dirs    = '';
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $dir_tmp = '';

        $i       = 0;
        $themes  = [];

        $dirs = new \DirectoryIterator($dir);

        foreach ($dirs as $dir) {
            /*
             * Skip early on dots, like "." or ".." or ".svn", by cheching the first char.
             * we can not use DirectoryIterator::isDot() here, because it only checks "." and "..".
             */
            $dir_tmp = $dir->getFilename();


            if ($dir_tmp{0} === '.') {

                continue;
            }

            /*
             * take only directories in account, which contain a "theme_info.xml" file
             */
            if (is_file($dir->getPathName() . DIRECTORY_SEPARATOR . 'theme_info.xml')) {
                $i = $i + 1;

                if ($only_index_name === false) {

                    // add fullpath
                    $themes[$i]['path'] = $dir->getPathName();

                    // set frontend as type
                    $themes[$i]['type'] = $type;

                    // add dirname
                    $themes[$i]['name'] = $type . DIRECTORY_SEPARATOR . (string) $dir;
                } else {
                    // add dirname
                    $themes[$i] = $type . DIRECTORY_SEPARATOR . (string) $dir;
                }
            }
        }

        unset($i, $dirs, $dir_tmp);


        return $themes;
    }
}


1			<?php
2
3			/**
4			* Koch Framework
5			* Jens-André Koch © 2005 - onwards.
6			*
7			* This file is part of "Koch Framework".
8			*
9			* License: GNU/GPL v2 or any later version, see LICENSE file.
10			*
11			* This program is free software; you can redistribute it and/or modify
12			* it under the terms of the GNU General Public License as published by
13			* the Free Software Foundation; either version 2 of the License, or
14			* (at your option) any later version.
15			*
16			* This program is distributed in the hope that it will be useful,
17			* but WITHOUT ANY WARRANTY; without even the implied warranty of
18			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19			* GNU General Public License for more details.
20			*
21			* You should have received a copy of the GNU General Public License
22			* along with this program. If not, see <http://www.gnu.org/licenses/>.
23			*/
24
25			namespace Koch\View\Helper;
26
27			use Koch\View\AbstractRenderer;
28
29			/**
30			* Koch Framework - Class for handling of Themes.
31			*
32			* This class provides abstracted (object) access to a theme's theme_info.xml file.
33			*/
34			class Theme
35			{
36			public $theme = '';
37			public $theme_info = [];
			0 ignored issues – show Coding Style introduced 2015-12-23 17:35 UTC by Report Bug Copy Issue Report `$theme_info` does not seem to conform to the naming convention (`^[a-z][a-zA-Z0-9]*$`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
38
39			/**

KSST / KF

Theme::getArray() A last analyzed 2017-04-11 14:32 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Theme::getArray() A
last analyzed 2017-04-11 14:32 UTC