Add return type

sop · sop · commit 751a02d28338 · 2019-05-07T13:45:32.000+03:00
diff --git a/lib/CryptoTypes/AlgorithmIdentifier/Asymmetric/ECPublicKeyAlgorithmIdentifier.php b/lib/CryptoTypes/AlgorithmIdentifier/Asymmetric/ECPublicKeyAlgorithmIdentifier.php
@@ -270,8 +270,11 @@ public function name(): string
 
     /**
      * {@inheritdoc}
+     *
+     * @return self
      */
-    public static function fromASN1Params(?UnspecifiedType $params = null)
+    public static function fromASN1Params(
+        ?UnspecifiedType $params = null): SpecificAlgorithmIdentifier
     {
         if (!isset($params)) {
             throw new \UnexpectedValueException('No parameters.');
diff --git a/lib/CryptoTypes/AlgorithmIdentifier/Asymmetric/RSAEncryptionAlgorithmIdentifier.php b/lib/CryptoTypes/AlgorithmIdentifier/Asymmetric/RSAEncryptionAlgorithmIdentifier.php
@@ -43,8 +43,11 @@ public function name(): string
 
     /**
      * {@inheritdoc}
+     *
+     * @return self
      */
-    public static function fromASN1Params(?UnspecifiedType $params = null)
+    public static function fromASN1Params(
+        ?UnspecifiedType $params = null): SpecificAlgorithmIdentifier
     {
         if (!isset($params)) {
             throw new \UnexpectedValueException('No parameters.');
diff --git a/lib/CryptoTypes/AlgorithmIdentifier/Cipher/AESCBCAlgorithmIdentifier.php b/lib/CryptoTypes/AlgorithmIdentifier/Cipher/AESCBCAlgorithmIdentifier.php
@@ -7,6 +7,7 @@
 use Sop\ASN1\Element;
 use Sop\ASN1\Type\Primitive\OctetString;
 use Sop\ASN1\Type\UnspecifiedType;
+use Sop\CryptoTypes\AlgorithmIdentifier\SpecificAlgorithmIdentifier;
 
 /*
 From RFC 3565 - 4.1. AES Algorithm Identifiers and Parameters:
@@ -36,13 +37,12 @@ public function __construct(?string $iv = null)
     }
 
     /**
-     * @param UnspecifiedType $params
-     *
-     * @throws \UnexpectedValueException If parameters are invalid
+     * {@inheritdoc}
      *
      * @return self
      */
-    public static function fromASN1Params(?UnspecifiedType $params = null)
+    public static function fromASN1Params(
+        ?UnspecifiedType $params = null): SpecificAlgorithmIdentifier
     {
         if (!isset($params)) {
             throw new \UnexpectedValueException('No parameters.');
diff --git a/lib/CryptoTypes/AlgorithmIdentifier/Cipher/DESCBCAlgorithmIdentifier.php b/lib/CryptoTypes/AlgorithmIdentifier/Cipher/DESCBCAlgorithmIdentifier.php
@@ -7,6 +7,7 @@
 use Sop\ASN1\Element;
 use Sop\ASN1\Type\Primitive\OctetString;
 use Sop\ASN1\Type\UnspecifiedType;
+use Sop\CryptoTypes\AlgorithmIdentifier\SpecificAlgorithmIdentifier;
 
 /*
 RFC 2898 defines parameters as follows:
@@ -45,8 +46,11 @@ public function name(): string
 
     /**
      * {@inheritdoc}
+     *
+     * @return self
      */
-    public static function fromASN1Params(?UnspecifiedType $params = null)
+    public static function fromASN1Params(
+        ?UnspecifiedType $params = null): SpecificAlgorithmIdentifier
     {
         if (!isset($params)) {
             throw new \UnexpectedValueException('No parameters.');
diff --git a/lib/CryptoTypes/AlgorithmIdentifier/Cipher/DESEDE3CBCAlgorithmIdentifier.php b/lib/CryptoTypes/AlgorithmIdentifier/Cipher/DESEDE3CBCAlgorithmIdentifier.php
@@ -7,6 +7,7 @@
 use Sop\ASN1\Element;
 use Sop\ASN1\Type\Primitive\OctetString;
 use Sop\ASN1\Type\UnspecifiedType;
+use Sop\CryptoTypes\AlgorithmIdentifier\SpecificAlgorithmIdentifier;
 
 /*
 RFC 2898 defines parameters as follows:
@@ -46,8 +47,11 @@ public function name(): string
 
     /**
      * {@inheritdoc}
+     *
+     * @return self
      */
-    public static function fromASN1Params(?UnspecifiedType $params = null)
+    public static function fromASN1Params(
+        ?UnspecifiedType $params = null): SpecificAlgorithmIdentifier
     {
         if (!isset($params)) {
             throw new \UnexpectedValueException('No parameters.');
diff --git a/lib/CryptoTypes/AlgorithmIdentifier/Cipher/RC2CBCAlgorithmIdentifier.php b/lib/CryptoTypes/AlgorithmIdentifier/Cipher/RC2CBCAlgorithmIdentifier.php
@@ -9,6 +9,7 @@
 use Sop\ASN1\Type\Primitive\Integer;
 use Sop\ASN1\Type\Primitive\OctetString;
 use Sop\ASN1\Type\UnspecifiedType;
+use Sop\CryptoTypes\AlgorithmIdentifier\SpecificAlgorithmIdentifier;
 
 /*
 Parameters may be seen in various forms. This implementation attemts
@@ -107,8 +108,11 @@ public function name(): string
 
     /**
      * {@inheritdoc}
+     *
+     * @return self
      */
-    public static function fromASN1Params(?UnspecifiedType $params = null)
+    public static function fromASN1Params(
+        ?UnspecifiedType $params = null): SpecificAlgorithmIdentifier
     {
         if (!isset($params)) {
             throw new \UnexpectedValueException('No parameters.');
diff --git a/lib/CryptoTypes/AlgorithmIdentifier/Hash/HMACWithSHA1AlgorithmIdentifier.php b/lib/CryptoTypes/AlgorithmIdentifier/Hash/HMACWithSHA1AlgorithmIdentifier.php
@@ -44,8 +44,11 @@ public function name(): string
 
     /**
      * {@inheritdoc}
+     *
+     * @return self
      */
-    public static function fromASN1Params(?UnspecifiedType $params = null)
+    public static function fromASN1Params(
+        ?UnspecifiedType $params = null): SpecificAlgorithmIdentifier
     {
         if (isset($params)) {
             throw new \UnexpectedValueException('Parameters must be omitted.');
diff --git a/lib/CryptoTypes/AlgorithmIdentifier/Hash/MD5AlgorithmIdentifier.php b/lib/CryptoTypes/AlgorithmIdentifier/Hash/MD5AlgorithmIdentifier.php
@@ -59,8 +59,11 @@ public function name(): string
 
     /**
      * {@inheritdoc}
+     *
+     * @return self
      */
-    public static function fromASN1Params(?UnspecifiedType $params = null)
+    public static function fromASN1Params(
+        ?UnspecifiedType $params = null): SpecificAlgorithmIdentifier
     {
         $obj = new static();
         // if parameters field is present, it must be null type
diff --git a/lib/CryptoTypes/AlgorithmIdentifier/Hash/RFC4231HMACAlgorithmIdentifier.php b/lib/CryptoTypes/AlgorithmIdentifier/Hash/RFC4231HMACAlgorithmIdentifier.php
@@ -26,8 +26,11 @@ abstract class RFC4231HMACAlgorithmIdentifier extends SpecificAlgorithmIdentifie
 
     /**
      * {@inheritdoc}
+     *
+     * @return self
      */
-    public static function fromASN1Params(?UnspecifiedType $params = null)
+    public static function fromASN1Params(
+        ?UnspecifiedType $params = null): SpecificAlgorithmIdentifier
     {
         /*
          * RFC 4231 states that the "parameter" component SHOULD be present
diff --git a/lib/CryptoTypes/AlgorithmIdentifier/Hash/SHA1AlgorithmIdentifier.php b/lib/CryptoTypes/AlgorithmIdentifier/Hash/SHA1AlgorithmIdentifier.php
@@ -54,8 +54,11 @@ public function name(): string
 
     /**
      * {@inheritdoc}
+     *
+     * @return self
      */
-    public static function fromASN1Params(?UnspecifiedType $params = null)
+    public static function fromASN1Params(
+        ?UnspecifiedType $params = null): SpecificAlgorithmIdentifier
     {
         $obj = new static();
         // if parameters field is present, it must be null type
diff --git a/lib/CryptoTypes/AlgorithmIdentifier/Hash/SHA2AlgorithmIdentifier.php b/lib/CryptoTypes/AlgorithmIdentifier/Hash/SHA2AlgorithmIdentifier.php
@@ -44,8 +44,11 @@ public function __construct()
 
     /**
      * {@inheritdoc}
+     *
+     * @return self
      */
-    public static function fromASN1Params(?UnspecifiedType $params = null)
+    public static function fromASN1Params(
+        ?UnspecifiedType $params = null): SpecificAlgorithmIdentifier
     {
         $obj = new static();
         // if parameters field is present, it must be null type
diff --git a/lib/CryptoTypes/AlgorithmIdentifier/Signature/ECSignatureAlgorithmIdentifier.php b/lib/CryptoTypes/AlgorithmIdentifier/Signature/ECSignatureAlgorithmIdentifier.php
@@ -29,8 +29,11 @@ abstract class ECSignatureAlgorithmIdentifier extends SpecificAlgorithmIdentifie
 {
     /**
      * {@inheritdoc}
+     *
+     * @return self
      */
-    public static function fromASN1Params(?UnspecifiedType $params = null)
+    public static function fromASN1Params(
+        ?UnspecifiedType $params = null): SpecificAlgorithmIdentifier
     {
         if (isset($params)) {
             throw new \UnexpectedValueException('Parameters must be omitted.');
diff --git a/lib/CryptoTypes/AlgorithmIdentifier/Signature/RFC3279RSASignatureAlgorithmIdentifier.php b/lib/CryptoTypes/AlgorithmIdentifier/Signature/RFC3279RSASignatureAlgorithmIdentifier.php
@@ -7,6 +7,7 @@
 use Sop\ASN1\Element;
 use Sop\ASN1\Type\Primitive\NullType;
 use Sop\ASN1\Type\UnspecifiedType;
+use Sop\CryptoTypes\AlgorithmIdentifier\SpecificAlgorithmIdentifier;
 
 /*
 From RFC 3279 - 2.2.1  RSA Signature Algorithm:
@@ -25,8 +26,11 @@ abstract class RFC3279RSASignatureAlgorithmIdentifier extends RSASignatureAlgori
 {
     /**
      * {@inheritdoc}
+     *
+     * @return self
      */
-    public static function fromASN1Params(?UnspecifiedType $params = null)
+    public static function fromASN1Params(
+        ?UnspecifiedType $params = null): SpecificAlgorithmIdentifier
     {
         if (!isset($params)) {
             throw new \UnexpectedValueException('No parameters.');
diff --git a/lib/CryptoTypes/AlgorithmIdentifier/Signature/RFC4055RSASignatureAlgorithmIdentifier.php b/lib/CryptoTypes/AlgorithmIdentifier/Signature/RFC4055RSASignatureAlgorithmIdentifier.php
@@ -7,6 +7,7 @@
 use Sop\ASN1\Element;
 use Sop\ASN1\Type\Primitive\NullType;
 use Sop\ASN1\Type\UnspecifiedType;
+use Sop\CryptoTypes\AlgorithmIdentifier\SpecificAlgorithmIdentifier;
 
 /*
 From RFC 4055 - 5.  PKCS #1 Version 1.5 Signature Algorithm
@@ -40,8 +41,11 @@ public function __construct()
 
     /**
      * {@inheritdoc}
+     *
+     * @return self
      */
-    public static function fromASN1Params(?UnspecifiedType $params = null)
+    public static function fromASN1Params(
+        ?UnspecifiedType $params = null): SpecificAlgorithmIdentifier
     {
         $obj = new static();
         // store parameters so re-encoding doesn't change
diff --git a/lib/CryptoTypes/AlgorithmIdentifier/SpecificAlgorithmIdentifier.php b/lib/CryptoTypes/AlgorithmIdentifier/SpecificAlgorithmIdentifier.php
@@ -16,12 +16,15 @@ abstract class SpecificAlgorithmIdentifier extends AlgorithmIdentifier
      * Initialize object from algorithm identifier parameters.
      *
      * @todo return typing
-     * 
+     *
      * @param null|UnspecifiedType $params Parameters or null if none
      *
+     * @throws \UnexpectedValueException If parameters are invalid for the algorithm
+     *
      * @return self
      */
-    public static function fromASN1Params(?UnspecifiedType $params = null)
+    public static function fromASN1Params(
+        ?UnspecifiedType $params = null): SpecificAlgorithmIdentifier
     {
         throw new \BadMethodCallException(
             __FUNCTION__ . ' must be implemented in derived class.');
diff --git a/test/unit/algo-id/AIFactoryTest.php b/test/unit/algo-id/AIFactoryTest.php
@@ -51,7 +51,8 @@ public function getClassByOID(string $oid): string
 
 class AIFactoryTest_CustomAlgo extends SpecificAlgorithmIdentifier
 {
-    public static function fromASN1Params(?UnspecifiedType $params = null)
+    public static function fromASN1Params(
+        ?UnspecifiedType $params = null): SpecificAlgorithmIdentifier
     {
         return new self();
     }
