ODataEntry::handleMediaLinkEntry() - 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 14:20 UTC

ODataEntry::handleMediaLinkEntry() A

↳ Parent: ODataEntry

Complexity

Conditions	4
Paths	8

Size

Total Lines	11
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	7
nc	8
nop	2
dl	0
loc	11
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace POData\ObjectModel;

use AlgoWeb\ODataMetadata\MetadataManager;
use POData\Common\MimeTypes;
use POData\Common\ODataConstants;
use POData\ObjectModel\AtomObjectModel\AtomAuthor;
use POData\ObjectModel\AtomObjectModel\AtomContent;

/**
 * Class ODataEntry.
 * TODO: the methods should be rearranged to match theorder of the properties.
 * TODO: the properties are still public needs a lot of unpicking to work out as type hints maybe wrong.
 */
class ODataEntry extends ODataContainerBase
{
    /**
     * Entry Edit Link.
     *
     * @var ODataLink|null
     */
    public $editLink;
    /**
     * Entry Type. This become the value of term attribute of Category element.
     *
     * @var ODataCategory|null
     */
    public $type;
    /**
     * Instance to hold entity properties.
     * Properties corresponding to "m:properties" under content element
     * in the case of Non-MLE. For MLE "m:properties" is direct child of entry.
     *
     * @var ODataPropertyContent|null
     */
    public $propertyContent;
    /**
     * Collection of entry media links (Named Stream Links).
     *
     * @var array<ODataMediaLink>
     */
    public $mediaLinks = [];
    /**
     * media link entry (MLE Link).
     *
     * @var ODataMediaLink|null
     */
    public $mediaLink;
    /**
     * Collection of navigation links (can be expanded).
     *
     * @var array<ODataLink>
     */
    public $links = [];
    /**
     * Entry ETag.
     *
     * @var string|null
     */
    public $eTag;

    /**
     * True if this is a media link entry.
     *
     * @var bool|null
     */
    public $isMediaLinkEntry;

    /**
     * The name of the resource set this entry belongs to, use in metadata output.
     *
     * @var string|null
     */
    public $resourceSetName;



    /**
     * ODataEntry constructor.
     * @param string|null $id
     * @param string|null $selfLink
     * @param ODataTitle|null $title
     * @param ODataLink|null $editLink
     * @param ODataCategory|null $type
     * @param ODataPropertyContent|null $propertyContent
     * @param array $mediaLinks
     * @param ODataMediaLink|null $mediaLink
     * @param array $links
     * @param string|null $eTag
     * @param bool|null $isMediaLinkEntry
     * @param string|null $resourceSetName
     * @param string|null $updated
     * @param string|null $baseURI
     */
    public function __construct(
        ?string $id = null,
        ?string $selfLink = null,
        ?ODataTitle $title = null,
        ?ODataLink $editLink = null,
        ?ODataCategory $type = null,
        ?ODataPropertyContent $propertyContent = null,
        array $mediaLinks = [],
        ?ODataMediaLink $mediaLink = null,
        array $links = [],
        ?string $eTag = null,
        ?bool $isMediaLinkEntry = null,
        ?string $resourceSetName = null,
        ?string $updated = null,
        ?string $baseURI = null
    ) {
        $this->id = $id;
        $this->selfLink = $selfLink;
        $this->title = $title;
        $this->editLink = $editLink;
        $this->type = $type;
        $this->propertyContent = $propertyContent;
        $this->mediaLinks = $mediaLinks;
        $this->mediaLink = $mediaLink;
        $this->links = $links;
        $this->eTag = $eTag;
        $this->isMediaLinkEntry = $isMediaLinkEntry;
        $this->resourceSetName = $resourceSetName;
        $this->updated = $updated;
        $this->baseURI = $baseURI;
    }


    /**
     * @return string|null
     */
    public function getETag(): ?string
    {
        return $this->eTag;
    }

    /**
     * @param string|null $eTag
     * @return ODataEntry
     */
    public function setETag(?string $eTag): ODataEntry
    {
        $this->eTag = $eTag;
        return $this;
    }

    /**
     * @return bool|null
     */
    public function getIsMediaLinkEntry(): ?bool
    {
        return $this->isMediaLinkEntry;
    }

    /**
     * @param bool|null $isMediaLinkEntry
     * @return ODataEntry
     */
    public function setIsMediaLinkEntry(?bool $isMediaLinkEntry): ODataEntry
    {
        $this->isMediaLinkEntry = $isMediaLinkEntry;
        return $this;
    }

    /**
     * @return string|null
     */
    public function getResourceSetName(): ?string
    {
        return $this->resourceSetName;
    }

    /**
     * @param string|null $resourceSetName
     * @return ODataEntry
     */
    public function setResourceSetName(?string $resourceSetName): ODataEntry
    {
        $this->resourceSetName = $resourceSetName;
        return $this;
    }

    /**
     * @return AtomContent
     */
    public function getAtomContent()
    {
        if (!$this->isMediaLinkEntry) {
$a = canBeFalseAndNull();

// Instead of
if ( ! $a) { }

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
            return new AtomObjectModel\AtomContent(
                MimeTypes::MIME_APPLICATION_XML,
                null,
                $this->propertyContent
            );
        }
        return new AtomObjectModel\AtomContent($this->mediaLink->contentType, $this->mediaLink->srcLink);
    }

    /**
     * @param AtomContent $atomContent
     * @return ODataEntry
     */
    public function setAtomContent(AtomObjectModel\AtomContent $atomContent): self
    {
        $this->setPropertyContent($atomContent->properties);
        return $this;
    }

    /**
     * @return AtomAuthor
     */
    public function getAtomAuthor(): AtomAuthor
    {
        return new AtomObjectModel\AtomAuthor();
    }

    /**
     * @return null|ODataPropertyContent
     */
    public function getPropertyContent(): ?ODataPropertyContent
    {
        if (!$this->isMediaLinkEntry) {
$a = canBeFalseAndNull();

// Instead of
if ( ! $a) { }

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
            return null;
        }
        return $this->propertyContent;
    }

    /**
     * @param ODataPropertyContent|null $oDataPropertyContent
     * @return ODataEntry
     */
    public function setPropertyContent(ODataPropertyContent $oDataPropertyContent = null): self
    {
        $this->propertyContent = $oDataPropertyContent;
        return $this;
    }

    /**
     * @return ODataLink
     */
    public function getEditLink(): ODataLink
    {
        return $this->editLink;

    }

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

    /**
     * @param ODataCategory|null $type
     * @return ODataEntry
     */
    public function setType(ODataCategory $type = null): self
    {
        $this->type = $type;
        if (null !== $type) {
            $rawTerm               = $type->getTerm();
            $termArray             = explode('.', $rawTerm);
            $final                 = $termArray[count($termArray) - 1];
            $this->resourceSetName = MetadataManager::getResourceSetNameFromResourceType($final);
        }
        return $this;
    }

    /**
     * @return ODataLink[]
     */
    public function getLinks(): array
    {
        return $this->links;
    }

    /**
     * @param $links ODataLink[]
     * @return ODataEntry
     */
    public function setLinks(array $links): self
    {
        $this->links = [];
        foreach ($links as $link) {
            if ('edit' == $link->getName()) {
                $this->editLink        = $link;
                $this->resourceSetName = explode('(', $link->getUrl())[0];
                continue;
            }
            if ('http://schemas.microsoft.com/ado/2007/08/dataservices/related' == substr($link->getName(), 0, 61)
            ) {
                $this->links[] = $link;
                continue;
            }
        }
        return $this;
    }

    /**
     * @return ODataMediaLink[]
     */
    public function getMediaLinks(): array
    {
        return $this->mediaLinks;
    }

    /**
     * @param ODataMediaLink[] $mediaLinks
     * @return ODataEntry
     */
    public function setMediaLinks(array $mediaLinks): self
    {
        $this->mediaLinks = [];
        $editLink         = null;
        foreach ($mediaLinks as $mediaLink) {
            $this->handleMediaLinkEntry($mediaLink, $editLink);
        }
        $this->correctMediaLinkSrc($editLink);
        if (null === $this->mediaLink) {
            $this->isMediaLinkEntry = false;
        }
        return $this;
    }

    /**
     * @param ODataMediaLink      $mediaLink
     * @param ODataMediaLink|null $editLink
     */
    private function handleMediaLinkEntry(ODataMediaLink $mediaLink, ODataMediaLink &$editLink = null): void
    {
        if ('edit-media' == $mediaLink->rel) {
            $this->isMediaLinkEntry = true;
            $this->mediaLink        = $mediaLink;
        }
        if (ODataConstants::ATOM_MEDIA_RESOURCE_RELATION_ATTRIBUTE_VALUE == substr($mediaLink->rel, 0, 68)) {
            $this->mediaLinks[] = $mediaLink;
        }
        if ('edit' == $mediaLink->rel) {
            $editLink = $mediaLink;
        }
    }

    /**
     * @param ODataMediaLink|null $editLink
     */
    private function correctMediaLinkSrc(ODataMediaLink $editLink = null): void
    {
        if (null !== $this->mediaLink && null !== $editLink) {
            $this->mediaLink->srcLink = $editLink->editLink . $this->mediaLink->editLink;
            foreach ($this->mediaLinks as $mediaLink) {
                $mediaLink->srcLink = $editLink->editLink . '/' . $mediaLink->name;
            }
        }
    }

    /**
     * @return ODataMediaLink
     */
    public function getMediaLink(): ODataMediaLink
    {
        return $this->mediaLink;

    }

    /**
     * @param  string|null $msg
     * @return bool
     */
    public function isOk(&$msg = null): bool
    {
        if (!$this->propertyContent instanceof ODataPropertyContent) {
            $msg = 'Property content must be instanceof ODataPropertyContent.';
            return false;
        }
        if (0 === count($this->propertyContent->properties)) {
            $msg = 'Must have at least one property present.';
            return false;
        }

        return true;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace POData\ObjectModel;
6
7			use AlgoWeb\ODataMetadata\MetadataManager;
8			use POData\Common\MimeTypes;
9			use POData\Common\ODataConstants;
10			use POData\ObjectModel\AtomObjectModel\AtomAuthor;
11			use POData\ObjectModel\AtomObjectModel\AtomContent;
12
13			/**
14			* Class ODataEntry.
15			* TODO: the methods should be rearranged to match theorder of the properties.
16			* TODO: the properties are still public needs a lot of unpicking to work out as type hints maybe wrong.
17			*/
18			class ODataEntry extends ODataContainerBase
19			{
20			/**
21			* Entry Edit Link.
22			*
23			* @var ODataLink\|null
24			*/
25			public $editLink;
26			/**
27			* Entry Type. This become the value of term attribute of Category element.
28			*
29			* @var ODataCategory\|null
30			*/
31			public $type;
32			/**
33			* Instance to hold entity properties.
34			* Properties corresponding to "m:properties" under content element
35			* in the case of Non-MLE. For MLE "m:properties" is direct child of entry.
36			*
37			* @var ODataPropertyContent\|null
38			*/
39			public $propertyContent;
40			/**
41			* Collection of entry media links (Named Stream Links).
42			*
43			* @var array<ODataMediaLink>
44			*/
45			public $mediaLinks = [];
46			/**
47			* media link entry (MLE Link).
48			*
49			* @var ODataMediaLink\|null
50			*/
51			public $mediaLink;
52			/**
53			* Collection of navigation links (can be expanded).
54			*
55			* @var array<ODataLink>
56			*/
57			public $links = [];
58			/**
59			* Entry ETag.
60			*
61			* @var string\|null
62			*/
63			public $eTag;
64
65			/**
66			* True if this is a media link entry.
67			*
68			* @var bool\|null
69			*/
70			public $isMediaLinkEntry;
71
72			/**
73			* The name of the resource set this entry belongs to, use in metadata output.
74			*
75			* @var string\|null
76			*/
77			public $resourceSetName;
78
79
80
81			/**
82			* ODataEntry constructor.
83			* @param string\|null $id
84			* @param string\|null $selfLink
85			* @param ODataTitle\|null $title
86			* @param ODataLink\|null $editLink
87			* @param ODataCategory\|null $type
88			* @param ODataPropertyContent\|null $propertyContent
89			* @param array $mediaLinks
90			* @param ODataMediaLink\|null $mediaLink
91			* @param array $links
92			* @param string\|null $eTag
93			* @param bool\|null $isMediaLinkEntry
94			* @param string\|null $resourceSetName
95			* @param string\|null $updated
96			* @param string\|null $baseURI
97			*/
98			public function __construct(
99			?string $id = null,
100			?string $selfLink = null,
101			?ODataTitle $title = null,
102			?ODataLink $editLink = null,
103			?ODataCategory $type = null,
104			?ODataPropertyContent $propertyContent = null,
105			array $mediaLinks = [],
106			?ODataMediaLink $mediaLink = null,
107			array $links = [],
108			?string $eTag = null,
109			?bool $isMediaLinkEntry = null,
110			?string $resourceSetName = null,
111			?string $updated = null,
112			?string $baseURI = null
113			) {
114			$this->id = $id;
115			$this->selfLink = $selfLink;
116			$this->title = $title;
117			$this->editLink = $editLink;
118			$this->type = $type;
119			$this->propertyContent = $propertyContent;
120			$this->mediaLinks = $mediaLinks;
121			$this->mediaLink = $mediaLink;
122			$this->links = $links;
123			$this->eTag = $eTag;
124			$this->isMediaLinkEntry = $isMediaLinkEntry;
125			$this->resourceSetName = $resourceSetName;
126			$this->updated = $updated;
127			$this->baseURI = $baseURI;
128			}
129
130
131			/**
132			* @return string\|null
133			*/
134			public function getETag(): ?string
135			{
136			return $this->eTag;
137			}
138
139			/**
140			* @param string\|null $eTag
141			* @return ODataEntry
142			*/
143			public function setETag(?string $eTag): ODataEntry
144			{
145			$this->eTag = $eTag;
146			return $this;
147			}
148
149			/**
150			* @return bool\|null
151			*/
152			public function getIsMediaLinkEntry(): ?bool
153			{
154			return $this->isMediaLinkEntry;
155			}
156
157			/**
158			* @param bool\|null $isMediaLinkEntry
159			* @return ODataEntry
160			*/
161			public function setIsMediaLinkEntry(?bool $isMediaLinkEntry): ODataEntry
162			{
163			$this->isMediaLinkEntry = $isMediaLinkEntry;
164			return $this;
165			}
166
167			/**
168			* @return string\|null
169			*/
170			public function getResourceSetName(): ?string
171			{
172			return $this->resourceSetName;
173			}
174
175			/**
176			* @param string\|null $resourceSetName
177			* @return ODataEntry
178			*/
179			public function setResourceSetName(?string $resourceSetName): ODataEntry
180			{
181			$this->resourceSetName = $resourceSetName;
182			return $this;
183			}
184
185			/**
186			* @return AtomContent
187			*/
188			public function getAtomContent()
189			{
190			if (!$this->isMediaLinkEntry) {
			0 ignored issues – show Bug Best Practice introduced 2020-05-14 13:34 UTC by Report Bug Copy Issue Report The expression `$this->isMediaLinkEntry` of type `boolean\|null` is loosely compared to `false`; this is ambiguous if the boolean can be false. You might want to explicitly use `!== null` instead. If an expression can have both `false`, and `null` as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values. $a = canBeFalseAndNull(); // Instead of if ( ! $a) { } // Better use one of the explicit versions: if ($a !== null) { } if ($a !== false) { } if ($a !== null && $a !== false) { } Loading history...
191			return new AtomObjectModel\AtomContent(
192			MimeTypes::MIME_APPLICATION_XML,
193			null,
194			$this->propertyContent
195			);
196			}
197			return new AtomObjectModel\AtomContent($this->mediaLink->contentType, $this->mediaLink->srcLink);
198			}
199
200			/**
201			* @param AtomContent $atomContent
202			* @return ODataEntry
203			*/
204			public function setAtomContent(AtomObjectModel\AtomContent $atomContent): self
205			{
206			$this->setPropertyContent($atomContent->properties);
207			return $this;
208			}
209
210			/**
211			* @return AtomAuthor
212			*/
213			public function getAtomAuthor(): AtomAuthor
214			{
215			return new AtomObjectModel\AtomAuthor();
216			}
217
218			/**
219			* @return null\|ODataPropertyContent
220			*/
221			public function getPropertyContent(): ?ODataPropertyContent
222			{
223			if (!$this->isMediaLinkEntry) {
			0 ignored issues – show Bug Best Practice introduced 2020-05-14 13:34 UTC by Report Bug Copy Issue Report The expression `$this->isMediaLinkEntry` of type `boolean\|null` is loosely compared to `false`; this is ambiguous if the boolean can be false. You might want to explicitly use `!== null` instead. If an expression can have both `false`, and `null` as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values. $a = canBeFalseAndNull(); // Instead of if ( ! $a) { } // Better use one of the explicit versions: if ($a !== null) { } if ($a !== false) { } if ($a !== null && $a !== false) { } Loading history...
224			return null;
225			}
226			return $this->propertyContent;
227			}
228
229			/**
230			* @param ODataPropertyContent\|null $oDataPropertyContent
231			* @return ODataEntry
232			*/
233			public function setPropertyContent(ODataPropertyContent $oDataPropertyContent = null): self
234			{
235			$this->propertyContent = $oDataPropertyContent;
236			return $this;
237			}
238
239			/**
240			* @return ODataLink
241			*/
242			public function getEditLink(): ODataLink
243			{
244			return $this->editLink;
			0 ignored issues – show Bug Best Practice introduced 2020-05-16 13:12 UTC by Report Bug Copy Issue Report The expression `return $this->editLink` could return the type `null` which is incompatible with the type-hinted return `POData\ObjectModel\ODataLink`. Consider adding an additional type-check to rule them out. Loading history...
245			}
246
247			/**
248			* @return ODataCategory
249			*/
250			public function getType(): ?ODataCategory
251			{
252			return $this->type;
253			}
254
255			/**
256			* @param ODataCategory\|null $type
257			* @return ODataEntry
258			*/
259			public function setType(ODataCategory $type = null): self
260			{
261			$this->type = $type;
262			if (null !== $type) {
263			$rawTerm = $type->getTerm();
264			$termArray = explode('.', $rawTerm);
265			$final = $termArray[count($termArray) - 1];
266			$this->resourceSetName = MetadataManager::getResourceSetNameFromResourceType($final);
267			}
268			return $this;
269			}
270
271			/**
272			* @return ODataLink[]
273			*/
274			public function getLinks(): array
275			{
276			return $this->links;
277			}
278
279			/**
280			* @param $links ODataLink[]
281			* @return ODataEntry
282			*/
283			public function setLinks(array $links): self
284			{
285			$this->links = [];
286			foreach ($links as $link) {
287			if ('edit' == $link->getName()) {
288			$this->editLink = $link;
289			$this->resourceSetName = explode('(', $link->getUrl())[0];
290			continue;
291			}
292			if ('http://schemas.microsoft.com/ado/2007/08/dataservices/related' == substr($link->getName(), 0, 61)
293			) {
294			$this->links[] = $link;
295			continue;
296			}
297			}
298			return $this;
299			}
300
301			/**
302			* @return ODataMediaLink[]
303			*/
304			public function getMediaLinks(): array
305			{
306			return $this->mediaLinks;
307			}
308
309			/**
310			* @param ODataMediaLink[] $mediaLinks
311			* @return ODataEntry
312			*/
313			public function setMediaLinks(array $mediaLinks): self
314			{
315			$this->mediaLinks = [];
316			$editLink = null;
317			foreach ($mediaLinks as $mediaLink) {
318			$this->handleMediaLinkEntry($mediaLink, $editLink);
319			}
320			$this->correctMediaLinkSrc($editLink);
321			if (null === $this->mediaLink) {
322			$this->isMediaLinkEntry = false;
323			}
324			return $this;
325			}
326
327			/**
328			* @param ODataMediaLink $mediaLink
329			* @param ODataMediaLink\|null $editLink
330			*/
331			private function handleMediaLinkEntry(ODataMediaLink $mediaLink, ODataMediaLink &$editLink = null): void
332			{
333			if ('edit-media' == $mediaLink->rel) {
334			$this->isMediaLinkEntry = true;
335			$this->mediaLink = $mediaLink;
336			}
337			if (ODataConstants::ATOM_MEDIA_RESOURCE_RELATION_ATTRIBUTE_VALUE == substr($mediaLink->rel, 0, 68)) {
338			$this->mediaLinks[] = $mediaLink;
339			}
340			if ('edit' == $mediaLink->rel) {
341			$editLink = $mediaLink;
342			}
343			}
344
345			/**
346			* @param ODataMediaLink\|null $editLink
347			*/
348			private function correctMediaLinkSrc(ODataMediaLink $editLink = null): void
349			{
350			if (null !== $this->mediaLink && null !== $editLink) {
351			$this->mediaLink->srcLink = $editLink->editLink . $this->mediaLink->editLink;
352			foreach ($this->mediaLinks as $mediaLink) {
353			$mediaLink->srcLink = $editLink->editLink . '/' . $mediaLink->name;
354			}
355			}
356			}
357
358			/**
359			* @return ODataMediaLink
360			*/
361			public function getMediaLink(): ODataMediaLink
362			{
363			return $this->mediaLink;
			0 ignored issues – show Bug Best Practice introduced 2020-05-16 13:12 UTC by Report Bug Copy Issue Report The expression `return $this->mediaLink` could return the type `null` which is incompatible with the type-hinted return `POData\ObjectModel\ODataMediaLink`. Consider adding an additional type-check to rule them out. Loading history...
364			}
365
366			/**
367			* @param string\|null $msg
368			* @return bool
369			*/
370			public function isOk(&$msg = null): bool
371			{
372			if (!$this->propertyContent instanceof ODataPropertyContent) {
373			$msg = 'Property content must be instanceof ODataPropertyContent.';
374			return false;
375			}
376			if (0 === count($this->propertyContent->properties)) {
377			$msg = 'Must have at least one property present.';
378			return false;
379			}
380
381			return true;
382			}
383			}
384

Algo-Web / POData

Pull Request — master (#269)

ODataEntry::handleMediaLinkEntry() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like