Completed
Push — master ( bcdba8...408d98 )
by Jan
03:54
created

AttachmentType::getIDString()   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
c 0
b 0
f 0
nc 1
nop 0
dl 0
loc 3
rs 10
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\StructuralDBElement;
56
use App\Validator\Constraints\NoneOfItsChildren;
57
use Doctrine\Common\Collections\ArrayCollection;
58
use Doctrine\Common\Collections\Collection;
59
use Doctrine\ORM\Mapping as ORM;
60
61
/**
62
 * Class AttachmentType.
63
 *
64
 * @ORM\Entity(repositoryClass="App\Repository\StructuralDBElementRepository")
65
 * @ORM\Table(name="`attachement_types`")
66
 */
67
class AttachmentType extends StructuralDBElement
68
{
69
    /**
70
     * @var ArrayCollection
71
     * @ORM\OneToMany(targetEntity="Attachment", mappedBy="attachement_type")
72
     */
73
    protected $attachments;
74
75
    /**
76
     * @ORM\OneToMany(targetEntity="AttachmentType", mappedBy="parent", cascade={"persist"})
77
     */
78
    protected $children;
79
80
    /**
81
     * @ORM\ManyToOne(targetEntity="AttachmentType", inversedBy="children")
82
     * @ORM\JoinColumn(name="parent_id", referencedColumnName="id")
83
     */
84
    protected $parent;
85
86
    /**
87
     * Get all attachements ("Attachement" objects) with this type.
88
     *
89
     * @return Attachment[] all attachements with this type, as a one-dimensional array of Attachement-objects
90
     *                      (sorted by their names)
91
     */
92
    public function getAttachementsForType(): Collection
93
    {
94
        // the attribute $this->attachements is used from class "AttachementsContainingDBELement"
95
        if (null === $this->attachments) {
96
            $this->attachments = new ArrayCollection();
97
        }
98
99
        return $this->attachments;
0 ignored issues
show
Bug Best Practice introduced by
The expression return $this->attachments returns the type Doctrine\Common\Collections\ArrayCollection which is incompatible with the documented return type App\Entity\Attachments\Attachment[].
Loading history...
100
    }
101
102
    /**
103
     * Returns the ID as an string, defined by the element class.
104
     * This should have a form like P000014, for a part with ID 14.
105
     *
106
     * @return string The ID as a string;
107
     */
108
    public function getIDString(): string
109
    {
110
        return 'AT' . sprintf('%09d', $this->getID());
111
    }
112
}
113