| @@ -16,9 +16,9 @@ | ||
| 16 | 16 | */ |
| 17 | 17 | abstract class Alert_Type { |
| 18 | 18 | |
| 19 | 19 | /** |
| 20 | - * Hold the Plugin class | |
| 20 | + * Holds instance of plugin object | |
| 21 | 21 | * |
| 22 | 22 | * @var Plugin |
| 23 | 23 | */ |
| 24 | 24 | public $plugin; |
| @@ -33,9 +33,8 @@ | ||
| 33 | 33 | /** |
| 34 | 34 | * Class constructor. |
| 35 | 35 | * |
| 36 | 36 | * @param Plugin $plugin Plugin object. |
| 37 | - * @return void | |
| 38 | 37 | */ |
| 39 | 38 | public function __construct( $plugin ) { |
| 40 | 39 | $this->plugin = $plugin; |
| 41 | 40 | } |
| @@ -40,9 +39,9 @@ | ||
| 40 | 39 | $this->plugin = $plugin; |
| 41 | 40 | } |
| 42 | 41 | |
| 43 | 42 | /** |
| 44 | - * Alert recipients about the new record | |
| 43 | + * Alert recipients about the new record | |
| 45 | 44 | * |
| 46 | 45 | * @param int $record_id Record ID. |
| 47 | 46 | * @param array $recordarr Record details. |
| 48 | 47 | * @param array $options Alert options. |
| @@ -54,9 +53,9 @@ | ||
| 54 | 53 | * |
| 55 | 54 | * @param Alert $alert Alert currently being worked on. |
| 56 | 55 | */ |
| 57 | 56 | public function display_fields( $alert ) { |
| 58 | - return; | |
| 57 | + // Implementation optional, but recommended. | |
| 59 | 58 | } |
| 60 | 59 | |
| 61 | 60 | /** |
| 62 | 61 | * Process settings form for configuration of individual alerts |
| @@ -63,9 +62,9 @@ | ||
| 63 | 62 | * |
| 64 | 63 | * @param Alert $alert Alert currently being worked on. |
| 65 | 64 | */ |
| 66 | 65 | public function save_fields( $alert ) { |
| 67 | - return; | |
| 66 | + // Implementation optional, but recommended. | |
| 68 | 67 | } |
| 69 | 68 | |
| 70 | 69 | /** |
| 71 | 70 | * Allow connectors to determine if their dependencies are satisfied or not |
| @@ -72,7 +71,8 @@ | ||
| 72 | 71 | * |
| 73 | 72 | * @return bool |
| 74 | 73 | */ |
| 75 | 74 | public function is_dependency_satisfied() { |
| 75 | + // Implementation optional, but recommended. | |
| 76 | 76 | return true; |
| 77 | 77 | } |
| 78 | 78 | } |