Publisher::__construct() - Code Metrics - Inspection of "Refactoring. Improvements. Code cleaning" - squareetlabs/LaravelOpenVidu - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 77f1b4...a6165e )

by Jacobo

created 2019-12-20 20:02 UTC

Publisher::__construct() A

↳ Parent: Publisher

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	9
nc	1
nop	9
dl	0
loc	11
rs	9.9666
c	1
b	0
f	0

How to fix Many Parameters

<?php

namespace SquareetLabs\LaravelOpenVidu;

use JsonSerializable;

/**
 * Class Connection
 * @package SquareetLabs\LaravelOpenVidu
 * This is a backend representation of a published media stream (see [OpenVidu Browser Stream class](/api/openvidu-browser/classes/stream.html)
 * {@see Connection::getPublishers()}
 */
class Publisher implements JsonSerializable
{

    /** @var  string
     * Unique identifier of the Stream {@link https://api/openvidu-browser/classes/stream.html} associated to this Publisher.
     * Each Publisher is paired with only one Stream, so you can identify each Publisher by its
     * Stream.streamId {@link https://api/openvidu-browser/classes/stream.html#streamid}
     */
    private $streamId;

    /** @var int
     * Timestamp when this connection was established, in UTC milliseconds (ms since Jan 1, 1970, 00:00:00 UTC)
     */
    private $createdAt;


    /** @var bool
     * See properties of Stream {@link https://api/openvidu-browser/classes/stream.html} object in OpenVidu Browser library to find out more
     */
    private $hasAudio;


    /** @var  bool
     * See properties of Stream {@link https://api/openvidu-browser/classes/stream.html}object in OpenVidu Browser library to find out more
     */
    private $hasVideo;


    /** @var  bool
     * See properties of Stream {@link https://api/openvidu-browser/classes/stream.html} object in OpenVidu Browser library to find out more
     */
    private $audioActive;


    /** @var  bool
     * See properties of Stream {@link https://api/openvidu-browser/classes/stream.html} object in OpenVidu Browser library to find out more
     */
    private $videoActive;


    /**
     * @var int
     * See properties of Stream {@link https://api/openvidu-browser/classes/stream.html} object in OpenVidu Browser library to find out more
     */
    private $frameRate;


    /**
     * @var string
     * See properties of Stream {@link https://api/openvidu-browser/classes/stream.html} object in OpenVidu Browser library to find out more
     */
    private $typeOfVideo;


    /**
     * var string
     * See properties of Stream {@link https://api/openvidu-browser/classes/stream.html} object in OpenVidu Browser library to find out more
     */
    private $videoDimensions;


    /**
     * Publisher constructor.
     * @param string $streamId
     * @param int $createdAt
     * @param bool $hasAudio
     * @param bool $hasVideo
     * @param bool $audioActive
     * @param bool $videoActive
     * @param int $frameRate
     * @param string $typeOfVideo
     * @param string $videoDimensions
     */
    public function __construct(string $streamId, int $createdAt, bool $hasAudio, bool $hasVideo, bool $audioActive, bool $videoActive, int $frameRate, string $typeOfVideo, string $videoDimensions)
    {
        $this->streamId = $streamId;
        $this->createdAt = $createdAt;
        $this->hasAudio = $hasAudio;
        $this->hasVideo = $hasVideo;
        $this->audioActive = $audioActive;
        $this->videoActive = $videoActive;
        $this->frameRate = $frameRate;
        $this->typeOfVideo = $typeOfVideo;
        $this->videoDimensions = $videoDimensions;

    }

    /**
     * @return int
     */
    public function getCreatedAt(): int
    {
        return $this->createdAt;
    }

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

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

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

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

    /**
     * @return int
     */
    public function getFrameRate(): int
    {
        return $this->frameRate;
    }

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

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

    public function __toString(): string
    {
        return $this->getStreamId();
    }

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

    /**
     * Convert the model instance to JSON.
     *
     * @param int $options
     * @return string
     *
     */
    public function toJson($options = 0): string
    {
        $json = json_encode($this->jsonSerialize(), $options);
        return $json;
    }

    /**
     * Specify data which should be serialized to JSON
     * @link https://php.net/manual/en/jsonserializable.jsonserialize.php
     * @return mixed data which can be serialized by <b>json_encode</b>,
     * which is a value of any type other than a resource.
     * @since 5.4.0
     */
    public function jsonSerialize()
    {
        return $this->toArray();
    }

    /**
     * Convert the model instance to an array.
     *
     * @return array
     */
    public function toArray(): array
    {
        $array = ['streamId' => $this->streamId,
            'createdAt' => $this->createdAt,
            'hasAudio' => $this->hasAudio,
            'hasVideo' => $this->hasVideo,
            'audioActive' => $this->audioActive,
            'videoActive' => $this->videoActive,
            'frameRate' => $this->frameRate,
            'typeOfVideo' => $this->typeOfVideo,
            'videoDimensions' => $this->videoDimensions];
        foreach ($array as $key => $value) {
            if (is_null($value) || $value == '')
                unset($array[$key]);
        }
        return $array;
    }

    /**
     * @param Publisher $other
     * @return bool
     */
    public function equalTo(Publisher $other): bool
    {
        return (
            $this->streamId === $other->getStreamId() &&
            $this->createdAt === $other->getCreatedAt() &&
            $this->hasAudio === $other->hasAudio() &&
            $this->hasVideo === $other->hasVideo() &&
            $this->audioActive === $other->isAudioActive() &&
            $this->videoActive === $other->isVideoActive() &&
            $this->frameRate === $other->getFrameRate() &&
            $this->typeOfVideo === $other->getTypeOfVideo() &&
            $this->videoDimensions === $other->getVideoDimensions()
        );
    }
}


1			<?php
2
3			namespace SquareetLabs\LaravelOpenVidu;
4
5			use JsonSerializable;
6
7			/**
8			* Class Connection
9			* @package SquareetLabs\LaravelOpenVidu
10			* This is a backend representation of a published media stream (see [OpenVidu Browser Stream class](/api/openvidu-browser/classes/stream.html)
11			* {@see Connection::getPublishers()}
12			*/
13			class Publisher implements JsonSerializable
14			{
15
16			/** @var string
17			* Unique identifier of the Stream {@link https://api/openvidu-browser/classes/stream.html} associated to this Publisher.
18			* Each Publisher is paired with only one Stream, so you can identify each Publisher by its
19			* Stream.streamId {@link https://api/openvidu-browser/classes/stream.html#streamid}
20			*/
21			private $streamId;
22
23			/** @var int
24			* Timestamp when this connection was established, in UTC milliseconds (ms since Jan 1, 1970, 00:00:00 UTC)
25			*/
26			private $createdAt;
27
28
29			/** @var bool
30			* See properties of Stream {@link https://api/openvidu-browser/classes/stream.html} object in OpenVidu Browser library to find out more
31			*/
32			private $hasAudio;
33
34
35			/** @var bool
36			* See properties of Stream {@link https://api/openvidu-browser/classes/stream.html}object in OpenVidu Browser library to find out more
37			*/
38			private $hasVideo;
39
40
41			/** @var bool
42			* See properties of Stream {@link https://api/openvidu-browser/classes/stream.html} object in OpenVidu Browser library to find out more
43			*/
44			private $audioActive;
45
46
47			/** @var bool
48			* See properties of Stream {@link https://api/openvidu-browser/classes/stream.html} object in OpenVidu Browser library to find out more
49			*/
50			private $videoActive;
51
52
53			/**
54			* @var int
55			* See properties of Stream {@link https://api/openvidu-browser/classes/stream.html} object in OpenVidu Browser library to find out more
56			*/
57			private $frameRate;
58
59
60			/**
61			* @var string
62			* See properties of Stream {@link https://api/openvidu-browser/classes/stream.html} object in OpenVidu Browser library to find out more
63			*/
64			private $typeOfVideo;
65
66
67			/**
68			* var string
69			* See properties of Stream {@link https://api/openvidu-browser/classes/stream.html} object in OpenVidu Browser library to find out more
70			*/
71			private $videoDimensions;
72
73
74			/**
75			* Publisher constructor.
76			* @param string $streamId
77			* @param int $createdAt
78			* @param bool $hasAudio
79			* @param bool $hasVideo
80			* @param bool $audioActive
81			* @param bool $videoActive
82			* @param int $frameRate
83			* @param string $typeOfVideo
84			* @param string $videoDimensions
85			*/
86			public function __construct(string $streamId, int $createdAt, bool $hasAudio, bool $hasVideo, bool $audioActive, bool $videoActive, int $frameRate, string $typeOfVideo, string $videoDimensions)
87			{
88			$this->streamId = $streamId;
89			$this->createdAt = $createdAt;
90			$this->hasAudio = $hasAudio;
91			$this->hasVideo = $hasVideo;
92			$this->audioActive = $audioActive;
93			$this->videoActive = $videoActive;
94			$this->frameRate = $frameRate;
95			$this->typeOfVideo = $typeOfVideo;
96			$this->videoDimensions = $videoDimensions;
97
98			}
99
100			/**
101			* @return int
102			*/
103			public function getCreatedAt(): int
104			{
105			return $this->createdAt;
106			}
107
108			/**
109			* @return bool
110			*/
111			public function hasAudio(): bool
112			{
113			return $this->hasAudio;
114			}
115
116			/**
117			* @return bool
118			*/
119			public function hasVideo(): bool
120			{
121			return $this->hasVideo;
122			}
123
124			/**
125			* @return bool
126			*/
127			public function isAudioActive(): bool
128			{
129			return $this->audioActive;
130			}
131
132			/**
133			* @return bool
134			*/
135			public function isVideoActive(): bool
136			{
137			return $this->videoActive;
138			}
139
140			/**
141			* @return int
142			*/
143			public function getFrameRate(): int
144			{
145			return $this->frameRate;
146			}
147
148			/**
149			* @return string
150			*/
151			public function getTypeOfVideo(): string
152			{
153			return $this->typeOfVideo;
154			}
155
156			/**
157			* @return string
158			*/
159			public function getVideoDimensions(): string
160			{
161			return $this->videoDimensions;
162			}
163
164			public function __toString(): string
165			{
166			return $this->getStreamId();
167			}
168
169			/**
170			* @return string
171			*/
172			public function getStreamId(): string
173			{
174			return $this->streamId;
175			}
176
177			/**
178			* Convert the model instance to JSON.
179			*
180			* @param int $options
181			* @return string
182			*
183			*/
184			public function toJson($options = 0): string
185			{
186			$json = json_encode($this->jsonSerialize(), $options);
187			return $json;
188			}
189
190			/**
191			* Specify data which should be serialized to JSON
192			* @link https://php.net/manual/en/jsonserializable.jsonserialize.php
193			* @return mixed data which can be serialized by <b>json_encode</b>,
194			* which is a value of any type other than a resource.
195			* @since 5.4.0
196			*/
197			public function jsonSerialize()
198			{
199			return $this->toArray();
200			}
201
202			/**
203			* Convert the model instance to an array.
204			*
205			* @return array
206			*/
207			public function toArray(): array
208			{
209			$array = ['streamId' => $this->streamId,
210			'createdAt' => $this->createdAt,
211			'hasAudio' => $this->hasAudio,
212			'hasVideo' => $this->hasVideo,
213			'audioActive' => $this->audioActive,
214			'videoActive' => $this->videoActive,
215			'frameRate' => $this->frameRate,
216			'typeOfVideo' => $this->typeOfVideo,
217			'videoDimensions' => $this->videoDimensions];
218			foreach ($array as $key => $value) {
219			if (is_null($value) \|\| $value == '')
220			unset($array[$key]);
221			}
222			return $array;
223			}
224
225			/**
226			* @param Publisher $other
227			* @return bool
228			*/
229			public function equalTo(Publisher $other): bool
230			{
231			return (
232			$this->streamId === $other->getStreamId() &&
233			$this->createdAt === $other->getCreatedAt() &&
234			$this->hasAudio === $other->hasAudio() &&
235			$this->hasVideo === $other->hasVideo() &&
236			$this->audioActive === $other->isAudioActive() &&
237			$this->videoActive === $other->isVideoActive() &&
238			$this->frameRate === $other->getFrameRate() &&
239			$this->typeOfVideo === $other->getTypeOfVideo() &&
240			$this->videoDimensions === $other->getVideoDimensions()
241			);
242			}
243			}
244

squareetlabs / LaravelOpenVidu

Push — master ( 77f1b4...a6165e )

Publisher::__construct() A

Complexity

Size

Duplication

Importance

How to fix Many Parameters

Many Parameters

Duplication Side-by-Side

Filter issues like