Fetch::keys() - Code Metrics - csphere-cms/cSphere - Measure and Improve Code Quality continuously with Scrutinizer

Fetch::keys() A
last analyzed 2017-04-21 16:53 UTC

↳ Parent: Fetch

Complexity

Conditions	3
Paths	3

Size

Total Lines	20
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	9
nc	3
nop	1
dl	0
loc	20
rs	9.4285
c	0
b	0
f	0

<?php

/**
 * Loads the requested language content
 *
 * PHP Version 5
 *
 * @category  Core
 * @package   Translation
 * @author    Hans-Joachim Piepereit <[email protected]>
 * @copyright 2013 cSphere Team
 * @license   http://opensource.org/licenses/bsd-license Simplified BSD License
 * @link      http://www.csphere.eu
 **/

namespace csphere\core\translation;

/**
 * Loads the requested language content
 *
 * PHP Version 5
 *
 * @category  Core
 * @package   Translation
 * @author    Hans-Joachim Piepereit <[email protected]>
 * @copyright 2013 cSphere Team
 * @license   http://opensource.org/licenses/bsd-license Simplified BSD License
 * @link      http://www.csphere.eu
 **/

abstract class Fetch
{
    /**
     * Language shorthandle for translation
     **/
    private static $_language = '';

    /**
     * Service loader object
     **/
    private static $_loader = null;

    /**
     * XML driver object
     **/
    private static $_xml = null;

    /**
     * Cache driver object
     **/
    private static $_cache = null;

    /**
     * View driver theme name
     **/
    private static $_theme = '';

    /**
     * Store language files that are already opened
     **/
    private static $_loaded = [];

    /**
     * Fetches the whole translation table
     *
     * @param string $plugin Plugin to use for language file
     *
     * @throws \Exception
     *
     * @return array
     **/


    public static function keys($plugin)
    {
        $exists = self::exists($plugin);

        // Return key if it exists
        if ($exists == true) {


            $return = self::$_loaded[$plugin];

        } else {

            // Empty plugin means that a theme translation is going on
            $error  = ($plugin == '') ? 'Theme' : 'Plugin "' . $plugin . '"';
            $error .= ' does not contain the requested translation';

            throw new \Exception($error);
        }

        return $return;
    }

    /**
     * Delivers the requested translation string
     *
     * @param string $plugin Plugin to use for language file
     * @param string $key    Key to search in that file
     *
     * @throws \Exception
     *
     * @return string
     **/


    public static function key($plugin, $key)
    {
        $exists = self::exists($plugin, $key);

        // Return key if it exists
        if ($exists == true) {


            $return = self::$_loaded[$plugin][$key];

        } else {

            // Empty plugin means that a theme translation is going on
            $error  = ($plugin == '') ? 'Theme' : 'Plugin "' . $plugin . '"';
            $error .= ' fails to translate this key: ' . $key;

            throw new \Exception($error);
        }

        return $return;
    }

    /**
     * Search for a key in a given plugin and the default plugin
     *
     * @param string $plugin Plugin to use for language file
     * @param string $key    Key to search in that file
     *
     * @return string
     **/


    public static function fallback($plugin, $key)
    {
        $target = '';
        $exists = self::exists($plugin, $key);

        // Search key in default plugin otherwise
        if ($exists === true) {

            $target = $plugin;

        } else {

            $exists = self::exists('default', $key);

            if ($exists === true) {

                $target = 'default';
            }
        }

        return $target;
    }

    /**
     * Checks if a plugin is translated or contains a key
     *
     * @param string $plugin Plugin to use for language file
     * @param string $key    Key to search in that file
     *
     * @return boolean
     **/


    public static function exists($plugin, $key = '')
    {
        // Check if translation is already loaded
        if (!isset(self::$_loaded[$plugin])) {

            self::$_loaded[$plugin] = self::_cache($plugin);
        }

        if ($key == '') {

            $result = isset(self::$_loaded[$plugin]) ? true : false;

        } else {

            $result = isset(self::$_loaded[$plugin][$key]) ? true : false;
        }

        return $result;
    }

    /**
     * Short name of active language
     *
     * @return string
     **/


    public static function lang()
    {
        // Load language short if not done yet
        if (self::$_language == '') {

            // Get user language from session
            $session  = new \csphere\core\session\Session();
            $language = $session->get('user_lang');

            self::$_language = empty($language) ? 'en' : $language;
        }

        return self::$_language;
    }

    /**
     * Sets options to work with translation files
     *
     * @return void
     **/


    private static function _settings()
    {
        // Set language if not done yet
        self::lang();

        // Get basic objects
        self::$_loader = \csphere\core\service\Locator::get();

        self::$_cache = self::$_loader->load('cache');

        $view = self::$_loader->load('view');

        self::$_theme = $view->getOption('theme');
    }

    /**
     * Delivers the requested translation file
     *
     * @param string $plugin Plugin to use for language file
     *
     * @return array
     **/


    private static function _cache($plugin)
    {
        // Load cache and settings if not done yet
        if (self::$_cache == null) {

            self::_settings();
        }

        // Empty plugin means that a theme translation is going on
        if ($plugin == '') {

            $token = 'lang_theme_' . self::$_theme . '_' . self::$_language;

        } else {

            $token = 'lang_plugin_' . $plugin . '_' . self::$_language;
        }

        // Look for plugin and language inside cache
        $lang = self::$_cache->load($token);

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

            $lang = self::_open($plugin);

            self::$_cache->save($token, $lang);
        }

        return $lang;
    }

    /**
     * Gets the content for the requested translation file
     *
     * @param string $plugin Plugin to use for language file
     *
     * @return array
     **/


    private static function _open($plugin)
    {
        // Set XML loader if not done yet
        if (self::$_xml == null) {

            self::$_xml = self::$_loader->load('xml', 'language');
        }

        // Empty plugin means that a theme translation is going on
        if ($plugin == '') {

            $data = self::$_xml->source('theme', self::$_theme, self::$_language);

        } else {

            $data = self::$_xml->source('plugin', $plugin, self::$_language);
        }

        // Array should be a list of names with their value
        $lang = [];
        $data = $data['definitions'];

        //@ToDo: Find out why the XML Parser delete empty values
        foreach ($data AS $def) {

            if (empty($def['value'])) {
                $lang[$def['name']]="";
            } else {
                $lang[$def['name']] = $def['value'];
            }

        }


        return $lang;
    }
}


1			<?php
2
3			/**
4			* Loads the requested language content
5			*
6			* PHP Version 5
7			*
8			* @category Core
9			* @package Translation
10			* @author Hans-Joachim Piepereit <[email protected]>
11			* @copyright 2013 cSphere Team
12			* @license http://opensource.org/licenses/bsd-license Simplified BSD License
13			* @link http://www.csphere.eu
14			**/
15
16			namespace csphere\core\translation;
17
18			/**
19			* Loads the requested language content
20			*
21			* PHP Version 5
22			*
23			* @category Core
24			* @package Translation
25			* @author Hans-Joachim Piepereit <[email protected]>
26			* @copyright 2013 cSphere Team
27			* @license http://opensource.org/licenses/bsd-license Simplified BSD License
28			* @link http://www.csphere.eu
29			**/
30
31			abstract class Fetch
32			{
33			/**
34			* Language shorthandle for translation
35			**/
36			private static $_language = '';
37
38			/**
39			* Service loader object
40			**/
41			private static $_loader = null;
42
43			/**
44			* XML driver object
45			**/
46			private static $_xml = null;
47
48			/**
49			* Cache driver object
50			**/
51			private static $_cache = null;
52
53			/**
54			* View driver theme name
55			**/
56			private static $_theme = '';
57
58			/**
59			* Store language files that are already opened
60			**/
61			private static $_loaded = [];
62
63			/**
64			* Fetches the whole translation table
65			*
66			* @param string $plugin Plugin to use for language file
67			*
68			* @throws \Exception
69			*
70			* @return array
71			**/
			0 ignored issues – show Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history...
72
73			public static function keys($plugin)
74			{
75			$exists = self::exists($plugin);
76
77			// Return key if it exists
78			if ($exists == true) {
			0 ignored issues – show Coding Style Best Practice introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing two booleans. Considering using the strict comparison `===` instead. When comparing two booleans, it is generally considered safer to use the strict comparison operator. Loading history...
79
80			$return = self::$_loaded[$plugin];
81
82			} else {
83
84			// Empty plugin means that a theme translation is going on
85			$error = ($plugin == '') ? 'Theme' : 'Plugin "' . $plugin . '"';
86			$error .= ' does not contain the requested translation';
87
88			throw new \Exception($error);
89			}
90
91			return $return;
92			}
93
94			/**
95			* Delivers the requested translation string
96			*
97			* @param string $plugin Plugin to use for language file
98			* @param string $key Key to search in that file
99			*
100			* @throws \Exception
101			*
102			* @return string
103			**/
			0 ignored issues – show Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history...
104
105			public static function key($plugin, $key)
106			{
107			$exists = self::exists($plugin, $key);
108
109			// Return key if it exists
110			if ($exists == true) {
			0 ignored issues – show Coding Style Best Practice introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing two booleans. Considering using the strict comparison `===` instead. When comparing two booleans, it is generally considered safer to use the strict comparison operator. Loading history...
111
112			$return = self::$_loaded[$plugin][$key];
113
114			} else {
115
116			// Empty plugin means that a theme translation is going on
117			$error = ($plugin == '') ? 'Theme' : 'Plugin "' . $plugin . '"';
118			$error .= ' fails to translate this key: ' . $key;
119
120			throw new \Exception($error);
121			}
122
123			return $return;
124			}
125
126			/**
127			* Search for a key in a given plugin and the default plugin
128			*
129			* @param string $plugin Plugin to use for language file
130			* @param string $key Key to search in that file
131			*
132			* @return string
133			**/
			0 ignored issues – show Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history...
134
135			public static function fallback($plugin, $key)
136			{
137			$target = '';
138			$exists = self::exists($plugin, $key);
139
140			// Search key in default plugin otherwise
141			if ($exists === true) {
142
143			$target = $plugin;
144
145			} else {
146
147			$exists = self::exists('default', $key);
148
149			if ($exists === true) {
150
151			$target = 'default';
152			}
153			}
154
155			return $target;
156			}
157
158			/**
159			* Checks if a plugin is translated or contains a key
160			*
161			* @param string $plugin Plugin to use for language file
162			* @param string $key Key to search in that file
163			*
164			* @return boolean
165			**/
			0 ignored issues – show Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history...
166
167			public static function exists($plugin, $key = '')
168			{
169			// Check if translation is already loaded
170			if (!isset(self::$_loaded[$plugin])) {
171
172			self::$_loaded[$plugin] = self::_cache($plugin);
173			}
174
175			if ($key == '') {
176
177			$result = isset(self::$_loaded[$plugin]) ? true : false;
178
179			} else {
180
181			$result = isset(self::$_loaded[$plugin][$key]) ? true : false;
182			}
183
184			return $result;
185			}
186
187			/**
188			* Short name of active language
189			*
190			* @return string
191			**/
			0 ignored issues – show Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history...
192
193			public static function lang()
194			{
195			// Load language short if not done yet
196			if (self::$_language == '') {
197
198			// Get user language from session
199			$session = new \csphere\core\session\Session();
200			$language = $session->get('user_lang');
201
202			self::$_language = empty($language) ? 'en' : $language;
203			}
204
205			return self::$_language;
206			}
207
208			/**
209			* Sets options to work with translation files
210			*
211			* @return void
212			**/
			0 ignored issues – show Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history...
213
214			private static function _settings()
215			{
216			// Set language if not done yet
217			self::lang();
218
219			// Get basic objects
220			self::$_loader = \csphere\core\service\Locator::get();
221
222			self::$_cache = self::$_loader->load('cache');
223
224			$view = self::$_loader->load('view');
225
226			self::$_theme = $view->getOption('theme');
227			}
228
229			/**
230			* Delivers the requested translation file
231			*
232			* @param string $plugin Plugin to use for language file
233			*
234			* @return array
235			**/
			0 ignored issues – show Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history...
236
237			private static function _cache($plugin)
238			{
239			// Load cache and settings if not done yet
240			if (self::$_cache == null) {
241
242			self::_settings();
243			}
244
245			// Empty plugin means that a theme translation is going on
246			if ($plugin == '') {
247
248			$token = 'lang_theme_' . self::$_theme . '_' . self::$_language;
249
250			} else {
251
252			$token = 'lang_plugin_' . $plugin . '_' . self::$_language;
253			}
254
255			// Look for plugin and language inside cache
256			$lang = self::$_cache->load($token);
257
258			// If cache loading fails load it and create cache file
259			if ($lang == false) {
260
261			$lang = self::_open($plugin);
262
263			self::$_cache->save($token, $lang);
264			}
265
266			return $lang;
267			}
268
269			/**
270			* Gets the content for the requested translation file
271			*
272			* @param string $plugin Plugin to use for language file
273			*
274			* @return array
275			**/
			0 ignored issues – show Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history...
276
277			private static function _open($plugin)
278			{
279			// Set XML loader if not done yet
280			if (self::$_xml == null) {
281
282			self::$_xml = self::$_loader->load('xml', 'language');
283			}
284
285			// Empty plugin means that a theme translation is going on
286			if ($plugin == '') {
287
288			$data = self::$_xml->source('theme', self::$_theme, self::$_language);
289
290			} else {
291
292			$data = self::$_xml->source('plugin', $plugin, self::$_language);
293			}
294
295			// Array should be a list of names with their value
296			$lang = [];
297			$data = $data['definitions'];
298
299			//@ToDo: Find out why the XML Parser delete empty values
300			foreach ($data AS $def) {
301
302			if (empty($def['value'])) {
303			$lang[$def['name']]="";
304			} else {
305			$lang[$def['name']] = $def['value'];
306			}
307
308			}
309
310
311			return $lang;
312			}
313			}
314

csphere-cms / cSphere

Fetch::keys() A last analyzed 2017-04-21 16:53 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Fetch::keys() A
last analyzed 2017-04-21 16:53 UTC