demola/urbandictionary

A package that helps in managing urban words (slang)

Urban Dictionary

, _(*1)

The Urban dictionary is the collation of urban words. It is a package that stores meaning and usage of words in a multi associative array. The package allows for addition, editing, updating and retrieving of words in the dictionary., _(*2)

Design

Classes, _(*3)

• UrbanWords: Contains an array where urban words are stored., _(*4)

• DictionaryEngine: Contain methods that add new word, retrieve the whole dictionary, retrieve word, update existing word, and delete word in the urban dictionary., _(*5)

• RankWord: Contain methods that rank words based on the number of times they occurred in the sentence., _(*6)

Installation

To install this package, PHP 5.5+ and composer are required. After these requirements have been met, type the following code, _(*7)

    $ composer require demola/urbandictionary

Usage

The dictionary contains urban words with their meaning and usage, _(*8)

• Create a dictionaryManager instance, _(*9)

   $dictionaryManager = new DictionaryEngine();

• Add urban words to the dictionary, _(*10)

         $dictionaryManager->add('word', 'description', 'sampleSentence'); // This returns true

• Retrieve a word from the dictionary, _(*11)

         $data = $dictionaryManager->retrieve('word');

• Retrieve the whole dictionary, _(*12)

         $data = $dictionaryManager->retrieveAll();              

• Update a word, its meaning and its sample sentence, _(*13)

       $data = $dictionaryManager->update('word', newDescription', 'newSampleSentence');

• Delete a word in the urban dictionary, _(*14)

       $dictionaryManager->delete('word'); // This returns true

• Rank words in a sentence, _(*15)

  • create a wordOccurence instance, _(*16)

    $wordOccurence = new RankWord;
    
    $ranking = $wordOccurence->rankWord($word));

Testing

Run the following command in the urban-dictionary directory:, _(*17)

      ~ phpunit

Change log

Please check out CHANGELOG file for information on what has changed recently., _(*18)

Contributing

Please check out CONTRIBUTING file for detailed contribution guidelines., _(*19)

Security

If you discover any issue, kindly contact ademola.raimi@andela.com, _(*20)

Credits

Urban Dictionary is maintained by Raimi Ademola., _(*21)

License

UrbanDictionary is released under the MIT Licence. See the bundled LICENSE file for more details., _(*22)