UrbanDict

UrbanDict is a compilation of common slangs. It is a simple project that demonstrates the use of simple and basic programming concepts.

Design

Classes

• DictStore: The main dictionary
• DictTool: The data access layer, responsible for performing CRUD operations on the dictionary.
• DictRank: Returns a word count in descending order of words used in sample sentences in the dictionary

Testing

The phpunit framework for testing is used to perform unit test on the classes. The TDD principle has been employed to make the application robust

Run this in your terminal to execute the tests

 /vendor/bin/phpunit

Install

• To install this package, PHP 5.5+ and Composer are required

composer require `dara/urbandict`

Usage

• Instantiating the Dictionary

$dictionary = new DictStore();

• Instantiating the Dictionary tool

$dictTool = new DictTool();

• Get a slang's meaning from the dictionary

$meaning = $dictTool->getSlang($dictionary,'crash');

• Add a slang to the dictionary

$add = $dictTool->addSlang($dictionary, 'jump', 'To run from the police', 'Tunde will jump despite the warning from the judge');

• Edit a slang in the dictionary

$edit = $dictTool->editSlang($dictionary,'tight','A very impressive performance');

• Delete a slang from the dictionary

$delete = $dictTool->deleteSlang($dictionary,'tight');

Change log

Please check out CHANGELOG file for information on what has changed recently.

Contributing

Please check out CONTRIBUTING file for detailed contribution guidelines.

Credits

Open-source Evangelist is maintained by Dara Oladosu.

License

UrbanDict is released under the MIT Licence. See the bundled LICENSE file for more details.