. */ namespace SP\Core\Events; use SP\Core\Messages\FormatterInterface; use SP\Core\Messages\HtmlFormatter; use SP\Core\Messages\MessageInterface; use SP\Core\Messages\TextFormatter; /** * Class EventMessage * * @package SP\Core\Events */ final class EventMessage implements MessageInterface { /** * @var array Detalles de la acción en formato "detalle : descripción" */ protected array $details = []; protected int $descriptionCounter = 0; protected int $detailsCounter = 0; protected array $description = []; protected array $extra = []; public static function factory(): EventMessage { return new self(); } public function getDescriptionRaw(): array { return $this->description; } /** * Establece los detalles de la acción realizada */ public function addDetail(string $key, ?string $value): EventMessage { if (empty($value) || empty($key)) { return $this; } $this->details[] = [$this->formatString($key), $this->formatString($value)]; $this->detailsCounter++; return $this; } /** * Formatear una cadena para guardarla en el registro */ private function formatString(string $string): string { return strip_tags($string); } /** * Establece la descripción de la acción realizada */ public function addDescription(string $description = ''): EventMessage { $this->description[] = $this->formatString($description); $this->descriptionCounter++; return $this; } /** * Componer un mensaje en formato texto */ public function composeText(string $delimiter = PHP_EOL): string { if ($this->descriptionCounter === 0 && $this->detailsCounter === 0) { return ''; } $formatter = new TextFormatter($delimiter); return implode($delimiter, array_filter([ $this->getDescription($formatter, true), $this->getDetails($formatter, true) ])); } /** * Devuelve la descripción de la acción realizada */ public function getDescription( FormatterInterface $formatter, bool $translate ): string { if ($this->descriptionCounter === 0) { return ''; } return $formatter->formatDescription($this->description, $translate); } /** * Devuelve los detalles de la acción realizada */ public function getDetails( FormatterInterface $formatter, bool $translate = false ): string { if ($this->detailsCounter === 0) { return ''; } return $formatter->formatDetail($this->details, $translate); } /** * Devuelve los detalles */ public function getDetailsRaw(): array { return $this->details; } /** * Componer un mensaje en formato HTML */ public function composeHtml(): string { $formatter = new HtmlFormatter(); $message = '
'; $message .= '
' . $this->getDescription($formatter, true) . '
'; $message .= '
' . $this->getDetails($formatter, true) . '
'; $message .= '
'; return $message; } public function getDescriptionCounter(): int { return $this->descriptionCounter; } public function getDetailsCounter(): int { return $this->detailsCounter; } public function getExtra(): array { return $this->extra; } public function setExtra(string $type, array $data): EventMessage { if (isset($this->extra[$type])) { $this->extra[$type] = array_merge($this->extra[$type], $data); } else { $this->extra[$type] = $data; } return $this; } /** * Extra data are stored as an array of values per key, thus each key is unique */ public function addExtra(string $type, $data): EventMessage { if (isset($this->extra[$type]) && in_array($data, $this->extra[$type], false) ) { return $this; } $this->extra[$type][] = $data; return $this; } }