1. class
  2. Illuminate
  3. Support
  4. Str

Str

class Str (View source)

Traits

Macroable

Methods

static  void
macro( string $name, callable $macro)

Register a custom macro.

from Macroable
static  bool
hasMacro( string $name)

Checks if macro is registered.

from Macroable
static  mixed
__callStatic( string $method, array $parameters)

Dynamically handle calls to the class.

from Macroable
mixed
__call( string $method, array $parameters)

Dynamically handle calls to the class.

from Macroable
static  string
ascii( string $value)

Transliterate a UTF-8 value to ASCII.

static  string
camel( string $value)

Convert a value to camel case.

static  bool
contains( string $haystack, string|array $needles)

Determine if a given string contains a given substring.

static  bool
endsWith( string $haystack, string|array $needles)

Determine if a given string ends with a given substring.

static  string
finish( string $value, string $cap)

Cap a string with a single instance of a given value.

static  bool
is( string $pattern, string $value)

Determine if a given string matches a given pattern.

static  int
length( string $value)

Return the length of the given string.

static  string
limit( string $value, int $limit = 100, string $end = '...')

Limit the number of characters in a string.

static  string
lower( string $value)

Convert the given string to lower-case.

static  string
words( string $value, int $words = 100, string $end = '...')

Limit the number of words in a string.

static  array
parseCallback( string $callback, string $default)

Parse a Class@method style callback into class and method.

static  string
plural( string $value, int $count = 2)

Get the plural form of an English word.

static  string
random( int $length = 16)

Generate a more truly "random" alpha-numeric string.

static  string
randomBytes( int $length = 16)

Generate a more truly "random" bytes.

static  string
quickRandom( int $length = 16)

Generate a "random" alpha-numeric string.

static  bool
equals( string $knownString, string $userInput)

Compares two strings using a constant-time algorithm.

static  string
replaceFirst( string $search, string $replace, string $subject)

Replace the first occurrence of a given value in the string.

static  string
replaceLast( string $search, string $replace, string $subject)

Replace the last occurrence of a given value in the string.

static  string
upper( string $value)

Convert the given string to upper-case.

static  string
title( string $value)

Convert the given string to title case.

static  string
singular( string $value)

Get the singular form of an English word.

static  string
slug( string $title, string $separator = '-')

Generate a URL friendly "slug" from a given string.

static  string
snake( string $value, string $delimiter = '_')

Convert a string to snake case.

static  bool
startsWith( string $haystack, string|array $needles)

Determine if a given string starts with a given substring.

static  string
studly( string $value)

Convert a value to studly caps case.

static  string
substr( string $string, int $start, int|null $length = null)

Returns the portion of string specified by the start and length parameters.

static  string
ucfirst( string $string)

Make a string's first character uppercase.

Details

in Macroable at line line 24
static void macro( string $name, callable $macro)

Register a custom macro.

Parameters

string $name
callable $macro

Return Value

void

in Macroable at line line 35
static bool hasMacro( string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line line 49
static mixed __callStatic( string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line line 71
mixed __call( string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line line 38
static string ascii( string $value)

Transliterate a UTF-8 value to ASCII.

Parameters

string $value

Return Value

string

at line line 53
static string camel( string $value)

Convert a value to camel case.

Parameters

string $value

Return Value

string

at line line 69
static bool contains( string $haystack, string|array $needles)

Determine if a given string contains a given substring.

Parameters

string $haystack
string|array $needles

Return Value

bool

at line line 87
static bool endsWith( string $haystack, string|array $needles)

Determine if a given string ends with a given substring.

Parameters

string $haystack
string|array $needles

Return Value

bool

at line line 105
static string finish( string $value, string $cap)

Cap a string with a single instance of a given value.

Parameters

string $value
string $cap

Return Value

string

at line line 119
static bool is( string $pattern, string $value)

Determine if a given string matches a given pattern.

Parameters

string $pattern
string $value

Return Value

bool

at line line 141
static int length( string $value)

Return the length of the given string.

Parameters

string $value

Return Value

int

at line line 154
static string limit( string $value, int $limit = 100, string $end = '...')

Limit the number of characters in a string.

Parameters

string $value
int $limit
string $end

Return Value

string

at line line 169
static string lower( string $value)

Convert the given string to lower-case.

Parameters

string $value

Return Value

string

at line line 182
static string words( string $value, int $words = 100, string $end = '...')

Limit the number of words in a string.

Parameters

string $value
int $words
string $end

Return Value

string

at line line 200
static array parseCallback( string $callback, string $default)

Parse a Class@method style callback into class and method.

Parameters

string $callback
string $default

Return Value

array

at line line 212
static string plural( string $value, int $count = 2)

Get the plural form of an English word.

Parameters

string $value
int $count

Return Value

string

at line line 223
static string random( int $length = 16)

Generate a more truly "random" alpha-numeric string.

Parameters

int $length

Return Value

string

at line line 246
static string randomBytes( int $length = 16)

Generate a more truly "random" bytes.

Parameters

int $length

Return Value

string

at line line 259
static string quickRandom( int $length = 16)

Generate a "random" alpha-numeric string.

Should not be considered sufficient for cryptography, etc.

Parameters

int $length

Return Value

string

at line line 279
static bool equals( string $knownString, string $userInput)

Compares two strings using a constant-time algorithm.

Note: This method will leak length information.

Note: Adapted from Symfony\Component\Security\Core\Util\StringUtils.

Parameters

string $knownString
string $userInput

Return Value

bool

at line line 292
static string replaceFirst( string $search, string $replace, string $subject)

Replace the first occurrence of a given value in the string.

Parameters

string $search
string $replace
string $subject

Return Value

string

at line line 311
static string replaceLast( string $search, string $replace, string $subject)

Replace the last occurrence of a given value in the string.

Parameters

string $search
string $replace
string $subject

Return Value

string

at line line 328
static string upper( string $value)

Convert the given string to upper-case.

Parameters

string $value

Return Value

string

at line line 339
static string title( string $value)

Convert the given string to title case.

Parameters

string $value

Return Value

string

at line line 350
static string singular( string $value)

Get the singular form of an English word.

Parameters

string $value

Return Value

string

at line line 362
static string slug( string $title, string $separator = '-')

Generate a URL friendly "slug" from a given string.

Parameters

string $title
string $separator

Return Value

string

at line line 387
static string snake( string $value, string $delimiter = '_')

Convert a string to snake case.

Parameters

string $value
string $delimiter

Return Value

string

at line line 411
static bool startsWith( string $haystack, string|array $needles)

Determine if a given string starts with a given substring.

Parameters

string $haystack
string|array $needles

Return Value

bool

at line line 428
static string studly( string $value)

Convert a value to studly caps case.

Parameters

string $value

Return Value

string

at line line 449
static string substr( string $string, int $start, int|null $length = null)

Returns the portion of string specified by the start and length parameters.

Parameters

string $string
int $start
int|null $length

Return Value

string

at line line 460
static string ucfirst( string $string)

Make a string's first character uppercase.

Parameters

string $string

Return Value

string