ActionLinkType::resolveName() - Code Metrics - Inspection of "wip" - spatie/laravel-resource-links - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d9d1e2...b73c31 )

by Ruben

created 2019-09-19 15:20 UTC

ActionLinkType::resolveName() A

↳ Parent: ActionLinkType

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	12
rs	9.8666
c	0
b	0
f	0
cc	3
nc	3
nop	0

<?php

namespace Spatie\ResourceLinks\LinkTypes;

use Exception;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Routing\Route;
use Illuminate\Routing\Router;
use Illuminate\Support\Arr;
use Illuminate\Support\Str;

class ActionLinkType extends LinkType
{
    /** @var array|string */
    private $action;

    /** @var string|null */
    private $httpVerb;

    /** @var string|null */
    private $name;

    public static function make($action): ActionLinkType
    {
        return new self($action);
    }

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

    public function httpVerb(?string $httpVerb): ActionLinkType
    {
        $this->httpVerb = $httpVerb;

        return $this;
    }

    public function name(?string $name): ActionLinkType
    {
        $this->name = $name;

        return $this;
    }

    public function getLinks(Model $model = null): array
    {
        $formattedAction = $this->formatAction();

        $route = app(Router::class)
            ->getRoutes()
            ->getByAction($formattedAction);

        if ($route === null) {
            throw new Exception("Route `{$formattedAction}` does not exist!");
        }

        return RouteLinkType::make($route)
            ->name($this->resolveName())
            ->httpVerb($this->httpVerb)
            ->prefix($this->prefix)
            ->parameters($this->getParameters($model))
            ->serializer($this->serializer)
            ->getLinks($model);
    }

    private function formatAction(): string
    {
        return is_array($this->action)
            ? trim('\\'.implode('@', $this->action), '\\')
            : $this->action;
    }

    private function resolveName(): ?string
    {
        if ($this->name) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            return $this->name;
        }

        if ($this->isInvokableController()) {
            return 'invoke';
        }

        return null;
    }

    private function isInvokableController(): bool
    {
        if (is_array($this->action) && count($this->action) > 1) {
            return false;
        }

        $action = is_array($this->action) ? $this->action[0] : $this->action;

        return ! Str::contains($action, '@');
    }

    private function getParameters(?Model $model)
    {
        if (! optional($model)->exists) {
            return $this->parameters;
        }

        return array_merge($this->parameters, [$model]);
    }
}


1			<?php
2
3			namespace Spatie\ResourceLinks\LinkTypes;
4
5			use Exception;
6			use Illuminate\Database\Eloquent\Model;
7			use Illuminate\Routing\Route;
8			use Illuminate\Routing\Router;
9			use Illuminate\Support\Arr;
10			use Illuminate\Support\Str;
11
12			class ActionLinkType extends LinkType
13			{
14			/** @var array\|string */
15			private $action;
16
17			/** @var string\|null */
18			private $httpVerb;
19
20			/** @var string\|null */
21			private $name;
22
23			public static function make($action): ActionLinkType
24			{
25			return new self($action);
26			}
27
28			public function __construct($action)
29			{
30			$this->action = $action;
31			}
32
33			public function httpVerb(?string $httpVerb): ActionLinkType
34			{
35			$this->httpVerb = $httpVerb;
36
37			return $this;
38			}
39
40			public function name(?string $name): ActionLinkType
41			{
42			$this->name = $name;
43
44			return $this;
45			}
46
47			public function getLinks(Model $model = null): array
48			{
49			$formattedAction = $this->formatAction();
50
51			$route = app(Router::class)
52			->getRoutes()
53			->getByAction($formattedAction);
54
55			if ($route === null) {
56			throw new Exception("Route `{$formattedAction}` does not exist!");
57			}
58
59			return RouteLinkType::make($route)
60			->name($this->resolveName())
61			->httpVerb($this->httpVerb)
62			->prefix($this->prefix)
63			->parameters($this->getParameters($model))
64			->serializer($this->serializer)
65			->getLinks($model);
66			}
67
68			private function formatAction(): string
69			{
70			return is_array($this->action)
71			? trim('\\'.implode('@', $this->action), '\\')
72			: $this->action;
73			}
74
75			private function resolveName(): ?string
76			{
77			if ($this->name) {
			0 ignored issues – show Bug Best Practice introduced 2019-05-29 12:10 UTC by Report Bug Copy Issue Report The expression `$this->name` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
78			return $this->name;
79			}
80
81			if ($this->isInvokableController()) {
82			return 'invoke';
83			}
84
85			return null;
86			}
87
88			private function isInvokableController(): bool
89			{
90			if (is_array($this->action) && count($this->action) > 1) {
91			return false;
92			}
93
94			$action = is_array($this->action) ? $this->action[0] : $this->action;
95
96			return ! Str::contains($action, '@');
97			}
98
99			private function getParameters(?Model $model)
100			{
101			if (! optional($model)->exists) {
102			return $this->parameters;
103			}
104
105			return array_merge($this->parameters, [$model]);
106			}
107			}
108

spatie / laravel-resource-links

Push — master ( d9d1e2...b73c31 )

ActionLinkType::resolveName() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like