Explorar el Código

#4716 Alerts(hooks) docs

Alex Trofimov hace 2 años
padre
commit
553a3bcb7d

+ 1 - 1
inc/profiles.inc.php

@@ -129,7 +129,7 @@ function bx_login($iId, $bRememberMe = false)
 
     /**
      * @page alerts
-     * @section System
+     * @section system System
      * @subsection system-login 'system', 'login' - hook after user performed login
      * Used in @ref bx_login function
      * - $unit_name - `system`

+ 3 - 3
inc/utils.inc.php

@@ -509,7 +509,7 @@ function _sendMail($sRecipientEmail, $sMailSubject, $sMailBody, $iRecipientID =
     
     /**
      * @page alerts
-     * @section System
+     * @section system System
      * @subsection system-check_send_mail 'system', 'check_send_mail' - hook for disabling mail sending 
      * Used in @ref sendMail function 
      * - $unit_name - `system`
@@ -537,7 +537,7 @@ function _sendMail($sRecipientEmail, $sMailSubject, $sMailBody, $iRecipientID =
     if (!$isDisableAlert) {
         /**
          * @page alerts
-         * @section System
+         * @section system System
          * @subsection system-before_send_mail 'system', 'before_send_mail' - hook before mail sending
          * It's equivalent to @ref system-check_send_mail 
          */
@@ -566,7 +566,7 @@ function _sendMail($sRecipientEmail, $sMailSubject, $sMailBody, $iRecipientID =
     if (!$isDisableAlert) {
         /**
          * @page alerts
-         * @section System
+         * @section system System
          * @subsection system-send_mail 'system', 'send_mail' - hook when mail was sent
          * It's equivalent to @ref system-check_send_mail 
          * except `override_result` parameter in $extra_params is missing

+ 1 - 1
modules/base/general/classes/BxBaseModGeneralModule.php

@@ -3157,7 +3157,7 @@ class BxBaseModGeneralModule extends BxDolModule
          * @page alerts
          * @section bx_base_general Base General
          * @subsection bx_base_general-approved '{module_name}', 'approved' - hook when module content has been approved
-         * Used in @ref BxBaseModGeneralModule::alertAfterApprove methodunction 
+         * Used in @ref BxBaseModGeneralModule::alertAfterApprove "alertAfterApprove" method
          * - $unit_name - module name
          * - $action - `approved` 
          * - $object_id - content id