csphere\core\translation\Metadata

Complexity

Total Complexity

11

Size/Duplication

Total Lines	137
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
B	generate()	0	33	3
A	names()	0	19	2
A	plugins()	0	23	3
A	themes()	0	23	3

<?php

/**
 * Collects the important data from all translations for a central registry
 *
 * PHP Version 5
 *
 * @category  Core
 * @package   Translation
 * @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\translation;

/**
 * Collects the important data from all translations for a central registry
 *
 * @category  Core
 * @package   Translation
 * @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 Metadata extends \csphere\core\xml\Metadata
{
    /**
     * Type of registry
     **/
    protected $driver = 'language';

    /**
     * Generate registry from XML files
     *
     * @return array
    **/

There must be no blank lines after the function comment

    protected function generate()
    {
        // Try to load metadata from cache
        $key = 'metadata_' . $this->driver;
        $reg = $this->cache->load($key);

        // If cache loading fails load it and create cache file
        if ($reg == false) {

            // Get a directory listing of all default languages
            $origin = $this->path . 'csphere/plugins/default/languages';
            $files  = \csphere\core\files\File::search($origin);

            // Load xml content into an array
            $xml = $this->loader->load('xml', 'language');
            $reg = [];

            foreach ($files AS $file) {

                $lang   = explode('.xml', $file);
                $source = $xml->source('plugin', 'default', $lang[0]);

                // Definitions are just wasting space here
                unset($source['definitions']);

                $reg[$lang[0]] = $source;
            }

            $this->cache->save($key, $reg);
        }

        return $reg;
    }

    /**
     * List all language names with their short tag
     *
     * @return array
    **/

There must be no blank lines after the function comment

    public function names()
    {
        // Create a list of languages
        $reg   = $this->generate();
        $names = [];

        foreach ($reg AS $short => $info) {

            $names[$info['name']] = ['name'     => $info['name'],
                                     'short'    => $short,
                                     'icon_url' => $info['icon']['url']];
        }

        ksort($names);

        $names = array_values($names);

        return $names;
    }

    /**
     * List of all plugins with their translation status
     *
     * @param string $lang Language short handle, e.g. en
     *
     * @return array
    **/

There must be no blank lines after the function comment

    public function plugins($lang)
    {
        // Get plugin metadata
        $meta = new \csphere\core\plugins\Metadata();

        $plugins = $meta->details();

        // Add translation status to each entry
        $result = [];

        foreach ($plugins AS $plugin) {

            $origin = $this->path . 'csphere/plugins/'
                    . $plugin['short'] . '/languages/'
                    . $lang . '.xml';

            $plugin['exists'] = file_exists($origin) ? 'yes' : '';

            $result[] = $plugin;
        }

        return $result;
    }

    /**
     * List of all themes with their translation status
     *
     * @param string $lang Language short handle, e.g. en
     *
     * @return array
    **/

There must be no blank lines after the function comment

    public function themes($lang)
    {
        // Get plugin metadata
        $meta = new \csphere\core\themes\Metadata();

        $themes = $meta->details();

        // Add translation status to each entry
        $result = [];

        foreach ($themes AS $theme) {

            $origin = $this->path . 'csphere/themes/'
                    . $theme['short'] . '/languages/'
                    . $lang . '.xml';

            $theme['exists'] = file_exists($origin) ? 'yes' : '';

            $result[] = $theme;
        }

        return $result;
    }
}