AttachmentContainingDBElement::getAttachments() - Code Metrics - Inspection of "Added database migration for new entities." - Part-DB/Part-DB-symfony - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bcdba8...408d98 )

by Jan

created 2019-08-12 16:05 UTC

AttachmentContainingDBElement::getAttachments() B

↳ Parent: AttachmentContainingDBElement

Complexity

Conditions	8
Paths	4

Size

Total Lines	16
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	8
eloc	8
c	0
b	0
f	0
nc	4
nop	2
dl	0
loc	16
rs	8.4444

<?php
/**
 *
 * part-db version 0.1
 * Copyright (C) 2005 Christoph Lechner
 * http://www.cl-projects.de/
 *
 * part-db version 0.2+
 * Copyright (C) 2009 K. Jacobs and others (see authors.php)
 * http://code.google.com/p/part-db/
 *
 * Part-DB Version 0.4+
 * Copyright (C) 2016 - 2019 Jan Böhmer
 * https://github.com/jbtronics
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 *
 */

declare(strict_types=1);
/**
 * Part-DB Version 0.4+ "nextgen"
 * Copyright (C) 2016 - 2019 Jan Böhmer
 * https://github.com/jbtronics.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */

namespace App\Entity\Attachments;

use App\Entity\Base\NamedDBElement;
use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
use Exception;

/**
 * @ORM\MappedSuperclass()
 */
abstract class AttachmentContainingDBElement extends NamedDBElement
{
    /**
     * @var Attachment[]
     * //TODO
     * //@ORM\OneToMany(targetEntity="Attachment", mappedBy="element")
     *
     * Mapping is done in sub classes like part
     */
    protected $attachments;

    //TODO
    protected $attachmentTypes;

    /********************************************************************************
     *
     *   Getters
     *
     *********************************************************************************/

    /**
     * Get all different attachement types of the attachements of this element.
     *
     * @return AttachmentType[] the attachement types as a one-dimensional array of AttachementType objects,
     *                          sorted by their names
     *
     * @throws Exception if there was an error
     */
    public function getAttachmentTypes(): ?array
    {
        return $this->attachmentTypes;
    }

    /**
     * Get all attachements of this element / Get the element's attachements with a specific type.
     *
     * @param int  $type_id                 * if NULL, all attachements of this element will be returned
     *                                      * if this is a number > 0, only attachements with this type ID will be returned
     * @param bool $only_table_attachements if true, only attachements with "show_in_table == true"
     *
     * @return Attachment[] the attachements as a one-dimensional array of Attachement objects
     *
     * @throws Exception if there was an error
     */
    public function getAttachments($type_id = null, bool $only_table_attachements = false) : Collection
    {
        if ($only_table_attachements || $type_id) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            $attachements = $this->attachments;

            foreach ($attachements as $key => $attachement) {
                if (($only_table_attachements && (!$attachement->getShowInTable()))
                    || ($type_id && ($attachement->getType()->getID() !== $type_id))) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
                    unset($attachements[$key]);
                }
            }

            return $attachements;

        }

        return $this->attachments;

    }
}


1			<?php
2			/**
3			*
4			* part-db version 0.1
5			* Copyright (C) 2005 Christoph Lechner
6			* http://www.cl-projects.de/
7			*
8			* part-db version 0.2+
9			* Copyright (C) 2009 K. Jacobs and others (see authors.php)
10			* http://code.google.com/p/part-db/
11			*
12			* Part-DB Version 0.4+
13			* Copyright (C) 2016 - 2019 Jan Böhmer
14			* https://github.com/jbtronics
15			*
16			* This program is free software; you can redistribute it and/or
17			* modify it under the terms of the GNU General Public License
18			* as published by the Free Software Foundation; either version 2
19			* of the License, or (at your option) any later version.
20			*
21			* This program is distributed in the hope that it will be useful,
22			* but WITHOUT ANY WARRANTY; without even the implied warranty of
23			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24			* GNU General Public License for more details.
25			*
26			* You should have received a copy of the GNU General Public License
27			* along with this program; if not, write to the Free Software
28			* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
29			*
30			*/
31
32			declare(strict_types=1);
33			/**
34			* Part-DB Version 0.4+ "nextgen"
35			* Copyright (C) 2016 - 2019 Jan Böhmer
36			* https://github.com/jbtronics.
37			*
38			* This program is free software; you can redistribute it and/or
39			* modify it under the terms of the GNU General Public License
40			* as published by the Free Software Foundation; either version 2
41			* of the License, or (at your option) any later version.
42			*
43			* This program is distributed in the hope that it will be useful,
44			* but WITHOUT ANY WARRANTY; without even the implied warranty of
45			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
46			* GNU General Public License for more details.
47			*
48			* You should have received a copy of the GNU General Public License
49			* along with this program; if not, write to the Free Software
50			* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
51			*/
52
53			namespace App\Entity\Attachments;
54
55			use App\Entity\Base\NamedDBElement;
56			use Doctrine\Common\Collections\Collection;
57			use Doctrine\ORM\Mapping as ORM;
58			use Exception;
59
60			/**
61			* @ORM\MappedSuperclass()
62			*/
63			abstract class AttachmentContainingDBElement extends NamedDBElement
64			{
65			/**
66			* @var Attachment[]
67			* //TODO
68			* //@ORM\OneToMany(targetEntity="Attachment", mappedBy="element")
69			*
70			* Mapping is done in sub classes like part
71			*/
72			protected $attachments;
73
74			//TODO
75			protected $attachmentTypes;
76
77			/********************************************************************************
78			*
79			* Getters
80			*
81			*********************************************************************************/
82
83			/**
84			* Get all different attachement types of the attachements of this element.
85			*
86			* @return AttachmentType[] the attachement types as a one-dimensional array of AttachementType objects,
87			* sorted by their names
88			*
89			* @throws Exception if there was an error
90			*/
91			public function getAttachmentTypes(): ?array
92			{
93			return $this->attachmentTypes;
94			}
95
96			/**
97			* Get all attachements of this element / Get the element's attachements with a specific type.
98			*
99			* @param int $type_id * if NULL, all attachements of this element will be returned
100			* * if this is a number > 0, only attachements with this type ID will be returned
101			* @param bool $only_table_attachements if true, only attachements with "show_in_table == true"
102			*
103			* @return Attachment[] the attachements as a one-dimensional array of Attachement objects
104			*
105			* @throws Exception if there was an error
106			*/
107			public function getAttachments($type_id = null, bool $only_table_attachements = false) : Collection
108			{
109			if ($only_table_attachements \|\| $type_id) {
			0 ignored issues – show Bug Best Practice introduced 2019-03-09 19:53 UTC by Report Bug Copy Issue Report The expression `$type_id` of type `integer\|null` is loosely compared to `true`; this is ambiguous if the integer can be 0. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
110			$attachements = $this->attachments;
111
112			foreach ($attachements as $key => $attachement) {
113			if (($only_table_attachements && (!$attachement->getShowInTable()))
114			\|\| ($type_id && ($attachement->getType()->getID() !== $type_id))) {
			0 ignored issues – show Bug Best Practice introduced 2019-03-09 19:53 UTC by Report Bug Copy Issue Report The expression `$type_id` of type `integer\|null` is loosely compared to `true`; this is ambiguous if the integer can be 0. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
115			unset($attachements[$key]);
116			}
117			}
118
119			return $attachements;
			0 ignored issues – show Bug Best Practice introduced 2019-08-12 16:08 UTC by Report Bug Copy Issue Report The expression `return $attachements` returns the type `App\Entity\Attachments\Attachment[]` which is incompatible with the type-hinted return `Doctrine\Common\Collections\Collection`. Loading history...
120			}
121
122			return $this->attachments;
			0 ignored issues – show Bug Best Practice introduced 2019-08-12 16:08 UTC by Report Bug Copy Issue Report The expression `return $this->attachments` returns the type `App\Entity\Attachments\Attachment[]` which is incompatible with the type-hinted return `Doctrine\Common\Collections\Collection`. Loading history...
123			}
124			}
125

Part-DB / Part-DB-symfony

Push — master ( bcdba8...408d98 )

AttachmentContainingDBElement::getAttachments() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like