Dominique.Fournier/DomFramework
1
0
Fork 0
Code Issues Pull Requests Projects Releases Activity

Better @return description

Browse Source
This commit is contained in:
Dominique Fournier
2022-09-06 16:41:46 +02:00
parent ed8449d321
commit d7f0c2f6dd
3 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/Certificationauthority.php
View File

@@ -121,7 +121,7 @@ extendedKeyUsage = serverAuth, clientAuth
/** Get/Set the ca cert /** Get/Set the ca cert
* @param string|null $caCert The CA cert to get/set * @param string|null $caCert The CA cert to get/set
* @return the CA if get in PEM, $this if set * @return string|self the CA if get in PEM, $this if set
*/ */
public function caCert ($caCert = null) public function caCert ($caCert = null)
// {{{ // {{{
@@ -137,7 +137,7 @@ extendedKeyUsage = serverAuth, clientAuth
/** Get/Set the ca key /** Get/Set the ca key
* @param string|null $caKey The CA key to get/set * @param string|null $caKey The CA key to get/set
* @return the CA if get, $this if set * @return string|self the CA if get, $this if set
*/ */
public function caKey ($caKey = null) public function caKey ($caKey = null)
// {{{ // {{{
@@ -168,7 +168,7 @@ extendedKeyUsage = serverAuth, clientAuth
/** Get in PEM/Set the private key /** Get in PEM/Set the private key
* @param string|null $privateKey The private key to use * @param string|null $privateKey The private key to use
* @return the privatekey if get in PEM, $this if set * @return string|self the privatekey if get in PEM, $this if set
*/ */
public function privateKey ($privateKey = null) public function privateKey ($privateKey = null)
// {{{ // {{{
@@ -191,7 +191,7 @@ extendedKeyUsage = serverAuth, clientAuth
* @param string $countryName Country name (like FR) * @param string $countryName Country name (like FR)
* @param string $organizationName Name of organization * @param string $organizationName Name of organization
* @param string $commonName Common name of authority * @param string $commonName Common name of authority
* @return the CSR created in PEM * @return string the CSR created in PEM
*/ */
public function createCSR ($countryName, $organizationName, $commonName) public function createCSR ($countryName, $organizationName, $commonName)
// {{{ // {{{
@@ -221,7 +221,7 @@ extendedKeyUsage = serverAuth, clientAuth
* @param string $caKey The CA private key * @param string $caKey The CA private key
* @param integer|null $days The number of days of validity (365 by default) * @param integer|null $days The number of days of validity (365 by default)
* @param array|null $altNames The alternative names allowed in cert * @param array|null $altNames The alternative names allowed in cert
* @return the signed certificate in PEM * @return string the signed certificate in PEM
*/ */
public function signCSR ($csr, $caCert, $caKey, $days = 365, public function signCSR ($csr, $caCert, $caKey, $days = 365,
$altNames = array ()) $altNames = array ())

2
src/File.php
View File

@@ -230,7 +230,7 @@ class File
/** Write a string to a file /** Write a string to a file
* @param string $filename Path to the file where to write the data * @param string $filename Path to the file where to write the data
* @param string $data The data to write * @param string|integer $data The data to write
* @param integer|null $flags The optional flags * @param integer|null $flags The optional flags
* @return integer the length of the data stored * @return integer the length of the data stored
* @throws If parent directory not exists, is not writeable, or the file * @throws If parent directory not exists, is not writeable, or the file

2
src/Macaddresses.php
View File

@@ -61,7 +61,7 @@ class Macaddresses
/** Remove all the separators from the provided MAC address /** Remove all the separators from the provided MAC address
* @param string $mac the mac address to update * @param string $mac the mac address to update
* @param array|null $separators The separators to remove * @param array|null $separators The separators to remove
* @return the updated mac address without separators * @return string the updated mac address without separators
*/ */
public static function removeSeparator ($mac, public static function removeSeparator ($mac,
$separators = array (":", "-", ".")) $separators = array (":", "-", "."))