Module:String/doc/cs
Toto je dokumentace podstránky Module:String/doc. Obsahuje informace o použití, kategorie a další obsah, který není součástí původní stránky Module. |
Varování: | Tato stránka je sdílena mezi několika wiki. Všechny změny této stránky budou automaticky zkopírované na všechny wiki, které se nachází v levém postranním panelu. |
Tento modul je hodnocen jako připraven pro všeobecné použití. Dosáhl zralé formy a předpokládá se, že je bez chyb a je připraven k použití, kdekoli je to vhodné. Je připraven zmínit se na stránkách nápovědy a dalších zdrojích jako možnost, kterou se mohou naučit noví uživatelé. Aby se snížilo zatížení serveru a špatný výstup, měl by být vylepšen pomocí testování v izolovaném prostoru spíše než opakovanými úpravami metodou pokus-omyl. |
Tento modul podléhá stránkové ochraně. Je to vysoce viditelný modul, který používá velmi velký počet stránek. Protože vandalismus nebo chyby by ovlivnily mnoho stránek a dokonce i triviální úpravy by mohly způsobit značné zatížení serverů, je chráněn před úpravami. |
Tento modul je určen k poskytování přístupu k základním funkcím řetězců.
Většinu zde poskytovaných funkcí lze vyvolat s pojmenovanými parametry, nepojmenovanými parametry nebo kombinací. Pokud jsou použity pojmenované parametry, MediaWiki z parametru automaticky odstraní všechny úvodní nebo koncové mezery. V závislosti na zamýšleném použití může být výhodné takové mezery buď zachovat nebo odstranit.
Celosvětové možnosti
ignore_errors
- Pokud je nastaveno na
true
nebo 1, jakýkoli chybový stav bude mít za následek vrácený prázdný řetězec, nikoli chybovou zprávu. error_category
- Pokud dojde k chybě, určuje název kategorie, která má být zahrnuta do chybové zprávy. Výchozí kategorie je Category:Errors reported by Module String .
no_category
- Pokud je nastaveno na
true
nebo 1, pokud dojde k chybě, nebude přidána žádná kategorie.
Celkové testy pro tento modul jsou k dispozici na Module:String/testcases.
len
Tato funkce vrací délku cílového řetězce.
Použitíː
{{#invoke:String|len|cílový_řetězec}}
nebo
{{#invoke:String|len|s= cílový_řetězec }}
Parametry:
s
- Řetězec, jehož délka se má hlásit
sub
- Tato funkce vrací podřetězec cílového řetězce se zadanými indexy.
Použitíː
{{#invoke:String|sub|cílový_řetězec|počáteční_index|konečný_index}}
nebo
{{#invoke:String|sub
|s= cílový_řetězec |i= počáteční_index |j= konečný_index }}
Parametry:
s
- Řetězec, jehož podmnožina se má vrátit
i
- První index podřetězce, který se má vrátit, má výchozí hodnotu 1.
j
- Poslední index řetězce, který se má vrátit, je výchozí na poslední znak.
Prvnímu znaku řetězce je přiřazen index 1. Pokud je i nebo j záporná hodnota, interpretuje se to stejně jako výběr znaku počítáním od konce řetězce. Hodnota -1 je tedy stejná jako výběr posledního znaku řetězce.
Pokud jsou požadované indexy mimo rozsah pro daný řetězec, je hlášena chyba.
match
Tato funkce vrací podřetězec ze zdrojového řetězce, který odpovídá zadanému vzoru.
Použitíː
{{#invoke:String|match|zdrojový_řetězec|vzorový_řetězec|počáteční_index|číslo_shody|obyčejná_značka|žádný_shodný_výstup}}
nebo
{{#invoke:String|match|s= zdrojový_řetězec |pattern= vzorový_řetězec |start= počáteční_index |match= číslo_shody |plain= obyčejná_značka |nomatch= žádný_shodný_výstup }}
Parametry:
s
- Řetězec, který se má hledat
pattern
- Vzor nebo řetězec, který se má v řetězci najít
start
- Index ve zdrojovém řetězci pro zahájení vyhledávání. První znak řetězce má index 1. Výchozí hodnota je 1.
match
- V některých případech může být možné vytvořit více shod na jednom řetězci. To určuje, která shoda se má vrátit, přičemž první shoda je
match = 1
. Pokud je zadáno záporné číslo, vrátí se shoda počítaná od poslední shody.match = -1
je tedy stejný jako požadavek na poslední zápas. Výchozí hodnota je 1. plain
- Booleovský příznak označující, že vzor by měl být chápán jako prostý text a nikoli jako Lua (programovací jazyk) ve stylu regulárního výrazu. Výchozí hodnota je
false
. nomatch
- Pokud není nalezena žádná shoda, vypíše místo chyby hodnotu "nomatch".
Pokud jsou match
nebo start
mimo rozsah pro dotazovaný řetězec, pak tato funkce vygeneruje chybu.
Chyba je také generována, pokud není nalezena žádná shoda.
Pokud přidáte parametr ignore_errors=true
, chyba bude potlačena a při každém selhání bude vrácen prázdný řetězec.
Informace o vytváření Lua vzorů, což je forma regulárního výrazu, viz:
- Lua reference: Vzory - od verze 5.1
- Scribunto vzory
- Vzory Unicode řetězců Scribunto
pos
Tato funkce vrací jeden znak z cílového řetězce na pozici pos.
Použitíː
{{#invoke:String|pos|cílový_řetězec|hodnota_indexu}}
nebo
{{#invoke:String|pos|target= cílový_řetězec |pos= hodnota_indexu }}
Parametry:
target
- Řetězec, který se má hledat
pos
- Index znaku, který se má vrátit
První znak má hodnotu indexu 1.
Pokud požadujete zápornou hodnotu, tato funkce vybere znak počítáním zpětně od konce řetězce.
Jinými slovy pos = -1
je totéž jako požadavek na poslední znak.
Požadovaná hodnota nula nebo hodnota větší než délka řetězce vrátí chybu.
find
Tato funkce umožňuje vyhledávat cílový řetězec nebo vzor v jiném řetězci.
Použitíː
{{#invoke:String|find|zdrojový_řetězec|cílový_řetězec|počáteční_index|obyčejná_značka}}
nebo
{{#invoke:String|find|source= zdrojový_řetězec |target= cílový_řetězec |start= počáteční_index |plain= obyčejná_značka }}
Parametry:
source
- Řetězec, který se má hledat
target
- Řetězec nebo vzor, který se má najít ve zdroji
start
- Index ve zdrojovém řetězci pro zahájení vyhledávání je výchozí 1
plain
- Booleovský příznak označující, že cíl by měl být chápán jako prostý text a nikoli jako Lua ve stylu regulárního výrazu, výchozí hodnota je
true
Tato funkce vrací první index >= "start", kde "target" lze nalézt v rámci "source". Indexy jsou založeny na 1. Pokud "target" není nalezen, pak tato funkce vrátí 0. Pokud chybí nebo je prázdné "source" nebo "target", tato funkce také vrátí 0.
Tato funkce by měla být bezpečná pro řetězce UTF-8.
replace
Tato funkce umožňuje nahradit cílový řetězec nebo vzor v jiném řetězci.
Použitíː
{{#invoke:String|replace|zdrojový_řetězec|vzorový_řetězec|nahradit_řetězec|počet_nahrazení|obyčejná_značka}}
nebo
{{#invoke:String|replace|source= zdrojový_řetězec |pattern= vzorový_řetězec |replace= nahradit_řetězec |count= počet_nahrazení |plain= obyčejná_značka }}
Parametry:
source
- Řetězec, který se má hledat
pattern
- Řetězec nebo vzor, který se má najít ve zdroji
replace
- Náhradní text
count
- Počet výskytů, které se mají nahradit. Výchozí pro všechny
plain
- Booleovský příznak označující, že vzor by měl být chápán jako prostý text a nikoli jako Scribunto ustring vzor (Lua ve stylu regulárního výrazu, který je vhodný pro unicode). Výchozí hodnota je
true
rep
Opakuje řetězec n krát.
Použitíː
{{#invoke:String|rep|zdroj|počet}}
Parametry:
source
- Řetězec k opakování
count
- Počet opakování.
Příklad {{#invoke:String|rep|hello|3}}
dává hellohellohello