mirror/Part-DB.Part-DB-server
1
0
Fork 1
mirror of https://github.com/Part-DB/Part-DB-server.git synced 2025-06-21 17:39:06 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Used PHP_CS_Fixer with symfony preset on codebase.

Browse source
This commit is contained in:
Jan Böhmer 2019-03-20 23:16:07 +01:00
parent 0f3ba9b6a8
commit e2f7aafa2d
43 changed files with 971 additions and 1068 deletions
Download patch file Download diff file Expand all files Collapse all files

167
src/Entity/StructuralDBElement.php
View file

@ -1,9 +1,10 @@
<?php declare(strict_types=1);
<?php
declare(strict_types=1);
/**
*
* Part-DB Version 0.4+ "nextgen"
* Copyright (C) 2016 - 2019 Jan Böhmer
* https://github.com/jbtronics
* 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
@ -18,7 +19,6 @@
* 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;
@ -28,8 +28,7 @@ use Doctrine\ORM\Mapping as ORM;
use Doctrine\ORM\PersistentCollection;
/**
*
* All elements with the fields "id", "name" and "parent_id" (at least)
* All elements with the fields "id", "name" and "parent_id" (at least).
*
* This class is for managing all database objects with a structural design.
* All these sub-objects must have the table columns 'id', 'name' and 'parent_id' (at least)!
@ -46,7 +45,6 @@ abstract class StructuralDBElement extends AttachmentContainingDBElement
//This is a not standard character, so build a const, so a dev can easily use it
const PATH_DELIMITER_ARROW = ' → ';
// We can not define the mapping here or we will get an exception. Unfortunatly we have to do the mapping in the
// subclasses
/**
@ -73,7 +71,7 @@ abstract class StructuralDBElement extends AttachmentContainingDBElement
/**
* @var int
*/
protected $level=0;
protected $level = 0;
/** @var string[] all names of all parent elements as a array of strings,
* the last array element is the name of the element itself */
@ -84,10 +82,10 @@ abstract class StructuralDBElement extends AttachmentContainingDBElement
*****************************************************************************/
/**
* Check if this element is a child of another element (recursive)
* Check if this element is a child of another element (recursive).
*
* @param StructuralDBElement $another_element the object to compare
* IMPORTANT: both objects to compare must be from the same class (for example two "Device" objects)!
* @param StructuralDBElement $another_element the object to compare
* IMPORTANT: both objects to compare must be from the same class (for example two "Device" objects)!
*
* @return bool True, if this element is child of $another_element.
*
@ -102,16 +100,15 @@ abstract class StructuralDBElement extends AttachmentContainingDBElement
throw new \InvalidArgumentException('isChildOf() funktioniert nur mit Elementen des gleichen Typs!');
}
if ($this->getID() == null) { // this is the root node
if (null == $this->getID()) { // this is the root node
return false;
}
//If this' parents element, is $another_element, then we are finished
return (($this->parent->getID() == $another_element->getID())
|| $this->parent->isChildOf($another_element)); //Otherwise, check recursivley
//If this' parents element, is $another_element, then we are finished
return ($this->parent->getID() == $another_element->getID())
|| $this->parent->isChildOf($another_element); //Otherwise, check recursivley
}
/******************************************************************************
*
* Getters
@ -125,16 +122,17 @@ abstract class StructuralDBElement extends AttachmentContainingDBElement
* * NULL means, the parent is the root node
* * the parent ID of the root node is -1
*/
public function getParentID() : int
public function getParentID(): int
{
return $this->parent_id ?? self::ID_ROOT_ELEMENT; //Null means root element
}
/**
* Get the parent of this element.
*
* @return StructuralDBElement|null The parent element. Null if this element, does not have a parent.
*/
public function getParent() : ?self
public function getParent(): ?self
{
return $this->parent;
}
@ -142,10 +140,11 @@ abstract class StructuralDBElement extends AttachmentContainingDBElement
/**
* Get the comment of the element.
*
* @param boolean $parse_bbcode Should BBCode converted to HTML, before returning
* @return string the comment
* @param bool $parse_bbcode Should BBCode converted to HTML, before returning
*
* @return string the comment
*/
public function getComment(bool $parse_bbcode = true) : string
public function getComment(bool $parse_bbcode = true): string
{
$val = htmlspecialchars($this->comment ?? '');
@ -153,24 +152,23 @@ abstract class StructuralDBElement extends AttachmentContainingDBElement
}
/**
* Get the level
* Get the level.
*
* The level of the root node is -1.
*
* @return integer the level of this element (zero means a most top element
* [a subelement of the root node])
*
* @return int the level of this element (zero means a most top element
* [a subelement of the root node])
*/
public function getLevel() : int
public function getLevel(): int
{
if ($this->level === 0) {
if (0 === $this->level) {
$element = $this->parent;
$parent_id = $element->getParentID();
while ($parent_id > 0) {
/** @var StructuralDBElement $element */
$element = $element->parent;
$parent_id = $element->getParentID();
$this->level++;
++$this->level;
}
}
@ -178,22 +176,22 @@ abstract class StructuralDBElement extends AttachmentContainingDBElement
}
/**
* Get the full path
* Get the full path.
*
* @param string $delimeter the delimeter of the returned string
* @param string $delimeter the delimeter of the returned string
*
* @return string the full path (incl. the name of this element), delimeted by $delimeter
* @return string the full path (incl. the name of this element), delimeted by $delimeter
*
* @throws Exception if there was an error
* @throws Exception if there was an error
*/
public function getFullPath(string $delimeter = self::PATH_DELIMITER_ARROW) : string
public function getFullPath(string $delimeter = self::PATH_DELIMITER_ARROW): string
{
if (! \is_array($this->full_path_strings)) {
if (!\is_array($this->full_path_strings)) {
$this->full_path_strings = array();
$this->full_path_strings[] = $this->getName();
$element = $this;
while ($element->parent != null) {
while (null != $element->parent) {
$element = $element->parent;
$this->full_path_strings[] = $element->getName();
}
@ -205,19 +203,19 @@ abstract class StructuralDBElement extends AttachmentContainingDBElement
}
/**
* Get all subelements of this element
* Get all subelements of this element.
*
* @param boolean $recursive if true, the search is recursive
* @param bool $recursive if true, the search is recursive
*
* @return static[] all subelements as an array of objects (sorted by their full path)
* @return static[] all subelements as an array of objects (sorted by their full path)
*/
public function getSubelements(bool $recursive) : PersistentCollection
public function getSubelements(bool $recursive): PersistentCollection
{
if ($this->children == null) {
if (null == $this->children) {
$this->children = new ArrayCollection();
}
if (! $recursive) {
if (!$recursive) {
return $this->children;
} else {
$all_elements = array();
@ -237,26 +235,29 @@ abstract class StructuralDBElement extends AttachmentContainingDBElement
******************************************************************************/
/**
* Change the parent ID of this element
* Change the parent ID of this element.
*
* @param integer|null $new_parent_id * the ID of the new parent element
* * NULL if the parent should be the root node
* @param int|null $new_parent_id * the ID of the new parent element
* * NULL if the parent should be the root node
*/
public function setParentID($new_parent_id) : self
public function setParentID($new_parent_id): self
{
$this->parent_id = $new_parent_id;
return $this;
}
/**
* Set the comment
* Set the comment.
*
* @param string $new_comment the new comment
*
* @param string $new_comment the new comment
* @throws Exception if there was an error
*/
public function setComment(string $new_comment) : self
public function setComment(string $new_comment): self
{
$this->comment = $new_comment;
return $this;
}
@ -267,21 +268,21 @@ abstract class StructuralDBElement extends AttachmentContainingDBElement
*********************************************************************************/
/**
* Build a HTML tree with all subcategories of this element
* Build a HTML tree with all subcategories of this element.
*
* This method prints a <option>-Line for every item.
* <b>The <select>-tags are not printed here, you have to print them yourself!</b>
* Deeper levels have more spaces in front.
*
* @param integer $selected_id the ID of the selected item
* @param boolean $recursive if true, the tree will be recursive
* @param boolean $show_root if true, the root node will be displayed
* @param string $root_name if the root node is the very root element, you can set its name here
* @param string $value_prefix This string is used as a prefix before the id in the value part of the option.
* @param int $selected_id the ID of the selected item
* @param bool $recursive if true, the tree will be recursive
* @param bool $show_root if true, the root node will be displayed
* @param string $root_name if the root node is the very root element, you can set its name here
* @param string $value_prefix This string is used as a prefix before the id in the value part of the option.
*
* @return string HTML string if success
* @return string HTML string if success
*
* @throws Exception if there was an error
* @throws Exception if there was an error
*/
public function buildHtmlTree(
$selected_id = null,
@ -289,8 +290,8 @@ abstract class StructuralDBElement extends AttachmentContainingDBElement
bool $show_root = true,
string $root_name = '$$',
string $value_prefix = ''
) : string {
if ($root_name == '$$') {
): string {
if ('$$' == $root_name) {
$root_name = _('Oberste Ebene');
}
@ -302,9 +303,9 @@ abstract class StructuralDBElement extends AttachmentContainingDBElement
$root_name = htmlspecialchars($this->getName());
}
$html[] = '<option value="'. $value_prefix . $this->getID() . '">' . $root_name . '</option>';
$html[] = '<option value="'.$value_prefix.$this->getID().'">'.$root_name.'</option>';
} else {
$root_level = $this->getLevel() + 1;
$root_level = $this->getLevel() + 1;
}
// get all subelements
@ -314,17 +315,16 @@ abstract class StructuralDBElement extends AttachmentContainingDBElement
$level = $element->getLevel() - $root_level;
$selected = ($element->getID() == $selected_id) ? 'selected' : '';
$html[] = '<option ' . $selected . ' value="' . $value_prefix . $element->getID() . '">';
for ($i = 0; $i < $level; $i++) {
$html[] = '<option '.$selected.' value="'.$value_prefix.$element->getID().'">';
for ($i = 0; $i < $level; ++$i) {
$html[] = '&nbsp;&nbsp;&nbsp;';
}
$html[] = htmlspecialchars($element->getName()) . '</option>';
$html[] = htmlspecialchars($element->getName()).'</option>';
}
return implode("\n", $html);
}
public function buildBootstrapTree(
$page,
$parameter,
@ -332,9 +332,8 @@ abstract class StructuralDBElement extends AttachmentContainingDBElement
$show_root = false,
$use_db_root_name = true,
$root_name = '$$'
): array
{
if ($root_name == '$$') {
): array {
if ('$$' == $root_name) {
$root_name = _('Oberste Ebene');
}
@ -346,61 +345,62 @@ abstract class StructuralDBElement extends AttachmentContainingDBElement
}
// if we are on root level?
if ($this->getParentID() == -1) {
if (-1 == $this->getParentID()) {
if ($show_root) {
$tree = array(
array('text' => $use_db_root_name ? htmlspecialchars($this->getName()) : $root_name ,
'href' => $page . '?' . $parameter . '=' . $this->getID(),
'nodes' => $nodes)
array('text' => $use_db_root_name ? htmlspecialchars($this->getName()) : $root_name,
'href' => $page.'?'.$parameter.'='.$this->getID(),
'nodes' => $nodes, ),
);
} else { //Dont show root node
$tree = $nodes;
}
} elseif (!empty($nodes)) {
$tree = array('text' => htmlspecialchars($this->getName()),
'href' => $page . '?' . $parameter . '=' . $this->getID(),
'nodes' => $nodes
'href' => $page.'?'.$parameter.'='.$this->getID(),
'nodes' => $nodes,
);
} else {
$tree = array('text' => htmlspecialchars($this->getName()),
'href' => $page . '?' . $parameter . '=' . $this->getID()
'href' => $page.'?'.$parameter.'='.$this->getID(),
);
}
return $tree;
}
/**
* Creates a template loop for a Breadcrumb bar, representing the structural DB element.
*
* @param $page string The base page, to which the breadcrumb links should be directing to.
* @param $parameter string The parameter, which selects the ID of the StructuralDBElement.
* @param bool $show_root Show the root as its own breadcrumb.
* @param bool $show_root Show the root as its own breadcrumb.
* @param string $root_name The label which should be used for the root breadcrumb.
*
* @return array An Loop containing multiple arrays, which contains href and caption for the breadcrumb.
*/
public function buildBreadcrumbLoop(string $page, string $parameter, bool $show_root = false, $root_name = '$$', bool $element_is_link = false) : array
public function buildBreadcrumbLoop(string $page, string $parameter, bool $show_root = false, $root_name = '$$', bool $element_is_link = false): array
{
$breadcrumb = array();
if ($root_name == '$$') {
if ('$$' == $root_name) {
$root_name = _('Oberste Ebene');
}
if ($show_root) {
$breadcrumb[] = array('label' => $root_name,
'disabled' => true);
'disabled' => true, );
}
if (!$this->current_user->canDo(static::getPermissionName(), StructuralPermission::READ)) {
return array('label' => '???',
'disabled' => true);
'disabled' => true, );
}
$tmp = array();
if ($element_is_link) {
$tmp[] = array('label' => $this->getName(), 'href' => $page . '?' . $parameter . '=' .$this->getID(), 'selected' => true);
$tmp[] = array('label' => $this->getName(), 'href' => $page.'?'.$parameter.'='.$this->getID(), 'selected' => true);
} else {
$tmp[] = array('label' => $this->getName(), 'selected' => true);
}
@ -410,7 +410,7 @@ abstract class StructuralDBElement extends AttachmentContainingDBElement
/** @var StructuralDBElement $element */
$element = static::getInstance($this->database, $this->current_user, $this->log, $parent_id);
$parent_id = $element->getParentID();
$tmp[] = array('label' => $element->getName(), 'href' => $page . '?' . $parameter . '=' . $element->getID());
$tmp[] = array('label' => $element->getName(), 'href' => $page.'?'.$parameter.'='.$element->getID());
}
$tmp = array_reverse($tmp);
@ -418,5 +418,4 @@ abstract class StructuralDBElement extends AttachmentContainingDBElement
return $breadcrumb;
}
}
}