Fixed inspection issues.

This commit is contained in:
Jan Böhmer 2020-02-02 14:05:36 +01:00
parent 16497b76c5
commit 96d7e4c9f4
45 changed files with 448 additions and 89 deletions

View file

@ -351,7 +351,10 @@ abstract class Attachment extends AbstractNamedDBElement
/*****************************************************************************************************
* Setters
****************************************************************************************************/
***************************************************************************************************
* @param bool $show_in_table
* @return Attachment
*/
public function setShowInTable(bool $show_in_table): self
{
@ -363,6 +366,7 @@ abstract class Attachment extends AbstractNamedDBElement
/**
* Sets the element that is associated with this attachment.
*
* @param AttachmentContainingDBElement $element
* @return $this
*/
public function setElement(AttachmentContainingDBElement $element): self
@ -391,6 +395,7 @@ abstract class Attachment extends AbstractNamedDBElement
}
/**
* @param AttachmentType $attachement_type
* @return $this
*/
public function setAttachmentType(AttachmentType $attachement_type): self
@ -404,6 +409,7 @@ abstract class Attachment extends AbstractNamedDBElement
* Sets the url associated with this attachment.
* If the url is empty nothing is changed, to not override the file path.
*
* @param string|null $url
* @return Attachment
*/
public function setURL(?string $url): self

View file

@ -25,6 +25,7 @@ namespace App\Entity\Attachments;
use App\Entity\Base\MasterAttachmentTrait;
use App\Entity\Base\AbstractNamedDBElement;
use App\Entity\Contracts\HasAttachmentsInterface;
use App\Entity\Contracts\HasMasterAttachmentInterface;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
@ -33,7 +34,7 @@ use Doctrine\ORM\Mapping as ORM;
/**
* @ORM\MappedSuperclass()
*/
abstract class AttachmentContainingDBElement extends AbstractNamedDBElement implements HasMasterAttachmentInterface
abstract class AttachmentContainingDBElement extends AbstractNamedDBElement implements HasMasterAttachmentInterface, HasAttachmentsInterface
{
use MasterAttachmentTrait;
@ -86,6 +87,7 @@ abstract class AttachmentContainingDBElement extends AbstractNamedDBElement impl
/**
* Removes the given attachment from this element.
*
* @param Attachment $attachment
* @return $this
*/
public function removeAttachment(Attachment $attachment): self

View file

@ -174,7 +174,9 @@ abstract class AbstractCompany extends AbstractPartsContainingDBElement
/**
* Set the addres.
*
* @param string $new_address the new address (with "\n" as line break)
* @param string $new_address the new address (with "\n" as line break)
*
* @return $this
*/
public function setAddress(string $new_address): self
{
@ -187,6 +189,7 @@ abstract class AbstractCompany extends AbstractPartsContainingDBElement
* Set the phone number.
*
* @param string $new_phone_number the new phone number
* @return $this
*/
public function setPhoneNumber(string $new_phone_number): self
{
@ -199,6 +202,7 @@ abstract class AbstractCompany extends AbstractPartsContainingDBElement
* Set the fax number.
*
* @param string $new_fax_number the new fax number
* @return $this
*/
public function setFaxNumber(string $new_fax_number): self
{
@ -211,6 +215,7 @@ abstract class AbstractCompany extends AbstractPartsContainingDBElement
* Set the e-mail address.
*
* @param string $new_email_address the new e-mail address
* @return $this
*/
public function setEmailAddress(string $new_email_address): self
{
@ -223,6 +228,7 @@ abstract class AbstractCompany extends AbstractPartsContainingDBElement
* Set the website.
*
* @param string $new_website the new website
* @return $this
*/
public function setWebsite(string $new_website): self
{
@ -235,6 +241,7 @@ abstract class AbstractCompany extends AbstractPartsContainingDBElement
* Set the link to the website of an article.
*
* @param string $new_url the new URL with the placeholder %PARTNUMBER% for the part number
* @return $this
*/
public function setAutoProductUrl(string $new_url): self
{

View file

@ -328,6 +328,7 @@ abstract class AbstractStructuralDBElement extends AttachmentContainingDBElement
}
/**
* @param bool $not_selectable
* @return AbstractStructuralDBElement
*/
public function setNotSelectable(bool $not_selectable): self

View file

@ -54,9 +54,10 @@ trait MasterAttachmentTrait
/**
* Sets the new master picture for this part.
*
* @param Attachment|null $new_master_attachment
* @return $this
*/
public function setMasterPictureAttachment(?Attachment $new_master_attachment)
public function setMasterPictureAttachment(?Attachment $new_master_attachment): self
{
$this->master_picture_attachment = $new_master_attachment;

View file

@ -169,6 +169,7 @@ abstract class AbstractLogEntry extends AbstractDBElement
/**
* Sets the user that caused the event.
*
* @param User $user
* @return $this
*/
public function setUser(User $user): self
@ -191,6 +192,7 @@ abstract class AbstractLogEntry extends AbstractDBElement
/**
* Sets the timestamp when the event happened.
*
* @param DateTime $timestamp
* @return $this
*/
public function setTimestamp(DateTime $timestamp): self
@ -219,6 +221,7 @@ abstract class AbstractLogEntry extends AbstractDBElement
/**
* Sets the new level of this log entry.
*
* @param int $level
* @return $this
*/
public function setLevel(int $level): self
@ -244,6 +247,7 @@ abstract class AbstractLogEntry extends AbstractDBElement
/**
* Sets the priority level of this log entry as PSR3 compatible string.
*
* @param string $level
* @return $this
*/
public function setLevelString(string $level): self

View file

@ -36,6 +36,7 @@ class ConfigChangedLogEntry extends AbstractLogEntry
public function __construct()
{
parent::__construct();
throw new LogEntryObsoleteException();
}
}

View file

@ -36,6 +36,7 @@ class ExceptionLogEntry extends AbstractLogEntry
public function __construct()
{
parent::__construct();
throw new LogEntryObsoleteException();
}

View file

@ -36,6 +36,7 @@ class UserNotAllowedLogEntry extends AbstractLogEntry
public function __construct()
{
parent::__construct();
//Obsolete, use server log now.
throw new LogEntryObsoleteException();
}

View file

@ -122,6 +122,7 @@ class Category extends AbstractPartsContainingDBElement
}
/**
* @param string $partname_hint
* @return Category
*/
public function setPartnameHint(string $partname_hint): self
@ -137,6 +138,7 @@ class Category extends AbstractPartsContainingDBElement
}
/**
* @param string $partname_regex
* @return Category
*/
public function setPartnameRegex(string $partname_regex): self
@ -152,6 +154,7 @@ class Category extends AbstractPartsContainingDBElement
}
/**
* @param bool $disable_footprints
* @return Category
*/
public function setDisableFootprints(bool $disable_footprints): self
@ -167,6 +170,7 @@ class Category extends AbstractPartsContainingDBElement
}
/**
* @param bool $disable_manufacturers
* @return Category
*/
public function setDisableManufacturers(bool $disable_manufacturers): self
@ -182,6 +186,7 @@ class Category extends AbstractPartsContainingDBElement
}
/**
* @param bool $disable_autodatasheets
* @return Category
*/
public function setDisableAutodatasheets(bool $disable_autodatasheets): self
@ -197,6 +202,7 @@ class Category extends AbstractPartsContainingDBElement
}
/**
* @param bool $disable_properties
* @return Category
*/
public function setDisableProperties(bool $disable_properties): self
@ -212,6 +218,7 @@ class Category extends AbstractPartsContainingDBElement
}
/**
* @param string $default_description
* @return Category
*/
public function setDefaultDescription(string $default_description): self
@ -227,6 +234,7 @@ class Category extends AbstractPartsContainingDBElement
}
/**
* @param string $default_comment
* @return Category
*/
public function setDefaultComment(string $default_comment): self

View file

@ -121,6 +121,7 @@ class MeasurementUnit extends AbstractPartsContainingDBElement
}
/**
* @param bool $isInteger
* @return MeasurementUnit
*/
public function setIsInteger(bool $isInteger): self
@ -136,6 +137,7 @@ class MeasurementUnit extends AbstractPartsContainingDBElement
}
/**
* @param bool $usesSIPrefixes
* @return MeasurementUnit
*/
public function setUseSIPrefix(bool $usesSIPrefixes): self

View file

@ -26,7 +26,6 @@ namespace App\Entity\Parts;
use App\Entity\Base\AbstractDBElement;
use App\Entity\Base\TimestampTrait;
use App\Entity\Parts\PartTraits\InstockTrait;
use App\Validator\Constraints\Selectable;
use App\Validator\Constraints\ValidPartLot;
use DateTime;
@ -143,6 +142,7 @@ class PartLot extends AbstractDBElement
/**
* Sets the description of the part lot.
*
* @param string $description
* @return PartLot
*/
public function setDescription(string $description): self
@ -165,6 +165,7 @@ class PartLot extends AbstractDBElement
/**
* Sets the comment for this part lot.
*
* @param string $comment
* @return PartLot
*/
public function setComment(string $comment): self
@ -211,6 +212,7 @@ class PartLot extends AbstractDBElement
/**
* Sets the storage location, where this part lot is stored.
*
* @param Storelocation|null $storage_location
* @return PartLot
*/
public function setStorageLocation(?Storelocation $storage_location): self
@ -257,6 +259,7 @@ class PartLot extends AbstractDBElement
/**
* Set the unknown instock status of this part lot.
*
* @param bool $instock_unknown
* @return PartLot
*/
public function setInstockUnknown(bool $instock_unknown): self
@ -294,6 +297,7 @@ class PartLot extends AbstractDBElement
}
/**
* @param bool $needs_refill
* @return PartLot
*/
public function setNeedsRefill(bool $needs_refill): self

View file

@ -88,6 +88,7 @@ trait AdvancedPropertyTrait
* Sets a comma separated list of tags, that are assigned to this part.
*
* @param string $tags The new tags
* @return $this
*/
public function setTags(string $tags): self
{
@ -110,6 +111,7 @@ trait AdvancedPropertyTrait
* Sett to null, if the mass is unknown.
*
* @param float|null $mass the new mass
* @return $this
*/
public function setMass(?float $mass): self
{

View file

@ -146,6 +146,7 @@ trait BasicPropertyTrait
* Sets the description of this part.
*
* @param string $new_description the new description
* @return $this
*/
public function setDescription(?string $new_description): self
{
@ -158,6 +159,7 @@ trait BasicPropertyTrait
* Sets the comment property of this part.
*
* @param string $new_comment the new comment
* @return $this
*/
public function setComment(string $new_comment): self
{
@ -171,6 +173,7 @@ trait BasicPropertyTrait
* The category property is required for every part, so you can not pass null like the other properties (footprints).
*
* @param Category $category The new category of this part
* @return $this
*/
public function setCategory(Category $category): self
{
@ -184,6 +187,7 @@ trait BasicPropertyTrait
*
* @param Footprint|null $new_footprint The new footprint of this part. Set to null, if this part should not have
* a footprint.
* @return $this
*/
public function setFootprint(?Footprint $new_footprint): self
{
@ -197,6 +201,7 @@ trait BasicPropertyTrait
*
* @param bool $new_favorite_status The new favorite status, that should be applied on this part.
* Set this to true, when the part should be a favorite.
* @return $this
*/
public function setFavorite(bool $new_favorite_status): self
{

View file

@ -72,6 +72,8 @@ trait InstockTrait
/**
* Adds the given part lot, to the list of part lots.
* The part lot is assigned to this part.
* @param PartLot $lot
* @return $this
*/
public function addPartLot(PartLot $lot): self
{
@ -85,6 +87,7 @@ trait InstockTrait
* Removes the given part lot from the list of part lots.
*
* @param PartLot $lot the part lot that should be deleted
* @return $this
*/
public function removePartLot(PartLot $lot): self
{
@ -105,6 +108,8 @@ trait InstockTrait
/**
* Sets the measurement unit in which the part's amount should be measured.
* Set to null, if the part should be measured in quantities.
* @param MeasurementUnit|null $partUnit
* @return $this
*/
public function setPartUnit(?MeasurementUnit $partUnit): self
{
@ -149,6 +154,7 @@ trait InstockTrait
* Part Lots that have unknown value or are expired, are not used for this value.
*
* @return float The amount of parts given in partUnit
*
*/
public function getAmountSum(): float
{
@ -175,6 +181,7 @@ trait InstockTrait
* See getPartUnit() for the associated unit.
*
* @param float $new_minamount the new count of parts which should be in stock at least
* @return $this
*/
public function setMinAmount(float $new_minamount): self
{

View file

@ -118,6 +118,7 @@ trait ManufacturerTrait
* Sets the manufacturing status for this part
* See getManufacturingStatus() for valid values.
*
* @param string $manufacturing_status
* @return Part
*/
public function setManufacturingStatus(string $manufacturing_status): self
@ -148,6 +149,7 @@ trait ManufacturerTrait
/**
* Sets the manufacturer product number (MPN) for this part.
*
* @param string $manufacturer_product_number
* @return Part
*/
public function setManufacturerProductNumber(string $manufacturer_product_number): self
@ -162,6 +164,7 @@ trait ManufacturerTrait
* Set to "" if this part should use the automatically URL based on its manufacturer.
*
* @param string $new_url The new url
* @return $this
*/
public function setManufacturerProductURL(string $new_url): self
{
@ -175,6 +178,7 @@ trait ManufacturerTrait
*
* @param Manufacturer|null $new_manufacturer The new Manufacturer of this part. Set to null, if this part should
* not have a manufacturer.
* @return $this
*/
public function setManufacturer(?Manufacturer $new_manufacturer): self
{

View file

@ -144,6 +144,7 @@ class Storelocation extends AbstractPartsContainingDBElement
}
/**
* @param bool $only_single_part
* @return Storelocation
*/
public function setOnlySinglePart(bool $only_single_part): self
@ -164,6 +165,7 @@ class Storelocation extends AbstractPartsContainingDBElement
}
/**
* @param bool $limit_to_existing_parts
* @return Storelocation
*/
public function setLimitToExistingParts(bool $limit_to_existing_parts): self
@ -182,6 +184,7 @@ class Storelocation extends AbstractPartsContainingDBElement
}
/**
* @param MeasurementUnit|null $storage_type
* @return Storelocation
*/
public function setStorageType(?MeasurementUnit $storage_type): self

View file

@ -126,6 +126,7 @@ class Supplier extends AbstractCompany
/**
* Sets the default currency.
*
* @param Currency|null $default_currency
* @return Supplier
*/
public function setDefaultCurrency(?Currency $default_currency): self

View file

@ -228,6 +228,7 @@ class Orderdetail extends AbstractDBElement
/**
* Removes an pricedetail from this orderdetail.
*
* @param Pricedetail $pricedetail
* @return Orderdetail
*/
public function removePricedetail(Pricedetail $pricedetail): self
@ -275,6 +276,7 @@ class Orderdetail extends AbstractDBElement
/**
* Sets a new part with which this orderdetail is associated.
*
* @param Part $part
* @return Orderdetail
*/
public function setPart(Part $part): self
@ -287,6 +289,7 @@ class Orderdetail extends AbstractDBElement
/**
* Sets the new supplier associated with this orderdetail.
*
* @param Supplier $new_supplier
* @return Orderdetail
*/
public function setSupplier(Supplier $new_supplier): self

View file

@ -230,6 +230,7 @@ class Pricedetail extends AbstractDBElement
/**
* Sets the orderdetail to which this pricedetail belongs to.
*
* @param Orderdetail $orderdetail
* @return $this
*/
public function setOrderdetail(Orderdetail $orderdetail): self
@ -243,6 +244,7 @@ class Pricedetail extends AbstractDBElement
* Sets the currency associated with the price informations.
* Set to null, to use the global base currency.
*
* @param Currency|null $currency
* @return Pricedetail
*/
public function setCurrency(?Currency $currency): self
@ -260,6 +262,7 @@ class Pricedetail extends AbstractDBElement
* * This is the price for "price_related_quantity" parts!!
* * Example: if "price_related_quantity" is '10',
* you have to set here the price for 10 parts!
* @return $this
*/
public function setPrice(string $new_price): self
{
@ -306,6 +309,7 @@ class Pricedetail extends AbstractDBElement
* So the orderdetails would have three Pricedetails for one supplier.)
*
* @param float $new_min_discount_quantity the minimum discount quantity
* @return $this
*/
public function setMinDiscountQuantity(float $new_min_discount_quantity): self
{

View file

@ -26,7 +26,6 @@ namespace App\Entity\UserSystem;
use App\Entity\Base\TimestampTrait;
use Doctrine\ORM\Mapping as ORM;
use R\U2FTwoFactorBundle\Model\U2F\TwoFactorInterface;
use R\U2FTwoFactorBundle\Model\U2F\TwoFactorKeyInterface;
use u2flib_server\Registration;
@ -176,6 +175,7 @@ class U2FKey implements TwoFactorKeyInterface
/**
* Sets the user this U2F key belongs to.
*
* @param User $new_user
* @return $this
*/
public function setUser(User $new_user): self

View file

@ -87,7 +87,7 @@ use Symfony\Component\Validator\Constraints as Assert;
*/
class User extends AttachmentContainingDBElement implements UserInterface, HasPermissionsInterface, TwoFactorInterface, BackupCodeInterface, TrustedDeviceInterface, U2FTwoFactorInterface, PreferredProviderInterface
{
use MasterAttachmentTrait;
//use MasterAttachmentTrait;
/**
* The User id of the anonymous user.
@ -339,6 +339,7 @@ class User extends AttachmentContainingDBElement implements UserInterface, HasPe
/**
* Sets the password hash for this user.
*
* @param string $password
* @return User
*/
public function setPassword(string $password): self
@ -378,6 +379,7 @@ class User extends AttachmentContainingDBElement implements UserInterface, HasPe
/**
* Sets the currency the users prefers to see prices in.
*
* @param Currency|null $currency
* @return User
*/
public function setCurrency(?Currency $currency): self
@ -440,6 +442,7 @@ class User extends AttachmentContainingDBElement implements UserInterface, HasPe
/**
* Set the status, if the user needs a password change.
*
* @param bool $need_pw_change
* @return User
*/
public function setNeedPwChange(bool $need_pw_change): self
@ -462,6 +465,7 @@ class User extends AttachmentContainingDBElement implements UserInterface, HasPe
/**
* Sets the encrypted password reset token.
*
* @param string|null $pw_reset_token
* @return User
*/
public function setPwResetToken(?string $pw_reset_token): self
@ -484,6 +488,7 @@ class User extends AttachmentContainingDBElement implements UserInterface, HasPe
/**
* Sets the datetime when the password reset token expires.
*
* @param DateTime $pw_reset_expires
* @return User
*/
public function setPwResetExpires(DateTime $pw_reset_expires): self
@ -667,6 +672,7 @@ class User extends AttachmentContainingDBElement implements UserInterface, HasPe
/**
* Change the timezone of this user.
*
* @param string|null $timezone
* @return $this
*/
public function setTimezone(?string $timezone): self
@ -759,6 +765,7 @@ class User extends AttachmentContainingDBElement implements UserInterface, HasPe
/**
* Sets the secret used for Google Authenticator. Set to null to disable Google Authenticator.
*
* @param string|null $googleAuthenticatorSecret
* @return $this
*/
public function setGoogleAuthenticatorSecret(?string $googleAuthenticatorSecret): self
@ -875,6 +882,7 @@ class User extends AttachmentContainingDBElement implements UserInterface, HasPe
/**
* Add a U2F key to this user.
* @param TwoFactorKeyInterface $key
*/
public function addU2FKey(TwoFactorKeyInterface $key): void
{
@ -883,6 +891,7 @@ class User extends AttachmentContainingDBElement implements UserInterface, HasPe
/**
* Remove a U2F key from this user.
* @param TwoFactorKeyInterface $key
*/
public function removeU2FKey(TwoFactorKeyInterface $key): void
{