library urban-words

john-kariuki/urban-words

Urban words, CheckpointOne Andela

CheckpointOne

![Build Pass] (https://travis-ci.org/andela-jkariuki/CheckpointOne.svg?branch=master) , _(*1)

Urban Dictionary Agnostic PHP Package

Andela Checkpoint One., _(*2)

Urban Words Manager

An urban words dictionary, Urban Word CRUD and Ranking System for word occurence in a sentence., _(*3)

Word Rank Manager

Rank the occurence of words in a sentence., _(*4)

#TIA, _(*5)

Installation

add the package to your projects folder, _(*6)

composer require john-kariuki/urban-words

Install packages using composer, _(*7)

composer install

Usage

Let's get using Urban Words, _(*8)

<?php
require 'vendor/autoload.php';

use John\Cp\UrbanWordsDatastore;
use John\Cp\UrbanWordsManager;
use John\Cp\WordRankManager;
use John\Exceptions\UrbanWordException;
use John\Exceptions\WordRankManagerException;
use John\Exceptions\WordManagerException;

//Class UrbanWordsDatastore contains a static array of urban words
print_r(UrbanWordsDatastore::$data);

/**
    * Class UrbanWordsManager performs CRUD methods on the $data array in UrbanWordsDataStore
    * Methods:
    * addWord(word, desc, sentence)
    * readWord(word)
    * updateWord(word, foo, bar, foobar)
    * deleteWord(word)
*/
try {

    $urbanWord = new UrbanWordsManager();

    //Add new word, description and sentence
    print_r($urbanWord->addWord('Bae', 'Endearing term for lover', 'Your bae has a bae'));

    //Pass slang word to read
    print_r($urbanWord->readWord('Bae'));

    //Update slang word details
    print_r($urbanWord->updateWord("Bae", "Foo", "Bar", "Foo Bar"));

    //Pass slang word to delete
    print_r($urbanWord->deleteWord('Turnt'));

    print_r($urbanWord->getWords());

} catch (WordManagerException $e) {
    echo $e->errorMessage();
}

//Class WordRankManager returns the frequency of occurence of a word in a sentence


try {
    $sentence = new WordRankManager("The big brown fox is just a big brown fox jumping up all in the lazy dog's business");
    print_r($sentence->ranker());
} catch (WordRankManagerException $e) {
    echo $e->errorMessage();
}

Contributing

Contributions are welcome and will be fully credited., _(*9)

We accept contributions via Pull Requests on Github., _(*10)

Pull Requests

• PSR-2 Coding Standard - The easiest way to apply the conventions is to install PHP Code Sniffer., _(*11)

• Add tests! - Your patch won't be accepted if it doesn't have tests., _(*12)

• Document any change in behaviour - Make sure the README.md and any other relevant documentation are kept up-to-date., _(*13)

• Consider our release cycle - We try to follow SemVer v2.0.0. Randomly breaking public APIs is not an option., _(*14)

• Create feature branches - Don't ask us to pull from your master branch., _(*15)

• One pull request per feature - If you want to do more than one thing, send multiple pull requests., _(*16)

• Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting., _(*17)

Security

If you discover any security related issues, please email me at John Kariuki or create an issue., _(*18)

Credits

John kariuki, _(*19)

License

The MIT License (MIT)

Copyright (c) 2016 John kariuki john.kariuki@andela.com, _(*20)

This is open-sourced software licensed under the MIT license., _(*21)