CacheTranslationDecorator - Code Metrics - AsgardCms/Translation - Measure and Improve Code Quality continuously with Scrutinizer

CacheTranslationDecorator A
last analyzed 2016-08-30 10:13 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	96
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	8
Bugs	0	Features	1

Metric	Value
wmc	9
c	8
b	0
f	1
lcom	1
cbo	3
dl	0
loc	96
rs	10

8 Methods

Rating	Name	Size	Complexity
A	findByKeyAndLocale()	14	2
A	allFormatted()	10	1
A	saveTranslationForLocaleAndKey()	6	1
A	findTranslationByKey()	12	1
A	updateFromImport()	6	1
A	updateTranslationToValue()	6	1
A	cleanKey()	4	1
A	__construct()	6	1

<?php namespace Modules\Translation\Repositories\Cache;

use Modules\Core\Repositories\Cache\BaseCacheDecorator;
use Modules\Translation\Entities\TranslationTranslation;
use Modules\Translation\Repositories\TranslationRepository;

class CacheTranslationDecorator extends BaseCacheDecorator implements TranslationRepository
{
    public function __construct(TranslationRepository $recipe)
    {
        parent::__construct();
        $this->entityName = 'translation.translations';
        $this->repository = $recipe;
    }

    /**
     * @param string $key
     * @param string $locale
     * @return string
     */
    public function findByKeyAndLocale($key, $locale = null)
    {
        $cleanKey = $this->cleanKey($key);

        $locale = $locale ?: app()->getLocale();

        return $this->cache
            ->tags($this->entityName, 'global')

            ->rememberForever("{$this->entityName}.findByKeyAndLocale.{$cleanKey}.{$locale}",
                function () use ($key, $locale) {
                    return $this->repository->findByKeyAndLocale($key, $locale);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                }
            );
    }

    public function allFormatted()
    {
        return $this->cache
            ->tags($this->entityName, 'global')

            ->rememberForever("{$this->locale}.{$this->entityName}.allFormatted",
                function () {
                    return $this->repository->allFormatted();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                }
            );
    }

    public function saveTranslationForLocaleAndKey($locale, $key, $value)
    {
        $this->cache->tags($this->entityName)->flush();

        return $this->repository->saveTranslationForLocaleAndKey($locale, $key, $value);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    public function findTranslationByKey($key)
    {
        $cleanKey = $this->cleanKey($key);

        return $this->cache
            ->tags($this->entityName, 'global')

            ->rememberForever("{$this->locale}.{$this->entityName}.findTranslationByKey.{$cleanKey}",
                function () use ($key) {
                    return $this->repository->findTranslationByKey($key);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                }
            );
    }

    /**
     * Update the given translation key with the given data
     * @param string $key
     * @param array $data
     * @return mixed
     */
    public function updateFromImport($key, array $data)
    {
        $this->cache->tags($this->entityName)->flush();

        return $this->repository->updateFromImport($key, $data);

    }

    /**
     * Set the given value on the given TranslationTranslation
     * @param TranslationTranslation $translationTranslation
     * @param string $value
     * @return void
     */
    public function updateTranslationToValue(TranslationTranslation $translationTranslation, $value)
    {
        $this->cache->tags($this->entityName)->flush();

        return $this->repository->updateTranslationToValue($translationTranslation, $value);

    }

    /**
     * Clean a Cache Key so it is safe for use
     * @param string $key   Potentially unsafe key
     * @return string
     */
    protected function cleanKey($key)
    {
        return str_replace(" ", "--", $key);
    }
}


1			<?php namespace Modules\Translation\Repositories\Cache;
2
3			use Modules\Core\Repositories\Cache\BaseCacheDecorator;
4			use Modules\Translation\Entities\TranslationTranslation;
5			use Modules\Translation\Repositories\TranslationRepository;
6
7			class CacheTranslationDecorator extends BaseCacheDecorator implements TranslationRepository
8			{
9			public function __construct(TranslationRepository $recipe)
10			{
11			parent::__construct();
12			$this->entityName = 'translation.translations';
13			$this->repository = $recipe;
14			}
15
16			/**
17			* @param string $key
18			* @param string $locale
19			* @return string
20			*/
21			public function findByKeyAndLocale($key, $locale = null)
22			{
23			$cleanKey = $this->cleanKey($key);
24
25			$locale = $locale ?: app()->getLocale();
26
27			return $this->cache
28			->tags($this->entityName, 'global')
			0 ignored issues – show Unused Code introduced 2016-01-27 17:13 UTC by Report Bug Copy Issue Report The call to `Repository::tags()` has too many arguments starting with `'global'`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
29			->rememberForever("{$this->entityName}.findByKeyAndLocale.{$cleanKey}.{$locale}",
30			function () use ($key, $locale) {
31			return $this->repository->findByKeyAndLocale($key, $locale);
			0 ignored issues – show Bug introduced 2015-11-29 11:40 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Modules\Core\Repositories\BaseRepository` as the method `findByKeyAndLocale()` does only exist in the following implementations of said interface: `Modules\Translation\Repo...cheTranslationDecorator`, `Modules\Translation\Repo...ntTranslationRepository`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
32			}
33			);
34			}
35
36			public function allFormatted()
37			{
38			return $this->cache
39			->tags($this->entityName, 'global')
			0 ignored issues – show Unused Code introduced 2016-01-27 17:13 UTC by Report Bug Copy Issue Report The call to `Repository::tags()` has too many arguments starting with `'global'`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
40			->rememberForever("{$this->locale}.{$this->entityName}.allFormatted",
41			function () {
42			return $this->repository->allFormatted();
			0 ignored issues – show Bug introduced 2015-11-29 11:40 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Modules\Core\Repositories\BaseRepository` as the method `allFormatted()` does only exist in the following implementations of said interface: `Modules\Translation\Repo...cheTranslationDecorator`, `Modules\Translation\Repo...ntTranslationRepository`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
43			}
44			);
45			}
46
47			public function saveTranslationForLocaleAndKey($locale, $key, $value)
48			{
49			$this->cache->tags($this->entityName)->flush();
50
51			return $this->repository->saveTranslationForLocaleAndKey($locale, $key, $value);
			0 ignored issues – show Bug introduced 2015-11-29 11:40 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Modules\Core\Repositories\BaseRepository` as the method `saveTranslationForLocaleAndKey()` does only exist in the following implementations of said interface: `Modules\Translation\Repo...cheTranslationDecorator`, `Modules\Translation\Repo...ntTranslationRepository`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
52			}
53
54			public function findTranslationByKey($key)
55			{
56			$cleanKey = $this->cleanKey($key);
57
58			return $this->cache
59			->tags($this->entityName, 'global')
			0 ignored issues – show Unused Code introduced 2016-01-27 17:13 UTC by Report Bug Copy Issue Report The call to `Repository::tags()` has too many arguments starting with `'global'`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
60			->rememberForever("{$this->locale}.{$this->entityName}.findTranslationByKey.{$cleanKey}",
61			function () use ($key) {
62			return $this->repository->findTranslationByKey($key);
			0 ignored issues – show Bug introduced 2015-11-29 11:40 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Modules\Core\Repositories\BaseRepository` as the method `findTranslationByKey()` does only exist in the following implementations of said interface: `Modules\Translation\Repo...cheTranslationDecorator`, `Modules\Translation\Repo...ntTranslationRepository`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
63			}
64			);
65			}
66
67			/**
68			* Update the given translation key with the given data
69			* @param string $key
70			* @param array $data
71			* @return mixed
72			*/
73			public function updateFromImport($key, array $data)
74			{
75			$this->cache->tags($this->entityName)->flush();
76
77			return $this->repository->updateFromImport($key, $data);
			0 ignored issues – show Bug introduced 2015-11-29 11:40 UTC by Report Bug Copy Issue Report The method `updateFromImport()` does not exist on `Modules\Core\Repositories\BaseRepository`. Did you maybe mean `update()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
78			}
79
80			/**
81			* Set the given value on the given TranslationTranslation
82			* @param TranslationTranslation $translationTranslation
83			* @param string $value
84			* @return void
85			*/
86			public function updateTranslationToValue(TranslationTranslation $translationTranslation, $value)
87			{
88			$this->cache->tags($this->entityName)->flush();
89
90			return $this->repository->updateTranslationToValue($translationTranslation, $value);
			0 ignored issues – show Bug introduced 2015-11-30 20:49 UTC by Report Bug Copy Issue Report The method `updateTranslationToValue()` does not exist on `Modules\Core\Repositories\BaseRepository`. Did you maybe mean `update()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
91			}
92
93			/**
94			* Clean a Cache Key so it is safe for use
95			* @param string $key Potentially unsafe key
96			* @return string
97			*/
98			protected function cleanKey($key)
99			{
100			return str_replace(" ", "--", $key);
101			}
102			}
103

AsgardCms / Translation

CacheTranslationDecorator A last analyzed 2016-08-30 10:13 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

8 Methods

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

CacheTranslationDecorator A
last analyzed 2016-08-30 10:13 UTC