cmgmyr / title-formatter
A simple to use text formatter, primarily used for page/blog titles
Fund package maintenance!
cmgmyr
Requires
- php: ^8.0
- ext-mbstring: *
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.2
- phpunit/phpunit: ^9.3.3
This package is auto-updated.
Last update: 2024-10-20 17:58:12 UTC
README
Title Text Formatter
A simple to use text formatter, primarily used for page/blog titles.
Install
Via Composer
"require": {
"cmgmyr/title-formatter": "~3.0"
}
Usage
use Cmgmyr\TitleFormatter\TitleFormatter; $title = "this is a messy title. [can you fix it?]"; $title = TitleFormatter::titleCase($title); echo $title; // This is a Messy Title. [Can You Fix It?]
Formatting "Rules"
- First word in a sentence is capitalized
- Last word in a sentence is capitalized
- Words within brackets (or similar) are capitalized, similar to rules #1 & #2
- Words within the
$ignoredWords
array should not be capitalized as long as it doesn't conflict with rules #1-#3 - Words preceded by multiple special characters should be capitalized: $$$Money
- All dashed words should be capitalized: Super-Awesome-Post
- 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 Vulnerabilities
Please review our security policy on how to report security vulnerabilities.