Passed
Push — master ( 8e2362...7608d5 )
by Jan
04:12
created

Footprint::is3dFilenameValid()   A

Complexity

Conditions 3
Paths 3

Size

Total Lines 12
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 3
eloc 5
c 0
b 0
f 0
nc 3
nop 0
dl 0
loc 12
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
/**
35
 * part-db version 0.1
36
 * Copyright (C) 2005 Christoph Lechner
37
 * http://www.cl-projects.de/.
38
 *
39
 * part-db version 0.2+
40
 * Copyright (C) 2009 K. Jacobs and others (see authors.php)
41
 * http://code.google.com/p/part-db/
42
 *
43
 * Part-DB Version 0.4+
44
 * Copyright (C) 2016 - 2019 Jan Böhmer
45
 * https://github.com/jbtronics
46
 *
47
 * This program is free software; you can redistribute it and/or
48
 * modify it under the terms of the GNU General Public License
49
 * as published by the Free Software Foundation; either version 2
50
 * of the License, or (at your option) any later version.
51
 *
52
 * This program is distributed in the hope that it will be useful,
53
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
54
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
55
 * GNU General Public License for more details.
56
 *
57
 * You should have received a copy of the GNU General Public License
58
 * along with this program; if not, write to the Free Software
59
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
60
 */
61
62
namespace App\Entity\Parts;
63
64
use App\Entity\Base\PartsContainingDBElement;
65
use Doctrine\ORM\Mapping as ORM;
66
67
/**
68
 * Class Footprint.
69
 *
70
 * @ORM\Entity(repositoryClass="App\Repository\StructuralDBElementRepository")
71
 * @ORM\Table("`footprints`")
72
 */
73
class Footprint extends PartsContainingDBElement
74
{
75
    /**
76
     * @ORM\OneToMany(targetEntity="Footprint", mappedBy="parent")
77
     */
78
    protected $children;
79
80
    /**
81
     * @ORM\ManyToOne(targetEntity="Footprint", inversedBy="children")
82
     * @ORM\JoinColumn(name="parent_id", referencedColumnName="id")
83
     */
84
    protected $parent;
85
86
    /**
87
     * @var string
88
     * @ORM\Column(type="string", length=65536)
89
     */
90
    protected $filename;
91
92
    /**
93
     * @ORM\OneToMany(targetEntity="Part", mappedBy="footprint")
94
     */
95
    protected $parts;
96
97
    /**
98
     * @var string
99
     * @ORM\Column(type="string", length=65536)
100
     */
101
    protected $filename_3d;
102
103
    /**
104
     * Returns the ID as an string, defined by the element class.
105
     * This should have a form like P000014, for a part with ID 14.
106
     *
107
     * @return string The ID as a string;
108
     */
109
    public function getIDString(): string
110
    {
111
        return 'F'.sprintf('%06d', $this->getID());
112
    }
113
114
    /****************************************
115
     * Getters
116
     ****************************************/
117
118
    /**
119
     * Get the filename of the picture (absolute path from filesystem root).
120
     *
121
     * @return string the saved filename in the DB
122
     *                * an empty string if there is no picture
123
     */
124
    public function getFilename(): string
125
    {
126
        return $this->filename;
127
    }
128
129
    /**
130
     *   Get the filename of the 3d model (absolute path from filesystem root).
131
     * @return string * the absolute path to the model (from filesystem root), as a UNIX path (with slashes)
132
     *                * an empty string if there is no model
133
     */
134
    public function get3dFilename(): string
135
    {
136
        return $this->filename_3d;
137
    }
138
139
    /********************************************************************************
140
     *
141
     *   Setters
142
     *
143
     *********************************************************************************/
144
145
    /**
146
     *  Change the filename of this footprint.
147
     *  @param string $new_filename The new file name
148
     *  @return Footprint
149
     */
150
    public function setFilename(string $new_filename): self
151
    {
152
        $this->filename = $new_filename;
153
154
        return $this;
155
    }
156
157
    /**
158
     *  Change the 3d model filename of this footprint.
159
     * @param string $new_filename The new filename
160
     *
161
     * @return Footprint
162
     */
163
    public function set3dFilename(string $new_filename): self
164
    {
165
        $this->filename = $new_filename;
166
167
        return $this;
168
    }
169
}
170