imliam/php-indefinite-article

Determine the indefinite article of an English term

v1.0.0 2019-02-12 23:13 UTC

Requires

• php: ^7.1

Requires (Dev)

• phpunit/phpunit: ^7.0

MIT

• Liam Hammett

• imliam
• php-indefinite-article

README

Determine the indefinite article of an English term.

An indefinite article is the word that comes before nouns or noun equivalents in English, such as "a" or "an". If the word starts with a consonant sound, the article used should be "a" — for example "banana" becomes "a banana". If the word starts with a vowel sound, the article used should be "an" — for example "apple" becomes "an apple".

This is not as simple as checking whether the first character of the word is a vowel or consonant as that does not determine the sound pronounced when speaking the word.

This is a port of Eamon Nerbonne's original solution for the problem.

• PHP Indefinite Articles
  • 💾 Installation
  • 📝 Usage
  • ✅ Testing
  • 🔖 Changelog
  • ⬆️ Upgrading
  • 🎉 Contributing
    • 🔒 Security
  • 👷 Credits
  • ♻️ License

💾 Installation

You can install the package with Composer using the following command:

composer require imliam/php-indefinite-article:^1.0.0

📝 Usage

$word = new ImLiam\IndefiniteArticle\IndefiniteArticle('apple');

echo $word->parse();
// "an apple"

echo $word->article();
// "an"

✅ Testing

composer test

🔖 Changelog

Please see the changelog file for more information on what has changed recently.

⬆️ Upgrading

Please see the upgrading file for details on upgrading from previous versions.

🎉 Contributing

Please see the contributing file and code of conduct for details on contributing to the project.

🔒 Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

👷 Credits

• Liam Hammett
• Eamon Nerbonne for the original solution
• All Contributors

♻️ License

The MIT License (MIT). Please see the license file for more information.