Completed
Push — master ( fcfab9...3a1193 )
by Jan
03:55
created

AttachmentContainingDBElement::getAttachments()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 1
nc 1
nop 0
dl 0
loc 3
rs 10
c 0
b 0
f 0
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\ArrayCollection;
57
use Doctrine\Common\Collections\Collection;
58
use Doctrine\ORM\Mapping as ORM;
59
use Exception;
60
61
/**
62
 * @ORM\MappedSuperclass()
63
 */
64
abstract class AttachmentContainingDBElement extends NamedDBElement
65
{
66
    /**
67
     * @var Attachment[]
68
     * //TODO
69
     * //@ORM\OneToMany(targetEntity="Attachment", mappedBy="element")
70
     *
71
     * Mapping is done in sub classes like part
72
     */
73
    protected $attachments;
74
75
    public function __construct()
76
    {
77
        $this->attachments = new ArrayCollection();
0 ignored issues
show
Documentation Bug introduced by
It seems like new Doctrine\Common\Collections\ArrayCollection() of type Doctrine\Common\Collections\ArrayCollection is incompatible with the declared type App\Entity\Attachments\Attachment[] of property $attachments.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
78
    }
79
80
    /********************************************************************************
81
     *
82
     *   Getters
83
     *
84
     *********************************************************************************/
85
86
    /**
87
     * Gets all attachments associated with this element.
88
     * @return Attachment[]|Collection
89
     */
90
    public function getAttachments() : Collection
91
    {
92
        return $this->attachments;
0 ignored issues
show
Bug Best Practice introduced by
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...
93
    }
94
95
    /**
96
     * Adds an attachment to this element
97
     * @param Attachment $attachment Attachment
98
     * @return $this
99
     */
100
    public function addAttachment(Attachment $attachment) : self
101
    {
102
        //Attachment must be associated with this element
103
        $attachment->setElement($this);
104
        $this->attachments->add($attachment);
105
        return $this;
106
    }
107
108
    /**
109
     * Removes the given attachment from this element
110
     * @param Attachment $attachment
111
     * @return $this
112
     */
113
    public function removeAttachment(Attachment $attachment) : self
114
    {
115
        $this->attachments->removeElement($attachment);
116
        return $this;
117
    }
118
}
119