Footprint::getFilename() - 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

Footprint::getFilename() A

↳ Parent: Footprint

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
c	0
b	0
f	0
nc	1
nop	0
dl	0
loc	3
rs	10

<?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.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
 */

namespace App\Entity\Parts;

use App\Entity\Base\PartsContainingDBElement;
use Doctrine\ORM\Mapping as ORM;

/**
 * Class Footprint.
 *
 * @ORM\Entity(repositoryClass="App\Repository\StructuralDBElementRepository")
 * @ORM\Table("`footprints`")
 */
class Footprint extends PartsContainingDBElement
{
    /**
     * @ORM\OneToMany(targetEntity="Footprint", mappedBy="parent")
     */
    protected $children;

    /**
     * @ORM\ManyToOne(targetEntity="Footprint", inversedBy="children")
     * @ORM\JoinColumn(name="parent_id", referencedColumnName="id")
     */
    protected $parent;

    /**
     * @var string
     * @ORM\Column(type="string", length=65536)
     */
    protected $filename;

    /**
     * @ORM\OneToMany(targetEntity="Part", mappedBy="footprint")
     */
    protected $parts;

    /**
     * @var string
     * @ORM\Column(type="string", length=65536)
     */
    protected $filename_3d;

    /**
     * Returns the ID as an string, defined by the element class.
     * This should have a form like P000014, for a part with ID 14.
     *
     * @return string The ID as a string;
     */
    public function getIDString(): string
    {
        return 'F'.sprintf('%06d', $this->getID());
    }

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

    /**
     * Get the filename of the picture (absolute path from filesystem root).
     *
     * @return string the saved filename in the DB
     *                * an empty string if there is no picture
     */
    public function getFilename(): string
    {
        return $this->filename;
    }

    /**
     *   Get the filename of the 3d model (absolute path from filesystem root).
     *
     * @param bool $absolute If set to true, then the absolute filename (from system root) is returned.
     *                       If set to false, then the path relative to Part-DB folder is returned.
     *
     * @return string * the absolute path to the model (from filesystem root), as a UNIX path (with slashes)
     *                * an empty string if there is no model
     */
    public function get3dFilename(bool $absolute = true): string
    {
        if (true === $absolute) {
            //TODO
            throw new \Exception('Not Implemented yet...');
            //return str_replace('%BASE%', BASE, $this->db_data['filename_3d']);
        }

        return $this->filename_3d;
    }

    /**
     *  Check if the filename of this footprint is valid (picture exists).
     *
     * This method is used to get all footprints with broken filename
     * (Footprint::get_broken_filename_footprints()).
     *
     *  An empty filename is a valid filename.
     *
     * @return bool * true if file exists or filename is empty
     *              * false if there is no file with this filename
     */
    public function isFilenameValid(): bool
    {
        if (empty($this->getFilename())) {
            return true;
        }

        return file_exists($this->getFilename());
    }

    /**
     *  Check if the filename of this 3d footprint is valid (model exists and have ).
     *
     * This method is used to get all footprints with broken 3d filename
     * (Footprint::get_broken_3d_filename_footprints()).
     *
     *  An empty filename is a valid filename.
     *
     * @return bool * true if file exists or filename is empty
     *              * false if there is no file with this filename
     */
    public function is3dFilenameValid(): bool
    {
        if (empty($this->get3dFilename())) {
            return true;
        }

        //Check if file is X3D-Model (these has .x3d extension)
        if (false === strpos($this->get3dFilename(), '.x3d')) {
            return false;
        }

        return file_exists($this->get3dFilename());
    }

    /*****************************************************************************
     * Setters
     ****************************************************************************/

    /********************************************************************************
     *
     *   Setters
     *
     *********************************************************************************/

    /**
     *  Change the filename of this footprint.
     *
     *     The filename won't be checked if it is valid.
     *          It's not really a Problem if there is no such file...
     *          (For this purpose we have the method Footprint::get_broken_filename_footprints())
     *
     * @param string $new_filename * the new filename (absolute path from filesystem root, as a UNIX path [only slashes!] !! )
     *                             * see also lib.functions.php::to_unix_path()
     *
     *      It's really important that you pass the whole (UNIX) path from filesystem root!
     *              If the file is located in the base directory of Part-DB, the base path
     *              will be automatically replaced with a placeholder before write it in the database.
     *              This way, the filenames are still correct if the installation directory
     *              of Part-DB is moved.
     *
     *         The path-replacing will be done in Footprint::check_values_validity(), not here.
     *
     * @return Footprint
     *
     * @throws \Exception if there was an error
     */
    public function setFilename(string $new_filename): self
    {
        $this->filename = $new_filename;

        return $this;
    }

    /**
     *  Change the 3d model filename of this footprint.
     *
     * @throws \Exception if there was an error
     */
    public function set3dFilename(string $new_filename): self
    {
        $this->filename = $new_filename;

        return $this;
    }
}


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			*
132			* @param bool $absolute If set to true, then the absolute filename (from system root) is returned.
133			* If set to false, then the path relative to Part-DB folder is returned.
134			*
135			* @return string * the absolute path to the model (from filesystem root), as a UNIX path (with slashes)
136			* * an empty string if there is no model
137			*/
138			public function get3dFilename(bool $absolute = true): string
139			{
140			if (true === $absolute) {
141			//TODO
142			throw new \Exception('Not Implemented yet...');
143			//return str_replace('%BASE%', BASE, $this->db_data['filename_3d']);
144			}
145
146			return $this->filename_3d;
147			}
148
149			/**
150			* Check if the filename of this footprint is valid (picture exists).
151			*
152			* This method is used to get all footprints with broken filename
153			* (Footprint::get_broken_filename_footprints()).
154			*
155			* An empty filename is a valid filename.
156			*
157			* @return bool * true if file exists or filename is empty
158			* * false if there is no file with this filename
159			*/
160			public function isFilenameValid(): bool
161			{
162			if (empty($this->getFilename())) {
163			return true;
164			}
165
166			return file_exists($this->getFilename());
167			}
168
169			/**
170			* Check if the filename of this 3d footprint is valid (model exists and have ).
171			*
172			* This method is used to get all footprints with broken 3d filename
173			* (Footprint::get_broken_3d_filename_footprints()).
174			*
175			* An empty filename is a valid filename.
176			*
177			* @return bool * true if file exists or filename is empty
178			* * false if there is no file with this filename
179			*/
180			public function is3dFilenameValid(): bool
181			{
182			if (empty($this->get3dFilename())) {
183			return true;
184			}
185
186			//Check if file is X3D-Model (these has .x3d extension)
187			if (false === strpos($this->get3dFilename(), '.x3d')) {
188			return false;
189			}
190
191			return file_exists($this->get3dFilename());
192			}
193
194			/*****************************************************************************
195			* Setters
196			****************************************************************************/
197
198			/********************************************************************************
199			*
200			* Setters
201			*
202			*********************************************************************************/
203
204			/**
205			* Change the filename of this footprint.
206			*
207			* The filename won't be checked if it is valid.
208			* It's not really a Problem if there is no such file...
209			* (For this purpose we have the method Footprint::get_broken_filename_footprints())
210			*
211			* @param string $new_filename * the new filename (absolute path from filesystem root, as a UNIX path [only slashes!] !! )
212			* * see also lib.functions.php::to_unix_path()
213			*
214			* It's really important that you pass the whole (UNIX) path from filesystem root!
215			* If the file is located in the base directory of Part-DB, the base path
216			* will be automatically replaced with a placeholder before write it in the database.
217			* This way, the filenames are still correct if the installation directory
218			* of Part-DB is moved.
219			*
220			* The path-replacing will be done in Footprint::check_values_validity(), not here.
221			*
222			* @return Footprint
223			*
224			* @throws \Exception if there was an error
225			*/
226			public function setFilename(string $new_filename): self
227			{
228			$this->filename = $new_filename;
229
230			return $this;
231			}
232
233			/**
234			* Change the 3d model filename of this footprint.
235			*
236			* @throws \Exception if there was an error
237			*/
238			public function set3dFilename(string $new_filename): self
239			{
240			$this->filename = $new_filename;
241
242			return $this;
243			}
244			}
245

Part-DB / Part-DB-symfony

Push — master ( bcdba8...408d98 )

Footprint::getFilename() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like