TenantsMediaController::index() - Code Metrics - Inspection of "Fix FormRequest typehints" - rinvex/cortex-tenants - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( bdf9f6...524ace )

by Abdelrahman

created 2018-01-03 15:04 UTC

TenantsMediaController::index() A

↳ Parent: TenantsMediaController

Complexity

Conditions	3
Paths	4

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

declare(strict_types=1);

namespace Cortex\Tenants\Http\Controllers\Adminarea;

use Spatie\MediaLibrary\Models\Media;
use Rinvex\Tenants\Contracts\TenantContract;
use Cortex\Foundation\DataTables\MediaDataTable;
use Cortex\Foundation\Http\Requests\ImageFormRequest;
use Cortex\Foundation\Http\Controllers\AuthorizedController;

class TenantsMediaController extends AuthorizedController
{
    /**
     * {@inheritdoc}
     */
    protected $resource = 'tenants';

    /**
     * {@inheritdoc}
     */
    protected $resourceAbilityMap = [
        'index' => 'list-media',
        'store' => 'create-media',
        'delete' => 'delete-media',
    ];

    /**
     * Get a listing of the resource media.
     *
     * @param \Rinvex\Tenants\Contracts\TenantContract $tenant
     *
     * @return \Illuminate\Http\RedirectResponse|\Illuminate\Http\JsonResponse
     */
    public function index(TenantContract $tenant)
    {
        return request()->ajax() && request()->wantsJson()
            ? app(MediaDataTable::class)->with(['resource' => $tenant])->ajax()
            : intend(['url' => route('adminarea.tenants.edit', ['tenant' => $tenant]).'#media-tab']);
    }

    /**
     * Store a newly created resource in storage.
     *
     * @param \Cortex\Foundation\Http\Requests\ImageFormRequest $request
     * @param \Rinvex\Tenants\Contracts\TenantContract          $tenant
     *
     * @return void
     */
    public function store(ImageFormRequest $request, TenantContract $tenant)

    {
        $tenant->addMediaFromRequest('file')
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.
    }
}
               ->sanitizingFileName(function($fileName) { return md5($fileName).'.'.pathinfo($fileName, PATHINFO_EXTENSION); })

               ->toMediaCollection('default', config('cortex.tenants.media.disk'));
    }

    /**
     * Delete the given resource from storage.
     *
     * @param \Rinvex\Tenants\Contracts\TenantContract $tenant
     * @param \Spatie\MediaLibrary\Models\Media        $media
     *
     * @return \Illuminate\Http\RedirectResponse|\Illuminate\Http\JsonResponse
     */
    public function delete(TenantContract $tenant, Media $media)
    {
        $tenant->media()->where('id' , $media->id)->first()->delete();
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.
    }
}

        return intend([
            'url' => route('adminarea.tenants.media.index', ['tenant' => $tenant]),
            'with' => ['warning' => trans('cortex/tenants::messages.tenant.media_deleted')],
        ]);
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Cortex\Tenants\Http\Controllers\Adminarea;
6
7			use Spatie\MediaLibrary\Models\Media;
8			use Rinvex\Tenants\Contracts\TenantContract;
9			use Cortex\Foundation\DataTables\MediaDataTable;
10			use Cortex\Foundation\Http\Requests\ImageFormRequest;
11			use Cortex\Foundation\Http\Controllers\AuthorizedController;
12
13			class TenantsMediaController extends AuthorizedController
14			{
15			/**
16			* {@inheritdoc}
17			*/
18			protected $resource = 'tenants';
19
20			/**
21			* {@inheritdoc}
22			*/
23			protected $resourceAbilityMap = [
24			'index' => 'list-media',
25			'store' => 'create-media',
26			'delete' => 'delete-media',
27			];
28
29			/**
30			* Get a listing of the resource media.
31			*
32			* @param \Rinvex\Tenants\Contracts\TenantContract $tenant
33			*
34			* @return \Illuminate\Http\RedirectResponse\|\Illuminate\Http\JsonResponse
35			*/
36			public function index(TenantContract $tenant)
37			{
38			return request()->ajax() && request()->wantsJson()
39			? app(MediaDataTable::class)->with(['resource' => $tenant])->ajax()
40			: intend(['url' => route('adminarea.tenants.edit', ['tenant' => $tenant]).'#media-tab']);
41			}
42
43			/**
44			* Store a newly created resource in storage.
45			*
46			* @param \Cortex\Foundation\Http\Requests\ImageFormRequest $request
47			* @param \Rinvex\Tenants\Contracts\TenantContract $tenant
48			*
49			* @return void
50			*/
51			public function store(ImageFormRequest $request, TenantContract $tenant)
			0 ignored issues – show Unused Code introduced 2018-01-03 15:23 UTC by Report Bug Copy Issue Report The parameter `$request` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
52			{
53			$tenant->addMediaFromRequest('file')
			0 ignored issues – show Bug introduced 2018-01-03 15:23 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Rinvex\Tenants\Contracts\TenantContract` as the method `addMediaFromRequest()` does only exist in the following implementations of said interface: `Cortex\Tenants\Models\Tenant`. 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...
54			->sanitizingFileName(function($fileName) { return md5($fileName).'.'.pathinfo($fileName, PATHINFO_EXTENSION); })
			0 ignored issues – show Coding Style introduced 2018-01-03 15:23 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 127 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
55			->toMediaCollection('default', config('cortex.tenants.media.disk'));
56			}
57
58			/**
59			* Delete the given resource from storage.
60			*
61			* @param \Rinvex\Tenants\Contracts\TenantContract $tenant
62			* @param \Spatie\MediaLibrary\Models\Media $media
63			*
64			* @return \Illuminate\Http\RedirectResponse\|\Illuminate\Http\JsonResponse
65			*/
66			public function delete(TenantContract $tenant, Media $media)
67			{
68			$tenant->media()->where('id' , $media->id)->first()->delete();
			0 ignored issues – show Bug introduced 2018-01-03 15:23 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Rinvex\Tenants\Contracts\TenantContract` as the method `media()` does only exist in the following implementations of said interface: `Cortex\Tenants\Models\Tenant`. 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...
69
70			return intend([
71			'url' => route('adminarea.tenants.media.index', ['tenant' => $tenant]),
72			'with' => ['warning' => trans('cortex/tenants::messages.tenant.media_deleted')],
73			]);
74			}
75			}
76

rinvex / cortex-tenants

Push — develop ( bdf9f6...524ace )

TenantsMediaController::index() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like