← All changes
|
libraries/action-scheduler/classes/ActionScheduler_LogEntry.php
+19
-8
2.7.9
→
3.1.1
View file →
| @@ -5,18 +5,24 @@ | ||
| 5 | 5 | */ |
| 6 | 6 | class ActionScheduler_LogEntry { |
| 7 | 7 | |
| 8 | 8 | /** |
| 9 | + * Action's ID for log entry. | |
| 10 | + * | |
| 9 | 11 | * @var int $action_id |
| 10 | 12 | */ |
| 11 | - protected $action_id = ''; | |
| 13 | + protected $action_id = ''; | |
| 12 | 14 | |
| 13 | 15 | /** |
| 16 | + * Log entry's message. | |
| 17 | + * | |
| 14 | 18 | * @var string $message |
| 15 | 19 | */ |
| 16 | - protected $message = ''; | |
| 20 | + protected $message = ''; | |
| 17 | 21 | |
| 18 | 22 | /** |
| 23 | + * Log entry's date. | |
| 24 | + * | |
| 19 | 25 | * @var Datetime $date |
| 20 | 26 | */ |
| 21 | 27 | protected $date; |
| 22 | 28 | |
| @@ -22,15 +28,14 @@ | ||
| 22 | 28 | |
| 23 | 29 | /** |
| 24 | 30 | * Constructor |
| 25 | 31 | * |
| 26 | - * @param mixed $action_id Action ID | |
| 27 | - * @param string $message Message | |
| 28 | - * @param Datetime $date Datetime object with the time when this log entry was created. If this parameter is | |
| 29 | - * not provided a new Datetime object (with current time) will be created. | |
| 32 | + * @param mixed $action_id Action ID. | |
| 33 | + * @param string $message Message. | |
| 34 | + * @param Datetime $date Datetime object with the time when this log entry was created. If this parameter is | |
| 35 | + * not provided a new Datetime object (with current time) will be created. | |
| 30 | 36 | */ |
| 31 | 37 | public function __construct( $action_id, $message, $date = null ) { |
| 32 | - | |
| 33 | 38 | /* |
| 34 | 39 | * ActionScheduler_wpCommentLogger::get_entry() previously passed a 3rd param of $comment->comment_type |
| 35 | 40 | * to ActionScheduler_LogEntry::__construct(), goodness knows why, and the Follow-up Emails plugin |
| 36 | 41 | * hard-codes loading its own version of ActionScheduler_wpCommentLogger with that out-dated method, |
| @@ -43,9 +48,9 @@ | ||
| 43 | 48 | } |
| 44 | 49 | |
| 45 | 50 | $this->action_id = $action_id; |
| 46 | 51 | $this->message = $message; |
| 47 | - $this->date = $date ? $date : new Datetime; | |
| 52 | + $this->date = $date ? $date : new Datetime(); | |
| 48 | 53 | } |
| 49 | 54 | |
| 50 | 55 | /** |
| 51 | 56 | * Returns the date when this log entry was created |
| @@ -55,12 +60,18 @@ | ||
| 55 | 60 | public function get_date() { |
| 56 | 61 | return $this->date; |
| 57 | 62 | } |
| 58 | 63 | |
| 64 | + /** | |
| 65 | + * Get action ID of log entry. | |
| 66 | + */ | |
| 59 | 67 | public function get_action_id() { |
| 60 | 68 | return $this->action_id; |
| 61 | 69 | } |
| 62 | 70 | |
| 71 | + /** | |
| 72 | + * Get log entry message. | |
| 73 | + */ | |
| 63 | 74 | public function get_message() { |
| 64 | 75 | return $this->message; |
| 65 | 76 | } |
| 66 | 77 | } |