Article::getPossibleAttachment() - Code Metrics - Inspection of "fix php 5.3 constant no array problem, patch docs..." - KLYgarage/onesdk - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( a325bd...ce51d7 )

by Charis

created 2018-06-30 01:46 UTC

Article::getPossibleAttachment() A

↳ Parent: Article

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace One\Model;

use Psr\Http\Message\UriInterface;
use One\Collection;

/**
 * Article Class
 */
class Article extends Model
{
    const CATEGORY_NASIONAL = 1;
    const CATEGORY_INTERNASIONAL = 2;
    const CATEGORY_BISNIS = 3;
    const CATEGORY_SEPAK_BOLA = 4;
    const CATEGORY_OLAHRAGA = 5;
    const CATEGORY_HIBURAN = 6;
    const CATEGORY_TEKNOLOGI = 7;
    const CATEGORY_TRAVEL = 8;
    const CATEGORY_LIFESTYLE = 9;
    const CATEGORY_WANITA = 10;
    const CATEGORY_HIJAB = 11;
    const CATEGORY_KULINER = 12;
    const CATEGORY_SEHAT = 13;
    const CATEGORY_OTOMOTIF = 14;
    const CATEGORY_INSPIRASI = 15;
    const CATEGORY_UNIK = 16;
    const CATEGORY_EVENT = 17;
    const CATEGORY_KOMUNITAS = 18;

    const TYPE_TEXT = 1;
    const TYPE_PHOTO = 2;
    const TYPE_VIDEO = 3;

    const ATTACHMENT_FIELD_PHOTO = 'photo';
    const ATTACHMENT_FIELD_PAGE = 'page';
    const ATTACHMENT_FIELD_VIDEO = 'video';
    const ATTACHMENT_FIELD_GALLERY = 'gallery';

    /**
     * attachment property
     *
     * @var array $attachment
     */
    private $attachment = array();

    /**
     * identifier
     *
     * @var string $identifier
     */
    protected $identifier = null;

    /**
     * constructor
     *
     * @param string $title
     * @param string $body
     * @param \Psr\Http\Message\UriInterface|string $source
     * @param string $uniqueId
     * @param integer $typeId
     * @param integer $categoryId
     * @param string $reporter
     * @param string $lead
     * @param string $tags
     * @param \DateTimeInterface|string $publishedAt
     */
    public function __construct(
        $title,
        $body,
        $source,
        $uniqueId,
        $typeId = self::TYPE_TEXT,
        $categoryId = self::CATEGORY_NASIONAL,
        $reporter = '',
        $lead = '',
        $tags = '',
        $publishedAt = null,
        $identifier = null
    ) {
        $source = $this->filterUriInstance($source);
        $publishedAt = $this->filterDateInstance($publishedAt);

        if (empty($lead)) {
            $lead = $this->createLeadFromBody($body);
        }

        $allowedType = array(
            self::TYPE_PHOTO,
            self::TYPE_TEXT,
            self::TYPE_VIDEO
        );

        if (!in_array($typeId, $allowedType)) {
            throw new \InvalidArgumentException("Invalid typeId : $typeId, allowed typeId are " . implode(', ', $allowedType));
        }

        $allowedCategory = array(
            self::CATEGORY_NASIONAL,
            self::CATEGORY_INTERNASIONAL,
            self::CATEGORY_BISNIS,
            self::CATEGORY_SEPAK_BOLA,
            self::CATEGORY_OLAHRAGA,
            self::CATEGORY_HIBURAN,
            self::CATEGORY_TEKNOLOGI,
            self::CATEGORY_TRAVEL,
            self::CATEGORY_LIFESTYLE,
            self::CATEGORY_WANITA,
            self::CATEGORY_HIJAB,
            self::CATEGORY_KULINER,
            self::CATEGORY_SEHAT,
            self::CATEGORY_OTOMOTIF,
            self::CATEGORY_INSPIRASI,
            self::CATEGORY_UNIK,
            self::CATEGORY_EVENT,
            self::CATEGORY_KOMUNITAS,
        );

        if (!in_array($categoryId, $allowedCategory)) {
            throw new \InvalidArgumentException("Invalid categoryId : $categoryId, allowed category are " . implode(', ', $allowedCategory));
        }

        $this->collection = new Collection(
            array(
                'title' => $title,
                'reporter' => $reporter,
                'lead' => $lead,
                'body' => $body,
                'source' => $source,
                'uniqueId' => $uniqueId,
                'type_id' => $typeId,
                'category_id' => $categoryId,
                'tags' => $tags,
                'published_at' => $publishedAt
            )
        );

        if ($identifier) {
            $this->setId($identifier);
        }
    }

    /**
     * get ALL Possible attachment for an article, return arrays of field name. Used for consistency accross sdk
     * leveraging php version 5.3 cannot use array constant
     *
     * @return array
     */
    public static function getPossibleAttachment()
    {
        return array_merge(
            self::getDeleteableAttachment(),
            array(
                self::ATTACHMENT_FIELD_PHOTO
            )
        );
    }

    /**
     * get deleteable attachment for constant usage across sdk
     *
     * @return array
     */
    public static function getDeleteableAttachment()
    {
        return array(
            self::ATTACHMENT_FIELD_GALLERY,
            self::ATTACHMENT_FIELD_PAGE,
            self::ATTACHMENT_FIELD_VIDEO
        );
    }

    /**
     * setIdentifier from rest api response
     *
     * @param string $identifier
     * @return void
     */
    public function setId($identifier)
    {
        $this->identifier = $identifier;
    }

    /**
     * getIdentifier set before
     *
     * @return string
     */
    public function getId()
    {
        return $this->identifier;
    }

    /**
     * check if this object has attachment assigned to it
     *
     * @param string $field
     * @return boolean
     */
    public function hasAttachment($field)
    {
        return isset($this->attachment[$field]);
    }

    /**
     * getAttachment based on fields
     *
     * @param string $field
     * @return array
     */
    public function getAttachmentByField($field)
    {
        if (isset($this->attachment[$field])) {
            return $this->attachment[$field];
        }

        return array();
    }

    /**
     * get ALL attachment assigned to this object
     *
     * @return array|null
     */
    public function getAttachments()
    {
        return $this->attachment;
    }

    /**
     * add attach an attachment to this model
     *
     * @param string $field
     * @param Model $item
     * @return Article
     */
    public function attach($field, Model $item)
    {
        $this->attachment[$field][] = $item;

        return $this;
    }

    /**
     * Attach Photo Attachment to article
     *
     * @param Photo $photo
     * @return self
     */
    public function attachPhoto(Photo $photo)
    {
        return $this->attach(
            self::ATTACHMENT_FIELD_PHOTO,
            $photo
        );
    }

    /**
     * Attach Paging
     *
     * @param Page $page
     * @return self
     */
    public function attachPage(Page $page)
    {
        return $this->attach(
            self::ATTACHMENT_FIELD_PAGE,
            $this->ensureOrder(

                $page,
                self::ATTACHMENT_FIELD_PAGE
            )
        );
    }

    /**
     * Attach gallery here
     *
     * @param Gallery $gallery
     * @return self
     */
    public function attachGallery(Gallery $gallery)
    {
        return $this->attach(
            self::ATTACHMENT_FIELD_GALLERY,
            $this->ensureOrder(

                $gallery,
                self::ATTACHMENT_FIELD_GALLERY
            )
        );
    }

    /**
     * attach Video
     *
     * @param Video $video
     * @return self
     */
    public function attachVideo(Video $video)
    {
        return $this->attach(
            self::ATTACHMENT_FIELD_VIDEO,
            $this->ensureOrder(

                $video,
                self::ATTACHMENT_FIELD_VIDEO
            )
        );
    }

    /**
     * ensuring order
     *
     * @param Model|Collection $attachment
     * @param string $type
     * @return Model|Collection
     */
    private function ensureOrder($attachment, $type)
    {
        if (empty($attachment->get('order'))) {
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            $attachment->set(
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                'order',
                count($this->getAttachmentByField($type)) + 1
            );
        }

        return $attachment;
    }
}


Push — master ( a325bd...ce51d7 )

Article::getPossibleAttachment() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

1			<?php
2
3			namespace One\Model;
4
5			use Psr\Http\Message\UriInterface;
6			use One\Collection;
7
8			/**
9			* Article Class
10			*/
11			class Article extends Model
12			{
13			const CATEGORY_NASIONAL = 1;
14			const CATEGORY_INTERNASIONAL = 2;
15			const CATEGORY_BISNIS = 3;
16			const CATEGORY_SEPAK_BOLA = 4;
17			const CATEGORY_OLAHRAGA = 5;
18			const CATEGORY_HIBURAN = 6;
19			const CATEGORY_TEKNOLOGI = 7;
20			const CATEGORY_TRAVEL = 8;
21			const CATEGORY_LIFESTYLE = 9;
22			const CATEGORY_WANITA = 10;
23			const CATEGORY_HIJAB = 11;
24			const CATEGORY_KULINER = 12;
25			const CATEGORY_SEHAT = 13;
26			const CATEGORY_OTOMOTIF = 14;
27			const CATEGORY_INSPIRASI = 15;
28			const CATEGORY_UNIK = 16;
29			const CATEGORY_EVENT = 17;
30			const CATEGORY_KOMUNITAS = 18;
31
32			const TYPE_TEXT = 1;
33			const TYPE_PHOTO = 2;
34			const TYPE_VIDEO = 3;
35
36			const ATTACHMENT_FIELD_PHOTO = 'photo';
37			const ATTACHMENT_FIELD_PAGE = 'page';
38			const ATTACHMENT_FIELD_VIDEO = 'video';
39			const ATTACHMENT_FIELD_GALLERY = 'gallery';
40
41			/**
42			* attachment property
43			*
44			* @var array $attachment
45			*/
46			private $attachment = array();
47
48			/**
49			* identifier
50			*
51			* @var string $identifier
52			*/
53			protected $identifier = null;
54
55			/**
56			* constructor
57			*
58			* @param string $title
59			* @param string $body
60			* @param \Psr\Http\Message\UriInterface\|string $source
61			* @param string $uniqueId
62			* @param integer $typeId
63			* @param integer $categoryId
64			* @param string $reporter
65			* @param string $lead
66			* @param string $tags
67			* @param \DateTimeInterface\|string $publishedAt
68			*/
69			public function __construct(
70			$title,
71			$body,
72			$source,
73			$uniqueId,
74			$typeId = self::TYPE_TEXT,
75			$categoryId = self::CATEGORY_NASIONAL,
76			$reporter = '',
77			$lead = '',
78			$tags = '',
79			$publishedAt = null,
80			$identifier = null
81			) {
82			$source = $this->filterUriInstance($source);
83			$publishedAt = $this->filterDateInstance($publishedAt);
84
85			if (empty($lead)) {
86			$lead = $this->createLeadFromBody($body);
87			}
88
89			$allowedType = array(
90			self::TYPE_PHOTO,
91			self::TYPE_TEXT,
92			self::TYPE_VIDEO
93			);
94
95			if (!in_array($typeId, $allowedType)) {
96			throw new \InvalidArgumentException("Invalid typeId : $typeId, allowed typeId are " . implode(', ', $allowedType));
97			}
98
99			$allowedCategory = array(
100			self::CATEGORY_NASIONAL,
101			self::CATEGORY_INTERNASIONAL,
102			self::CATEGORY_BISNIS,
103			self::CATEGORY_SEPAK_BOLA,
104			self::CATEGORY_OLAHRAGA,
105			self::CATEGORY_HIBURAN,
106			self::CATEGORY_TEKNOLOGI,
107			self::CATEGORY_TRAVEL,
108			self::CATEGORY_LIFESTYLE,
109			self::CATEGORY_WANITA,
110			self::CATEGORY_HIJAB,
111			self::CATEGORY_KULINER,
112			self::CATEGORY_SEHAT,
113			self::CATEGORY_OTOMOTIF,
114			self::CATEGORY_INSPIRASI,
115			self::CATEGORY_UNIK,
116			self::CATEGORY_EVENT,
117			self::CATEGORY_KOMUNITAS,
118			);
119
120			if (!in_array($categoryId, $allowedCategory)) {
121			throw new \InvalidArgumentException("Invalid categoryId : $categoryId, allowed category are " . implode(', ', $allowedCategory));
122			}
123
124			$this->collection = new Collection(
125			array(
126			'title' => $title,
127			'reporter' => $reporter,
128			'lead' => $lead,
129			'body' => $body,
130			'source' => $source,
131			'uniqueId' => $uniqueId,
132			'type_id' => $typeId,
133			'category_id' => $categoryId,
134			'tags' => $tags,
135			'published_at' => $publishedAt
136			)
137			);
138
139			if ($identifier) {
140			$this->setId($identifier);
141			}
142			}
143
144			/**
145			* get ALL Possible attachment for an article, return arrays of field name. Used for consistency accross sdk
146			* leveraging php version 5.3 cannot use array constant
147			*
148			* @return array
149			*/
150			public static function getPossibleAttachment()
151			{
152			return array_merge(
153			self::getDeleteableAttachment(),
154			array(
155			self::ATTACHMENT_FIELD_PHOTO
156			)
157			);
158			}
159
160			/**
161			* get deleteable attachment for constant usage across sdk
162			*
163			* @return array
164			*/
165			public static function getDeleteableAttachment()
166			{
167			return array(
168			self::ATTACHMENT_FIELD_GALLERY,
169			self::ATTACHMENT_FIELD_PAGE,
170			self::ATTACHMENT_FIELD_VIDEO
171			);
172			}
173
174			/**
175			* setIdentifier from rest api response
176			*
177			* @param string $identifier
178			* @return void
179			*/
180			public function setId($identifier)
181			{
182			$this->identifier = $identifier;
183			}
184
185			/**
186			* getIdentifier set before
187			*
188			* @return string
189			*/
190			public function getId()
191			{
192			return $this->identifier;
193			}
194
195			/**
196			* check if this object has attachment assigned to it
197			*
198			* @param string $field
199			* @return boolean
200			*/
201			public function hasAttachment($field)
202			{
203			return isset($this->attachment[$field]);
204			}
205
206			/**
207			* getAttachment based on fields
208			*
209			* @param string $field
210			* @return array
211			*/
212			public function getAttachmentByField($field)
213			{
214			if (isset($this->attachment[$field])) {
215			return $this->attachment[$field];
216			}
217
218			return array();
219			}
220
221			/**
222			* get ALL attachment assigned to this object
223			*
224			* @return array\|null
225			*/
226			public function getAttachments()
227			{
228			return $this->attachment;
229			}
230
231			/**
232			* add attach an attachment to this model
233			*
234			* @param string $field
235			* @param Model $item
236			* @return Article
237			*/
238			public function attach($field, Model $item)
239			{
240			$this->attachment[$field][] = $item;
241
242			return $this;
243			}
244
245			/**
246			* Attach Photo Attachment to article
247			*
248			* @param Photo $photo
249			* @return self
250			*/
251			public function attachPhoto(Photo $photo)
252			{
253			return $this->attach(
254			self::ATTACHMENT_FIELD_PHOTO,
255			$photo
256			);
257			}
258
259			/**
260			* Attach Paging
261			*
262			* @param Page $page
263			* @return self
264			*/
265			public function attachPage(Page $page)
266			{
267			return $this->attach(
268			self::ATTACHMENT_FIELD_PAGE,
269			$this->ensureOrder(
			0 ignored issues – show Bug introduced 2018-06-30 01:48 UTC by Report Bug Copy Issue Report It seems like `$this->ensureOrder($page...:ATTACHMENT_FIELD_PAGE)` targeting `One\Model\Article::ensureOrder()` can also be of type `object<One\Collection>`; however, `One\Model\Article::attach()` does only seem to accept `object<One\Model\Model>`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
270			$page,
271			self::ATTACHMENT_FIELD_PAGE
272			)
273			);
274			}
275
276			/**
277			* Attach gallery here
278			*
279			* @param Gallery $gallery
280			* @return self
281			*/
282			public function attachGallery(Gallery $gallery)
283			{
284			return $this->attach(
285			self::ATTACHMENT_FIELD_GALLERY,
286			$this->ensureOrder(
			0 ignored issues – show Bug introduced 2018-06-30 01:48 UTC by Report Bug Copy Issue Report It seems like `$this->ensureOrder($gall...TACHMENT_FIELD_GALLERY)` targeting `One\Model\Article::ensureOrder()` can also be of type `object<One\Collection>`; however, `One\Model\Article::attach()` does only seem to accept `object<One\Model\Model>`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
287			$gallery,
288			self::ATTACHMENT_FIELD_GALLERY
289			)
290			);
291			}
292
293			/**
294			* attach Video
295			*
296			* @param Video $video
297			* @return self
298			*/
299			public function attachVideo(Video $video)
300			{
301			return $this->attach(
302			self::ATTACHMENT_FIELD_VIDEO,
303			$this->ensureOrder(
			0 ignored issues – show Bug introduced 2018-06-30 01:48 UTC by Report Bug Copy Issue Report It seems like `$this->ensureOrder($vide...ATTACHMENT_FIELD_VIDEO)` targeting `One\Model\Article::ensureOrder()` can also be of type `object<One\Collection>`; however, `One\Model\Article::attach()` does only seem to accept `object<One\Model\Model>`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
304			$video,
305			self::ATTACHMENT_FIELD_VIDEO
306			)
307			);
308			}
309
310			/**
311			* ensuring order
312			*
313			* @param Model\|Collection $attachment
314			* @param string $type
315			* @return Model\|Collection
316			*/
317			private function ensureOrder($attachment, $type)
318			{
319			if (empty($attachment->get('order'))) {
			0 ignored issues – show Bug introduced 2018-06-30 01:48 UTC by Report Bug Copy Issue Report The method `get` does only exist in `One\Collection`, but not in `One\Model\Model`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
320			$attachment->set(
			0 ignored issues – show Bug introduced 2018-06-30 01:48 UTC by Report Bug Copy Issue Report The method `set` does only exist in `One\Collection`, but not in `One\Model\Model`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
321			'order',
322			count($this->getAttachmentByField($type)) + 1
323			);
324			}
325
326			return $attachment;
327			}
328			}
329

KLYgarage / onesdk

Push — master ( a325bd...ce51d7 )

Article::getPossibleAttachment() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like