marc1706/phpbb-text-shortener

Library for shortening post text in phpBB 3.2.x

phpbb-text-shortener library

About

phpbb-text-shortener is a PHP library for shortening post text in phpBB 3.3.x to a specified length., _(*1)

Requirements

PHP 7.1.3 or newer is required for this library to work., _(*2)

Installation

It is recommend to install the library using composer. Just add the following snippet to your composer.json:, _(*3)

  "require": {
    "marc1706/phpbb-text-shortener": "~0.2"
  },

Usage

Create an instance of text shortener:, _(*4)

$shortener = new \Marc1706\TextShortener\Shortener();

Grab the database representation of a post from the database and pass it to the shortener (e.g. to a length of 200 characters):, _(*5)

$shortener->setText($postText)
    ->shortenText(200);

Automated Tests

The library is being tested using unit tests to prevent possible issues., _(*6)

, _(*7)

License

The MIT License (MIT), _(*8)