PHP - substr

Třída

Kořen \ Bez třídy

Metoda - substr

(PHP 4, PHP 5, PHP 7)

Funkce vrací část textového řetězce, tzv. podřetězec, podle zadaných parametrů.

Procedurální

• function substr (string $string, int $start, int $length) : string

Parametry

Název	Datový typ	Výchozí hodnota	Popis
$string	string		Textový řetězec, kterého část chceme získat. Musí obsahovat minimálně jeden znak.
$start	int		Určuje počáteční pozici, od které chceme získat část textového řetězce. Parametr může být: kladné číslo: začátek se počítá od začátku textového řetězce. záporné číslo: začátek se počítá od konce textového řetězce a další pozice postupují směrem zprava doleva.
$length	int		Určuje délku podřetězce od počáteční pozice (druhý parametr), který chceme získat z hlavního textového řetězce (první parametr). Když není zadán, funkce vrací textový řetězec od počátečního bodu až do konce řetězce. Když je zadán jako: kladné číslo - Podřetězec bude dlouhý maximálně daný počet znaků, které budou začínat od startovní pozice původního řetězce záporné číslo - Od konce řetězce se vynechá tolik znaků, kolik je uvedeno a řetězec bude začínat od startovní pozice. Pokud zadáme takové číslo, že konec předběhne startovní pozici, vrátí funkce hodnotu false.

Návratové hodnoty

Vrací: string

Vrací požadovanou část z hlavního textového řetězce. V případě, že je výsledný textový řetězec prázdny (""), nebo funkce nebyla schopná vrátit žádnou hodnotu, tak vrací false.

Příklady

V ukázce se podíváme na různé výstupy funkce na základě zadaných parametrů.

<?php
$text = "Chuck Norris napocital do nekonecna. Dvakrat!";
echo substr($text, 5) . "<br>"; // Norris napocital do nekonecna. Dvakrat!
echo substr($text, -20) . "<br>"; // nekonecna. Dvakrat!
echo substr($text, 7, 12) . "<br>"; // orris napoci
echo substr($text, 2, -10) . "<br>"; // uck Norris napocital do nekonecna
echo substr($text, -20, 12) . "<br>"; // nekonecna.
echo substr($text, -17, -3) . "<br>"; // konecna. Dvakr
echo substr($text, -17, -18) ? substr($text, -17, -18) . "<br>" : "Vrací false <br>";
echo substr($text, 2, 0) ? substr($text, -17, -18) . "<br>" : "Vrací false <br>";