Automated formatting changes

This commit is contained in:
Formatter Bot 2021-05-28 18:33:49 +00:00
parent 7ac1d67115
commit 13555d5a76

View File

@ -25,82 +25,82 @@ namespace Modules\Purchase\OrderSuggestion;
final class DefaultOrderSuggestion implements OrderSuggestionInterface final class DefaultOrderSuggestion implements OrderSuggestionInterface
{ {
/** /**
* Which data should be used to create the order suggestion? * Which data should be used to create the order suggestion?
* *
* @var int * @var int
* @since 1.0.0 * @since 1.0.0
*/ */
public int $suggestionType = OrderSuggestionType::HISTORIC; public int $suggestionType = OrderSuggestionType::HISTORIC;
/** /**
* Comparison duration type. * Comparison duration type.
* *
* @var int * @var int
* @since 1.0.0 * @since 1.0.0
*/ */
public int $historicComparisonDurationType = OrderSuggestionComparisonDurationType::ANNUAL; public int $historicComparisonDurationType = OrderSuggestionComparisonDurationType::ANNUAL;
/** /**
* How many years should used for the analysis. * How many years should used for the analysis.
* *
* @var int * @var int
* @since 1.0.0 * @since 1.0.0
*/ */
public int $historicComparisonDuration = 1; public int $historicComparisonDuration = 1;
/** /**
* Which averaging method should be used? * Which averaging method should be used?
* *
* @var int * @var int
* @since 1.0.0 * @since 1.0.0
*/ */
public int $historicAveragingMethod = OrderSuggestionAveragingMethod::MEAN; public int $historicAveragingMethod = OrderSuggestionAveragingMethod::MEAN;
/** /**
* What should the focus of the order suggestion be? * What should the focus of the order suggestion be?
* *
* @var int * @var int
* @since 1.0.0 * @since 1.0.0
*/ */
public int $optimizationType = OrderSuggestionOptimizationType::PRICE; public int $optimizationType = OrderSuggestionOptimizationType::PRICE;
/** /**
* How greedy should the algorithm be? * How greedy should the algorithm be?
* *
* The number represents how many items in % can be bought in additon to the optimal stock quantity. * The number represents how many items in % can be bought in additon to the optimal stock quantity.
* *
* Higher means more room for adjustments. * Higher means more room for adjustments.
* *
* @var int * @var int
* @since 1.0.0 * @since 1.0.0
*/ */
public int $optimizationGreediness = 10; public int $optimizationGreediness = 10;
/** /**
* For how many days would you like to have stock? * For how many days would you like to have stock?
* *
* Or in other words, higher means you need to order less often per year. * Or in other words, higher means you need to order less often per year.
* *
* Only relevant if OptimizationType::AVAILABILITY * Only relevant if OptimizationType::AVAILABILITY
* *
* @var int * @var int
* @since 1.0.0 * @since 1.0.0
*/ */
public int $optimizationDays = 0; public int $optimizationDays = 0;
/** /**
* Maximum available budget. * Maximum available budget.
* *
* 0 = infinite budget * 0 = infinite budget
* *
* If a budget is defined and the optimal order is > than the available budget, * If a budget is defined and the optimal order is > than the available budget,
* the algorithm will try to order as many different items as possible. * the algorithm will try to order as many different items as possible.
* *
* If not all items can be ordered will try to order the items with the highest profit. * If not all items can be ordered will try to order the items with the highest profit.
* *
* @var int * @var int
* @since 1.0.0 * @since 1.0.0
*/ */
public int $maxAvailableBudget = 0; public int $maxAvailableBudget = 0;
/** /**
@ -117,4 +117,4 @@ final class DefaultOrderSuggestion implements OrderSuggestionInterface
* avg. profit * avg. profit
* demand in period N * demand in period N
*/ */
} }