Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Fonctions membres publiques | Fonctions membres publiques statiques | Champs de données | Attributs protégés
Référence de la classe AbstractString
+ Graphe d'héritage de AbstractString:

Fonctions membres publiques

 __construct (string $string='')
 
 after ($needle, bool $includeNeedle=false, int $offset=0)
 
 afterLast ($needle, bool $includeNeedle=false, int $offset=0)
 
 append (string ... $suffix)
 
 before ($needle, bool $includeNeedle=false, int $offset=0)
 
 beforeLast ($needle, bool $includeNeedle=false, int $offset=0)
 
 bytesAt (int $offset)
 
 camel ()
 
 chunk (int $length=1)
 
 collapseWhitespace ()
 
 containsAny ($needle)
 
 endsWith ($suffix)
 
 ensureEnd (string $suffix)
 
 ensureStart (string $prefix)
 
 equalsTo ($string)
 
 folded ()
 
 ignoreCase ()
 
 indexOf ($needle, int $offset=0)
 
 indexOfLast ($needle, int $offset=0)
 
 isEmpty ()
 
 join (array $strings, string $lastGlue=null)
 
 jsonSerialize ()
 
 length ()
 
 lower ()
 
 match (string $regexp, int $flags=0, int $offset=0)
 
 padBoth (int $length, string $padStr=' ')
 
 padEnd (int $length, string $padStr=' ')
 
 padStart (int $length, string $padStr=' ')
 
 prepend (string ... $prefix)
 
 repeat (int $multiplier)
 
 replace (string $from, string $to)
 
 replaceMatches (string $fromRegexp, $to)
 
 reverse ()
 
 slice (int $start=0, int $length=null)
 
 snake ()
 
 splice (string $replacement, int $start=0, int $length=null)
 
 split (string $delimiter, int $limit=null, int $flags=null)
 
 startsWith ($prefix)
 
 title (bool $allWords=false)
 
 toByteString (string $toEncoding=null)
 
 toCodePointString ()
 
 toString ()
 
 toUnicodeString ()
 
 trim (string $chars=" \\\B\C\A0}\FEFF}")
 
 trimEnd (string $chars=" \\\B\C\A0}\FEFF}")
 
 trimPrefix ($prefix)
 
 trimStart (string $chars=" \\\B\C\A0}\FEFF}")
 
 trimSuffix ($suffix)
 
 truncate (int $length, string $ellipsis='', bool $cut=true)
 
 upper ()
 
 width (bool $ignoreAnsiDecoration=true)
 
 wordwrap (int $width=75, string $break="\, bool $cut=false)
 
 __sleep ()
 
 __clone ()
 
 __toString ()
 

Fonctions membres publiques statiques

static unwrap (array $values)
 
static wrap (array $values)
 

Champs de données

const PREG_PATTERN_ORDER = \PREG_PATTERN_ORDER
 
const PREG_SET_ORDER = \PREG_SET_ORDER
 
const PREG_OFFSET_CAPTURE = \PREG_OFFSET_CAPTURE
 
const PREG_UNMATCHED_AS_NULL = \PREG_UNMATCHED_AS_NULL
 
const PREG_SPLIT = 0
 
const PREG_SPLIT_NO_EMPTY = \PREG_SPLIT_NO_EMPTY
 
const PREG_SPLIT_DELIM_CAPTURE = \PREG_SPLIT_DELIM_CAPTURE
 
const PREG_SPLIT_OFFSET_CAPTURE = \PREG_SPLIT_OFFSET_CAPTURE
 

Attributs protégés

 $string = ''
 
 $ignoreCase = false
 

Description détaillée

Represents a string of abstract characters.

Unicode defines 3 types of "characters" (bytes, code points and grapheme clusters). This class is the abstract type to use as a type-hint when the logic you want to implement doesn't care about the exact variant it deals with.

Auteur
Nicolas Grekas p@tch.nosp@m.work.nosp@m..com
Hugo Hamon hugoh.nosp@m.amon.nosp@m.@neuf.nosp@m..fr
Exceptions
ExceptionInterface

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( string  $string = '')
abstract

Documentation des fonctions membres

◆ __clone()

__clone ( )

Références AbstractString\ignoreCase().

◆ __sleep()

__sleep ( )

◆ __toString()

__toString ( )

Références AbstractString\$string.

◆ after()

after (   $needle,
bool  $includeNeedle = false,
int  $offset = 0 
)
Paramètres
string|string[]$needle
Renvoie
static

Références $i, $n, Joomla\Database\Query\$offset, $this, AbstractString\indexOf(), null, et AbstractString\slice().

◆ afterLast()

afterLast (   $needle,
bool  $includeNeedle = false,
int  $offset = 0 
)
Paramètres
string|string[]$needle
Renvoie
static

Références $i, $n, Joomla\Database\Query\$offset, $this, AbstractString\indexOfLast(), null, et AbstractString\slice().

◆ append()

append ( string ...  $suffix)
abstract
Renvoie
static

Référencé par AbstractString\ensureEnd().

◆ before()

before (   $needle,
bool  $includeNeedle = false,
int  $offset = 0 
)
Paramètres
string|string[]$needle
Renvoie
static

Références $i, $n, Joomla\Database\Query\$offset, $this, AbstractString\indexOf(), null, et AbstractString\slice().

◆ beforeLast()

beforeLast (   $needle,
bool  $includeNeedle = false,
int  $offset = 0 
)
Paramètres
string|string[]$needle
Renvoie
static

Références $i, $n, Joomla\Database\Query\$offset, $this, AbstractString\indexOfLast(), null, et AbstractString\slice().

◆ bytesAt()

bytesAt ( int  $offset)
Renvoie
int[]

Références AbstractString\slice().

◆ camel()

camel ( )
abstract
Renvoie
static

◆ chunk()

chunk ( int  $length = 1)
abstract
Renvoie
static[]

◆ collapseWhitespace()

collapseWhitespace ( )
Renvoie
static

Références $this, et AbstractString\trim().

◆ containsAny()

containsAny (   $needle)
Paramètres
string|string[]$needle

Références AbstractString\indexOf(), et null.

◆ endsWith()

endsWith (   $suffix)
Paramètres
string|string[]$suffix

Références $suffix, et class.

Référencé par AbstractString\ensureEnd().

◆ ensureEnd()

ensureEnd ( string  $suffix)
Renvoie
static

Références $suffix, AbstractString\append(), AbstractString\endsWith(), et AbstractString\replaceMatches().

◆ ensureStart()

ensureStart ( string  $prefix)
Renvoie
static

Références $i, $prefix, $this, AbstractString\indexOf(), AbstractString\prepend(), et AbstractString\startsWith().

◆ equalsTo()

equalsTo (   $string)
Paramètres
string|string[]$string

Références AbstractString\$string, et class.

◆ folded()

folded ( )
abstract
Renvoie
static

◆ ignoreCase()

ignoreCase ( )
Renvoie
static

Références $this.

Référencé par UnicodeString\__clone(), AbstractString\__clone(), CodePointString\endsWith(), UnicodeString\endsWith(), ByteString\endsWith(), CodePointString\equalsTo(), UnicodeString\equalsTo(), ByteString\equalsTo(), CodePointString\indexOf(), UnicodeString\indexOf(), ByteString\indexOf(), CodePointString\indexOfLast(), UnicodeString\indexOfLast(), ByteString\indexOfLast(), ByteString\match(), CodePointString\replace(), UnicodeString\replace(), ByteString\replace(), ByteString\replaceMatches(), CodePointString\split(), UnicodeString\split(), ByteString\split(), AbstractString\split(), CodePointString\startsWith(), UnicodeString\startsWith(), ByteString\startsWith(), AbstractString\trimPrefix(), et AbstractString\trimSuffix().

◆ indexOf()

indexOf (   $needle,
int  $offset = 0 
)
Paramètres
string|string[]$needle

Références $i, $n, Joomla\Database\Query\$offset, class, et null.

Référencé par AbstractString\after(), AbstractString\before(), AbstractString\containsAny(), AbstractString\ensureStart(), et AbstractString\truncate().

◆ indexOfLast()

indexOfLast (   $needle,
int  $offset = 0 
)
Paramètres
string|string[]$needle

Références $i, $n, Joomla\Database\Query\$offset, class, et null.

Référencé par AbstractString\afterLast(), et AbstractString\beforeLast().

◆ isEmpty()

isEmpty ( )

Références AbstractString\$string.

◆ join()

join ( array  $strings,
string  $lastGlue = null 
)
abstract
Renvoie
static

◆ jsonSerialize()

jsonSerialize ( )

Références AbstractString\$string.

◆ length()

length ( )
abstract

Référencé par AbstractString\truncate().

◆ lower()

lower ( )
abstract
Renvoie
static

◆ match()

match ( string  $regexp,
int  $flags = 0,
int  $offset = 0 
)
abstract

Matches the string using a regular expression.

Pass PREG_PATTERN_ORDER or PREG_SET_ORDER as $flags to get all occurrences matching the regular expression.

Renvoie
array All matches in a multi-dimensional array ordered according to flags

◆ padBoth()

padBoth ( int  $length,
string  $padStr = ' ' 
)
abstract
Renvoie
static

◆ padEnd()

padEnd ( int  $length,
string  $padStr = ' ' 
)
abstract
Renvoie
static

◆ padStart()

padStart ( int  $length,
string  $padStr = ' ' 
)
abstract
Renvoie
static

◆ prepend()

prepend ( string ...  $prefix)
abstract
Renvoie
static

Référencé par AbstractString\ensureStart().

◆ repeat()

repeat ( int  $multiplier)
Renvoie
static

Références $this.

◆ replace()

replace ( string  $from,
string  $to 
)
abstract
Renvoie
static

◆ replaceMatches()

replaceMatches ( string  $fromRegexp,
  $to 
)
abstract
Paramètres
string | callable$to
Renvoie
static

Référencé par AbstractString\ensureEnd().

◆ reverse()

reverse ( )
abstract
Renvoie
static

◆ slice()

slice ( int  $start = 0,
int  $length = null 
)
abstract
Renvoie
static

Référencé par AbstractString\after(), AbstractString\afterLast(), AbstractString\before(), AbstractString\beforeLast(), AbstractString\bytesAt(), et AbstractString\truncate().

◆ snake()

snake ( )
abstract
Renvoie
static

◆ splice()

splice ( string  $replacement,
int  $start = 0,
int  $length = null 
)
abstract
Renvoie
static

◆ split()

split ( string  $delimiter,
int  $limit = null,
int  $flags = null 
)
Renvoie
static[]

Références $limit, $this, AbstractString\ignoreCase(), et null.

Référencé par AbstractString\wordwrap().

◆ startsWith()

startsWith (   $prefix)
Paramètres
string|string[]$prefix

Références $prefix, et class.

Référencé par AbstractString\ensureStart().

◆ title()

title ( bool  $allWords = false)
abstract
Renvoie
static

◆ toByteString()

toByteString ( string  $toEncoding = null)

Références $b, AbstractString\$string, $this, et null.

◆ toCodePointString()

toCodePointString ( )

Référencé par ByteString\toUnicodeString().

◆ toString()

toString ( )

Références AbstractString\$string.

◆ toUnicodeString()

toUnicodeString ( )

◆ trim()

trim ( string  $chars = " \\\B\C\A0}\FEFF}")
abstract
Renvoie
static

Référencé par AbstractString\collapseWhitespace().

◆ trimEnd()

trimEnd ( string  $chars = " \\\B\C\A0}\FEFF}")
abstract
Renvoie
static

◆ trimPrefix()

trimPrefix (   $prefix)
Paramètres
string|string[]$prefix
Renvoie
static

Références $prefix, $this, et AbstractString\ignoreCase().

◆ trimStart()

trimStart ( string  $chars = " \\\B\C\A0}\FEFF}")
abstract
Renvoie
static

◆ trimSuffix()

trimSuffix (   $suffix)
Paramètres
string|string[]$suffix
Renvoie
static

Références $suffix, $this, AbstractString\ignoreCase(), et null.

◆ truncate()

truncate ( int  $length,
string  $ellipsis = '',
bool  $cut = true 
)
Renvoie
static

Références $this, AbstractString\indexOf(), AbstractString\length(), null, et AbstractString\slice().

◆ unwrap()

static unwrap ( array  $values)
static

Unwraps instances of AbstractString back to strings.

Renvoie
string[]|array

Références elseif.

◆ upper()

upper ( )
abstract
Renvoie
static

◆ width()

width ( bool  $ignoreAnsiDecoration = true)
abstract

Returns the printable length on a terminal.

◆ wordwrap()

wordwrap ( int  $width = 75,
string  $break = "\n",
bool  $cut = false 
)
Renvoie
static

Références $b, $i, AbstractString\$string, $this, $width, et AbstractString\split().

◆ wrap()

static wrap ( array  $values)
static

Wraps (and normalizes) strings in instances of AbstractString.

Renvoie
static[]|array

Références $i, elseif, et null.

Documentation des champs

◆ $ignoreCase

$ignoreCase = false
protected

◆ $string

$string = ''
protected

Référencé par CodePointString\__construct(), ByteString\__construct(), UnicodeString\__construct(), AbstractString\__toString(), CodePointString\equalsTo(), UnicodeString\equalsTo(), ByteString\equalsTo(), AbstractString\equalsTo(), AbstractUnicodeString\fromCodePoints(), UnicodeString\indexOfLast(), AbstractString\isEmpty(), AbstractString\jsonSerialize(), ByteString\replaceMatches(), UnicodeString\split(), AbstractString\toByteString(), ByteString\toCodePointString(), AbstractString\toString(), ByteString\width(), et AbstractString\wordwrap().

◆ PREG_OFFSET_CAPTURE

const PREG_OFFSET_CAPTURE = \PREG_OFFSET_CAPTURE

◆ PREG_PATTERN_ORDER

const PREG_PATTERN_ORDER = \PREG_PATTERN_ORDER

Référencé par ByteString\match().

◆ PREG_SET_ORDER

const PREG_SET_ORDER = \PREG_SET_ORDER

Référencé par ByteString\match().

◆ PREG_SPLIT

const PREG_SPLIT = 0

◆ PREG_SPLIT_DELIM_CAPTURE

const PREG_SPLIT_DELIM_CAPTURE = \PREG_SPLIT_DELIM_CAPTURE

Référencé par CodePointString\chunk(), et UnicodeString\chunk().

◆ PREG_SPLIT_NO_EMPTY

const PREG_SPLIT_NO_EMPTY = \PREG_SPLIT_NO_EMPTY

Référencé par CodePointString\chunk(), et UnicodeString\chunk().

◆ PREG_SPLIT_OFFSET_CAPTURE

const PREG_SPLIT_OFFSET_CAPTURE = \PREG_SPLIT_OFFSET_CAPTURE

◆ PREG_UNMATCHED_AS_NULL

const PREG_UNMATCHED_AS_NULL = \PREG_UNMATCHED_AS_NULL

Référencé par ByteString\match().

La documentation de cette classe a été générée à partir du fichier suivant :