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();

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

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)
         {

Braces +8 added lines, -5 removed lines

@@ -31,10 +31,11 @@ 
          */
         public function setValue($value)
         {
-            if ($this->isValidEnumValue($value))
-                $this->value = $value;
-            else
-                throw new Exception(ErrorMessages::getInvalidTypeMessage());
+            if ($this->isValidEnumValue($value)) {
+                            $this->value = $value;
+            } else {
+                            throw new Exception(ErrorMessages::getInvalidTypeMessage());
+            }
         }
 
         /**
@@ -48,7 +49,9 @@ 
             $reflector = new \ReflectionClass(get_class($this));
             foreach ($reflector->getConstants() as $validValue)
             {
-                if ($validValue == $checkValue) return true;
+                if ($validValue == $checkValue) {
+                    return true;
+                }
             }
             return false;
         }

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

src/FinanCalc.php

Braces +5 added lines, -4 removed lines

@@ -94,10 +94,11 @@
          * @throws Exception
          */
         public function getFactory($factoryClassName) {
-            if (array_key_exists($factoryClassName, $this->factoryClasses))
-                return $this->factoryClasses[$factoryClassName];
-            else
-                throw new Exception(ErrorMessages::getFactoryClassNotInitializedMessage($factoryClassName));
+            if (array_key_exists($factoryClassName, $this->factoryClasses)) {
+                            return $this->factoryClasses[$factoryClassName];
+            } else {
+                            throw new Exception(ErrorMessages::getFactoryClassNotInitializedMessage($factoryClassName));
+            }
         }
 
         /**