bayfrontmedia/php-string-helpers

Helper class to provide useful string functions.

Maintainers

Details

github.com/bayfrontmedia/php-string-helpers

Homepage

Source

Issues

Installs: 2 770

Dependents: 3

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 1

Open Issues: 0

v2.1.0 2024-10-01 19:07 UTC

Requires

MIT c2e9fde8d3f8ace03c4b31cea3eb79039c0dd6fd

phphelpersfunctionstringhelper

This package is auto-updated.

Last update: 2024-10-31 19:22:58 UTC

README

PHP helper class to provide useful string functions.

License

This project is open source and available under the MIT License.

Author

Bayfront Media

Requirements

  • PHP ^8.0

Installation

composer require bayfrontmedia/php-string-helpers

Usage

has

Description:

Checks if string contains a case-sensitive needle.

Parameters:

  • $string (string)
  • $needle (string)

Returns:

  • (bool)

Example:

use Bayfront\StringHelpers\Str;

$string = 'This is a string.';

if (Str::has($string, 'this')) {

    // Do something

}

hasSpace

Description:

Checks if string contains any whitespace.

Parameters:

  • $string (string)

Returns:

  • (bool)

Example:

use Bayfront\StringHelpers\Str;

$string = 'This is a string.';

if (Str::hasSpace($string)) {

    // Do something

}

startsWith

Description:

Checks if a string starts with a given case-sensitive string.

Parameters:

  • $string (string)
  • $starts_with (string)

Returns:

  • (bool)

Example:

use Bayfront\StringHelpers\Str;

$string = 'This is a string.';

if (Str::startsWith($string, 'this')) {

    // Do something

}

endsWith

Description:

Checks if a string ends with a given case-sensitive string.

Parameters:

  • $string (string)
  • $ends_with (string)

Returns:

  • (bool)

Example:

use Bayfront\StringHelpers\Str;

$string = 'This is a string.';

if (Str::endsWith($string, 'string.')) {

    // Do something

}

startWith

Description:

Returns string, ensuring that it starts with a given string.

Parameters:

  • $string (string)
  • $start_with (string)

Returns:

  • (string)

Example:

use Bayfront\StringHelpers\Str;

$string = 'This is a string.';

echo Str::startWith($string, 'Hello! ');

endWith

Description:

Returns string, ensuring that it ends with a given string.

Parameters:

  • $string (string)
  • $end_with (string)

Returns:

  • (string)

Example:

use Bayfront\StringHelpers\Str;

$string = 'This is a string.';

echo Str::endWith($string, ' Goodbye!');

lowercase

Description:

Converts string to lowercase using a specified character encoding.

See: https://www.php.net/manual/en/mbstring.supported-encodings.php

Parameters:

  • $string (string)
  • $encoding = 'UTF-8' (string)

Returns:

  • (string)

Example:

use Bayfront\StringHelpers\Str;

$string = 'This is a string.';

echo Str::lowercase($string);

uppercase

Description:

Converts string to uppercase using a specified character encoding.

See: https://www.php.net/manual/en/mbstring.supported-encodings.php

Parameters:

  • $string (string)
  • $encoding = 'UTF-8' (string)

Returns:

  • (string)

Example:

use Bayfront\StringHelpers\Str;

$string = 'This is a string.';

echo Str::uppercase($string);

titleCase

Description:

Converts string to title case using a specified character encoding.

See: https://www.php.net/manual/en/mbstring.supported-encodings.php

Parameters:

  • $string (string)
  • $encoding = 'UTF-8' (string)

Returns:

  • (string)

Example:

use Bayfront\StringHelpers\Str;

$string = 'This is a string.';

echo Str::titleCase($string);

camelCase

Description:

Converts string to camel case, removing any non-alpha and non-numeric characters.

Parameters:

  • $string (string)

Returns:

  • (string)

Example:

use Bayfront\StringHelpers\Str;

$string = 'This is a string.';

echo Str::camelCase($string);

kebabCase

Description:

Converts string to kebab case (URL-friendly slug), replacing any non-alpha and non-numeric characters with a hyphen.

Parameters:

  • $string (string)
  • $lowercase = false (bool): Convert string to lowercase

Returns:

  • (string)

Example:

use Bayfront\StringHelpers\Str;

$string = 'This is a string.';

echo Str::kebabCase($string);

snakeCase

Description:

Converts string to snake case, replacing any non-alpha and non-numeric characters with an underscore.

Parameters:

  • $string (string)
  • $lowercase = false (bool): Convert string to lowercase

Returns:

  • (string)

Example:

use Bayfront\StringHelpers\Str;

$string = 'This is a string.';

echo Str::snakeCase($string);

random

Description:

Return a random string of specified length and type.

Type of all includes alphanumeric and special characters.

Note: Returned string is not cryptographically secure.

Parameters:

  • $length = 8 (int)
  • $type = 'all' (string): Valid types include: nonzero, alpha, numeric, alphanumeric, and all

Returns:

  • (string)

Example:

use Bayfront\StringHelpers\Str;

echo Str::random(16, 'alphanumeric');

uuid

Description:

Return a UUID v4 string.

NOTE: This method is depreciated. The uuid4 and uuid7 methods should be used instead.

Parameters:

  • (None)

Returns:

  • (string)

Example:

use Bayfront\StringHelpers\Str;

echo Str::uuid();

uuid4

Description:

Return a UUID v4 string.

Parameters:

  • (None)

Returns:

  • (string)

Example:

use Bayfront\StringHelpers\Str;

echo Str::uuid4();

uuid7

Description:

Return a lexicographically sortable UUID v7 string.

Parameters:

  • (None)

Returns:

  • (string)

Example:

use Bayfront\StringHelpers\Str;

echo Str::uuid7();