CriticalActionPerformedEvent.php 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2021 Joas Schilling <coding@schilljs.com>
  5. *
  6. * @author Joas Schilling <coding@schilljs.com>
  7. *
  8. * @license GNU AGPL version 3 or any later version
  9. *
  10. * This program is free software: you can redistribute it and/or modify
  11. * it under the terms of the GNU Affero General Public License as
  12. * published by the Free Software Foundation, either version 3 of the
  13. * License, or (at your option) any later version.
  14. *
  15. * This program is distributed in the hope that it will be useful,
  16. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. * GNU Affero General Public License for more details.
  19. *
  20. * You should have received a copy of the GNU Affero General Public License
  21. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  22. *
  23. */
  24. namespace OCP\Log\Audit;
  25. use OCP\EventDispatcher\Event;
  26. /**
  27. * Emitted when the admin_audit app should log an entry
  28. *
  29. * @since 22.0.0
  30. */
  31. class CriticalActionPerformedEvent extends Event {
  32. /** @var string */
  33. private $logMessage;
  34. /** @var array */
  35. private $parameters;
  36. /** @var bool */
  37. private $obfuscateParameters;
  38. /**
  39. * @param string $logMessage
  40. * @param array $parameters
  41. * @param bool $obfuscateParameters
  42. * @since 22.0.0
  43. */
  44. public function __construct(string $logMessage,
  45. array $parameters = [],
  46. bool $obfuscateParameters = false) {
  47. parent::__construct();
  48. $this->logMessage = $logMessage;
  49. $this->parameters = $parameters;
  50. $this->obfuscateParameters = $obfuscateParameters;
  51. }
  52. /**
  53. * @return string
  54. * @since 22.0.0
  55. */
  56. public function getLogMessage(): string {
  57. return $this->logMessage;
  58. }
  59. /**
  60. * @return array
  61. * @since 22.0.0
  62. */
  63. public function getParameters(): array {
  64. return $this->parameters;
  65. }
  66. /**
  67. * @return bool
  68. * @since 22.0.0
  69. */
  70. public function getObfuscateParameters(): bool {
  71. return $this->obfuscateParameters;
  72. }
  73. }