flamecore/essentials

Essential helper classes for Social Networking sites

v0.1.0 2015-08-03 15:21 UTC

README

Latest Stable Build Status Scrutinizer Coverage License

This library provides essential helper classes for Social Networking sites.

Features

  • Formatters: Format meta information and text fragments

    Classes: LinkFormatter, RelativeTimeFormatter

  • Text Parsers: Parse and format all types of text

    Classes: SimpleTextParser, BBCodeParser

  • Helpers: Many useful helper classes

    Classes: KeywordsFinder, Slugifier, WordlistGenerator

Installation

Install via Composer

Create a file called composer.json in your project directory and put the following into it:

{
    "require": {
        "flamecore/essentials": "0.1.*"
    }
}

Install Composer if you don't already have it present on your system:

$ curl -sS https://getcomposer.org/installer | php

Use Composer to download the vendor libraries and generate the vendor/autoload.php file:

$ php composer.phar install

To make use of the API, include the vendor autoloader and use the classes:

namespace Acme\MyApplication;

use FlameCore\Essentials\KeywordsFinder;

require 'vendor/autoload.php';

Requirements

  • You must have at least PHP version 5.4 installed on your system.

Contributors

If you want to contribute, please see the CONTRIBUTING file first.

Thanks to the contributors:

  • Christian Neff (secondtruth)