README

Получает данные через API с сайта FishText (https://fish-text.ru/get) генерирующего тестовый контент трёх типов: заголовок, предложения и абзац/параграф.

Требования

PHP 7.4 или выше
для php 7.4 расширение mbstring

Установка

composer require aloskutov/php-fishtext

Адапторы

Можно использовать один из двух адапторов для получения данных онлайн (с сайта https://fish-text.ru/) или генерировать локально из генератора текстов.

Онлайн адаптор подключен по-умолчанию. Локальный генератор выдаёт данные намного быстрее, но заголовки генерируются в том же генераторе, что и текст, и мало похожи на заголовки.

Использование локального генератора:

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

Пример использования:

use ALoskutov\FishText\FishText;

$fishtext = new FishText();
$fishtext->setFormat('text');
echo $fishtext->title();

На выходе строка. При запросе нескольких параграфов, абзацы разделены символами \n\n.

html

Пример использования:

use ALoskutov\FishText\FishText;

$fishtext = new FishText();
$fishtext->setFormat('html');
echo $fishtext->paragraph(5);

Данные возвращаются обёрнутые html тэгами.

Предложения, (метод sentence()) оборачиваются тэгом <h1>.
Заголовки, (метод title()) оборачивается тегом <p>.
Абазацы/параграфы, (метод paragraph()) каждый параграф оборачивается тэгом <p>.

Пример

<?php

declare(strict_types=1);

require_once("vendor/autoload.php");

use ALoskutov\FishText\FishText;

$fishtext = new FishText();

// Запрашиваем данные типа Заголовок, одно предложение (по-умолчанию)
var_dump($fishtext->title());

// Устанавливаем формат возвращаемых данных: HTML
$fishtext->setFormat('html');

// Запрашиваем данные типа Предложение, три предложения (по-умолчанию)
var_dump($fishtext->sentence());

// Запрашиваем данные типа Абзац, по умолчанию три абзаца (по-умолчанию)
var_dump($fishtext->paragraph());

TODO

add local generator adaptor
add local title generator

aloskutov / php-fishtext

Maintainers

Details