Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mattsparks/the-stringler
An OOP approach to string manipulation.
https://github.com/mattsparks/the-stringler
laravel manipulating-strings oop php string-manipulation strings
Last synced: 3 months ago
JSON representation
An OOP approach to string manipulation.
- Host: GitHub
- URL: https://github.com/mattsparks/the-stringler
- Owner: mattsparks
- License: mit
- Created: 2016-06-30T19:51:16.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-08-28T01:24:28.000Z (over 5 years ago)
- Last Synced: 2024-09-19T09:48:40.005Z (4 months ago)
- Topics: laravel, manipulating-strings, oop, php, string-manipulation, strings
- Language: PHP
- Size: 32.2 KB
- Stars: 34
- Watchers: 6
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# The Stringler
A simple class to manipulate strings in an OO way. Inspired by [Spatie's String](https://github.com/spatie/string). Just built this for fun. Hope you like it.
## Install
Via composer:
```bash
composer require thestringler/manipulator
```
Using Laravel? Checkout [The Stringler Laravel Package](https://github.com/mattsparks/the-stringler-laravel).
## Methods
### append($string)
```php
Manipulator::make('Freak')->append(' Out!');
// Freak Out!
```
### camelToSnake
```php
Manipulator::make('camelCase')->camelToSnake();
// camel_case
```
### camelToClass
```php
Manipulator::make('className')->camelToClass();
// ClassName
```
### capitalize
```php
Manipulator::make('hello')->capitalize();
// Hello
```
### capitalizeEach
```php
Manipulator::make('i like toast!')->capitalizeEach();
// I Like Toast!
```
### custom
```php
Manipulator::make('Some String')->custom(function ($string) {
// This is just a sample, this can be achieved with existing methods,
// But you can do whatever string manipulation you want here.
return ucfirst(strtolower($string));
});
// Some string
```
### eachCharacter($closure)
```php
Manipulator::make('hello')->eachCharacter(function($char) {
return strtoupper($char);
});
// HELLO
```
### eachWord($closure, $preserveSpaces = false)
```php
Manipulator::make('hello moto')->eachWord(function($word) {
return strrev($word);
});
// ollehotom
Manipulator::make('hello moto')->eachWord(function($word) {
return strrev($word);
}, true);
// olleh otom
```
### getPossessive
```php
Manipulator::make('Bob')->getPossessive();
// Bob's
Manipulator::make('Silas')->getPossessive();
// Silas'
```
### htmlEntities($flags = ENT_HTML5, $encoding = 'UTF-8', $doubleEncode = true)
```php
Manipulator::make('&')->htmlEntities();
// &
```
### htmlEntitiesDecode($flags = ENT_HTML5, $encoding = 'UTF-8')
```php
Manipulator::make('&')->htmlEntitiesDecode();
// &
```
### htmlSpecialCharacters($flags = ENT_HTML5, $encoding = 'UTF-8', $doubleEncode = true)
```php
Manipulator::make('&<>')->htmlSpecialCharacters();
// &<>
```
### lowercaseFirst
```php
Manipulator::make('HELLO')->lowercaseFirst();
// hELLO
```
### make($string)
```php
// Named constructor
Manipulator::make('string');
```
### pad($length, $string, $type = null)
```php
Manipulator::make('Hello')->pad(2, '!!', STR_PAD_RIGHT);
// Hello!!
```
### prepend($string)
```php
Manipulator::make('is the one.')->prepend('Neo ');
// Neo is the one.
```
### pluralize($items = null)
```php
Manipulator::make('Potato')->pluralize();
// Potatoes
```
You can optionally pass an array or numeric value to `pluaralize` to determine if the given string should be pluaralized.
```php
$dogs = ['Zoe', 'Spot', 'Pickles'];
Manipulator::make('Dog')->pluralize($dogs);
// Dogs
$cats = ['Whiskers'];
Manipulator::make('Cat')->pluralize($cats);
// Cat
```
### nthCharacter($nth, $closure)
```php
Manipulator::make('Wordpress')->nthCharacter(5, function($character) {
return mb_strtoupper($character);
});
// WordPress
```
### nthWord($nth, $closure, $preserveSpaces = true)
```php
Manipulator::make('Oh hello there!')->nthWord(2, function($word) {
return mb_strtoupper($word);
});
// Oh HELLO there!
```
### remove($string, $caseSensitive = true)
```php
Manipulator::make('Dog Gone')->remove('Gone');
// Dog
```
### removeSpecialCharacters($exceptions = [])
```php
Manipulator::make('Hello!!')->removeSpecialCharacters();
// Hello
Manipulator::make('Hello!!')->removeSpecialCharacters(['!']);
// Hello!!
```
### repeat($multiplier = 1)
```php
Manipulator::make('la')->repeat(3);
// lalala
```
### replace($find, $replace = '', $caseSensitive = true)
```php
Manipulator::make('Pickles are good.')->replace('good', 'terrible');
// Pickles are terrible.
```
### reverse
```php
Manipulator::make('Whoa!')->reverse();
// !aohW
```
### snakeToCamel
```php
Manipulator::make('snake_case')->snakeToCamel();
// snakeCase
```
### snakeToClass
```php
Manipulator::make('class_name')->snakeToClass();
// ClassName
```
### stripTags($allowed = '')
```php
Manipulator::make('Hello')->stripTags();
// Hello
```
### toCamelCase
```php
Manipulator::make('camel case')->toCamelCase();
// camelCase
```
### toL33t
```php
Manipulator::make('Hack The Planet!')->toL33t();
// (-)@{|< +/-/€ |O7@|\|€][!
```
### toLower
```php
Manipulator::make('LOWER')->toLower();
// lower
```
### toSlug
```php
Manipulator::make('This is a slug!')->toSlug();
// this-is-a-slug
```
### toSnakeCase
```php
Manipulator::make('snake case')->toSnakeCase();
// snake_case
```
### toString
This method just returns the string.
### toUpper
```php
Manipulator::make('upper')->toUpper();
// UPPER
```
### trim
```php
Manipulator::make(' trimmed ')->trim();
// trimmed
```
### trimBeginning
```php
Manipulator::make(' trimmed')->trimBeginning();
// trimmed
```
### trimEnd
```php
Manipulator::make('trimmed ')->trimEnd();
// trimmed
```
### truncate($length = 100, $append = '...')
```php
Manipulator::make('This is a sentence and will be truncated.')->truncate(10, '...');
// This is a ...
```
### urlDecode
```php
Manipulator::make('hello%21')->urlDecode();
// hello!
```
### urlEncode
```php
Manipulator::make('hello!')->urlEncode();
// hello%21
```
## Chainable
All of these methods (minus `toString`) can be chained.
```php
Manipulator::make('hello')->toUpper()->reverse();
// OLLEH
```
## Contribute
Contributions are very welcome!
1. Follow the [PSR-2 Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)
2. Send a pull request.
That's pretty much it!