mahnung/lib/mahnung_ui.lib.php

<?php
/* Copyright (C) 2026  Eduard Wisch  <data@data-it-solution.de>
 *
 * GPL v3 (siehe COPYING).
 */

/**
 * \file    htdocs/custom/mahnung/lib/mahnung_ui.lib.php
 * \ingroup mahnung
 * \brief   Gemeinsame Anzeige-Bausteine des Moduls.
 *
 *          Hier liegt die EINE Darstellung einer Mahnstufe. Vorher gab es sie
 *          dreimal — auf der Mahnungskarte, in der Vorschlagsliste und im Widget
 *          — jeweils mit eigener Farbskala. Dadurch stand die Stufe an zwei
 *          Stellen doppelt da (farbiger Badge UND derselbe Text daneben), und die
 *          Farben wären beim nächsten Eingriff auseinandergelaufen.
 */


/**
 * Zahnrad-Link in die Modul-Einstellungen — für den Kopf einer Modulseite.
 *
 * Gedacht für den Parameter $morehtmlright von load_fiche_titre(), damit das Icon
 * rechts neben dem Seitentitel steht (Dolibarr-Konvention).
 *
 * Sichtbar nur mit dem Recht mahnung.setup oder für Administratoren. Wer die
 * Einstellungen ohnehin nicht öffnen darf, bekommt kein Icon zu sehen, das ihn in
 * eine "Zugriff verweigert"-Meldung laufen lässt.
 *
 * @return string  HTML ('' = kein Recht)
 */
function mahnungSetupLink()
{
	global $langs, $user;

	if (!$user->hasRight('mahnung', 'setup') && empty($user->admin)) {
		return '';
	}

	return '<a class="butActionNew" href="'.DOL_URL_ROOT.'/custom/mahnung/admin/setup.php"'
		.' title="'.dol_escape_htmltag($langs->trans('MahnungSetupOeffnen')).'">'
		.img_picto($langs->trans('MahnungSetupOeffnen'), 'setup', 'class="pictofixedwidth"')
		.'</a>';
}

/**
 * Farbe einer Mahnstufe.
 *
 * Maßgeblich ist das Flag ist_erinnerung der Stufe, NICHT die Stufennummer: eine
 * kostenlose Zahlungserinnerung ist keine Eskalationsstufe und bleibt deshalb
 * neutral grau. Stufennummern oberhalb der Standardskala sind frei konfigurierte
 * Eskalationen und werden dunkelrot — sonst sähen sie harmloser aus als Stufe 3.
 *
 * @param  int  $stufe          Stufennummer
 * @param  bool $istErinnerung  true = kostenlose Zahlungserinnerung
 * @return string               CSS-Farbwert
 */
function mahnungStufeFarbe($stufe, $istErinnerung)
{
	if ($istErinnerung) {
		return '#7a7a7a';
	}

	// Eintrag für 0 ist nötig, weil die Stufennummer 0 auch eine echte
	// (kostenpflichtige) Mahnstufe sein kann — die kostenlose Erinnerung hängt am
	// Flag, nicht an der Nummer, und ist oben schon abgehandelt. Gedecktes
	// Blaugrau = mildeste Eskalation; bewusst nicht heller als Stufe 1, sonst
	// leidet der Kontrast zur weißen Badge-Schrift.
	$colors = array(0 => '#5b7fa6', 1 => '#4a90d9', 2 => '#e68a00', 3 => '#cc3333');
	if (isset($colors[(int) $stufe])) {
		return $colors[(int) $stufe];
	}
	return ((int) $stufe > 3) ? '#a32020' : '#666';
}

/**
 * Badge einer Mahnstufe — Nummer und Bezeichnung in EINEM Element.
 *
 * Bewusst keine zweite Textausgabe daneben: die Bezeichnung der Stufe ist frei
 * konfigurierbar und heißt in der Praxis "Zahlungserinnerung", "1. Mahnung" usw.
 * Ein zusätzliches Typ-Etikett würde damit nur dasselbe Wort wiederholen. Welcher
 * Art die Stufe ist, transportieren Farbe und Tooltip.
 *
 * @param  int    $stufe          Stufennummer
 * @param  string $label          Bezeichnung der Stufe ('' = nur Nummer)
 * @param  bool   $istErinnerung  true = kostenlose Zahlungserinnerung
 * @param  string $tooltip        Zusatztext für das title-Attribut ('' = Standard)
 * @return string                 HTML
 */
function mahnungStufeBadge($stufe, $label, $istErinnerung, $tooltip = '')
{
	global $langs;

	$stufe = (int) $stufe;
	$label = trim((string) $label);

	if ($tooltip === '') {
		$tooltip = $istErinnerung
			? $langs->transnoentities('MahnungErinnerungKostenfrei')
			: $langs->transnoentities('MahnungVorschlagBadgeMahnungHelp');
	}

	$text = (string) $stufe;
	if ($label !== '') {
		$text .= ' — '.$label;
	}

	$out = '<span class="badge" style="background-color:'.mahnungStufeFarbe($stufe, $istErinnerung).';color:#fff;"';
	$out .= ' title="'.dol_escape_htmltag($tooltip).'">'.dol_escape_htmltag($text).'</span>';
	return $out;
}


/**
 * Setzt im Widget-Kopf Tooltip und Auswahl-Bezeichnung auf den reinen Titel.
 *
 * ModeleBoxes::showBox() schreibt den kompletten Widget-Titel zusätzlich in das
 * title-Attribut des Tabellenkopfs und in die Bezeichnung für die Widget-Auswahl
 * (boxlabelentry, landet nach dem Schließen im Auswahlfeld). Unser Titel trägt den
 * Anzahl-Badge samt Link als HTML — der Browser zeigt beim Überfahren dann
 * „…Mahnstufe<span class="badge">2</span>“. Der sichtbare Kopf bleibt unverändert.
 *
 * @param string $out   Ausgabe von ModeleBoxes::showBox()
 * @param string $label Titel ohne HTML (Entities wie von $langs->trans() erlaubt)
 * @return string       Bereinigte Ausgabe
 */
function mahnungBoxKopfOhneHtml($out, $label)
{
	$label = dol_escape_htmltag(html_entity_decode($label, ENT_QUOTES | ENT_HTML5, 'UTF-8'));

	$out = preg_replace_callback('/(<tr class="liste_titre box_titre"><th[^>]*?) title="[^"]*"/', function ($m) use ($label) {
		return $m[1].' title="'.$label.'"';
	}, $out, 1);

	return preg_replace_callback('/(<input type="hidden" id="boxlabelentry\d*" value=")[^"]*"/', function ($m) use ($label) {
		return $m[1].$label.'"';
	}, $out, 1);
}