"Modül:Dizgi/belge" sayfasını değiştirmektesiniz

{{karıştırma|Modül:Dizi}}
{{ml|module=string}}

Bu modülle temel string (karakter dizisi) işlemleri yapılabilmektedir.

Eğer isimli parametreler kullanılırsa, string'lerin etrafındaki boşlukları
MediaWiki yazılımı otomatik olarak silecektir.
Eğer anonim parametreler kullanılırsa, otomatik boşluk silme 
gerçekleşmeyecektir.
Buna göre anonim ve isimli parametre tercihi yapabilirsiniz.

== Hata durumları ile ilgili küresel seçenekler ==
;ignore_errors
:'true' veya 1 diye verilirse, hata mesajı çıkmayacak ve sonuç olarak boş string geri döndürülecektir.  

;error_category
:Hata olduğunda sayfanın ekleneceği kategoriyi bu seçenekle  belirtebilirsiniz. Varsayılan değer: Kategori:Errors reported by Module String .

;no_category
:'true' veya 1 diye verilirse, hata da oluşsa sayfa hata kategorisine eklenmeyecektir.

== len ==

:Bu fonksiyon verilen string'in uzunluğunu döndürür. 

=== İsimli parametreler ===
:s: Uzunluğu bulunacak string

=== Kullanım ===
;Anonim parametre ile (string'in etrafındaki boşluklar aynen kalacaktır):
<code><nowiki>{{#invoke:String|len|ilgili_string}}</nowiki></code> 

;İsimli parametre ile (string'in etrafındaki boşluklar silinecektir):
<code><nowiki>{{#invoke:String|len|s=ilgili_string}}</nowiki></code>


;Örnek:
* <nowiki>{{#invoke:String|len|s=Türkiye }}</nowiki>   sonuç: {{#invoke:String|len|s=Türkiye }}
* <nowiki>{{#invoke:String|len|Türkiye }}</nowiki>   sonuç: {{#invoke:String|len|Türkiye }}

== sub ==

: Bu fonksiyon verilen string'in verilen indislere göre alt karakter dizilerini bulur ve döndürür.

=== İsimli parametreler ===
:s: Uzunluğu bulunacak string
:i: Karakter alt dizisi için başlangıç indisi. Varsayılan: 1
:j: Karakter alt dizisi için bitiş indisi. Varsayılan: sonuna kadar

=== Kullanım ===
;Anonim parametreler ile (string'in etrafındaki boşluklar aynen kalacaktır):
<code><nowiki>{{#invoke:String|sub|ilgili_string|ilk_indis|son_indis}}</nowiki></code>

;İsimli parametreler ile (string'in etrafındaki boşluklar silinecektir):
<code><nowiki>{{#invoke:String|sub|s=ilgili_string|i=ilk_indis|j=son_indis}}</nowiki></code>

;Notlar: 
* Parametreler, hem isimli, hem anonim karışık da verilebilir.
* Karakter alt dizisinin uzunluğu normal durumlarda (j-i+1) olacaktır.
:*Normal durum: 1<=i<=j<=string uzunluğu
* i ve j negatif de seçilebilir. Bu durumda indis, string'in sonundan geriye kaçıncı sırada başlanılacağını belirtir. Örneğin, -1 verilirse en sağdaki karakter, -4 verilirse en sağdan 4. karakter ile başlanılacak/bitirilecektir.

;Örnekler:
:<code><nowiki>{{#invoke:String|sub|s=Türkiye|2|5}}</nowiki></code>    sonuç: {{#invoke:String|sub|s=Türkiye|2|5}} 
:<code><nowiki>{{#invoke:String|sub|s=Türkiye|2}}</nowiki></code>    sonuç: {{#invoke:String|sub|s=Türkiye|2}}
:<code><nowiki>{{#invoke:String|sub|s=Türkiye|-3|-2}}</nowiki></code>    sonuç: {{#invoke:String|sub|s=Türkiye|-3|-2}}
:<code><nowiki>{{#invoke:String|sub|s=Türkiye|-1}}</nowiki></code>    sonuç: {{#invoke:String|sub|s=Türkiye|-1}}

;Hata durumları
Verilen indislerle string sınırlarının dışına çıkılıyorsa hata oluşacaktır.

:<code><nowiki>{{#invoke:String|sub|s=Türkiye|3|13}}</nowiki></code>   hata çünkü 13> 7 = string uzunluğu .
:<code><nowiki>{{#invoke:String|sub|s=Türkiye|6|3}}</nowiki></code>    hata çünkü ilk indis daha büyük.

== match ==

This function returns a substring from the source string that matches a specified pattern.

Usage:

: <code><nowiki>{{#invoke:</nowiki>String|match|''source_string''|''pattern_string''|''start_index''|''match_number''|''plain_flag''|''nomatch_output''}}</code>

OR

: <code><nowiki>{{#invoke:</nowiki>String|match|s= ''source_string'' |pattern= ''pattern_string'' |start= ''start_index''|match= ''match_number''|plain= ''plain_flag'' |nomatch= ''nomatch_output'' }}</code>

Parameters:

; s
: The string to search
; pattern
: The pattern or string to find within the string
; start
: The index within the source string to start the search.  The first character of the string has index 1.  Defaults to 1.
; match
: In some cases it may be possible to make multiple matches on a single string.  This specifies which match to return, where the first match is match= 1.  If a negative number is specified then a match is returned counting from the last match.  Hence match = -1 is the same as requesting the last match.  Defaults to 1.
; plain
: Boolean flag indicating that pattern should be understood as plain text and not as a [[w:en:Lua (programming language)|Lua]]-style [[w:en:regular expression|regular expression]]. Defaults to false (to change: <code>plain=true</code>)
; nomatch
: If no match is found, output the "nomatch" value rather than an error.

If the match_number or start_index are out of range for the string being queried, then this function generates an error.  An error is also generated if no match is found.
If one adds the parameter ignore_errors=true, then the error will be suppressed and an empty string will be returned on any failure.

For information on constructing [[w:en:Lua (programming language)|Lua]] patterns, a form of [[w:en:regular expression|regular expression]], see:

* [[mw:Extension:Scribunto/Lua_reference_manual#Patterns|Scribunto patterns]]
* [[mw:Extension:Scribunto/Lua_reference_manual#Ustring_patterns|Scribunto Unicode string patterns]]

== pos ==

This function returns a single character from the target string at position pos.

Usage:

: <code><nowiki>{{#invoke:</nowiki>String|pos|''target_string''|''index_value''}}</code>

OR

: <code><nowiki>{{#invoke:</nowiki>String|pos|target= ''target_string'' |pos= ''index_value'' }}</code>

Parameters:

; target
: The string to search
; pos
: The index for the character to return

The first character has an index value of 1.

If one requests a negative value, this function will select a character by counting backwards
from the end of the string.  In other words pos = -1 is the same as asking for the last character.

A requested value of zero, or a value greater than the length of the string returns an error.

== find ==

This function allows one to search for a target string or pattern within another string.

Usage:

: <code><nowiki>{{#invoke:</nowiki>String|find|''source_str''|''target_string''|''start_index''|''plain_flag''}}</code>

OR

: <code><nowiki>{{#invoke:</nowiki>String|find|source= ''source_str'' |target= ''target_str'' |start= ''start_index''|plain= ''plain_flag'' }}</code>

Parameters:

; source
: The string to search
; target
: The string or pattern to find within source
; start
: The index within the source string to start the search, defaults to 1
; plain
: Boolean flag indicating that target should be understood as plain text and not as a [[w:en:Lua (programming language)|Lua]]-style [[w:en:regular expression|regular expression]], defaults to true

This function returns the first index >= "start" where "target" can be found within "source".  Indices are 1-based.  If "target" is not found, then this function returns 0.  If either "source" or "target" are missing / empty, this function also returns 0.

This function should be safe for UTF-8 strings.

== replace ==

This function allows one to replace a target string or pattern within another string.

Usage:

: <code><nowiki>{{#invoke:</nowiki>String|replace|''source_str''|''pattern_string''|''replace_string''|''replacement_count''|''plain_flag''}}</code>

OR

: <code><nowiki>{{#invoke:</nowiki>String|replace|source= ''source_string'' |pattern= ''pattern_string''|replace= ''replace_string'' |count= ''replacement_count'' |plain= ''plain_flag'' }}</code>

Parameters:

; source
: The string to search
; pattern
: The string or pattern to find within source
; replace
: The replacement text
; count
: The number of occurrences to replace; defaults to all
; plain
: Boolean flag indicating that pattern should be understood as plain text and not as a [[mw:Extension:Scribunto/Lua reference manual#Ustring patterns|Scribunto ustring pattern]] (a unicode-friendly [[w:en:Lua (programming language)|Lua]]-style [[w:en:regular expression|regular expression]]); defaults to true

== rep ==

Repeats a string ''n'' times. A simple function to pipe string.rep to templates.
Usage:

: <code><nowiki>{{#invoke:</nowiki>String|rep|''source''|''count''}}</code>

Parameters:

; source
: The string to repeat
; count
: The number of repetitions.

Example <code><nowiki>{{#invoke:String|rep|hello|3}}</nowiki></code> gives {{#invoke:String|rep|hello|3}}

== See also ==
*[[Module:String2]] for functions to convert the capitalisation of strings to upper, lower, sentence or title case.
*[[Module:StringFunc]]
*[[Module:Str endswith]]

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||

[[Category:Lua metamodules|String, {{PAGENAME}}]]
[[Category:Modules that add a tracking category]]

}}</includeonly><noinclude>[[en:Module:String/doc]]</noinclude>