minor #32317 [Mime] Updated some PHPDoc contents (javiereguiluz)

fabpot · fabpot · commit e0e476da7196 · 2019-07-03T14:35:36.000+02:00
This PR was squashed before being merged into the 4.4 branch (closes #32317). Discussion ---------- [Mime] Updated some PHPDoc contents | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | no  | BC breaks? | no  | Deprecations? | no  | Tests pass? | yes  | Fixed tickets | - | License | MIT | Doc PR | not needed While documenting #30981 I found some PHPDoc info not clear enough. This "improves" it, but if you don't like it, it's OK to close this. Thanks. Commits ------- 9432f1f [Mime] Updated some PHPDoc contents
diff --git a/src/Symfony/Component/Mime/Crypto/SMimeEncrypter.php b/src/Symfony/Component/Mime/Crypto/SMimeEncrypter.php
@@ -23,7 +23,8 @@ final class SMimeEncrypter extends SMime
     private $cipher;
 
     /**
-     * @param string|string[] $certificate Either a lone X.509 certificate, or an array of X.509 certificates
+     * @param string|string[] $certificate The path (or array of paths) of the file(s) containing the X.509 certificate(s)
+     * @param int             $cipher      A set of algorithms used to encrypt the message. Must be one of these PHP constants: https://www.php.net/manual/en/openssl.ciphers.php
      */
     public function __construct($certificate, int $cipher = OPENSSL_CIPHER_AES_256_CBC)
     {
diff --git a/src/Symfony/Component/Mime/Crypto/SMimeSigner.php b/src/Symfony/Component/Mime/Crypto/SMimeSigner.php
@@ -30,13 +30,11 @@ final class SMimeSigner extends SMime
     private $privateKeyPassphrase;
 
     /**
-     * @see https://secure.php.net/manual/en/openssl.pkcs7.flags.php
-     *
-     * @param string      $certificate
-     * @param string      $privateKey           A file containing the private key (in PEM format)
+     * @param string      $certificate          The path of the file containing the signing certificate (in PEM format)
+     * @param string      $privateKey           The path of the file containing the private key (in PEM format)
      * @param string|null $privateKeyPassphrase A passphrase of the private key (if any)
-     * @param string      $extraCerts           A file containing intermediate certificates (in PEM format) needed by the signing certificate
-     * @param int         $signOptions          Bitwise operator options for openssl_pkcs7_sign()
+     * @param string|null $extraCerts           The path of the file containing intermediate certificates (in PEM format) needed by the signing certificate
+     * @param int         $signOptions          Bitwise operator options for openssl_pkcs7_sign() (@see https://secure.php.net/manual/en/openssl.pkcs7.flags.php)
      */
     public function __construct(string $certificate, string $privateKey, ?string $privateKeyPassphrase = null, ?string $extraCerts = null, int $signOptions = PKCS7_DETACHED)
     {

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,8 @@ final class SMimeEncrypter extends SMime`
`23`	`23`	`private $cipher;`
`24`	`24`
`25`	`25`	`/**`
`26`		`- * @param string\|string[] $certificate Either a lone X.509 certificate, or an array of X.509 certificates`
	`26`	`+ * @param string\|string[] $certificate The path (or array of paths) of the file(s) containing the X.509 certificate(s)`
	`27`	`+ * @param int $cipher A set of algorithms used to encrypt the message. Must be one of these PHP constants: https://www.php.net/manual/en/openssl.ciphers.php`
`27`	`28`	`*/`
`28`	`29`	`public function __construct($certificate, int $cipher = OPENSSL_CIPHER_AES_256_CBC)`
`29`	`30`	`{`