helpers.php changed

Author: biscolab

src/helpers.php

@@ -11,56 +11,56 @@
 use Biscolab\ReCaptcha\Facades\ReCaptcha;
 
 if (!function_exists('recaptcha')) {
-	/**
-	 * @return Biscolab\ReCaptcha\ReCaptchaBuilder
-	 */
-	function recaptcha()
-	{
-
-		return app('recaptcha');
-	}
+    /**
+     * @return Biscolab\ReCaptcha\ReCaptchaBuilder|\Biscolab\ReCaptcha\ReCaptchaBuilderV2|\Biscolab\ReCaptcha\ReCaptchaBuilderInvisible|\Biscolab\ReCaptcha\ReCaptchaBuilderV3
+     */
+    function recaptcha(): \Biscolab\ReCaptcha\ReCaptchaBuilder
+    {
+
+        return app('recaptcha');
+    }
 }
 
 /**
  * call ReCaptcha::htmlScriptTagJsApi()
  * Write script HTML tag in you HTML code
  * Insert before </head> tag
  *
- * @param $formId required if you are using invisible ReCaptcha
+ * @param $config ['form_id'] required if you are using invisible ReCaptcha
  */
 if (!function_exists('htmlScriptTagJsApi')) {
 
-	/**
-	 * @param string $formId
-	 *
-	 * @return string
-	 */
-	function htmlScriptTagJsApi($formId = ''): string
-	{
+    /**
+     * @param array|null $config
+     *
+     * @return string
+     */
+    function htmlScriptTagJsApi(?array $config = []): string
+    {
 
-		return ReCaptcha::htmlScriptTagJsApi($formId);
-	}
+        return ReCaptcha::htmlScriptTagJsApi($config);
+    }
 }
 
 /**
  * call ReCaptcha::htmlScriptTagJsApi()
  * Write script HTML tag in you HTML code
  * Insert before </head> tag
  *
- * @param $formId required if you are using invisible ReCaptcha
  */
 if (!function_exists('htmlScriptTagJsApiV3')) {
 
-	/**
-	 * @param array $config
-	 *
-	 * @return string
-	 */
-	function htmlScriptTagJsApiV3($config = []): string
-	{
-
-		return ReCaptcha::htmlScriptTagJsApiV3($config);
-	}
+    /**
+     * @param array $config
+     *
+     * @return string
+     * @deprecated
+     */
+    function htmlScriptTagJsApiV3(?array $config = []): string
+    {
+
+        return ReCaptcha::htmlScriptTagJsApiV3($config);
+    }
 }
 
 /**
@@ -74,16 +74,17 @@ function htmlScriptTagJsApiV3($config = []): string
  */
 if (!function_exists('htmlFormButton')) {
 
-	/**
-	 * @param null|string $buttonInnerHTML
-	 *
-	 * @return string
-	 */
-	function htmlFormButton(?string $buttonInnerHTML = 'Submit'): string
-	{
-
-		return ReCaptcha::htmlFormButton($buttonInnerHTML);
-	}
+    /**
+     * @param null|string $button_label
+     * @param array|null  $properties
+     *
+     * @return string
+     */
+    function htmlFormButton(?string $button_label = 'Submit', ?array $properties = []): string
+    {
+
+        return ReCaptcha::htmlFormButton($button_label, $properties);
+    }
 }
 
 /**
@@ -95,13 +96,62 @@ function htmlFormButton(?string $buttonInnerHTML = 'Submit'): string
  */
 if (!function_exists('htmlFormSnippet')) {
 
-	/**
-	 * @return string
-	 */
-	function htmlFormSnippet(): string
-	{
+    /**
+     * @return string
+     */
+    function htmlFormSnippet(): string
+    {
+
+        return ReCaptcha::htmlFormSnippet();
+    }
+}
+
+/**
+ * call ReCaptcha::getFormId()
+ * return the form ID
+ * Warning! Using only with ReCAPTCHA invisible
+ */
+if (!function_exists('getFormId')) {
+
+    /**
+     * @return string
+     */
+    function getFormId(): string
+    {
+
+        return ReCaptcha::getFormId();
+    }
+}
+
+/**
+ * return ReCaptchaBuilder::DEFAULT_RECAPTCHA_RULE_NAME value ("recaptcha")
+ * Use V2 (checkbox and invisible)
+ */
+if (!function_exists('recaptchaRuleName')) {
+
+    /**
+     * @return string
+     */
+    function recaptchaRuleName(): string
+    {
+
+        return \Biscolab\ReCaptcha\ReCaptchaBuilder::DEFAULT_RECAPTCHA_RULE_NAME;
+    }
+}
+
+/**
+ * return ReCaptchaBuilder::DEFAULT_RECAPTCHA_FIELD_NAME value "g-recaptcha-response"
+ * Use V2 (checkbox and invisible)
+ */
+if (!function_exists('recaptchaFieldName')) {
+
+    /**
+     * @return string
+     */
+    function recaptchaFieldName(): string
+    {
 
-		return ReCaptcha::htmlFormSnippet();
-	}
+        return \Biscolab\ReCaptcha\ReCaptchaBuilder::DEFAULT_RECAPTCHA_FIELD_NAME;
+    }
 }