uruba / FinanCalc

src/Calculators/AnnuityCalculator.php

Doc Comments +1 added lines, -1 removed lines

@@ -143,7 +143,7 @@
         }
 
         /**
-         * @return mixed
+         * @return string
          */
         public function getAnnuityPeriodLengthInDays() {
             return $this->annuityPeriodLength->toDays();

Indentation +3 added lines, -3 removed lines

@@ -60,9 +60,9 @@
          * @param $annuityInterest
          */
         function __construct($annuitySinglePaymentAmount,
-                             $annuityNoOfCompoundingPeriods,
-                             TimeSpan $annuityPeriodLength,
-                             $annuityInterest) {
+                                $annuityNoOfCompoundingPeriods,
+                                TimeSpan $annuityPeriodLength,
+                                $annuityInterest) {
             $this->setAnnuitySinglePaymentAmount($annuitySinglePaymentAmount);
             $this->setAnnuityNoOfCompoundingPeriods($annuityNoOfCompoundingPeriods);
             $this->setAnnuityPeriodLength($annuityPeriodLength);

src/Calculators/BondFairValueCalculator.php

Doc Comments +1 added lines, -1 removed lines

@@ -73,7 +73,7 @@
         }
 
         /**
-         * @return float
+         * @return string
          */
         public function getBondFairValue() {
             // we need to get the coupon rate per payment period = c/payment frequency

Indentation +4 added lines, -4 removed lines

@@ -47,10 +47,10 @@
          * @param $bondPaymentFrequency
          */
         function __construct($bondFaceValue,
-                             $bondAnnualCouponRate,
-                             $bondVIR,
-                             $bondYearsToMaturity,
-                             $bondPaymentFrequency = 1) {
+                                $bondAnnualCouponRate,
+                                $bondVIR,
+                                $bondYearsToMaturity,
+                                $bondPaymentFrequency = 1) {
             $this->setBondFaceValue($bondFaceValue);
             $this->setBondAnnualCouponRate($bondAnnualCouponRate);
             $this->setBondVIR($bondVIR);

src/Constants/ErrorMessages.php

Doc Comments +5 added lines, -5 removed lines

@@ -12,7 +12,7 @@ 
     {
         /**
          * @param $expectedTypeName [Name of the expected class as a string]
-         * @param $foundTypeName    [Name of the class that was used instead]
+         * @param string $foundTypeName    [Name of the class that was used instead]
          * @return string           [Concatenated message as a string]
          */
         static function getIncompatibleTypesMessage($expectedTypeName, $foundTypeName) {
@@ -63,7 +63,7 @@ 
 
         /**
          * @param $propertyName [Name of the property as a string]
-         * @param $className    [Name of the class as a string]
+         * @param string $className    [Name of the class as a string]
          * @return string       [Concatenated message as a string]
          */
         static function getNonExistentPropertyMessage($propertyName, $className) {
@@ -103,7 +103,7 @@ 
 
         /**
          * @param $factoryClassName         [Name of the factory class as a string]
-         * @param $factoryClassAncestorName [Name of the factory class' expected parent class name as a string]
+         * @param string $factoryClassAncestorName [Name of the factory class' expected parent class name as a string]
          * @return string                   [Concatenated message as a string]
          */
         static function getFactoryClassExpectedAncestorMessage($factoryClassName, $factoryClassAncestorName) {
@@ -163,8 +163,8 @@ 
         }
 
         /**
-         * @param $methodName [Name of the method]
-         * @param $className  [Name of the class]
+         * @param string $methodName [Name of the method]
+         * @param string $className  [Name of the class]
          * @return string     [Concatenated message as a string]
          */
         static function getMethodDoesNotExistMessage($methodName, $className) {

src/Interfaces/Calculator/CalculatorAbstract.php

Doc Comments +2 added lines, -2 removed lines

@@ -14,9 +14,9 @@
         protected $propResultArray = null;
 
         /**
-         * @param $name
+         * @param string $name
          * @param $value
-         * @param null $callbackBefore
+         * @param \Closure $callbackBefore
          * @throws Exception
          */
         protected final function setProperty($name, $value, $callbackBefore = null) {

src/Utils/Config.php

Doc Comments +1 added lines, -1 removed lines

@@ -31,7 +31,7 @@
         }
 
         /**
-         * @param $key
+         * @param string $key
          * @return mixed
          * @throws Exception
          */

src/Utils/Enum.php

Doc Comments +2 added lines, -2 removed lines

@@ -16,7 +16,7 @@ 
         /**
          * Return string representation of this enum
          *
-         * @return string
+         * @return integer
          */
         public function getValue()
         {
@@ -71,7 +71,7 @@ 
          * </code>
          *
          * @param string $property
-         * @return string
+         * @return integer
          */
         function __get($property)
         {

src/Utils/Helpers.php

Doc Comments +4 added lines, -4 removed lines

@@ -28,7 +28,7 @@ 
         /**
          * @param $leftOperand
          * @param $rightOperand
-         * @param $messageOnException
+         * @param string $messageOnException
          * @return bool
          */
         static function checkIfLeftOperandGreaterOrThrowAnException($leftOperand, $rightOperand, $messageOnException) {
@@ -64,7 +64,7 @@ 
         }
 
         /**
-         * @param $checkedVariable
+         * @param null|\FinanCalc\Constants\AnnuityPaymentTypes $checkedVariable
          * @return bool
          */
         static function checkIfNotNull($checkedVariable) {
@@ -105,7 +105,7 @@ 
 
         /**
          * @param $checkedVariable
-         * @param $expectedResult
+         * @param integer $expectedResult
          * @return bool|null
          */
         static function checkNumberRelativityToZero($checkedVariable, $expectedResult) {
@@ -117,7 +117,7 @@ 
         }
 
         /**
-         * @param $inputValue
+         * @param string $inputValue
          * @return string
          */
         static function roundMoneyForDisplay($inputValue) {

src/Utils/Strings.php

Doc Comments +1 added lines, -1 removed lines

@@ -44,7 +44,7 @@
         }
 
         /**
-         * @param $identifier
+         * @param string $identifier
          * @param $locale
          * @param null $formatArgs
          * @return string

Indentation +5 added lines, -5 removed lines

@@ -1,10 +1,10 @@
 <?php
 /**
- * Created by PhpStorm.
- * User: uruba
- * Date: 2/15/2016
- * Time: 2:54 PM
- */
+     * Created by PhpStorm.
+     * User: uruba
+     * Date: 2/15/2016
+     * Time: 2:54 PM
+     */
 
 namespace FinanCalc\Utils {
 

src/FinanCalc.php

Indentation +27 added lines, -27 removed lines

@@ -1,32 +1,32 @@
 <?php
 /**
- * FinanCalc
- *
- * A lightweight, simple and easy PHP library for calculating annuities (e.g., mortgages)
- * and other financial instruments according to various input data
- *
- *
- * DISCLAIMER
- * You are free to use/modify/extend the library as you please - for it to serve your purpose.
- * As per the (un)license, the software is provided as is and the original author cannot be held liable
- * for any losses/damages directly or indirectly resulting from using thereof.
- * Attribution is welcome, but certainly not required.
- *
- * NOTE
- * The library is currently work-in-progress and it is certain that new features will be added in the process.
- * Consider this, therefore, as a preview product prone to abrupt and extensive changes that may affect functionality
- * of an external code adapted to a prior version(s) of the library.
- * Always explore the provisional compatibility of the library with your project in case you upgrade to a new version
- * of the library (by means of an extensive testing of the code in which you are exerting the library's features).
- *
- * PREREQUISITES
- * PHP 5.5+
- * Module php-bcmath
- *
- * @author Václav Uruba
- * @version 0.3
- * @license http://unlicense.org The Unlicense
- */
+     * FinanCalc
+     *
+     * A lightweight, simple and easy PHP library for calculating annuities (e.g., mortgages)
+     * and other financial instruments according to various input data
+     *
+     *
+     * DISCLAIMER
+     * You are free to use/modify/extend the library as you please - for it to serve your purpose.
+     * As per the (un)license, the software is provided as is and the original author cannot be held liable
+     * for any losses/damages directly or indirectly resulting from using thereof.
+     * Attribution is welcome, but certainly not required.
+     *
+     * NOTE
+     * The library is currently work-in-progress and it is certain that new features will be added in the process.
+     * Consider this, therefore, as a preview product prone to abrupt and extensive changes that may affect functionality
+     * of an external code adapted to a prior version(s) of the library.
+     * Always explore the provisional compatibility of the library with your project in case you upgrade to a new version
+     * of the library (by means of an extensive testing of the code in which you are exerting the library's features).
+     *
+     * PREREQUISITES
+     * PHP 5.5+
+     * Module php-bcmath
+     *
+     * @author Václav Uruba
+     * @version 0.3
+     * @license http://unlicense.org The Unlicense
+     */
 namespace FinanCalc {
     use Exception;
     use FinanCalc\Constants\ErrorMessages;