String (Objekt)

Aus SiteparkWiki
Zur Navigation springen Zur Suche springen

Name

String - Zeichenkette

Beschreibung

Eine beliebige Zeichenkette. Ein Sonderfall für ein String-Objekt ergibt sich, wenn der String die Form einer ID hat. In diesem Fall wird das String-Objekt nicht als Zeichenkette interpretiert sondern als ID.

Attribute

Attribut Type Beschreibung ab IES Version
toLowerCase String Alle Großbuchstaben werden in Kleinbuchstaben umgewandelt. 1
toUpperCase String Alle Kleinbuchstaben werden in Großbuchstaben umgewandelt. 1
length String Länge der Zeichenkette 1
trim String Entfernt sämtliche Leerraumzeichen am Anfang und am Ende des Strings. 2.0.3.6
toJson JSONObject | JSONArray Parst den String als JSON und liefert ein JSONObject oder ein JSONArray zurück 2.9
toColor Color Parst den String als RGB-Hex-Wert und liefert ein Color-Objekt zurück 2.31

Methoden

Methode Rückgabewert Beschreibung ab IES Version
replaceAll(String regex, String replacement) String Ersetzt alle String-Teile, die auf den Regulären Ausdruck regex passen durch replacement 1
replaceFirst(String regex, String replacement) String Ersetzt den ersten String-Teil, der auf den Regulären Ausdruck regex passt durch replacement 1
matches(String regex) Boolean Liefert true, wenn der Reguläre Ausdruck regex auf diesen String passt 1
contains(String s) Boolean Liefert true, wenn s in diesem String enthalten ist 1
encrypt(String s, String s) String Encrypted den String mit dem übergebenen Algorithmus und weiteren Optionen 2.0.1
convert(String s) Boolean Konvertiert den String mit dem angegebenen Konverter 2.1.0
encode(String s) String Encodet den String mit den angegebenen Encodings 2.0.3.24
indexOf(String s) Number Findet die erste Position in der s zu finden ist 2.13
indexOf(String s, Number fromIndex) Number Findet die erste Position in der s zu finden ist. Gesucht wird ab der Position fromIndex 2.13
lastIndexOf(String s) Number Findet die letzte Position in der s zu finden ist 2.13
lastIndexOf(String s, Number fromIndex) Number Findet die letzte Position in der s zu finden ist. Gesucht wird ab der Position fromIndex 2.13
substring(Number startIndex) String Liefert einen Teil des Strings, ab der Index-Position startIndex bis zum Ende der Zeichenkette 1
substring(Number startIndex, Number endIndex) String Liefert einen Teil des Strings, ab der Index-Position startIndex bis zur Position endIndex, wobei das Zeichen des endIndex in dem Substring nicht enhalten ist 1
toCollection(String separator) Collection <String> Splittet den String mit Hilfe des Trennzeichens separator auf und liefert die einzelnen Strings in einer Collection zurück. Wird als Trennzeichen eine Zeichenkette angegeben, wird der String an allen übergebenen Zeichen aufgetrennt. 1
startsWith(String prefix) Boolean Liefert true, wenn dieser String mit prefix beginnt 1
startsWith(String prefix, Number offset) Boolean Liefert true, wenn dieser String ab der Position offset mit prefix beginnt 1
split(String regex, Number limit) Collection<String> Zerlegt die Zeichenkette anhand eines Regulären Ausdrucks in eine Collection. Wenn limit gesetzt wurde, enthält die zurückgegebene Liste höchstens limit Elemente, von denen das letzte den Rest des Strings enthält. 2.0.2.12
toPhoneNumber() PhoneNumber Parst den String als Telefonnummer und liefert ein PhoneNumber-Objekt zurück, oder null, wenn die Telefonnummer ungültig ist. 2.14.2
String replaceAll(String regex, String replacement)
Ersetzt alle String-Teile, die auf den Regulären Ausdruck regex passen durch replacement.
Parameter
String regex
Regulärer Ausdruck, mit dem die String-Teile gefunden werden, die zu ersetzen sind.
String replacement
Zeichenkette mit der die String-Teile ersetzt werden sollen.
Rückgabewert
String
Ersetzter String.
String replaceFirst(String regex, String replacement)
Ersetzt den ersten String-Teil, der auf den Regulären Ausdruck regex passt durch replacement.
Parameter
String regex
Regulärer Ausdruck, mit dem die String-Teile gefunden werden, die zu ersetzen sind.
String replacement
Zeichenkette mit der die String-Teile ersetzt werden sollen.
Rückgabewert
String
Ersetzter String.
Boolean matches(String regex)
Liefert true, wenn der Reguläre Ausdruck regex auf diesen String passt.
Parameter
String regex
Regulärer Ausdruck, mit dem die String-Teile gefunden werden sollen.
Rückgabewert
Boolean
true, wenn der Reguläre Ausdruck regex auf diesen String passt.
Boolean contains(String s)
Liefert true, wenn s in diesem String enthalten ist.
Parameter
String s
Zeichenkette mit der dieser String geprüft werden soll.
Rückgabewert
Boolean
true, wenn s in diesem String enthalten ist.

Konvertiert den String mit dem angegebenen Konverter

String convert(String s)
Konvertiert den String mit dem angegebenen Konverter
Parameter
String s
Es ist möglich eine kommaseparierte Liste von Konvertern anzugeben, die nacheinander ausgeführt werden. Gültige Werte sind:
html2text
Wandelt HTML in reinen Text um und versucht das Erscheinungsbild des Textes so gut wie möglich beizubehalten (Z.B. bei Tabellen)
striphtml
Bereinigt den Text um die Html-Tags.
wiki2html
Erzeugt aus einer Wiki-Text Syntax HTML. Weitere Informationen über Wiki-Text finden sie hier: [1]


Rückgabewert
String
Konvertierte Zeichenkette.
String encrypt(String s, String s)
Verschlüsselt die Zeichenkette mit dem übergebenen Algorithmus
Parameter
String s
Algorithmus: 3des, unixcrypt, md5, sha
String s
z.B. Zeichenkette mit dem sog. "salt" für unixcrypt
Rückgabewert
String
Verschlüsselte Zeichenkette.
String decrypt(String s)
Entschlüsselt eine Zeichenkette, die mit dem symmetrischen Verfahren 3des verschlüsselt wurde
Parameter
String s
Algorithmus: 3des
Rückgabewert
String
Entschlüsselte Zeichenkette.
String encode(String s)
Encodiert die auszugebende Zeichenkette mit dem angegebenen Encoding.
Parameter
String s
Es ist möglich eine kommaseparierte Liste von Encodings anzugeben, die nacheinander ausgeführt werden. Gültige Werte sind:
none
kein encoding
html
encoded HTML-Text
< zu &lt;
> zu &gt;
' zu &#039;
" zu &#034;
& zu &amp;
xml
encoded XML-Text
< zu &lt;
> zu &gt;
' zu &apos;
" zu &quot;
& zu &amp;
script
encoded für JavaScript, JSP, o.ä (escaped \n, \r, " und ')
\ zu \\
' zu \'
" zu \"
\n zu \\n
\r zu \\r
php (ab Version 2.1.0.44)
encoded für PHP (escaped \n, \r, $, " und ')
\ zu \\
' zu \'
" zu \"
$ zu \$
\n zu \\n
\r zu \\r
php;[KEY=VALUE;KEY=VALUE;...] (ab Version 2.12.22)
Derzeit wird nur der KEY 'ignore' aktzeptiert, um zu definieren, welche Werte NICHT encodiert werden sollen! Mögliche Werte für den KEY ::'ignore' sind:
backslash
singleQuote
doubleQuote
carriageReturn
newLine
backspace
tab
dollar
Beispiel:
php;ignore=singleQuote;ignore=newLine


url
encoded eine URL (entsprechend dem Charset des Publishers)
url; charset=latin1
encoded eine URL (mit dem übergebenen Charset)
entity
encoded alle Entitäten (jedes Zeichen wird zu seinem Entitäts-Pendant)
z.B.
A zu &#65;
[SPACE] zu &#32;
plain
encoded <, > und Zeilenenden (\n, \r, \r\n)
< zu &lt;
> zu &gt;
\n zu <br> oder <br/>\n
\r\n zu <br> oder <br/>\r\n
ascii
encoded Windows-Sonderzeichen nach ASCII
path
encoded einen Verzeichnisnamen
filename
encoded einen Dateinamen
wikitext
Erzeugt ein Wiki-Text Syntax HTML. Weitere Informationen über Wiki-Text finden sie hier: [2]
Deprecated (ab Version 2.1.0) wikitext ist kein encoding, sondern eine Konvertierung und sollte jetzt über das Attribut convert und dem Wert wiki2html verwendet werden
base64
encoded nach BASE64
base64NotChunked (ab Version 2.8)
encoded nach BASE64, fügt aber keine Zeilenumbrüche hinzu
hex
encoded nach HEX. Hierbei wird jedes Zeichen in eine Zahl umgewandelt und dessen Hex-Wert ausgegeben
escff (ab Version 2.0.3.26)
encodet alle Zeichen mit einem Byte-Wert kleiner als 128 in einen Hex-Wert, beginnend mit einem Doppelpunkt (:). Dieses Encoding wird dazu verwendet, von sp:form erzeugte Formularfelder zu encoden, wenn das Formular an eine PHP-Seite gesendet wird. Dieses Encoding ist kein Standardencoding, sondern eine proprietäre Entwicklung von Sitepark.
Rückgabewert
String
Encodete Zeichenkette.
Boolean decode(String s)
Decodiert die auszugebende Zeichenkette mit dem angegebenen Encoding.
Parameter
String s
Es ist möglich eine kommaseparierte Liste von Encodings anzugeben, die nacheinander ausgeführt werden. Gültige Werte sind:
none
kein decoding
xml
decoded XML-Text
&lt; zu <
&gt; zu >
&apos; zu '
&quot; zu "
&amp; zu &
url
decoded eine URL (entsprechend dem Charset des Publishers)
base64
decoded eine BASE64 encodete Zeichenkette
escff (ab Version 2.0.3.26)
decodet die mit dem escff-encoding encodierten Zeichenketten.
Rückgabewert
String
Decodete Zeichenkette.
Number indexOf(String s, Number fromIndex)
Findet die erste Position in der s zu finden ist. Gesucht wird ab der Position fromIndex
Parameter
String s
Zeichenkette nach der gesucht werden soll
Number fromIndex
Position ab der gesucht werden solll.
Rückgabewert
Number
Position an der der gesuchte Zeichenkette beginnt oder -1 wenn die Zeichenkette nicht gefunden werden kann.
Number lastIndexOf(String s, Number fromIndex)
Findet die letzte Position in der s zu finden ist. Gesucht wird ab der Position fromIndex
Parameter
String s
Zeichenkette nach der gesucht werden soll
Number fromIndex
Position ab der gesucht werden solll.
Rückgabewert
Number
Position an der der gesuchte Zeichenkette beginnt oder -1 wenn die Zeichenkette nicht gefunden werden kann.
String substring(Number startIndex)
Liefert einen Teil des Strings, ab der Index-Position startIndex bis zum Ende der Zeichenkette.
Parameter
Number startIndex
Startposition, ab der der neue String beginnen soll. Der Index bezieht sich auf die einzelnen Zeichen der Zeichenkette. Das erste Zeichen hat den index 0.
Rückgabewert
String
Strings, ab der Index-Position startIndex bis zum Ende der Zeichenkette.
String substring(Number startIndex, Number endIndex)
Liefert einen Teil des Strings, ab der Index-Position startIndex bis zur Position endIndex, wobei das Zeichen des endIndex in dem Substring nicht enhalten ist.
Parameter
Number startIndex
Startposition, ab der der neue String beginnen soll. Der Index bezieht sich auf die einzelnen Zeichen der Zeichenkette. Das erste Zeichen hat den index 0.
Number endIndex
Endposition, bis zu der der neue String gehen soll. Der Index bezieht sich auf die einzelnen Zeichen der Zeichenkette. Das erste Zeichen hat den index 0. Das mit endindex angegebene Zeichen ist in dem neuen String nicht enthalten (das letzte Zeichen des neuen Strings ist somit endIndex-1).
Rückgabewert
String
Strings, ab der Index-Position startIndex bis zur Position endIndex, wobei das Zeichen des endIndex in dem Substring nicht enhalten ist.
Collection <String> toCollection(String separator)
Splittet den String mit Hilfe des Trennzeichens separator auf und liefert die einzelnen Strings in einer Collection zurück. Wird als Trennzeichen eine Zeichenkette angegeben, wird der String an allen übergebenen Zeichen aufgetrennt.
Parameter
String separator
Trennzeichen, der die einzelnen Zeichenketten unterteilt.
Rückgabewert
Collection
Liste aus String-Objekten.
Boolean startsWith(String prefix)
Liefert true, wenn dieser String mit prefix beginnt.
Parameter
String prefix
Prefix, mit dem der String verglichen wird.
Rückgabewert
Boolean
true, wenn dieser String mit prefix beginnt.
Boolean startsWith(String prefix, Number offset)
Liefert true, wenn dieser String ab der Position offset mit prefix beginnt.
Parameter
String prefix
Prefix, mit dem der String verglichen wird.
Number offset
Position, ab der dieser String mit prefix verglichen werden soll. Der Offset bezieht sich auf die einzelnen Zeichen der Zeichenkette. Das erste Zeichen hat den Offset 0.
Rückgabewert
Boolean
true, wenn dieser String ab der Position offset mit prefix beginnt.
Collection<String> split(String regex, Number limit)
Zerlegt die Zeichenkette anhand eines Regulären Ausdrucks in eine Collection. Wenn limit gesetzt wurde, enthält die zurückgegebene Liste höchstens limit Elemente, von denen das letzte den Rest des Strings enthält.
Parameter
String regex
Regulärer Ausdruck mit dem die Zeichenkette zerlegt werden soll.
Number limit
Maximale Anzahl der Element, die in der Liste enthalten sein sollen.
Rückgabewert
Collection<String> Die zerlegte Liste