Event::update() - Code Metrics - Inspection of "Revert LiveStream Singleton Pattern." - francis94c/vimeo-livestream - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( d91ec9...05758d )

by Francis

created 2020-07-24 16:23 UTC

Event::update() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace LiveStream\Resources;

use LiveStream\Resources\Resource;
use LiveStream\Exceptions\InValidResourceException;
use LiveStream\Interfaces\Resource as ResourceInterface;

class Event extends Resource implements ResourceInterface
{
    /**
     * Class Constructor.
     *
     * @param string  $fullName
     * @param boolean $init
     */
    public function __construct(string $fullName, bool $init = true)
    {
        parent::__construct($init);
        if ($init)
            $this->data->fullName  = $fullName;
    }

    /**
     * Set Event Start Time.
     *
     * @param  string $strtime
     * @return \LiveStream\Resources\Event
     */
    public function setStartTime(string $strtime): Event
    {
        $this->data->startTime = date('c', strtotime($strtime));
        return $this;
    }

    /**
     * Set End Time
     *
     * @param  string $strtime
     * @return \LiveStream\Resources\Event
     */
    public function setEndTime(string $strtime): Event
    {
        $this->data->endTime = date('c', strtotime($strtime));
        return $this;
    }

    /**
     * Set Is Draft.
     *
     * @param boolean $isDraft
     * 
     * @return \LiveStream\Resources\Event
     */
    public function setIsDraft(bool $isDraft = true): Event
    {
        $this->data->draft = $isDraft;
        return $this;
    }

    /**
     * Get Is Draft.
     *
     * @return boolean
     */
    public function isDraft(): bool
    {
        return $this->data->draft ?? true;
    }

    /**
     * Add Event Tag
     *
     * @param  string $tag
     * @return \LiveStream\Resources\Event
     */
    public function addTag(string $tag): Event
    {
        if (!isset($this->data->tags)) $this->data->tags = '';

        $this->data->tags .= rtrim($tag, ',') . ',';

        return $this;
    }

    /**
     * Get Tags.
     *
     * @return string
     */
    public function getTags()
    {
        return $this->data->tags ?? '';
    }

    /**
     * Undocumented function
     *
     * @param string $name
     * @param array $arguments
     * @return void
     */
    public function __call(string $name, array $arguments)
    {
        switch ($name) {
            case 'getDraft':
                return $this->isDraft();

            case 'setDraft':
                return $this->setIsDraft($arguments[0]);

            default:
                return parent::__call($name, $arguments);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
        }
    }

    /**
     * Resource Interface Method: Get Resource as JSON String.
     *
     * @return string
     */
    public function getResourceBody(): string
    {
        $body = ['fullName' => $this->data->fullName];

        $this->set_fields($body, [
            'shortName'                 => $this->data->shortName ?? null,
            'startTime'                 => $this->data->startTime ?? null,
            'endTime'                   => $this->data->endTime ?? null,
            'draft'                     => $this->data->draft ?? null,
            'description'               => $this->data->description ?? null,
            'tags'                      => ($this->data->tags ?? null) ? rtrim($this->data->tags, ',') : null,
            'isPublic'                  => $this->data->isPublic ?? null,
            'isSearchable'              => $this->data->isSearchable ?? null,
            'viewerCountVisible'        => $this->data->viewerCountVisible ?? null,
            'postCommentsEnabled'       => $this->data->postCommentsEnabled ?? null,
            'liveChatEnabled'           => $this->data->liveChatEnabled ?? null,
            'isEmbeddable'              => $this->data->isEmbeddable ?? null,
            'isPasswordProtected'       => $this->data->isPasswordProtected ?? null,
            'password'                  => $this->data->password ?? null,
            'isWhiteLabeled'            => $this->data->isWhiteLabeled ?? null,
            'embedRestriction'          => $this->data->embedRestriction ?? null,
            'embedRestrictionWhitelist' => $this->data->embedRestrictionWhitelist ?? null,
            'embedRestrictionBlacklist' => $this->data->embedRestrictionBlacklist ?? null,
        ]);

        return json_encode($body);
    }

    /**
     * Undocumented function
     *
     * @param  array $array
     * @param  array $map
     * @return void
     */
    private function set_fields(array &$array, array $map): void
    {
        foreach ($map as $key => $value) {
            if ($value)
                $array[$key] = $value;
        }
    }

    /**
     * Undocumented function
     *
     * @return string
     */
    public function getContentType(): string
    {
        return 'application/json';
    }

    /**
     * Validates the Event Resource.
     * 
     * @param bool $exists Whether resource is exists (being updated) or not.
     * 
     * @return void
     */
    public function validate(bool $exists = false): void
    {
        if (!$this->data->fullName ?? null) throw new InValidResourceException('Event', 'fullName');

        if (($this->data->isPasswordProtected ?? false) && (!$this->data->password ?? null)) {
            throw new InValidResourceException('Event', 'password (password must be present for a password protected event)');
        }

        if ($exists) {                   
            if (!$this->data->id ?? null) {
                throw new InValidResourceException('Event', 'id (Event ID must be present while updating an event.)');
            }
        }
    }
}


1			<?php
2
3			namespace LiveStream\Resources;
4
5			use LiveStream\Resources\Resource;
6			use LiveStream\Exceptions\InValidResourceException;
7			use LiveStream\Interfaces\Resource as ResourceInterface;
8
9			class Event extends Resource implements ResourceInterface
10			{
11			/**
12			* Class Constructor.
13			*
14			* @param string $fullName
15			* @param boolean $init
16			*/
17			public function __construct(string $fullName, bool $init = true)
18			{
19			parent::__construct($init);
20			if ($init)
21			$this->data->fullName = $fullName;
22			}
23
24			/**
25			* Set Event Start Time.
26			*
27			* @param string $strtime
28			* @return \LiveStream\Resources\Event
29			*/
30			public function setStartTime(string $strtime): Event
31			{
32			$this->data->startTime = date('c', strtotime($strtime));
33			return $this;
34			}
35
36			/**
37			* Set End Time
38			*
39			* @param string $strtime
40			* @return \LiveStream\Resources\Event
41			*/
42			public function setEndTime(string $strtime): Event
43			{
44			$this->data->endTime = date('c', strtotime($strtime));
45			return $this;
46			}
47
48			/**
49			* Set Is Draft.
50			*
51			* @param boolean $isDraft
52			*
53			* @return \LiveStream\Resources\Event
54			*/
55			public function setIsDraft(bool $isDraft = true): Event
56			{
57			$this->data->draft = $isDraft;
58			return $this;
59			}
60
61			/**
62			* Get Is Draft.
63			*
64			* @return boolean
65			*/
66			public function isDraft(): bool
67			{
68			return $this->data->draft ?? true;
69			}
70
71			/**
72			* Add Event Tag
73			*
74			* @param string $tag
75			* @return \LiveStream\Resources\Event
76			*/
77			public function addTag(string $tag): Event
78			{
79			if (!isset($this->data->tags)) $this->data->tags = '';
80
81			$this->data->tags .= rtrim($tag, ',') . ',';
82
83			return $this;
84			}
85
86			/**
87			* Get Tags.
88			*
89			* @return string
90			*/
91			public function getTags()
92			{
93			return $this->data->tags ?? '';
94			}
95
96			/**
97			* Undocumented function
98			*
99			* @param string $name
100			* @param array $arguments
101			* @return void
102			*/
103			public function __call(string $name, array $arguments)
104			{
105			switch ($name) {
106			case 'getDraft':
107			return $this->isDraft();
			0 ignored issues – show Bug Best Practice introduced 2020-07-22 09:04 UTC by Report Bug Copy Issue Report The expression `return $this->isDraft()` returns the type `boolean` which is incompatible with the documented return type `void`. Loading history...
108			case 'setDraft':
109			return $this->setIsDraft($arguments[0]);
			0 ignored issues – show Bug Best Practice introduced 2020-07-22 09:04 UTC by Report Bug Copy Issue Report The expression `return $this->setIsDraft($arguments[0])` returns the type `LiveStream\Resources\Event` which is incompatible with the documented return type `void`. Loading history...
110			default:
111			return parent::__call($name, $arguments);
			0 ignored issues – show Bug introduced 2020-07-22 09:04 UTC by Report Bug Copy Issue Report Are you sure the usage of `parent::__call($name, $arguments)` targeting `LiveStream\Resources\Resource::__call()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
112			}
113			}
114
115			/**
116			* Resource Interface Method: Get Resource as JSON String.
117			*
118			* @return string
119			*/
120			public function getResourceBody(): string
121			{
122			$body = ['fullName' => $this->data->fullName];
123
124			$this->set_fields($body, [
125			'shortName' => $this->data->shortName ?? null,
126			'startTime' => $this->data->startTime ?? null,
127			'endTime' => $this->data->endTime ?? null,
128			'draft' => $this->data->draft ?? null,
129			'description' => $this->data->description ?? null,
130			'tags' => ($this->data->tags ?? null) ? rtrim($this->data->tags, ',') : null,
131			'isPublic' => $this->data->isPublic ?? null,
132			'isSearchable' => $this->data->isSearchable ?? null,
133			'viewerCountVisible' => $this->data->viewerCountVisible ?? null,
134			'postCommentsEnabled' => $this->data->postCommentsEnabled ?? null,
135			'liveChatEnabled' => $this->data->liveChatEnabled ?? null,
136			'isEmbeddable' => $this->data->isEmbeddable ?? null,
137			'isPasswordProtected' => $this->data->isPasswordProtected ?? null,
138			'password' => $this->data->password ?? null,
139			'isWhiteLabeled' => $this->data->isWhiteLabeled ?? null,
140			'embedRestriction' => $this->data->embedRestriction ?? null,
141			'embedRestrictionWhitelist' => $this->data->embedRestrictionWhitelist ?? null,
142			'embedRestrictionBlacklist' => $this->data->embedRestrictionBlacklist ?? null,
143			]);
144
145			return json_encode($body);
146			}
147
148			/**
149			* Undocumented function
150			*
151			* @param array $array
152			* @param array $map
153			* @return void
154			*/
155			private function set_fields(array &$array, array $map): void
156			{
157			foreach ($map as $key => $value) {
158			if ($value)
159			$array[$key] = $value;
160			}
161			}
162
163			/**
164			* Undocumented function
165			*
166			* @return string
167			*/
168			public function getContentType(): string
169			{
170			return 'application/json';
171			}
172
173			/**
174			* Validates the Event Resource.
175			*
176			* @param bool $exists Whether resource is exists (being updated) or not.
177			*
178			* @return void
179			*/
180			public function validate(bool $exists = false): void
181			{
182			if (!$this->data->fullName ?? null) throw new InValidResourceException('Event', 'fullName');
183
184			if (($this->data->isPasswordProtected ?? false) && (!$this->data->password ?? null)) {
185			throw new InValidResourceException('Event', 'password (password must be present for a password protected event)');
186			}
187
188			if ($exists) {
189			if (!$this->data->id ?? null) {
190			throw new InValidResourceException('Event', 'id (Event ID must be present while updating an event.)');
191			}
192			}
193			}
194			}
195

francis94c / vimeo-livestream

Push — master ( d91ec9...05758d )

Event::update() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like