From 9432f1f970496690dac71a7440adb636b7d0d5c9 Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Tue, 2 Jul 2019 09:24:49 +0200 Subject: [PATCH] [Mime] Updated some PHPDoc contents --- src/Symfony/Component/Mime/Crypto/SMimeEncrypter.php | 3 ++- src/Symfony/Component/Mime/Crypto/SMimeSigner.php | 10 ++++------ 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/src/Symfony/Component/Mime/Crypto/SMimeEncrypter.php b/src/Symfony/Component/Mime/Crypto/SMimeEncrypter.php index 72f59ce1bc..d4c4a42aae 100644 --- 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 index 71ce5df962..ef4375cc1e 100644 --- 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) {