Skip to content
This repository has been archived by the owner on Jan 21, 2020. It is now read-only.

Commit

Permalink
Add a note about key names in MailHide vs ReCaptcha
Browse files Browse the repository at this point in the history
  • Loading branch information
akrabat committed Feb 9, 2017
1 parent a336acd commit 7978e18
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions src/MailHide.php
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,9 @@ public function getDefaultOptions()
*
* Override the parent method to store a binary representation of the private key as well.
*
* Note that we use the nomenclature "private key" as this is what MailHide's API
* uses, even though the parent ReCaptcha API uses "secret key"
*
* @param string $privateKey
* @return MailHide
*/
Expand All @@ -197,6 +200,9 @@ public function setPrivateKey($privateKey)
/**
* get the private key property
*
* Note that we use the nomenclature "private key" as this is what MailHide's API
* uses, even though the parent ReCaptcha API uses "secret key"
*
* @return string
*/
public function getPrivateKey()
Expand All @@ -207,6 +213,9 @@ public function getPrivateKey()
/**
* set the public key property
*
* Note that we use the nomenclature "public key" as this is what MailHide's API
* uses, even though the parent ReCaptcha API uses "site key"
*
* @param string $publicKey
*/
public function setPublicKey($publicKey)
Expand All @@ -217,6 +226,9 @@ public function setPublicKey($publicKey)
/**
* Get the public key property
*
* Note that we use the nomenclature "public key" as this is what MailHide's API
* uses, even though the parent ReCaptcha API uses "site key"
*
* @return string
*/
public function getPublicKey()
Expand Down

0 comments on commit 7978e18

Please sign in to comment.