https://github.com/divineomega/php-word-info

PHP library to look up information about words
https://github.com/divineomega/php-word-info

offensive-language php php-library rhymes syllables words

Last synced: about 2 months ago
JSON representation

PHP library to look up information about words

• Host: GitHub
• URL: https://github.com/divineomega/php-word-info
• Owner: DivineOmega
• License: lgpl-3.0
• Created: 2018-01-25T14:17:09.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2020-03-26T18:52:16.000Z (over 4 years ago)
• Last Synced: 2024-10-15T02:32:43.096Z (2 months ago)
• Topics: offensive-language, php, php-library, rhymes, syllables, words
• Language: PHP
• Size: 23.4 KB
• Stars: 4
• Watchers: 3
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PHP Word Info

[![Build Status](https://travis-ci.org/DivineOmega/php-word-info.svg?branch=master)](https://travis-ci.org/DivineOmega/php-word-info)

[![Coverage Status](https://coveralls.io/repos/github/DivineOmega/php-word-info/badge.svg?branch=master)](https://coveralls.io/github/DivineOmega/php-word-info?branch=master)

[![StyleCI](https://styleci.io/repos/118921741/shield?branch=master)](https://styleci.io/repos/118921741)

This PHP library can be used to look up information about a word, including the following.

* Rhymes

* Half rhymes

* Number of syllables

* Offensive or not

* Portmanteaus

* Plural / singular

## Installation

PHP Word Info can be easily installed using Composer. Just run the following command from the root of your project.

```

composer require divineomega/php-word-info

```

If you have never used the Composer dependency manager before, head to the [Composer website](https://getcomposer.org/) for more information on how to get started.

## Usage

To use PHP Word Info, you must first create a new `Word` object. You can then call any of the `Word` object methods, as shown below.

```php

$word = new Word('cat');

$rhymes = $word->rhymes();

$halfRhymes = $word->halfRhymes();

$portmanteaus = $word->portmanteaus();

$numberOfSyllables = $word->syllables();    // Returns an integer

$isOffensive = $word->offensive();          // Returns true/false

$plural = $word->plural();                  // Returns `Word` object

$singular = $word->singular();              // Returns `Word` object

```

Most methods will return an array of `Word` objects, unless specified otherwise.