Admin
5 years ago
Commands
5 years ago
Helpers
5 years ago
Migrations
5 years ago
ValueObjects
5 years ago
Assets.php
5 years ago
Log.php
5 years ago
LogFactory.php
5 years ago
LogModel.php
5 years ago
LogRepository.php
5 years ago
LogServiceProvider.php
5 years ago
LogModel.php
268 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Log; |
| 4 | |
| 5 | use DateTime; |
| 6 | use Give\Log\ValueObjects\LogType; |
| 7 | |
| 8 | /** |
| 9 | * Class LogModel |
| 10 | * @package Give\Log |
| 11 | * |
| 12 | * @method error( string $message, string $source, array $context = [] ) |
| 13 | * @method warning( string $message, string $source, array $context = [] ) |
| 14 | * @method notice( string $message, string $source, array $context = [] ) |
| 15 | * @method success( string $message, string $source, array $context = [] ) |
| 16 | * @method info( string $message, string $source, array $context = [] ) |
| 17 | * @method http( string $message, string $source, array $context = [] ) |
| 18 | * |
| 19 | * @since 2.10.0 |
| 20 | */ |
| 21 | class LogModel { |
| 22 | /** |
| 23 | * @var string |
| 24 | */ |
| 25 | private $type; |
| 26 | |
| 27 | /** |
| 28 | * @var string |
| 29 | */ |
| 30 | private $message; |
| 31 | |
| 32 | /** |
| 33 | * @var string |
| 34 | */ |
| 35 | private $category; |
| 36 | |
| 37 | /** |
| 38 | * @var string |
| 39 | */ |
| 40 | private $source; |
| 41 | |
| 42 | /** |
| 43 | * @var array |
| 44 | */ |
| 45 | private $context; |
| 46 | |
| 47 | /** |
| 48 | * @var int|null |
| 49 | */ |
| 50 | private $id; |
| 51 | |
| 52 | /** |
| 53 | * @var string |
| 54 | */ |
| 55 | private $date; |
| 56 | |
| 57 | /** |
| 58 | * LogModel constructor. |
| 59 | * |
| 60 | * @param string $type |
| 61 | * @param string $message |
| 62 | * @param string $category |
| 63 | * @param string $source |
| 64 | * @param array $context |
| 65 | * @param int|null $logId |
| 66 | * @param string $date |
| 67 | */ |
| 68 | public function __construct( $type, $message, $category, $source, $context, $logId, $date ) { |
| 69 | $this->setType( $type ); |
| 70 | $this->setDate( $date ); |
| 71 | $this->category = $category; |
| 72 | $this->source = $source; |
| 73 | $this->context = $context; |
| 74 | $this->message = $message; |
| 75 | $this->id = $logId; |
| 76 | } |
| 77 | |
| 78 | /** |
| 79 | * Set log type |
| 80 | * If log type is not supported, it will fallback to NOTICE type |
| 81 | * |
| 82 | * @param string $type |
| 83 | */ |
| 84 | private function setType( $type ) { |
| 85 | $this->type = in_array( $type, LogType::getAll(), true ) |
| 86 | ? $type |
| 87 | : LogType::getDefault(); |
| 88 | } |
| 89 | |
| 90 | /** |
| 91 | * Set log message |
| 92 | * If not defined, fallback to default value |
| 93 | * |
| 94 | * @param string|null $message |
| 95 | */ |
| 96 | private function setMessage( $message ) { |
| 97 | $this->message = is_null( $message ) |
| 98 | ? esc_html__( 'Something went wrong', 'give' ) |
| 99 | : $message; |
| 100 | } |
| 101 | |
| 102 | /** |
| 103 | * Set log date |
| 104 | * |
| 105 | * @param string $date |
| 106 | */ |
| 107 | private function setDate( $date ) { |
| 108 | $this->date = $this->isValidateDate( $date ) |
| 109 | ? $date |
| 110 | : date( 'Y-m-d H:i:s' ); |
| 111 | } |
| 112 | |
| 113 | /** |
| 114 | * Set log source |
| 115 | * If not defined, fallback to default value |
| 116 | * |
| 117 | * @param string|null $source |
| 118 | */ |
| 119 | private function setSource( $source ) { |
| 120 | $this->source = is_null( $source ) |
| 121 | ? esc_html__( 'Give Core', 'give' ) |
| 122 | : $source; |
| 123 | } |
| 124 | |
| 125 | /** |
| 126 | * Helper method to check if given string is a valid date |
| 127 | * |
| 128 | * @param string $date |
| 129 | * @param string $format |
| 130 | * |
| 131 | * @return bool |
| 132 | */ |
| 133 | public function isValidateDate( $date, $format = 'Y-m-d H:i:s' ) { |
| 134 | $dateTime = DateTime::createFromFormat( $format, $date ); |
| 135 | return $dateTime && $dateTime->format( $format ) === $date; |
| 136 | } |
| 137 | |
| 138 | /** |
| 139 | * @return int |
| 140 | */ |
| 141 | public function getId() { |
| 142 | return $this->id; |
| 143 | } |
| 144 | |
| 145 | /** |
| 146 | * @return string |
| 147 | */ |
| 148 | public function getType() { |
| 149 | return $this->type; |
| 150 | } |
| 151 | |
| 152 | /** |
| 153 | * @return string |
| 154 | */ |
| 155 | public function getCategory() { |
| 156 | return $this->category; |
| 157 | } |
| 158 | |
| 159 | /** |
| 160 | * @return string |
| 161 | */ |
| 162 | public function getSource() { |
| 163 | return $this->source; |
| 164 | } |
| 165 | |
| 166 | /** |
| 167 | * @return string |
| 168 | */ |
| 169 | public function getMessage() { |
| 170 | return $this->message; |
| 171 | } |
| 172 | |
| 173 | /** |
| 174 | * @return array |
| 175 | */ |
| 176 | public function getContext() { |
| 177 | return $this->context; |
| 178 | } |
| 179 | |
| 180 | /** |
| 181 | * @return string |
| 182 | */ |
| 183 | public function getDate() { |
| 184 | return $this->date; |
| 185 | } |
| 186 | |
| 187 | /** |
| 188 | * Get context data |
| 189 | * |
| 190 | * @param bool $jsonEncode |
| 191 | * |
| 192 | * @return string|array |
| 193 | */ |
| 194 | public function getData( $jsonEncode = false ) { |
| 195 | $data = [ |
| 196 | 'message' => $this->getMessage(), |
| 197 | 'context' => $this->getContext(), |
| 198 | ]; |
| 199 | |
| 200 | if ( $jsonEncode ) { |
| 201 | return json_encode( $data ); |
| 202 | } |
| 203 | |
| 204 | return $data; |
| 205 | } |
| 206 | |
| 207 | /** |
| 208 | * @param string $key |
| 209 | * @param mixed $value |
| 210 | */ |
| 211 | private function addContext( $key, $value ) { |
| 212 | if ( is_array( $value ) || is_object( $value ) ) { |
| 213 | $value = print_r( $value, true ); |
| 214 | } |
| 215 | $this->context[ $key ] = $value; |
| 216 | } |
| 217 | |
| 218 | /** |
| 219 | * Add supplemental information to existing log. |
| 220 | * Supplemental data will be added as a context with a key prefixed with the current timestamp. |
| 221 | * |
| 222 | * @param string $key |
| 223 | * @param string $value |
| 224 | */ |
| 225 | public function addSupplemental( $key, $value ) { |
| 226 | $contextName = sprintf( '[%s] %s', date( 'Y-m-d H:i:s' ), $key ); |
| 227 | $this->addContext( $contextName, $value ); |
| 228 | } |
| 229 | |
| 230 | /** |
| 231 | * @param string $type |
| 232 | * @param array $args |
| 233 | */ |
| 234 | public function __call( $type, $args ) { |
| 235 | list ( $message, $source, $context ) = array_pad( $args, 3, null ); |
| 236 | |
| 237 | $this->setType( $type ); |
| 238 | $this->setMessage( $message ); |
| 239 | $this->setSource( $source ); |
| 240 | |
| 241 | // Set additional context |
| 242 | if ( is_array( $context ) ) { |
| 243 | foreach ( $context as $key => $value ) { |
| 244 | $this->addContext( $key, $value ); |
| 245 | } |
| 246 | } |
| 247 | |
| 248 | $this->save(); |
| 249 | } |
| 250 | |
| 251 | /** |
| 252 | * Save log record |
| 253 | */ |
| 254 | public function save() { |
| 255 | /** |
| 256 | * var LogRepository $repository |
| 257 | */ |
| 258 | $repository = give( LogRepository::class ); |
| 259 | |
| 260 | if ( $this->getId() ) { |
| 261 | $this->date = date( 'Y-m-d H:i:s' ); |
| 262 | $repository->updateLog( $this ); |
| 263 | } else { |
| 264 | $this->id = $repository->insertLog( $this ); |
| 265 | } |
| 266 | } |
| 267 | } |
| 268 |