cmgmyr/title-formatter

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

Maintainers

Details

github.com/cmgmyr/title-formatter

Source

Issues

Fund package maintenance!
cmgmyr

Installs: 488

Dependents: 0

Suggesters: 0

Security: 0

Stars: 4

Watchers: 2

Forks: 2

Open Issues: 2

3.0.0 2021-11-20 11:24 UTC

Requires

Requires (Dev)

MIT 13636d1dc0266f04e914bcf1dbc33bd11c10e54c

This package is auto-updated.

Last update: 2024-04-20 16:57:26 UTC

README

Tests Latest Version Total Downloads Software License

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"

  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 Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits