README

Urban Dictionary 是城市词汇的集合。它是一个存储词汇意义和用法的多关联数组包。该包允许添加、编辑、更新和检索字典中的词汇。

设计

类

要安装此包，需要 PHP 5.5+ 和 composer。满足这些要求后，请输入以下代码：

    $ composer require demola/urbandictionary

该词典包含带有其意义和用法的城市词汇

创建 dictionaryManager 实例

  $dictionaryManager = new DictionaryEngine();

将城市词汇添加到词典中

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

从词典中检索一个词汇

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

检索整个词典

 	   $data = $dictionaryManager->retrieveAll();

更新一个词汇及其意义和示例句子

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

删除城市词典中的一个词汇

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

在一个句子中对词汇进行排名

创建一个 wordOccurence 实例

 $wordOccurence = new RankWord;

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

在 urban-dictionary 目录中运行以下命令：

      ~ phpunit

请查看 CHANGELOG 文件以获取最近更改的信息。

请查看 CONTRIBUTING 文件以获取详细的贡献指南。

如果您发现任何问题，请通过 ademola.raimi@andela.com 联系我们。

Urban Dictionary 由 Raimi Ademola 维护。

UrbanDictionary 在 MIT 许可证下发布。有关详细信息，请参阅捆绑的 LICENSE 文件。