Start · Sprachen · PHP · Referenz · pspell_config_save_repl

pspell_config_save_repl

Funktion

Legt fest, ob Ersetzungspaare beim Speichern der persönlichen Wortliste mit gespeichert werden sollen.

seit PHP 5.0.0 Kategorie: string

Signatur

pspell_config_save_repl(PSpell\Config $config, bool $save): bool

Beschreibung

pspell_config_save_repl konfiguriert einen PSpell-Konfigurationskontext dahingehend, ob sogenannte Replacement Pairs (Ersetzungspaare) gemeinsam mit der persönlichen Wortliste gespeichert werden. Ersetzungspaare entstehen, wenn der Benutzer die Funktion pspell_store_replacement nutzt, um zu einem falsch geschriebenen Wort eine bevorzugte Korrektur zu hinterlegen.

Diese Funktion muss vor dem Erzeugen des eigentlichen PSpell-Wörterbuchs mit pspell_new_config aufgerufen werden, da sie den Konfigurationskontext beeinflusst, aus dem das Wörterbuch erstellt wird.

Wenn $save auf true gesetzt ist, werden Ersetzungspaare persistent in der Wortlisten-Datei gespeichert und stehen beim nächsten Laden der Wortliste wieder zur Verfügung. Dies ist besonders nützlich bei personalisierten Rechtschreibkorrektur-Systemen, bei denen Nutzer bevorzugte Schreibweisen dauerhaft hinterlegen sollen.

Zu beachten ist, dass diese Einstellung nur greift, wenn die Wortliste anschließend explizit mit pspell_save_wordlist gespeichert wird.

Parameter

Name Typ Default Beschreibung
$config Pflicht PSpell\Config Ein PSpell-Konfigurationsobjekt, das zuvor mit pspell_config_create erzeugt wurde.
$save Pflicht bool Wenn true, werden Ersetzungspaare zusammen mit der Wortliste gespeichert. Bei false werden sie nicht persistiert.

Rückgabewert

Typ
bool
Beschreibung
Gibt true bei Erfolg zurück, false bei einem Fehler.

Beispiele

Ersetzungspaare persistent speichern

<?php
// Konfigurationskontext für deutsches Wörterbuch erstellen
$config = pspell_config_create('de');

// Persönliche Wortliste festlegen
pspell_config_personal($config, '/tmp/meine_woerter.pws');

// Ersetzungspaare sollen zusammen mit der Wortliste gespeichert werden
pspell_config_save_repl($config, true);

// Wörterbuch aus Konfiguration erstellen
$pspell = pspell_new_config($config);

// Ersetzungspaar hinterlegen: "tpyo" soll durch "typo" ersetzt werden
pspell_store_replacement($pspell, 'tpyo', 'typo');

// Wortliste (inkl. Ersetzungspaare) speichern
pspell_save_wordlist($pspell);

echo "Wortliste mit Ersetzungspaaren gespeichert.";
Wortliste mit Ersetzungspaaren gespeichert.

Ersetzungspaare nicht speichern (Standard-Verhalten deaktivieren)

<?php
// Konfigurationskontext erstellen
$config = pspell_config_create('en');

// Persönliche Wortliste festlegen
pspell_config_personal($config, '/tmp/my_words.pws');

// Ersetzungspaare NICHT mit der Wortliste speichern
pspell_config_save_repl($config, false);

// Wörterbuch erzeugen
$pspell = pspell_new_config($config);

// Ersetzungspaar wird nur in dieser Sitzung genutzt
pspell_store_replacement($pspell, 'seperate', 'separate');

// Wortliste speichern – Ersetzungspaare werden NICHT gespeichert
pspell_save_wordlist($pspell);

echo "Wortliste ohne Ersetzungspaare gespeichert.";
Wortliste ohne Ersetzungspaare gespeichert.

// Wichtig · Fallstricke

Reihenfolge beachten: pspell_config_save_repl muss zwingend vor dem Aufruf von pspell_new_config aufgerufen werden, da der Konfigurationskontext danach nicht mehr verändert werden kann.

Verfügbarkeit: Die PSpell-Erweiterung erfordert die installierten aspell-Bibliotheken sowie den entsprechenden PHP-Build mit PSpell-Unterstützung (--with-pspell). Ab PHP 8.1 verwenden die PSpell-Funktionen Objekte der Klasse PSpell\Config statt Integer-Ressourcen.

Deprecation: Die PSpell-Erweiterung gilt als veraltet und wird möglicherweise in zukünftigen PHP-Versionen entfernt. Für neue Projekte sollten modernere Alternativen wie externe Rechtschreibkorrektur-Dienste oder die Enchant-Erweiterung in Betracht gezogen werden.