Stringizer

Stringizer is a PHP string manipulation library with support for method chaining and multibyte handling

Build Status Coverage Status SensioLabsInsight Latest Stable Version License

Overview

Stringizer is a string library made up of existing PHP multibyte-string functions and a variety of string manipulation solutions found on Stackoverflow.com. The intent is to save you time looking up string maninpulation solutions yourself and provide the convience of method chaining. Awarded the Innovation Award in June 2016 from PHPClasses.org.

PSR Compliance and Code Quality: * PSR-0: Autoloading Standard * PSR-1: Basic Coding Standard * PSR-2: Coding Style * PSR-4: Autoloader * Semver Versioning * 100% Unit Test Coverage, results by Coveralls.io * Platinum Code Quality Analysis by SensioLabsInsight * Continuous Integration and regression unit testing using Travis CI

Key Highlights

Version

Latest Stable Version

Installation

It’s recommended that you use Composer to install Stringizer.

Manual install with composer

$ composer require jasonlam604/stringizer "^2.9.0"

Using the composer.json file

"require": {
    "jasonlam604/stringizer": "^2.9.0"
}

This will install Stringizer and all required dependencies. Stringizer requires PHP 5.6.0 or newer.

Usage

Sample usage:

<?php

// Composer Autoloader
require 'vendor/autoload.php';

use Stringizer\Stringizer;

$s = new Stringizer("myapp");

$s->ensureRight("/");

// The following outputs: myapp/
echo $s->getString(); 

Tests

To execute the test suite, you’ll need phpunit.

$ phpunit

Submit Issues

Feel free to open any Issues, Bugs or suggestions!

Contributing

Accepting Pull-Requests!

Credits

License

The Stringizer is licensed under the MIT license. See License File for more information.

String Functions

base64Decode

Bae64 decode string

$s = new Stringizer("44GT44KT44Gr44Gh44Gv");
$s->base64Decode(); // こんにちは
base64Encode

Base64 Encode String

$s = new Stringizer("ȘŦŗÍñĝìzĕŕ");
$s->base64Encode(); // yJjFpsWXw43DscSdw6x6xJXFlQ==
between

Extracts a string between left and right strings.

$s = new Stringizer("<div>ȘŦŗÍñĝìzĕŕ</div>");
$s->between("<div>", "</div>"); // ȘŦŗÍñĝìzĕŕ
camelize

Removes any underscores or dashes and converts a string into camel case.

$s = new Stringizer("data_rate");
$s->camelize(); // dataRate
camelToSnake

Converts Camel case to Snake Case.

$s = new Stringizer("helloSŦŗÍñĝìzĕŕ");
$s->camelToSnake(); // hello_sŦŗÍñĝìzĕŕ
charAt

Obtain character at specific position in a string where the first position is consider 0.

$s = new Stringizer("Foo Bar Fizz Buzz");
$s->charAt(4); // B
chars

Return the given string as an array where each index contains a character.

$s = new Stringizer("ȘŦŗÍñĝìzĕŕ");
$s->chars(); // an array made up 10 indexes ["Ș","Ŧ","ŗ","Í","ñ","ĝ","ì","z","ĕ","ŕ"]
$s = new Stringizer("ȘŦŗÍñĝìzĕŕ");
$s->charAt(1); // Ŧ
$s = new Stringizer("ȘŦŗÍñĝìzĕŕ");
$s->charAt(0); // S
chompLeft

Deprecated - Removes prefix from start of string.

$s = new Stringizer("ȘŦŗÍñĝìzĕŕ");
$s->chompLeft("ȘŦŗÍñĝ"); // ìzĕŕ
chompRight

Deprecated - Removes suffix from start of string.

$s = new Stringizer("ȘŦŗÍñĝìzĕŕ");
$s->chompRight("ìzĕŕ"); // ȘŦŗÍñĝ
chopLeft

Removes prefix from start of string.

$s = new Stringizer("ȘŦŗÍñĝìzĕŕ");
$s->chopLeft("ȘŦŗÍñĝ"); // ìzĕŕ
chopRight

Removes suffix from start of string.

$s = new Stringizer("ȘŦŗÍñĝìzĕŕ");
$s->chopRight("ìzĕŕ"); // ȘŦŗÍñĝ
collapseWhitespace

Remove extra whitespace, leave only one whitespace between characters where there is more then one whitespace value.

$s = new Stringizer(""ȘŦŗÍñĝ\n\nìzĕŕ \n\t    \r"");
$s->concat("collapseWhitespace") // ȘŦŗÍñĝ ìzĕŕ
concat

Combine string values.

Combine at end of the string.

$s = new Stringizer("fizz");
$s->concat(" buzz") // fizz buzz

Combine at the beginning of the string by passing in the boolean value true in the optional second parameter. php $s = new Stringizer(" buzz"); $s->concat("fizz",true) // fizz buzz ##### contains

Search for string within another string, return true if found else return false

$s = new Stringizer("fizz buzz foo bar");
$s->contains("buzz"); // true
$s = new Stringizer("fizz buzz foo bar");
$s->contains("Buzz"); // false, case sensitive
$s = new Stringizer("fizz buzz foo bar");
$s->containsIncaseSensitive("Buzz"); // true, case insensitive
containsCount

Count the number of string occurrences

$s = new Stringizer("fizz buzz fizz buzz fizz buzz");
$s->containsCount("buzz"); // 3
$s = new Stringizer("fizz buzz fizz buzz fizz buzz");
$s->containsCount("nomatch"); // 0
$s = new Stringizer("fizz buzz foo bar");
$this->assertEquals(0, $s->containsCount("BUZZ")); // 0, case sensitive no match found
$s = new Stringizer("fizz buzz foo bar");
$s->containsCountIncaseSensitive("BUZZ"); // 1, case in-sensitive 1 match found
$s = new Stringizer("文字列のそれ 文字列のそれ 文字列のそれ 文字列のそれ");
$this->assertEquals(4, $s->containsCount("れ")); // 4
dasherize

Break up a camelize string and seperate with dashes

$s = new Stringizer("dataRate");
$s->dasherize(); // data-rate
endsWith

Checks if a string ends with the given suffix.

$s = new Stringizer("Fizz Buzz");
$s->endsWith("zz"); // true
$s = new Stringizer("文字列のそれ");
$s->endsWith("れ"); // true
$s = new Stringizer("文字列のそれ");
$s->endsWith("れれれれ"); // false
ensureLeft

Ensure string starts with prefix

$s = new Stringizer("/myapp");
$s->ensureLeft("/"); //  /myapp
ensureRight

Ensure string ends with suffix

$s = new Stringizer("/myapp");
$s->ensureRight("/"); //  /myapp/
first

Grabs a section from the beginning of the string, the size of the section is determine by the given indicated value.

$s = new Stringizer("ȘŦŗÍñĝìzĕŕ");
$s->first(6); // ȘŦŗÍñĝ
hashCode

Determine the hashcode of a string, algorithm matches the hashCode method available in a Java String class

$s = new Stringizer("Hello, World");
$s->hashCode(); // -505841268
hasLowercase

Checks if value is contains only lowercase values.

$s = new Stringizer("stŗiñĝìzĕŕ");
$s->hasLowercase()); // true
$s = new Stringizer("sTŗiñĝìzĕŕ");
$s->hasLowercase()); // false
hasUppercase

Checks if value is contains only uppercase values.

$s = new Stringizer("STÃÑ");
$s->hasUppercase()); // true
$s = new Stringizer("StÃÑ");
$s->hasUppercase()); // false
indexOf

Finds position of first occurrence of a string within another.

$s = new Stringizer("Fizz Buzz Foo Bar");
$s->indexOf("Foo"); // 10

If no match is found boolean false is returned.

$s = new Stringizer("Fizz Buzz Foo Bar");
$s->indexOf("bad"); // false

There is a second optional parameter, position offset where to begin the search where left most value is index 0.

$s = new Stringizer("Foo Buzz Foo Bar");
$s->indexOf("Foo", 0); // 0, since offset starts at zero the first Foo is found at index 0
$s->indexOf("Foo", 1); // 9, since offset is past zero the next available match is at index 9

MultiByte

$s = new Stringizer("fòô bàř");
$s->indexOf("bàř"); // 4

Case In-sensitive

$s = new Stringizer("Fizz Buzz Foo Bar");
$s->indexOfCaseInsensitive("foo"); // 10
isAlpha

Checks if value is contains alpha values only.

$s = new Stringizer("FooBar");
$s->isAlpha(); // true
$s = new Stringizer("Foo Bar");
$s->isAlpha(); // false
isAlphaNumeric

Checks if value is contains alphanumeric values only

$s = new Stringizer("F00Bar");
$s->isAlphaNumeric(); // true
$s = new Stringizer("F00 Bar");
$s->isAlphaNumeric(); // false
isAlphaNumericSpace

Checks if value is contains alphanumeric values only including space(s).

$s = new Stringizer("F00 Bar");
$s->isAlphaNumericSpace(); // true
$s = new Stringizer("F00 Bar !");
$s->isAlphaNumericSpace(); // false
isAlphaNumericSpaceDash

Checks if value is contains alphanumeric values only including space(s) and dash(es).

$s = new Stringizer("Marie-Anne Lucy");
$s->isAlphaNumericSpaceDash(); // true
$s = new Stringizer("Marie-Ann Lucy!");
$s->isAlphaNumericSpaceDash(); // false
isBase64

Checks if value is a valid Base64 string

// Decoded value is ȘŦŗÍñĝìzĕŕ
$s = new Stringizer("yJjFpsWXw43DscSdw6x6xJXFlQ==");
$s->isBase64(); // true
isBlank

Checks if value is blank (alias to isEmpty), if string contains whitespace only it is considered empty.

$s = new Stringizer("\n  \n\r\t   ");
$s->isBlank(); // true
isDate

Checks if value is valid date based on the PHP function strtotime.

Requirement, default timezone must be set first

date_default_timezone_set('America/Vancouver');
$s = new Stringizer("2015-03-15");
$s->isDate(); // true
date_default_timezone_set('America/Vancouver');
$s = new Stringizer("January 1st");
$s->isDate(); // true
isDecimal

Checks if value is contains decimal value, whole numbers are considered valid.

$s = new Stringizer("19.99");
$s->isDecimal(); // true
$s = new Stringizer("19");
$s->isDecimal(); // true
$s = new Stringizer("19x");
$s->isDecimal(); // false
isEmail

Checks if value is a valid email.

$s = new Stringizer("John.Doe@fake.com");
$s->isEmail(); // true
$s = new Stringizer("John.Doe@fake@.com");
$s->isEmail(); // false
isEmpty

Checks if value is empty, if string contains whitespace only it is considered empty.

$s = new Stringizer("\n  \n\r\t   ");
$s->isEmpty(); // true

ishexdecimal

Checks if value is hexdecimal.

$s = new Stringizer("AB10BC99");
$s->isHexDecimal(); // true
isNumber

Checks if value is a whole number, can be a negative number but can not be a decimal number.

$s = new Stringizer("1234");
$s->isNumber() // true
isIPv4

Checks if value is a valid IP, IPv4.

$s = new Stringizer("192.168.1.1");
$s->isIpv4() // true
isIPv6

Checks if value is a valid IP, IPv6.

$s = new Stringizer("2001:cdba:0000:0000:0000:0000:3257:9652");
$s->isIpv6() // true
isUrl

Checks if value is contains a valid URL

$s = new Stringizer("https://github.com");
$s->isUrl(); // true
last

Grabs a section from the end of the string, the size of the section is determine by the given indicated value.

$s = new Stringizer("ȘŦŗÍñĝìzĕŕ");
$s->last(4); // ìzĕŕ

lastIndexOf

Finds position of last occurrence of a string within another

$s = new Stringizer("Foo Buzz Foo Bar");
$s->lastIndexOf("Foo"); // 9

If no match is found boolean false is returned.

$s = new Stringizer("Fizz Buzz Foo Bar");
$s->lastIndexOf("bad"); // false

There is a second optional parameter, position offset where to begin the search where left most value is index 0.

$s = new Stringizer("Foo Buzz Foo Bar");
$s->lastIndexOf("Foo", 0); // 9 
$s->lastIndexOf("Foo", 4)); // 9
$s->lastIndexOf("Foo", 10)); // false

MultiByte

$s = new Stringizer("fòô bàř fòô bàř fòô bàř");
$s->lastIndexOf("fòô"); // 16

Case In-sensitive

$s = new Stringizer("Fizz Buzz Foo Bar");
$s->lastIndexOf("foo"); //false
$s->lastIndexOfCaseInsensitive("foo"); // 10

length

Find the length of the string

$s = new Stringizer("FizzBuzz");
$s->length(); // 8

Multibyte

$s = new Stringizer("キラキラした");
$s->length(); // 6

lineCount

Count the number of lines based line feed, \n.

$s = new Stringizer("ȘŦŗÍñĝìzĕŕ\nȘŦŗÍñĝìzĕŕ\nȘŦŗÍñĝìzĕŕ");
$s->lineCount(); // 2

lowercase

Ensure the string is entirely lower case

$s = new Stringizer("FiZZ");
$s->lowercase(); // fizz

lowercaseFirst

First letter of the string is lower cased

$s = new Stringizer("FiZz");
$s->lowercaseFirst(); // fIZZ

padBoth

Pad string on both sides with indicated value

Padding with an even amount

$s = new Stringizer("fizz");
$s->padBoth("x", 10); // xxxfizzxxx

Padding with an odd amount, the extra character is addded to the end of the string

$s = new Stringizer("fizz");
$s->padBoth("x", 11); // xxxfizzxxxx

padLeft

Pad string on left side with indicated string value and number of times to pad with

$s = new Stringizer("10");
$s->padLeft("0", 5); // 00010

padRight

Pad string on right side with indicated string value and number of times to pad with

$s = new Stringizer("Alien");
$this->assertEquals("Alien     ", $s->padRight(" ", 10)); // "Alien     " 

randomAlpha

Generate a random alpha value, default length of 10 characters.

$s = new Stringizer("");
$s->randomAlpha(); // aYvPXitjCJ
$s = new Stringizer("");
$s->randomAlpha(20); // cmbOUofxAvWeyMGgPHK

randomNumeric

Generate a random string value containing only numeric values, default length of 10 characters. It is important to note this is a string value because otherwise if a value with leading zeros such as 0123456789 would then be 123456789 as type int; but, then would not be length of 10 characters (or the desired indicated expected length)

$s = new Stringizer("");
$s->randomNumeric(); // 8277761361

randomAlphaNumeric

Generate a random alphanumeric value, default length of 10 characters.

$s = new Stringizer("");
$s->randomAlphanumeric(); // w5quanvlUP

repeat

Returns a string repeated n times.

$s = new Stringizer("FizzöBuzz");
$s->repeat(2); // FizzöBuzzFizzöBuzz
$s = new Stringizer("こ");
$s->repeat(5); // こここここ

replaceAccents

Replace characters with accents with the same character without accents.

$s = new Stringizer("FizzöBuzz Fizz Buzz Fizz Buzzé");
$s->replaceAccents(); // FizzoeBuzz Fizz Buzz Fizz Buzze
$s = new Stringizer("ȘŦŗÍñĝìzĕŕ");
$s->replaceAccents(); // STrIngizer

removeAscii

Remove non Ascii characters

$s = new Stringizer("FizzöBuzz Fizz Buzz Fizz Buzzé");
$s->removeNonAscii(); // FizzBuzz Fizz Buzz Fizz Buzz

removeWhitespace

Remove any whitespace from the string (before, after and any in between)

$s = new Stringizer("Fizz Buzz Fizz Buzz Fizz Buzz");
$s->removeWhitespace(); // FizzBuzzFizzBuzzFizzBuzz
$s = new Stringizer(" Ș Ŧ ŗ Í ñ ĝ ì z ĕ ŕ ");
$s->removeWhitespace(); // ȘŦŗÍñĝìzĕŕ

replace

Match and replace string(s)

$s = new Stringizer("Fizz Buzz Fizz Buzz Fizz Buzz");
$s->replace("Buzz", "Bar"); // Fizz Bar Fizz Bar Fizz Bar

Multiple replace

$s = new Stringizer("Fizz Buzz Fizz Buzz Fizz Buzz");
$s->replace(array("Fizz","Buzz"), array("Foo","Bar")); // Foo Bar Foo Bar Foo Bar

No Match NOT Case-Insensitive

$s = new Stringizer("Fizz Buzz Fizz Buzz Fizz Buzz");
$s->replace("buzz", "bar"); // Fizz Buzz Fizz Buzz Fizz Buzz

Match Case-Insensitive
php $s = new Stringizer("Fizz Buzz Fizz Buzz Fizz Buzz"); $s->replaceIncaseSensitive("buzz", "bar"); // Fizz bar Fizz bar Fizz bar

MultiByte

$s = new Stringizer("Fizz列Buzz列Fizz列Buzz列Fizz列Buzz");
$s->replace("列", " "); // Fizz Buzz Fizz Buzz Fizz Buzz

reverse

$s = new Stringizer("mood");
$s->reverse(); // doom

MultiByte

$s = new Stringizer("文字列のそれ");
$s->reverse(); // れその列字文

sentenceCount

Count the number of sentences based sentences ending with one the following: . ! or ?

$s = new Stringizer("ȘŦŗÍñĝìzĕŕ jumped over the stringy stick. ȘŦŗÍñĝìzĕŕ jumped over the stringy stick again!  Or did it?");
$s->sentenceCount(); // 3

split

Explode string into an array default delimiter is comma

$s = new Stringizer("Fizz Buzz");
$array = $s->split(" "); // array( 0 => "Fizz", 1 => "Buzz")
$s = new Stringizer("文字列のそれ");
$array = $s->split("の"); // array( 0 => "文字列", 1 => "それ)
startsWith

Checks if a string starts with the specified suffix.

$s = new Stringizer("Fizz Buzz");
$s->startsWith("Fizz B"); // true
$s = new Stringizer("文字列のそれ");
$s->startsWith("文"); // true
$s = new Stringizer("文字列のそれ");
$s->startsWith("文文文文"); // false

stripPunctuation

Remove all of the punctuation

$s = new Stringizer("Hello World! It's me #stringizer");
$s->stripPunctuation(); // Hello World Its me stringizer
$s = new Stringizer("*-=!'\",?!Hello* World][");
$s->stripPunctuation(); // Hello World

stripTags

Remove HTML and PHP tags from a string

$s = new Stringizer("<html>Hello</html>");
$s->stripTags(); // Hello
$s = new Stringizer("<html><b>こんにちは世界</b></html>");
$s->stripTags(); // こんにちは世界

Optional second paramter to ignore tags (tags not to be to removed)

$s = new Stringizer("<html>Hello <b>World</b></html>");
$s->stripTags("<b>"); // Hello <b>World</b>
$s = new Stringizer("<html><head><title>title</title></head><body>Hello <b><span class='fake-class'>World</span></b> こんにちは世界</body></html>");
$s->stripTags(); // titleHello World こんにちは世界

substring

Find a portion of a string based on postioning (index position in the string) and length of the portion

$s = new Stringizer("Fizz Buzz Foo Bar");
$s->subString(0, 4); // Fizz
$s = new Stringizer("Fizz Buzz Foo Bar");
$s->subString(5, 4)); // Buzz
$s = new Stringizer("Fizz Buzz Foo Bar");
$s->subString(5, 4)); // Buzz

MultiByte

$s = new Stringizer("キラキラした キラキラした");
$s->subString(7); // キラキラした

swapCase

Swap the case of each character.

$s = new Stringizer("hELLO wORLD");
$s->swapCase(); // Hello World

toBoolean

Converts a logical truth string to boolean.

(new Stringizer(true))->toBoolean(); // true
(new Stringizer(false))->toBoolean(); // false
(new Stringizer("stringizer"))->toBoolean(); // false
(new Stringizer("true"))->toBoolean(); // true
(new Stringizer("false"))->toBoolean(); // false
(new Stringizer("TRUE"))->toBoolean(); // true
(new Stringizer("FALSE"))->toBoolean(); // false
(new Stringizer("on"))->toBoolean(); // true
(new Stringizer("off"))->toBoolean(); // false
(new Stringizer("ON"))->toBoolean(); // true
(new Stringizer("OFF"))->toBoolean(); // false
(new Stringizer("yes"))->toBoolean(); // true
(new Stringizer("no"))->toBoolean(); // false
(new Stringizer("YES"))->toBoolean(); // true
(new Stringizer("NO"))->toBoolean(); // false
(new Stringizer(""))->toBoolean(); // false
(new Stringizer(null))->toBoolean(); // false
(new Stringizer(1))->toBoolean(); // true
(new Stringizer(-1))->toBoolean(); // false

trim

Remove whitespace both right and left side of the string

$s = new Stringizer("\x20\x20\x20   キラキラしたfizzخالد الشمعة   ");
$s->trim(); // キラキラしたfizzخالد الشمعة

trimLeft

Remove whitespace left of the string

$s = new Stringizer("\x20\x20\x20   キラキラしたfizzخالد الشمعة   ");
$s->trimLeft()); // キラキラしたfizzخالد الشمعة   

trimRight

Remove whitespace right of the string

$s = new Stringizer("\x20\x20\x20   キラキラしたfizzخالد الشمعة   ");
$s->trimRight(); // \x20\x20\x20   キラキラしたfizzخالد الشمعة

truncate

Shorten right side of string by the specified indicated amount

$s = new Stringizer("fòô bàř");
$s->truncate(4); // fòô
$s = new Stringizer("FizzBuzz");
$s->truncate(4); // Fizz

truncateMatch

Shorten string left or right side if given substring is match

$s = new Stringizer("fòô bàř");
$s->truncateMatch(" bàř"); // fòô
$s = new Stringizer("FizzBuzzFooBar");
$s->truncateMatch("Foo"); // FizzBuzz

Case In-sensitive

$s = new Stringizer("FizzBuzzFooBar");
$s->truncateMatchCaseInsensitive("foo"); // FizzBuzz

uppercase

Ensure entire string is uppercase

$s = new Stringizer("fIzz");
$s->uppercase(); // FIZZ

uppercaseWords

Ensure entire string is uppercase

$s = new Stringizer("fizz buzz foo bar");
$s->uppercaseWords(); // Fizz Buzz Foo Bar
width

Find the width of the string this is different then length for multibyte strings

$s = new Stringizer("キラキラした");
$s->width(); // 12, note multi-byte characters take up more space, typice 2 for each character
$s = new Stringizer("FizzBuzz");
$s->length(); // 8

wordCount

Count the number of words.

$s = new Stringizer("ȘŦŗÍñĝìzĕŕ こんにちは ȘŦŗÍñĝìzĕŕ こんにちは ȘŦŗÍñĝìzĕŕ");
$s->wordCount(); // 5

Basic Functions

setstring

Setting the string you want to apply string manipulations on, this will set the orginal value as well.

$s = new Stringizer("dummy-value");
$s->setString("new-dummy-value");

#### getstring

Retrieve the string in its most current state

```php
$s = new Stringizer("dummy-value");
$s->getString();

getStringOriginal

Retrieve the string state prior to any string manipulations

$s = new Stringizer("dummy-value");
$s->getStringOriginal();

__toString

Retrieve the string in its most current state

$s = new Stringizer("dummy-value");
echo ($s); // this will output current state, defaults to using the PHP built __toString method

setEncoding

Set encoding, behind the scences PHP function mb_internal_encoding is applied

$s = new Stringizer("dummy-value");
$s->setEncoding("UTF-8");
$s->getEncoding(); // UTF-8

getEncoding

$s = new Stringizer("dummy-value");
$s->getEncoding(); // Outputs your default encoding based mb_internal_encoding