App::getDomainService() - Code Metrics - Inspection of "Allow symlinked data directories" - tollwerk/admin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1b03a0...553f9e )

by Joschi

created 2016-11-20 09:58 UTC

App::getDomainService() A

↳ Parent: App

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	8
c	0
b	0
f	0
ccs	0
cts	4
cp	0
rs	9.4285
cc	2
eloc	4
nc	2
nop	0
crap	6

<?php

/**
 * Toggl Dashboard
 *
 * @category    Tollwerk
 * @package     Tollwerk\Admin
 * @subpackage  Tollwerk\Admin\Ports
 * @author      Joschi Kuphal <[email protected]> / @jkphl
 * @copyright   Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
 * @license     http://opensource.org/licenses/MIT The MIT License (MIT)
 */

/***********************************************************************************
 *  The MIT License (MIT)
 *
 *  Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
 *  this software and associated documentation files (the "Software"), to deal in
 *  the Software without restriction, including without limitation the rights to
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 *  the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ***********************************************************************************/

namespace Tollwerk\Admin\Infrastructure;

use Doctrine\DBAL\Types\Type;
use Doctrine\ORM\EntityManager;
use Doctrine\ORM\Tools\Setup;
use Psr\Log\LogLevel;
use Symfony\Component\Yaml\Yaml;
use Tollwerk\Admin\Application\Contract\PersistenceAdapterFactoryInterface;
use Tollwerk\Admin\Application\Contract\PersistenceServiceInterface;
use Tollwerk\Admin\Application\Contract\ServiceServiceInterface;
use Tollwerk\Admin\Application\Contract\StorageAdapterStrategyInterface;
use Tollwerk\Admin\Application\Service\AccountService;
use Tollwerk\Admin\Application\Service\DomainService;
use Tollwerk\Admin\Application\Service\VirtualHostService;
use Tollwerk\Admin\Infrastructure\Doctrine\EnumVhosttypeType;
use Tollwerk\Admin\Infrastructure\Factory\PersistenceAdapterFactory;
use Tollwerk\Admin\Infrastructure\Service\PersistenceService;
use Tollwerk\Admin\Infrastructure\Service\ServiceService;
use Tollwerk\Admin\Infrastructure\Strategy\DoctrineStorageAdapterStrategy;

/**
 * App
 *
 * @package Tollwerk\Admin
 * @subpackage Tollwerk\Admin\Ports
 */
class App
{
    /**
     * Configuration
     *
     * @var array
     */
    protected static $config;
    /**
     * Root directory
     *
     * @var string
     */
    protected static $rootDirectory;
    /**
     * Entity manager
     *
     * @var EntityManager
     */
    protected static $entityManager;
    /**
     * Developer mode
     *
     * @var boolean
     */
    protected static $devMode;
    /**
     * Account service
     *
     * @var AccountService
     */
    protected static $accountService = null;
    /**
     * Virtual host service
     *
     * @var VirtualHostService
     */
    protected static $vhostService = null;
    /**
     * Domain service
     *
     * @var DomainService
     */
    protected static $domainService = null;
    /**
     * Active Storage adapter
     *
     * @var StorageAdapterStrategyInterface
     */
    protected static $storageAdapter;
    /**
     * Persistence adapter factory
     *
     * @var PersistenceAdapterFactoryInterface
     */
    protected static $persistenceAdapterFactory;
    /**
     * Persistence service
     *
     * @var PersistenceServiceInterface
     */
    protected static $persistenceService;
    /**
     * Service service
     *
     * @var ServiceServiceInterface
     */
    protected static $serviceService;
    /**
     * Application level messages
     *
     * @var array
     */
    protected static $messages = [];
    /**
     * App domain
     *
     * @var string
     */
    const DOMAIN = 'admin';

    /**
     * Bootstrap
     *
     * @see https://github.com/toggl/toggl_api_docs/blob/master/reports.md
     * @see http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/configuration.html
     *
     * @param bool $devMode Developer mode
     */
    public static function bootstrap($devMode = false)
    {
        self::$devMode = !!$devMode;
        self::$rootDirectory = dirname(dirname(dirname(__DIR__))).DIRECTORY_SEPARATOR;

        // Initialize the configuration
        $config = file_get_contents(self::$rootDirectory.'config'.DIRECTORY_SEPARATOR.'config.yml');
        self::$config = Yaml::parse($config);
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}

        // Initialize doctrine
        self::initializeDoctrine();

        // Register the Doctrine storage adapter and persistence adapter factory
        self::$storageAdapter = new DoctrineStorageAdapterStrategy();
        self::$persistenceAdapterFactory = new PersistenceAdapterFactory();
        self::$serviceService = new ServiceService();
        self::$persistenceService = new PersistenceService(self::$persistenceAdapterFactory, self::$serviceService);
    }

    /**
     * Initialize Doctrine
     */
    protected static function initializeDoctrine()
    {
        // If the Doctrine parameters don't exist
        if (empty(self::$config['doctrine'])
            || !is_array(self::$config['doctrine'])
            || empty(self::$config['doctrine']['dbparams'])
        ) {
            throw new \InvalidArgumentException('Invalid Doctrine database parameters', 1466175889);
        }

        $modelPaths = [
            self::$rootDirectory.'src'.DIRECTORY_SEPARATOR.'Admin'
            .DIRECTORY_SEPARATOR.'Infrastructure'.DIRECTORY_SEPARATOR.'Model'
        ];
        $dbParams = self::$config['doctrine']['dbparams'];
        $config = Setup::createAnnotationMetadataConfiguration($modelPaths, self::$devMode);

        self::$entityManager = EntityManager::create($dbParams, $config);
        $platform = self::$entityManager->getConnection()->getDatabasePlatform();
        $platform->registerDoctrineTypeMapping('enum', 'string');

        // Register the virtual host type declaration
        Type::addType(EnumVhosttypeType::ENUM_TYPE, EnumVhosttypeType::class);

        // Set the locale
        $locale = self::getConfig('general.locale');
        putenv('LC_ALL='.$locale);
        setlocale(LC_ALL, $locale);

        \bindtextdomain(self::DOMAIN, self::$rootDirectory.'src'.DIRECTORY_SEPARATOR.'Admin'
            .DIRECTORY_SEPARATOR.'Infrastructure'.DIRECTORY_SEPARATOR.'Lang');
        \bind_textdomain_codeset(self::DOMAIN, 'UTF-8');
        \textdomain(self::DOMAIN);
    }

    /**
     * Return the entity manager
     *
     * @return EntityManager
     */
    public static function getEntityManager()
    {
        return self::$entityManager;
    }

    /**
     * Get a configuration value
     *
     * @param null $key Optional: config value key
     * @return mixed Configuration value(s)
     */
    public static function getConfig($key = null)
    {
        if ($key === null) {
            return self::$config;
        }
        $keyParts = explode('.', $key);
        $config =& self::$config;
        foreach ($keyParts as $keyPart) {
            if (!array_key_exists($keyPart, $config)) {
                throw new \InvalidArgumentException(sprintf('Invalid config key "%s"', $key), 1466179561);
            }
            $config =& $config[$keyPart];
        }
        return $config;
    }

    /**
     * Return the contents of a particular template
     *
     * @param string $template Template name
     * @param bool $useDefault Use a default template
     * @return string template contents
     */
    public static function getTemplate($template, $useDefault = false)
    {
        $templateFile = self::$rootDirectory;
        $templateFile .= $useDefault ? 'config' :
            'src'.DIRECTORY_SEPARATOR.'Admin'.DIRECTORY_SEPARATOR.'Infrastructure'.DIRECTORY_SEPARATOR.'Templates';
        $templateFile .= DIRECTORY_SEPARATOR.$template;
        if (!file_exists($templateFile)) {
            throw new \RuntimeException(
                sprintf('Unknown '.($useDefault ? 'default ' : '').'template "%s"', $template),
                1475503926
            );
        }
        return file_get_contents($templateFile);
    }

    /**
     * Return the account service
     *
     * @return AccountService Account service
     */
    public static function getAccountService()
    {
        if (self::$accountService === null) {
            self::$accountService = new AccountService(self::$storageAdapter, self::$persistenceService);
        }

        return self::$accountService;
    }

    /**
     * Return the virtual host service
     *
     * @return VirtualHostService Virtual host service
     */
    public static function getVirtualHostService()
    {
        if (self::$vhostService === null) {
            self::$vhostService = new VirtualHostService(self::$storageAdapter, self::$persistenceService);
        }

        return self::$vhostService;
    }

    /**
     * Return the domain service
     *
     * @return DomainService Domain service
     */
    public static function getDomainService()
    {
        if (self::$domainService === null) {
            self::$domainService = new DomainService(self::$storageAdapter, self::$persistenceService);
        }

        return self::$domainService;
    }

    /**
     * Return the shell service service
     *
     * @return ServiceServiceInterface Service service
     */
    public static function getServiceService()
    {
        return self::$serviceService;
    }

    /**
     * Add an application level message
     *
     * @param string $message Message
     * @param string $level Log level
     */
    public static function addMessage($message, $level = LogLevel::INFO)
    {
        $message = trim($message);
        if (strlen($message)) {
            self::$messages[] = [$message, $level];
        }
    }

    /**
     * Return all application level messages
     *
     * @return array Messages
     */
    public static function getMessages()
    {
        return self::$messages;
    }
}


1		<?php
2
3		/**
4		* Toggl Dashboard
5		*
6		* @category Tollwerk
7		* @package Tollwerk\Admin
8		* @subpackage Tollwerk\Admin\Ports
9		* @author Joschi Kuphal <[email protected]> / @jkphl
10		* @copyright Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
11		* @license http://opensource.org/licenses/MIT The MIT License (MIT)
12		*/
13
14		/***********************************************************************************
15		* The MIT License (MIT)
16		*
17		* Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
18		*
19		* Permission is hereby granted, free of charge, to any person obtaining a copy of
20		* this software and associated documentation files (the "Software"), to deal in
21		* the Software without restriction, including without limitation the rights to
22		* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
23		* the Software, and to permit persons to whom the Software is furnished to do so,
24		* subject to the following conditions:
25		*
26		* The above copyright notice and this permission notice shall be included in all
27		* copies or substantial portions of the Software.
28		*
29		* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30		* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
31		* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
32		* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
33		* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
34		* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35		***********************************************************************************/
36
37		namespace Tollwerk\Admin\Infrastructure;
38
39		use Doctrine\DBAL\Types\Type;
40		use Doctrine\ORM\EntityManager;
41		use Doctrine\ORM\Tools\Setup;
42		use Psr\Log\LogLevel;
43		use Symfony\Component\Yaml\Yaml;
44		use Tollwerk\Admin\Application\Contract\PersistenceAdapterFactoryInterface;
45		use Tollwerk\Admin\Application\Contract\PersistenceServiceInterface;
46		use Tollwerk\Admin\Application\Contract\ServiceServiceInterface;
47		use Tollwerk\Admin\Application\Contract\StorageAdapterStrategyInterface;
48		use Tollwerk\Admin\Application\Service\AccountService;
49		use Tollwerk\Admin\Application\Service\DomainService;
50		use Tollwerk\Admin\Application\Service\VirtualHostService;
51		use Tollwerk\Admin\Infrastructure\Doctrine\EnumVhosttypeType;
52		use Tollwerk\Admin\Infrastructure\Factory\PersistenceAdapterFactory;
53		use Tollwerk\Admin\Infrastructure\Service\PersistenceService;
54		use Tollwerk\Admin\Infrastructure\Service\ServiceService;
55		use Tollwerk\Admin\Infrastructure\Strategy\DoctrineStorageAdapterStrategy;
56
57		/**
58		* App
59		*
60		* @package Tollwerk\Admin
61		* @subpackage Tollwerk\Admin\Ports
62		*/
63		class App
64		{
65		/**
66		* Configuration
67		*
68		* @var array
69		*/
70		protected static $config;
71		/**
72		* Root directory
73		*
74		* @var string
75		*/
76		protected static $rootDirectory;
77		/**
78		* Entity manager
79		*
80		* @var EntityManager
81		*/
82		protected static $entityManager;
83		/**
84		* Developer mode
85		*
86		* @var boolean
87		*/
88		protected static $devMode;
89		/**
90		* Account service
91		*
92		* @var AccountService
93		*/
94		protected static $accountService = null;
95		/**
96		* Virtual host service
97		*
98		* @var VirtualHostService
99		*/
100		protected static $vhostService = null;
101		/**
102		* Domain service
103		*
104		* @var DomainService
105		*/
106		protected static $domainService = null;
107		/**
108		* Active Storage adapter
109		*
110		* @var StorageAdapterStrategyInterface
111		*/
112		protected static $storageAdapter;
113		/**
114		* Persistence adapter factory
115		*
116		* @var PersistenceAdapterFactoryInterface
117		*/
118		protected static $persistenceAdapterFactory;
119		/**
120		* Persistence service
121		*
122		* @var PersistenceServiceInterface
123		*/
124		protected static $persistenceService;
125		/**
126		* Service service
127		*
128		* @var ServiceServiceInterface
129		*/
130		protected static $serviceService;
131		/**
132		* Application level messages
133		*
134		* @var array
135		*/
136		protected static $messages = [];
137		/**
138		* App domain
139		*
140		* @var string
141		*/
142		const DOMAIN = 'admin';
143
144		/**
145		* Bootstrap
146		*
147		* @see https://github.com/toggl/toggl_api_docs/blob/master/reports.md
148		* @see http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/configuration.html
149		*
150		* @param bool $devMode Developer mode
151		*/
152		public static function bootstrap($devMode = false)
153		{
154		self::$devMode = !!$devMode;
155		self::$rootDirectory = dirname(dirname(dirname(__DIR__))).DIRECTORY_SEPARATOR;
156
157		// Initialize the configuration
158		$config = file_get_contents(self::$rootDirectory.'config'.DIRECTORY_SEPARATOR.'config.yml');
159		self::$config = Yaml::parse($config);
		0 ignored issues – show Documentation Bug introduced 2016-10-04 19:39 UTC by Report Bug Copy Issue Report It seems like `\Symfony\Component\Yaml\Yaml::parse($config)` can also be of type `string` or `object<stdClass>`. However, the property `$config` is declared as type `array`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
160
161		// Initialize doctrine
162		self::initializeDoctrine();
163
164		// Register the Doctrine storage adapter and persistence adapter factory
165		self::$storageAdapter = new DoctrineStorageAdapterStrategy();
166		self::$persistenceAdapterFactory = new PersistenceAdapterFactory();
167		self::$serviceService = new ServiceService();
168		self::$persistenceService = new PersistenceService(self::$persistenceAdapterFactory, self::$serviceService);
169		}
170
171		/**
172		* Initialize Doctrine
173		*/
174		protected static function initializeDoctrine()
175		{
176		// If the Doctrine parameters don't exist
177		if (empty(self::$config['doctrine'])
178		\|\| !is_array(self::$config['doctrine'])
179		\|\| empty(self::$config['doctrine']['dbparams'])
180		) {
181		throw new \InvalidArgumentException('Invalid Doctrine database parameters', 1466175889);
182		}
183
184		$modelPaths = [
185		self::$rootDirectory.'src'.DIRECTORY_SEPARATOR.'Admin'
186		.DIRECTORY_SEPARATOR.'Infrastructure'.DIRECTORY_SEPARATOR.'Model'
187		];
188		$dbParams = self::$config['doctrine']['dbparams'];
189		$config = Setup::createAnnotationMetadataConfiguration($modelPaths, self::$devMode);
190
191		self::$entityManager = EntityManager::create($dbParams, $config);
192		$platform = self::$entityManager->getConnection()->getDatabasePlatform();
193		$platform->registerDoctrineTypeMapping('enum', 'string');
194
195		// Register the virtual host type declaration
196		Type::addType(EnumVhosttypeType::ENUM_TYPE, EnumVhosttypeType::class);
197
198		// Set the locale
199		$locale = self::getConfig('general.locale');
200		putenv('LC_ALL='.$locale);
201		setlocale(LC_ALL, $locale);
202
203		\bindtextdomain(self::DOMAIN, self::$rootDirectory.'src'.DIRECTORY_SEPARATOR.'Admin'
204		.DIRECTORY_SEPARATOR.'Infrastructure'.DIRECTORY_SEPARATOR.'Lang');
205		\bind_textdomain_codeset(self::DOMAIN, 'UTF-8');
206		\textdomain(self::DOMAIN);
207		}
208
209		/**
210		* Return the entity manager
211		*
212		* @return EntityManager
213		*/
214		public static function getEntityManager()
215		{
216		return self::$entityManager;
217		}
218
219		/**
220		* Get a configuration value
221		*
222		* @param null $key Optional: config value key
223		* @return mixed Configuration value(s)
224		*/
225	3	public static function getConfig($key = null)
226		{
227	3	if ($key === null) {
228		return self::$config;
229		}
230	3	$keyParts = explode('.', $key);
231	3	$config =& self::$config;
232	3	foreach ($keyParts as $keyPart) {
233	3	if (!array_key_exists($keyPart, $config)) {
234		throw new \InvalidArgumentException(sprintf('Invalid config key "%s"', $key), 1466179561);
235		}
236	3	$config =& $config[$keyPart];
237		}
238	3	return $config;
239		}
240
241		/**
242		* Return the contents of a particular template
243		*
244		* @param string $template Template name
245		* @param bool $useDefault Use a default template
246		* @return string template contents
247		*/
248		public static function getTemplate($template, $useDefault = false)
249		{
250		$templateFile = self::$rootDirectory;
251		$templateFile .= $useDefault ? 'config' :
252		'src'.DIRECTORY_SEPARATOR.'Admin'.DIRECTORY_SEPARATOR.'Infrastructure'.DIRECTORY_SEPARATOR.'Templates';
253		$templateFile .= DIRECTORY_SEPARATOR.$template;
254		if (!file_exists($templateFile)) {
255		throw new \RuntimeException(
256		sprintf('Unknown '.($useDefault ? 'default ' : '').'template "%s"', $template),
257		1475503926
258		);
259		}
260		return file_get_contents($templateFile);
261		}
262
263		/**
264		* Return the account service
265		*
266		* @return AccountService Account service
267		*/
268		public static function getAccountService()
269		{
270		if (self::$accountService === null) {
271		self::$accountService = new AccountService(self::$storageAdapter, self::$persistenceService);
272		}
273
274		return self::$accountService;
275		}
276
277		/**
278		* Return the virtual host service
279		*
280		* @return VirtualHostService Virtual host service
281		*/
282		public static function getVirtualHostService()
283		{
284		if (self::$vhostService === null) {
285		self::$vhostService = new VirtualHostService(self::$storageAdapter, self::$persistenceService);
286		}
287
288		return self::$vhostService;
289		}
290
291		/**
292		* Return the domain service
293		*
294		* @return DomainService Domain service
295		*/
296		public static function getDomainService()
297		{
298		if (self::$domainService === null) {
299		self::$domainService = new DomainService(self::$storageAdapter, self::$persistenceService);
300		}
301
302		return self::$domainService;
303		}
304
305		/**
306		* Return the shell service service
307		*
308		* @return ServiceServiceInterface Service service
309		*/
310		public static function getServiceService()
311		{
312		return self::$serviceService;
313		}
314
315		/**
316		* Add an application level message
317		*
318		* @param string $message Message
319		* @param string $level Log level
320		*/
321		public static function addMessage($message, $level = LogLevel::INFO)
322		{
323		$message = trim($message);
324		if (strlen($message)) {
325		self::$messages[] = [$message, $level];
326		}
327		}
328
329		/**
330		* Return all application level messages
331		*
332		* @return array Messages
333		*/
334		public static function getMessages()
335		{
336		return self::$messages;
337		}
338		}
339

tollwerk / admin

Push — master ( 1b03a0...553f9e )

App::getDomainService() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like