writecrow/lorem_gutenberg

一个用于从Project Gutenberg书籍生成填充文本的PHP库

1.1 2018-01-11 20:11 UTC

This package is auto-updated.

Last update: 2024-09-10 11:33:12 UTC


README

Circle CI

一个PHP库,用于生成随机文本,文本来源于Project Gutenberg的多个作者。

Screenshot of Text Generation

在应用中使用

包含的 /index.php 文件包含一个生成表单的演示。

通过您喜欢的途径(例如,userequire)让您的代码了解LoremGutenberg类

然后将一段文本传递给这个类

$text = LoremGutenberg::generate();
echo $text;
// Will return an excerpt of random length (1-10 sentences) from a random author.

$text = LoremGutenberg::generate(array('author' => 'austen'));
echo $text;
// Will return an excerpt of random length (1-10 sentences) from Jane Austen.

$text = LoremGutenberg::generate(array('author' => 'hardy', 'sentences' => 3));
echo $text;
// Will return an excerpt of 3 sentences from Thomas Hardy.

作为API使用

/api 目录中的文件演示了如何将URL中的GET参数传递给LoremGutenberg。例如,https://my-api.org/api/?author=hardy&sentences=2 将返回托马斯·哈代的2句话的LoremGutenberg文本。

参数

有效的API查询示例

  • /api/?author=hardy&sentences=2
  • /api/?author=hardy
  • /api/?sentences=2
  • /api/

有哪些作者可用?

截至本文撰写时,LoremGutenberg引用了以下作者的作品

public static $authors = [
  'austen' => 'Jane Austen',
  'hardy' => 'Thomas Hardy',
  'lawrence' => 'D.H. Lawrence',
  'wharton' => 'Edith Wharton',
];

测试

可以通过执行 vendor/bin/phpunit 运行单元测试(在 composer install 之后)