hiqdev / hipanel-module-finance

src/cart/AbstractPurchase.php

Doc Comments +1 added lines, -1 removed lines

@@ -74,7 +74,7 @@
      * Executes the purchase.
      * Calls proper API commands to purchase the product.
      * @throws ErrorPurchaseException in case of failed purchase
-     * @return true if the item was purchased successfully
+     * @return boolean if the item was purchased successfully
      */
     public function execute()
     {

src/controllers/PurseController.php

Doc Comments +3 added lines

@@ -68,6 +68,9 @@
         return $this->generateDocument('generate-document', compact('id', 'type'));
     }
 
+    /**
+     * @param string $action
+     */
     public function generateDocument($action, $params)
     {
         try {

src/forms/CertificateTariffForm.php

Doc Comments +1 added lines, -1 removed lines

@@ -40,7 +40,7 @@
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getPeriods()
     {

src/models/Purse.php

Doc Comments +3 added lines

@@ -89,6 +89,9 @@
         return $this->getDocumentsOfType('acceptance');
     }
 
+    /**
+     * @param string $type
+     */
     public function getDocumentsOfType($type)
     {
         if (Yii::$app->user->can('document.read') === false) {

src/models/query/PlanQuery.php

Doc Comments +3 added lines

@@ -15,6 +15,9 @@
 
 class PlanQuery extends \hiqdev\hiart\ActiveQuery
 {
+    /**
+     * @param integer $id
+     */
     public function byId($id)
     {
         return $this->andWhere(['id' => $id]);

src/providers/FormulaExamplesProvider.php

Doc Comments +3 added lines

@@ -47,6 +47,9 @@
         ];
     }
 
+    /**
+     * @param string $name
+     */
     private function groupOf($name, $formulas)
     {
         return ['name' => $name, 'formulas' => $formulas];

src/models/CertificatePrice.php

Doc Comments +4 added lines, -1 removed lines

@@ -119,7 +119,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getPeriods()
     {
@@ -153,6 +153,9 @@ 
         return $this->moneyFormatter->format($this->getMoneyForPeriod($period));
     }
 
+    /**
+     * @return Money
+     */
     public function getMoneyForPeriod(int $period): ?Money
     {
         if (!$this->hasPriceForPeriod($period)) {

src/cart/AbstractCartPosition.php

Doc Comments +2 added lines, -2 removed lines

@@ -86,7 +86,7 @@ 
      *
      * The $price will be casted to double
      *
-     * @param mixed $price
+     * @param string $price
      */
     public function setPrice($price)
     {
@@ -169,7 +169,7 @@ 
      *
      * The $value will be casted to double
      *
-     * @param mixed $value
+     * @param string $value
      */
     public function setValue($value)
     {

src/grid/BillGridView.php

Doc Comments +3 added lines

@@ -220,6 +220,9 @@
         return $canSeeLink ? Html::a($model->tariff, ['@plan/view', 'id' => $model->tariff_id]) : $model->tariff;
     }
 
+    /**
+     * @param Bill $model
+     */
     public function objectTag($model): string
     {
         return $model->object ? implode(': ', [Yii::t('hipanel', $model->class_label), $this->objectLink($model)]) : '';