https://github.com/aloskutov/php-fishtext
https://github.com/aloskutov/php-fishtext
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/aloskutov/php-fishtext
- Owner: aloskutov
- Created: 2022-04-24T11:45:34.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-11T18:40:45.000Z (over 2 years ago)
- Last Synced: 2025-01-22T12:13:30.564Z (4 months ago)
- Language: PHP
- Size: 32.2 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# php-fishtext
Получает данные через API с сайта FishText (https://fish-text.ru/get) генерирующего тестовый контент трёх типов: заголовок, предложения и абзац/параграф.
## Требования
- PHP 7.4 или выше
- для php 7.4 расширение **mbstring**
## Установка
```shell
composer require aloskutov/php-fishtext
```
## Адапторы
Можно использовать один из двух адапторов для получения данных онлайн (с сайта https://fish-text.ru/) или генерировать локально из генератора текстов.
Онлайн адаптор подключен по-умолчанию. Локальный генератор выдаёт данные намного быстрее, но заголовки генерируются в том же генераторе, что и текст, и мало похожи на заголовки.
Использование локального генератора:
```php
use ALoskutov\FishText\FishText;
use ALoskutov\FishText\FishTextAdaptorLocal;
$fishtext = new FishText(new FishTextAdaptorLocal());
```
## Данные
Работает с тремя типами данных:
- Заголовок (от 1 до 500 заголовков, по-умолчанию: 1)
- Предложение (от 1 до 500 предложений, по-умолчанию: 3)
- Абзац (от 1 до 100 абзацев, по умолчанию 3)
## Форматы
Может возвращать данные в формате `tex` или `html`. Формат указывается методом `setFormat()`, по-умолчанию установлен формат `text`.
### text
Пример использования:
```php
use ALoskutov\FishText\FishText;
$fishtext = new FishText();
$fishtext->setFormat('text');
echo $fishtext->title();
```
На выходе строка. При запросе нескольких параграфов, абзацы разделены символами `\n\n`.
### html
Пример использования:
```php
use ALoskutov\FishText\FishText;
$fishtext = new FishText();
$fishtext->setFormat('html');
echo $fishtext->paragraph(5);
```
Данные возвращаются обёрнутые html тэгами.
- Предложения, (метод `sentence()`) оборачиваются тэгом `
`.
- Заголовки, (метод `title()`) оборачивается тегом `
`.
- Абазацы/параграфы, (метод `paragraph()`) каждый параграф оборачивается тэгом `
`.
## Пример
```php
title());
// Устанавливаем формат возвращаемых данных: HTML
$fishtext->setFormat('html');
// Запрашиваем данные типа Предложение, три предложения (по-умолчанию)
var_dump($fishtext->sentence());
// Запрашиваем данные типа Абзац, по умолчанию три абзаца (по-умолчанию)
var_dump($fishtext->paragraph());
```
## TODO
- [x] add local generator adaptor
- [ ] add local title generator