ApplicationTrait::getWebroot() - Code Metrics - Inspection of "custom i18n with config file(env-local.php) (#1747..." - luyadev/luya - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 81474a...bc0aa4 )

by Basil

created 2018-01-05 09:27 UTC

ApplicationTrait::getWebroot() A

↳ Parent: ApplicationTrait

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	8
c	0
b	0
f	0
rs	9.4285
cc	2
eloc	4
nc	2
nop	0

<?php

namespace luya\traits;

use Yii;
use luya\base\AdminModuleInterface;
use luya\base\Module;
use luya\base\CoreModuleInterface;
use luya\base\PackageInstaller;

/**
 * LUYA Appliation trait
 *
 * @property string $webroot Returns the webroot directory event for console commands.
 * @property \luya\components\Mail $mail Get luya mail component
 *
 * @author Basil Suter <[email protected]>
 * @since 1.0.0
 */
trait ApplicationTrait
{
    private $_webroot;
    
    /**
     * @var string Title for the application used in different sections like Login screen
     */
    public $siteTitle = 'LUYA Application';
    
    /**
     * @var string|boolean Set a token, which will be used to collect data from a central host, if you want to enable this feature.
     * Use http://passwordsgenerator.net/ to create complex strings. When you have enabled this feature you can collect information's from
     * all your hosts with `example.com/admin/remote?token=Sha1EncodedRemoteToken`.
     */
    public $remoteToken = false;

    /**
     * @var string The directory where your webroot represents, this is basically used to find the webroot directory
     * in the console mode, cause some importer classes need those variables.
     */
    public $webrootDirectory = 'public_html';
    
    /**
     * @var string This value will be used as hostInfo when running console applications in urlManager. An example for using the hostInfo
     *
     * ```php
     * 'consoleHostInfo' => 'https://luya.io'
     * ```
     */
    public $consoleHostInfo;
    
    /**
     * @var string This value is used when declared for console request as urlManger baseUrl in order to enable urlHandling. If {{luya\web\traits\ApplicationTrait::$consoleHostInfo}}
     * is defined, consoleBaseUrl will use `/` as default value. The base url is the path where the application is running after hostInfo like
     *
     * ```php
     * 'consoleBaseUrl' => '/luya-kickstarter'
     * ```
     *
     * But in the most cases when the website is online the baseUrl is `/` which is enabled by default when {{luya\web\traits\ApplicationTrait::$consoleHostInfo}} is defined.
     */
    public $consoleBaseUrl;
    
    /**
     * @var array Add tags to the TagParser class. Example
     *
     * ```php
     * 'tags' => [
     *     'foobar' => ['class' => '\app\tags\FoobarTag'],
     * ],
     * ```
     */
    public $tags = [];

    /**
     * @var array Can override the localisation value used for php internal `setlocale()` method for specific language. For example
     * the language is de but the it should use the locale charset `de_CH.utf` (locale -a will return all locales installed on the server)
     * you can define them inside an array where key is the language and value the locale value to be used.
     *
     * ```php
     * public $locales = [
     *    'de' => 'de_CH',
     *    'en' => 'en_GB',
     * ];
     * ```
     */
    public $locales = [];
    
    /**
     * Add trace info to luya application trait
     */
    public function init()
    {
        parent::init();
        
        // add trace info
        Yii::trace('initialize LUYA Application', __METHOD__);
        
        $this->setLocale($this->language);
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }
    
    /**
     * Transform the $language into a locale sign to set php env settings.
     *
     * Example transform input `de` to `de_CH` when available $locales property.
     *
     * @param string $lang Find the locale POSIX for the provided $lang short code.
     * @return string The localisation code for the provided lang short code.
     */
    public function ensureLocale($lang)
    {
        if (array_key_exists($lang, $this->locales)) {
            return $this->locales[$lang];
        }
        
        if (strlen($lang) == 2) {
            switch ($lang) {
                case 'de':
                    return 'de_DE';
                case 'fr':
                    return 'fr_FR';
                case 'it':
                    return 'it_IT';
                case 'ru':
                    return 'ru_RU';
                case 'en':
                    return 'en_US';
                case 'cn':
                    return 'cn_CN';
                default:
                    return strtolower($lang) . '_' . strtoupper($lang);
            }
        }
        
        return $lang;
    }
    
    /**
     * Setter method ensures the locilations POSIX from {{ensureLocale}} for the provided lang
     * and changes the Yii::$app->langauge and sets the `setlocale()` code from ensureLocale().
     *
     * @param string $lang The language short code to set the locale for.
     */
    public function setLocale($lang)
    {
        $locale = str_replace('.utf8', '', $this->ensureLocale($lang));
        $this->language = $locale;
        setlocale(LC_ALL, $locale.'.utf8', $locale);
    }

    /**
     * Get the package Installer
     * @return \luya\base\PackageInstaller
     */
    public function getPackageInstaller()
    {
        $file = Yii::getAlias('@vendor/luyadev/installer.php');
        
        $data = is_file($file) ? include $file : [];
         
        return new PackageInstaller($data);
    }
    
    /**
     * @inheritdoc
     */
    protected function bootstrap()
    {
        foreach ($this->getPackageInstaller()->getConfigs() as $config) {
            $this->bootstrap = array_merge($this->bootstrap, $config->bootstrap);
class MyClass { }

$x = new MyClass();
$x->foo = true;
        }
        
        parent::bootstrap();
    }
    
    /**
     * Read only property which is used in cli bootstrap process to set the @webroot alias
     *
     * ```php
     * Yii::setAlias('@webroot', $app->webroot);
     * ```
     */
    public function getWebroot()
    {
        if ($this->_webroot === null) {
            $this->_webroot = realpath(realpath($this->basePath) . DIRECTORY_SEPARATOR . $this->webrootDirectory);
class MyClass { }

$x = new MyClass();
$x->foo = true;
        }
        
        return $this->_webroot;
    }

    /**
     * Add additional core components to the yii2 base core components.
     */
    public function luyaCoreComponents()
    {
        return array_merge(parent::coreComponents(), [
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
            'mail' => ['class' => 'luya\components\Mail'],
            'formatter' => ['class' => 'luya\components\Formatter'],
        ]);
    }

    /**
     * Get an array with all modules which are an instance of the `luya\base\Module`.
     *
     * @return \luya\base\Module
     */
    public function getApplicationModules()

    {
        $modules = [];

        foreach ($this->getModules() as $id => $obj) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            if ($obj instanceof Module) {
                $modules[$id] = $obj;
            }
        }

        return $modules;
    }

    /**
     * Return a list with all registered frontend modules except 'luya' and 'cms'. This is needed in the module block.
     *
     * @return \luya\base\Module
     */
    public function getFrontendModules()

    {
        $modules = [];

        foreach ($this->getModules() as $id => $obj) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            if ($obj instanceof Module && !$obj instanceof AdminModuleInterface && !$obj instanceof CoreModuleInterface) {
                $modules[$id] = $obj;
            }
        }

        return $modules;
    }
    
    /**
     * Return all Admin Module Interface implementing modules.
     *
     * @return \luya\base\AdminModuleInterface
     */
    public function getAdminModules()

    {
        $modules = [];
        
        foreach ($this->getModules() as $id => $obj) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            if ($obj instanceof Module && $obj instanceof AdminModuleInterface) {
                $modules[$id] = $obj;
            }
        }
        
        return $modules;
    }
}


1		<?php
2
3		namespace luya\traits;
4
5		use Yii;
6		use luya\base\AdminModuleInterface;
7		use luya\base\Module;
8		use luya\base\CoreModuleInterface;
9		use luya\base\PackageInstaller;
10
11		/**
12		* LUYA Appliation trait
13		*
14		* @property string $webroot Returns the webroot directory event for console commands.
15		* @property \luya\components\Mail $mail Get luya mail component
16		*
17		* @author Basil Suter <[email protected]>
18		* @since 1.0.0
19		*/
20		trait ApplicationTrait
21		{
22		private $_webroot;
23
24		/**
25		* @var string Title for the application used in different sections like Login screen
26		*/
27		public $siteTitle = 'LUYA Application';
28
29		/**
30		* @var string\|boolean Set a token, which will be used to collect data from a central host, if you want to enable this feature.
31		* Use http://passwordsgenerator.net/ to create complex strings. When you have enabled this feature you can collect information's from
32		* all your hosts with `example.com/admin/remote?token=Sha1EncodedRemoteToken`.
33		*/
34		public $remoteToken = false;
35
36		/**
37		* @var string The directory where your webroot represents, this is basically used to find the webroot directory
38		* in the console mode, cause some importer classes need those variables.
39		*/
40		public $webrootDirectory = 'public_html';
41
42		/**
43		* @var string This value will be used as hostInfo when running console applications in urlManager. An example for using the hostInfo
44		*
45		* ```php
46		* 'consoleHostInfo' => 'https://luya.io'
47		* ```
48		*/
49		public $consoleHostInfo;
50
51		/**
52		* @var string This value is used when declared for console request as urlManger baseUrl in order to enable urlHandling. If {{luya\web\traits\ApplicationTrait::$consoleHostInfo}}
53		* is defined, consoleBaseUrl will use `/` as default value. The base url is the path where the application is running after hostInfo like
54		*
55		* ```php
56		* 'consoleBaseUrl' => '/luya-kickstarter'
57		* ```
58		*
59		* But in the most cases when the website is online the baseUrl is `/` which is enabled by default when {{luya\web\traits\ApplicationTrait::$consoleHostInfo}} is defined.
60		*/
61		public $consoleBaseUrl;
62
63		/**
64		* @var array Add tags to the TagParser class. Example
65		*
66		* ```php
67		* 'tags' => [
68		* 'foobar' => ['class' => '\app\tags\FoobarTag'],
69		* ],
70		* ```
71		*/
72		public $tags = [];
73
74		/**
75		* @var array Can override the localisation value used for php internal `setlocale()` method for specific language. For example
76		* the language is de but the it should use the locale charset `de_CH.utf` (locale -a will return all locales installed on the server)
77		* you can define them inside an array where key is the language and value the locale value to be used.
78		*
79		* ```php
80		* public $locales = [
81		* 'de' => 'de_CH',
82		* 'en' => 'en_GB',
83		* ];
84		* ```
85		*/
86		public $locales = [];
87
88		/**
89		* Add trace info to luya application trait
90		*/
91		public function init()
92		{
93		parent::init();
94
95		// add trace info
96		Yii::trace('initialize LUYA Application', __METHOD__);
97
98		$this->setLocale($this->language);
		0 ignored issues – show Bug introduced 2017-05-16 10:55 UTC by Report Bug Copy Issue Report The property `language` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
99		}
100
101		/**
102		* Transform the $language into a locale sign to set php env settings.
103		*
104		* Example transform input `de` to `de_CH` when available $locales property.
105		*
106		* @param string $lang Find the locale POSIX for the provided $lang short code.
107		* @return string The localisation code for the provided lang short code.
108		*/
109		public function ensureLocale($lang)
110		{
111		if (array_key_exists($lang, $this->locales)) {
112		return $this->locales[$lang];
113		}
114
115		if (strlen($lang) == 2) {
116		switch ($lang) {
117		case 'de':
118		return 'de_DE';
119		case 'fr':
120		return 'fr_FR';
121		case 'it':
122		return 'it_IT';
123		case 'ru':
124		return 'ru_RU';
125		case 'en':
126		return 'en_US';
127		case 'cn':
128		return 'cn_CN';
129		default:
130		return strtolower($lang) . '_' . strtoupper($lang);
131		}
132		}
133
134		return $lang;
135		}
136
137		/**
138		* Setter method ensures the locilations POSIX from {{ensureLocale}} for the provided lang
139		* and changes the Yii::$app->langauge and sets the `setlocale()` code from ensureLocale().
140		*
141		* @param string $lang The language short code to set the locale for.
142		*/
143		public function setLocale($lang)
144		{
145		$locale = str_replace('.utf8', '', $this->ensureLocale($lang));
146		$this->language = $locale;
147		setlocale(LC_ALL, $locale.'.utf8', $locale);
148		}
149
150		/**
151		* Get the package Installer
152		* @return \luya\base\PackageInstaller
153		*/
154		public function getPackageInstaller()
155		{
156		$file = Yii::getAlias('@vendor/luyadev/installer.php');
157
158		$data = is_file($file) ? include $file : [];
159
160		return new PackageInstaller($data);
161		}
162
163		/**
164		* @inheritdoc
165		*/
166		protected function bootstrap()
167		{
168		foreach ($this->getPackageInstaller()->getConfigs() as $config) {
169		$this->bootstrap = array_merge($this->bootstrap, $config->bootstrap);
		0 ignored issues – show Bug introduced 2017-08-27 12:25 UTC by Report Bug Copy Issue Report The property `bootstrap` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
170		}
171
172		parent::bootstrap();
173		}
174
175		/**
176		* Read only property which is used in cli bootstrap process to set the @webroot alias
177		*
178		* ```php
179		* Yii::setAlias('@webroot', $app->webroot);
180		* ```
181		*/
182		public function getWebroot()
183		{
184		if ($this->_webroot === null) {
185		$this->_webroot = realpath(realpath($this->basePath) . DIRECTORY_SEPARATOR . $this->webrootDirectory);
		0 ignored issues – show Bug introduced 2017-04-18 11:06 UTC by Report Bug Copy Issue Report The property `basePath` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
186		}
187
188		return $this->_webroot;
189		}
190
191		/**
192		* Add additional core components to the yii2 base core components.
193		*/
194		public function luyaCoreComponents()
195		{
196		return array_merge(parent::coreComponents(), [
		0 ignored issues – show Comprehensibility Bug introduced 2016-03-08 10:05 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`coreComponents()` instead of `luyaCoreComponents()`). Are you sure this is correct? If so, you might want to change this to `$this->coreComponents()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
197		'mail' => ['class' => 'luya\components\Mail'],
198		'formatter' => ['class' => 'luya\components\Formatter'],
199		]);
200		}
201
202		/**
203		* Get an array with all modules which are an instance of the `luya\base\Module`.
204		*
205		* @return \luya\base\Module
206		*/
207	View Code Duplication	public function getApplicationModules()
		0 ignored issues – show Duplication introduced 2017-07-31 09:35 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
208		{
209		$modules = [];
210
211		foreach ($this->getModules() as $id => $obj) {
		0 ignored issues – show Bug introduced 2017-04-18 11:34 UTC by Report Bug Copy Issue Report It seems like `getModules()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
212		if ($obj instanceof Module) {
213		$modules[$id] = $obj;
214		}
215		}
216
217		return $modules;
218		}
219
220		/**
221		* Return a list with all registered frontend modules except 'luya' and 'cms'. This is needed in the module block.
222		*
223		* @return \luya\base\Module
224		*/
225	View Code Duplication	public function getFrontendModules()
		0 ignored issues – show Duplication introduced 2017-07-31 09:35 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
226		{
227		$modules = [];
228
229		foreach ($this->getModules() as $id => $obj) {
		0 ignored issues – show Bug introduced 2016-03-08 10:05 UTC by Report Bug Copy Issue Report It seems like `getModules()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
230		if ($obj instanceof Module && !$obj instanceof AdminModuleInterface && !$obj instanceof CoreModuleInterface) {
231		$modules[$id] = $obj;
232		}
233		}
234
235		return $modules;
236		}
237
238		/**
239		* Return all Admin Module Interface implementing modules.
240		*
241		* @return \luya\base\AdminModuleInterface
242		*/
243	View Code Duplication	public function getAdminModules()
		0 ignored issues – show Duplication introduced 2017-07-31 09:35 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
244		{
245		$modules = [];
246
247		foreach ($this->getModules() as $id => $obj) {
		0 ignored issues – show Bug introduced 2016-03-08 10:05 UTC by Report Bug Copy Issue Report It seems like `getModules()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
248		if ($obj instanceof Module && $obj instanceof AdminModuleInterface) {
249		$modules[$id] = $obj;
250		}
251		}
252
253		return $modules;
254		}
255		}
256

luyadev / luya

Push — master ( 81474a...bc0aa4 )

ApplicationTrait::getWebroot() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like