| Index: trunk/phase3/includes/logging/LogEntry.php |
| — | — | @@ -313,6 +313,14 @@ |
| 314 | 314 | protected $comment = ''; ///!< @var string |
| 315 | 315 | protected $deleted; ///!< @var int |
| 316 | 316 | |
| | 317 | + /** |
| | 318 | + * Constructor. |
| | 319 | + * |
| | 320 | + * @since 1.19 |
| | 321 | + * |
| | 322 | + * @param string $type |
| | 323 | + * @param string $subtype |
| | 324 | + */ |
| 317 | 325 | public function __construct( $type, $subtype ) { |
| 318 | 326 | $this->type = $type; |
| 319 | 327 | $this->subtype = $subtype; |
| — | — | @@ -329,28 +337,66 @@ |
| 330 | 338 | * '4:color' => 'blue', |
| 331 | 339 | * 'animal' => 'dog' |
| 332 | 340 | * ); |
| | 341 | + * |
| | 342 | + * @since 1.19 |
| | 343 | + * |
| 333 | 344 | * @param $parameters Associative array |
| 334 | 345 | */ |
| 335 | 346 | public function setParameters( $parameters ) { |
| 336 | 347 | $this->parameters = $parameters; |
| 337 | 348 | } |
| 338 | 349 | |
| | 350 | + /** |
| | 351 | + * Set the user that performed the action being logged. |
| | 352 | + * |
| | 353 | + * @since 1.19 |
| | 354 | + * |
| | 355 | + * @param User $performer |
| | 356 | + */ |
| 339 | 357 | public function setPerformer( User $performer ) { |
| 340 | 358 | $this->performer = $performer; |
| 341 | 359 | } |
| 342 | 360 | |
| | 361 | + /** |
| | 362 | + * Set the title of the object changed. |
| | 363 | + * |
| | 364 | + * @since 1.19 |
| | 365 | + * |
| | 366 | + * @param Title $target |
| | 367 | + */ |
| 343 | 368 | public function setTarget( Title $target ) { |
| 344 | 369 | $this->target = $target; |
| 345 | 370 | } |
| 346 | 371 | |
| | 372 | + /** |
| | 373 | + * Set the timestamp of when the logged action took place. |
| | 374 | + * |
| | 375 | + * @since 1.19 |
| | 376 | + * |
| | 377 | + * @param string $timestamp |
| | 378 | + */ |
| 347 | 379 | public function setTimestamp( $timestamp ) { |
| 348 | 380 | $this->timestamp = $timestamp; |
| 349 | 381 | } |
| 350 | 382 | |
| | 383 | + /** |
| | 384 | + * Set a comment associated with the action being logged. |
| | 385 | + * |
| | 386 | + * @since 1.19 |
| | 387 | + * |
| | 388 | + * @param string $comment |
| | 389 | + */ |
| 351 | 390 | public function setComment( $comment ) { |
| 352 | 391 | $this->comment = $comment; |
| 353 | 392 | } |
| 354 | 393 | |
| | 394 | + /** |
| | 395 | + * TODO: document |
| | 396 | + * |
| | 397 | + * @since 1.19 |
| | 398 | + * |
| | 399 | + * @param integer $deleted |
| | 400 | + */ |
| 355 | 401 | public function setDeleted( $deleted ) { |
| 356 | 402 | $this->deleted = $deleted; |
| 357 | 403 | } |