mirror/Part-DB.Part-DB-server
1
0
Fork 1
mirror of https://github.com/Part-DB/Part-DB-server.git synced 2025-06-23 18:28:49 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Applied code style rules to src/

Browse source
This commit is contained in:
Jan Böhmer 2020-01-05 15:46:58 +01:00
parent 700c049d26
commit f861de791f
186 changed files with 1462 additions and 1059 deletions
Download patch file Download diff file Expand all files Collapse all files

77
src/Services/EntityURLGenerator.php
View file

@ -1,4 +1,7 @@
<?php
declare(strict_types=1);
/**
* This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
*
@ -58,43 +61,13 @@ class EntityURLGenerator
$this->attachmentURLGenerator = $attachmentURLGenerator;
}
/**
* Finds the controller name for the class of the entity using the given map.
* Throws an exception if the entity class is not known to the map.
*
* @param array $map The map that should be used for determing the controller
* @param $entity mixed The entity for which the controller name should be determined
*
* @return string The name of the controller fitting the entity class
*
* @throws EntityNotSupportedException
*/
protected function mapToController(array $map, $entity): string
{
$class = \get_class($entity);
//Check if we have an direct mapping for the given class
if (!\array_key_exists($class, $map)) {
//Check if we need to check inheritance by looping through our map
foreach ($map as $key => $value) {
if (is_a($entity, $key)) {
return $map[$key];
}
}
throw new EntityNotSupportedException(sprintf('The given entity is not supported yet! Passed class type: %s', \get_class($entity)));
}
return $map[$class];
}
/**
* Generates an URL to the page using the given page type and element.
* For the given types, the [type]URL() functions are called (e.g. infoURL()).
* Not all entity class and $type combinations are supported.
*
* @param $entity mixed The element for which the page should be generated
* @param string $type The page type. Currently supported: 'info', 'edit', 'create', 'clone', 'list'/'list_parts'
* @param mixed $entity The element for which the page should be generated
* @param string $type The page type. Currently supported: 'info', 'edit', 'create', 'clone', 'list'/'list_parts'
*
* @return string the link to the desired page
*
@ -157,7 +130,7 @@ class EntityURLGenerator
/**
* Generates an URL to a page, where info about this entity can be viewed.
*
* @param $entity mixed The entity for which the info should be generated
* @param mixed $entity The entity for which the info should be generated
*
* @return string The URL to the info page
*
@ -188,7 +161,7 @@ class EntityURLGenerator
/**
* Generates an URL to a page, where this entity can be edited.
*
* @param $entity mixed The entity for which the edit link should be generated
* @param mixed $entity The entity for which the edit link should be generated
*
* @return string the URL to the edit page
*
@ -217,7 +190,7 @@ class EntityURLGenerator
/**
* Generates an URL to a page, where a entity of this type can be created.
*
* @param $entity mixed The entity for which the link should be generated
* @param mixed $entity The entity for which the link should be generated
*
* @return string the URL to the page
*
@ -247,7 +220,7 @@ class EntityURLGenerator
* Generates an URL to a page, where a new entity can be created, that has the same informations as the
* given entity (element cloning).
*
* @param $entity mixed The entity for which the link should be generated
* @param mixed $entity The entity for which the link should be generated
*
* @return string the URL to the page
*
@ -265,7 +238,7 @@ class EntityURLGenerator
/**
* Generates an URL to a page, where all parts are listed, which are contained in the given element.
*
* @param $entity mixed The entity for which the link should be generated
* @param mixed $entity The entity for which the link should be generated
*
* @return string the URL to the page
*
@ -303,4 +276,34 @@ class EntityURLGenerator
return $this->urlGenerator->generate($this->mapToController($map, $entity), ['id' => $entity->getID()]);
}
/**
* Finds the controller name for the class of the entity using the given map.
* Throws an exception if the entity class is not known to the map.
*
* @param array $map The map that should be used for determing the controller
* @param mixed $entity The entity for which the controller name should be determined
*
* @return string The name of the controller fitting the entity class
*
* @throws EntityNotSupportedException
*/
protected function mapToController(array $map, $entity): string
{
$class = \get_class($entity);
//Check if we have an direct mapping for the given class
if (! \array_key_exists($class, $map)) {
//Check if we need to check inheritance by looping through our map
foreach ($map as $key => $value) {
if (is_a($entity, $key)) {
return $map[$key];
}
}
throw new EntityNotSupportedException(sprintf('The given entity is not supported yet! Passed class type: %s', \get_class($entity)));
}
return $map[$class];
}
}