ODataLink::isExpanded() - Code Metrics - Inspection of "WIP: Object model" - Algo-Web/POData - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#269)

by Christopher

created 2020-05-16 05:19 UTC

ODataLink::isExpanded() A

↳ Parent: ODataLink

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
c	0
b	0
f	0
nc	1
nop	0
dl	0
loc	3
rs	10

<?php

declare(strict_types=1);

namespace POData\ObjectModel;

/**
 * Class ODataLink represents an OData Navigation Link.
 */
class ODataLink
{
      /**
     * Name of the link. This becomes last segment of rel attribute value.
     *
     * @var string
     */
    private $name;
    /**
     * Title of the link. This become value of title attribute.
     *
     * @var string
     */
    public $title;
    /**
     * Type of link.
     *
     * @var string
     */
    public $type;
    /**
     * Url to the navigation property. This become value of href attribute.
     *
     * @var string
     */
    public $url;
    /**
     * Checks is Expand result contains single entity or collection of
     * entities i.e. feed.
     *
     * @var bool
     */
    public $isCollection;
    /**
     * The expanded result. This becomes the inline content of the link.
     *
     * @var ODataEntry|ODataFeed
     */
    public $expandedResult;
    /**
     * True if Link is Expanded, False if not.
     *
     * @var bool
     */
    public $isExpanded;

    /**
     * ODataLink constructor.
     * @param string $name
     * @param string $title
     * @param string $type
     * @param string $url
     * @param bool $isCollection
     * @param ODataExpandedResult|null $expandedResult
     */
    public function __construct(string $name = null, string $title = null, string $type = null, string $url = null, bool $isCollection = null, ODataExpandedResult $expandedResult = null)
    {
        $this->name           = $name;
        $this->title          = $title;
        $this->type           = $type;
        $this->url            = $url;
        $this->isCollection   = $isCollection;
        $this->expandedResult = $expandedResult;
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;
}
    }
    /**
     * @return string
     */
    public function getName(): ?string
    {
        return $this->name;
    }

    /**
     * @param string $name
     * @return ODataLink
     */
    public function setName(string $name): ODataLink
    {
        $this->name = $name;
        return $this;
    }

    /**
     * @return string
     */
    public function getTitle(): string
    {
        return $this->title;
    }

    /**
     * @param string $title
     * @return ODataLink
     */
    public function setTitle(string $title): ODataLink
    {
        $this->title = $title;
        return $this;
    }

    /**
     * @return string
     */
    public function getType(): string
    {
        return $this->type;
    }

    /**
     * @param string $type
     * @return ODataLink
     */
    public function setType(string $type): ODataLink
    {
        $this->type = $type;
        return $this;
    }

    /**
     * @return string
     */
    public function getUrl(): string
    {
        return $this->url;
    }

    /**
     * @param string $url
     * @return ODataLink
     */
    public function setUrl(string $url): ODataLink
    {
        $this->url = $url;
        return $this;
    }

    /**
     * @return bool
     */
    public function isCollection(): bool
    {
        return $this->isCollection;
    }

    /**
     * @param bool $isCollection
     * @return ODataLink
     */
    public function setIsCollection(bool $isCollection): ODataLink
    {
        $this->isCollection = $isCollection;
        return $this;
    }

    /**
     * @return ODataEntry|ODataFeed
     */
    public function getExpandedResult()
    {
        return $this->expandedResult;
    }

    /**
     * @param ODataEntry|ODataFeed $expandedResult
     * @return ODataLink
     */
    public function setExpandedResult($expandedResult)
    {
        $this->expandedResult = $expandedResult;
        return $this;
    }

    /**
     * @return bool
     */
    public function isExpanded(): bool
    {
        return $this->isExpanded;
    }

    /**
     * @param bool $isExpanded
     * @return ODataLink
     */
    public function setIsExpanded(bool $isExpanded): ODataLink
    {
        $this->isExpanded = $isExpanded;
        return $this;
    }

    /**
     * @return null|ODataExpandedResult
     */
    public function getExpandResult(): ?ODataExpandedResult
    {
        if (!$this->isExpanded) {
            return null;
        }
        if ($this->isCollection) {
            assert($this->expandedResult instanceof ODataFeed);
            return new ODataExpandedResult(null, $this->expandedResult);
        }
        assert($this->expandedResult instanceof ODataEntry);
        return new ODataExpandedResult($this->expandedResult);
    }

    /**
     * @param ODataExpandedResult $eResult
     */
    public function setExpandResult(ODataExpandedResult $eResult)
    {
        if (null !== $eResult->getFeed()) {
            $this->isExpanded     = true;
            $this->isCollection   = true;
            $this->expandedResult = $eResult->getFeed();
        }
        if (null !== $eResult->getEntry()) {
            $this->isExpanded     = true;
            $this->isCollection   = false;
            $this->expandedResult = $eResult->getEntry();
        }
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace POData\ObjectModel;
6
7			/**
8			* Class ODataLink represents an OData Navigation Link.
9			*/
10			class ODataLink
11			{
12			/**
13			* Name of the link. This becomes last segment of rel attribute value.
14			*
15			* @var string
16			*/
17			private $name;
18			/**
19			* Title of the link. This become value of title attribute.
20			*
21			* @var string
22			*/
23			public $title;
24			/**
25			* Type of link.
26			*
27			* @var string
28			*/
29			public $type;
30			/**
31			* Url to the navigation property. This become value of href attribute.
32			*
33			* @var string
34			*/
35			public $url;
36			/**
37			* Checks is Expand result contains single entity or collection of
38			* entities i.e. feed.
39			*
40			* @var bool
41			*/
42			public $isCollection;
43			/**
44			* The expanded result. This becomes the inline content of the link.
45			*
46			* @var ODataEntry\|ODataFeed
47			*/
48			public $expandedResult;
49			/**
50			* True if Link is Expanded, False if not.
51			*
52			* @var bool
53			*/
54			public $isExpanded;
55
56			/**
57			* ODataLink constructor.
58			* @param string $name
59			* @param string $title
60			* @param string $type
61			* @param string $url
62			* @param bool $isCollection
63			* @param ODataExpandedResult\|null $expandedResult
64			*/
65			public function __construct(string $name = null, string $title = null, string $type = null, string $url = null, bool $isCollection = null, ODataExpandedResult $expandedResult = null)
66			{
67			$this->name = $name;
68			$this->title = $title;
69			$this->type = $type;
70			$this->url = $url;
71			$this->isCollection = $isCollection;
72			$this->expandedResult = $expandedResult;
			0 ignored issues – show Documentation Bug introduced 2020-05-15 13:50 UTC by Report Bug Copy Issue Report It seems like `$expandedResult` can also be of type `POData\ObjectModel\ODataExpandedResult`. However, the property `$expandedResult` is declared as type `POData\ObjectModel\OData...a\ObjectModel\ODataFeed`. 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...
73			}
74			/**
75			* @return string
76			*/
77			public function getName(): ?string
78			{
79			return $this->name;
80			}
81
82			/**
83			* @param string $name
84			* @return ODataLink
85			*/
86			public function setName(string $name): ODataLink
87			{
88			$this->name = $name;
89			return $this;
90			}
91
92			/**
93			* @return string
94			*/
95			public function getTitle(): string
96			{
97			return $this->title;
98			}
99
100			/**
101			* @param string $title
102			* @return ODataLink
103			*/
104			public function setTitle(string $title): ODataLink
105			{
106			$this->title = $title;
107			return $this;
108			}
109
110			/**
111			* @return string
112			*/
113			public function getType(): string
114			{
115			return $this->type;
116			}
117
118			/**
119			* @param string $type
120			* @return ODataLink
121			*/
122			public function setType(string $type): ODataLink
123			{
124			$this->type = $type;
125			return $this;
126			}
127
128			/**
129			* @return string
130			*/
131			public function getUrl(): string
132			{
133			return $this->url;
134			}
135
136			/**
137			* @param string $url
138			* @return ODataLink
139			*/
140			public function setUrl(string $url): ODataLink
141			{
142			$this->url = $url;
143			return $this;
144			}
145
146			/**
147			* @return bool
148			*/
149			public function isCollection(): bool
150			{
151			return $this->isCollection;
152			}
153
154			/**
155			* @param bool $isCollection
156			* @return ODataLink
157			*/
158			public function setIsCollection(bool $isCollection): ODataLink
159			{
160			$this->isCollection = $isCollection;
161			return $this;
162			}
163
164			/**
165			* @return ODataEntry\|ODataFeed
166			*/
167			public function getExpandedResult()
168			{
169			return $this->expandedResult;
170			}
171
172			/**
173			* @param ODataEntry\|ODataFeed $expandedResult
174			* @return ODataLink
175			*/
176			public function setExpandedResult($expandedResult)
177			{
178			$this->expandedResult = $expandedResult;
179			return $this;
180			}
181
182			/**
183			* @return bool
184			*/
185			public function isExpanded(): bool
186			{
187			return $this->isExpanded;
188			}
189
190			/**
191			* @param bool $isExpanded
192			* @return ODataLink
193			*/
194			public function setIsExpanded(bool $isExpanded): ODataLink
195			{
196			$this->isExpanded = $isExpanded;
197			return $this;
198			}
199
200			/**
201			* @return null\|ODataExpandedResult
202			*/
203			public function getExpandResult(): ?ODataExpandedResult
204			{
205			if (!$this->isExpanded) {
206			return null;
207			}
208			if ($this->isCollection) {
209			assert($this->expandedResult instanceof ODataFeed);
210			return new ODataExpandedResult(null, $this->expandedResult);
211			}
212			assert($this->expandedResult instanceof ODataEntry);
213			return new ODataExpandedResult($this->expandedResult);
214			}
215
216			/**
217			* @param ODataExpandedResult $eResult
218			*/
219			public function setExpandResult(ODataExpandedResult $eResult)
220			{
221			if (null !== $eResult->getFeed()) {
222			$this->isExpanded = true;
223			$this->isCollection = true;
224			$this->expandedResult = $eResult->getFeed();
225			}
226			if (null !== $eResult->getEntry()) {
227			$this->isExpanded = true;
228			$this->isCollection = false;
229			$this->expandedResult = $eResult->getEntry();
230			}
231			}
232			}
233

Algo-Web / POData

Pull Request — master (#269)

ODataLink::isExpanded() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like