spartz/text-formatter

This package is abandoned and no longer maintained. The author suggests using the cmgmyr/title-formatter package instead.

A simple to use text formatter, primarily used for page/blog titles

1.0.1 2015-11-02 20:09 UTC

Requires

• php: >=5.4.0
• ext-mbstring: *

Requires (Dev)

• phpunit/phpunit: 4.*
• scrutinizer/ocular: ~1.1

MIT

• Chris Gmyr

README

Title Text Formatter

A simple to use text formatter, primarily used for page/blog titles.

Install

Via Composer

"require": {
    "spartz/text-formatter": "~1.0"
}

Usage

use Spartz\TextFormatter\TextFormatter;

$title = "this is a messy title. [can you fix it?]";
$title = TextFormatter::titleCase($title);
echo $title; // This is a Messy Title. [Can You Fix It?]

Formatting "Rules"

1. First word in a sentence is capitalized
2. Last word in a sentence is capitalized
3. Words within brackets (or similar) are capitalized, similar to rules #1 & #2
4. Words within the $ignoredWords array should not be capitalized as long as it doesn't conflict with rules #1-#3
5. Words preceded by multiple special characters should be capitalized: $$$Money
6. All dashed words should be capitalized: Super-Awesome-Post
7. Ignore words that already include at least one uppercase letter. We'll assume that the author knows what they're doing: eBay, iPad, McCormick, etc

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email Chris Gmyr instead of using the issue tracker.

Credits

• Chris Gmyr
• All Contributors

License

The MIT License (MIT). Please see License File for more information.