substr-funktio
substr-funktio poimii ja palauttaa
osamerkkijonon merkkijonosta. Itse merkkijono ei
muutu. Ensimmäisenä parametrina funktio
ottaa merkkijonon, toisena - merkin position,
josta poiminta alkaa, ja kolmantena
- merkkien määrän. Huomaa, että merkkijonon
merkkien numerointi alkaa nollasta.
Toinen parametri voi olla negatiivinen
- tässä tapauksessa laskenta alkaa merkkijonon lopusta,
jolloin viimeisen merkin numero on
-1.
Kolmannen parametrin voi jättää määrittelemättä - tässä tapauksessa leikkaus tapahtuu merkkijonon loppuun asti.
Funktio käsittelee oikein vain latinalaisia merkkejä (yksitavuisia merkkejä).
Syntaksi
substr(string $string, int $offset, ?int $length = null): string
Esimerkki
Poimitaan 3 merkkiä merkkijonosta
position 1 alkaen (toisesta merkistä, koska
ensimmäinen on numero 0):
<?php
echo substr('abcde', 1, 3);
?>
Koodin suorituksen tulos:
'bcd'
Esimerkki
Poimitaan kaikki merkit merkkijonon loppuun asti, aloittaen toisesta (sen numero on 1):
<?php
echo substr('abcde', 1);
?>
Koodin suorituksen tulos:
'bcde'
Esimerkki
Poimitaan kolmas ja toinen merkki
lopusta, asetetaan poiminnan alku
-3 (tämä on kolmannen merkin numero lopusta),
ja merkkien määrä - 2:
<?php
echo substr('abcde', -3, 2);
?>
Koodin suorituksen tulos:
'cd'
Esimerkki
Poimitaan 2 viimeistä merkkiä,
asetetaan toiseksi viimeisen merkin position
(tämä on -2), ja kolmatta parametria ei aseteta - tässä
tapauksessa leikkaus tapahtuu merkkijonon loppuun asti:
<?php
echo substr('abcde', -2);
?>
Koodin suorituksen tulos:
'de'
Esimerkki
Poimitaan viimeinen merkki:
<?php
echo substr('abcde', -1);
?>
Koodin suorituksen tulos:
'e'
Katso myös
-
funktion
substr_replace,
joka poimii osan merkkijonosta ja korvaa sen toisella