CacheRepository::getByName() - Code Metrics - Inspection of "Fix menu item listing." - yajra/cms-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 03bc6f...00f77b )

by Arjay

created 2016-07-07 03:04 UTC

CacheRepository::getByName() A

↳ Parent: CacheRepository

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace Yajra\CMS\Repositories\FileAsset;

use Illuminate\Contracts\Cache\Repository as Cache;

class CacheRepository implements Repository
{
    /**
     * @var \Yajra\CMS\Repositories\FileAsset\Repository
     */
    private $repository;

    /**
     * @var \Illuminate\Contracts\Cache\Repository
     */
    private $cache;

    /**
     * FileAssetCacheRepository constructor.
     *
     * @param \Yajra\CMS\Repositories\FileAsset\Repository $repository
     * @param \Illuminate\Contracts\Cache\Repository $cache
     */
    public function __construct(Repository $repository, Cache $cache)
    {
        $this->repository = $repository;
        $this->cache      = $cache;
    }

    /**
     * Get all file assets.
     *
     * @return \Illuminate\Database\Eloquent\Collection|static[]
     */
    public function all()
    {
        return $this->cache->rememberForever('fileAssets.all', function () {
            return $this->repository->all();
        });
    }

    /**
     * Get file asset by name.
     *
     * @param string $name
     * @param null $category
     * @return \Yajra\CMS\Repositories\FileAsset\FileAsset
     */
    public function getByName($name, $category = null)
    {
        return $this->cache->rememberForever('fileAssets.' . $name . '.' . $category,
            function () use ($name, $category) {
                return $this->repository->getByName($name, $category);
            });
    }

    /**
     * Add site asset.
     *
     * @param string $type
     * @return \Roumen\Asset\Asset;

     */
    public function addAsset($type)
    {
        return $this->cache->rememberForever('fileAssets.addAsset.' . $type, function () use ($type) {
            return $this->repository->addAsset($type);
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.
    }
}
        });
    }
}

1			<?php
2
3			namespace Yajra\CMS\Repositories\FileAsset;
4
5			use Illuminate\Contracts\Cache\Repository as Cache;
6
7			class CacheRepository implements Repository
8			{
9			/**
10			* @var \Yajra\CMS\Repositories\FileAsset\Repository
11			*/
12			private $repository;
13
14			/**
15			* @var \Illuminate\Contracts\Cache\Repository
16			*/
17			private $cache;
18
19			/**
20			* FileAssetCacheRepository constructor.
21			*
22			* @param \Yajra\CMS\Repositories\FileAsset\Repository $repository
23			* @param \Illuminate\Contracts\Cache\Repository $cache
24			*/
25			public function __construct(Repository $repository, Cache $cache)
26			{
27			$this->repository = $repository;
28			$this->cache = $cache;
29			}
30
31			/**
32			* Get all file assets.
33			*
34			* @return \Illuminate\Database\Eloquent\Collection\|static[]
35			*/
36			public function all()
37			{
38			return $this->cache->rememberForever('fileAssets.all', function () {
39			return $this->repository->all();
40			});
41			}
42
43			/**
44			* Get file asset by name.
45			*
46			* @param string $name
47			* @param null $category
48			* @return \Yajra\CMS\Repositories\FileAsset\FileAsset
49			*/
50			public function getByName($name, $category = null)
51			{
52			return $this->cache->rememberForever('fileAssets.' . $name . '.' . $category,
53			function () use ($name, $category) {
54			return $this->repository->getByName($name, $category);
55			});
56			}
57
58			/**
59			* Add site asset.
60			*
61			* @param string $type
62			* @return \Roumen\Asset\Asset;
			0 ignored issues – show Documentation introduced 2016-06-21 10:05 UTC by Report Bug Copy Issue Report The doc-type `\Roumen\Asset\Asset;` could not be parsed: Expected "\|" or "end of type", but got ";" at position 19. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
63			*/
64			public function addAsset($type)
65			{
66			return $this->cache->rememberForever('fileAssets.addAsset.' . $type, function () use ($type) {
67			return $this->repository->addAsset($type);
			0 ignored issues – show Bug introduced 2016-07-07 03:15 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Yajra\CMS\Repositories\FileAsset\Repository` as the method `addAsset()` does only exist in the following implementations of said interface: `Yajra\CMS\Repositories\FileAsset\CacheRepository`. 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...
68			});
69			}
70			}

yajra / cms-core

Push — master ( 03bc6f...00f77b )

CacheRepository::getByName() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like