README

CLI and PHP class for generating lorem ipsum text using www.lipsum.com

Install

Via Composer

$ composer require rpalladino/php-lipsum

Usage

CLI

$ ./vendor/bin/lipsum 

Options

Usage:
 lipsum [-w|--what="..."] [-a|--amount="..."] [-s|--start-with-lipsum]

Options:
 --what (-w)              The kind of text to generate: paras, words, bytes, lists (default: "paras")
 --amount (-a)            The amount of text to generate (default: 5)
 --start-with-lipsum (-s) Start generated text with "Lorem ipsum dolor sit amet."

Examples

# get 1 paragraph of text
$ ./vendor/bin/lipsum -a 1

# get 25 words of text beginning with "lorem ipsum"
$ ./vendor/bin/lipsum -w words -a 25 -s

# get 3 list items
$ ./vendor/bin/lipsum -w lists -a 3

PHP Class

require "vendor/autoload.php";

$lipsum = new Rpalladino\Lipsum\Lipsum();

// get 1 paragraph of text
$lipsum->getParagraphs(1);

// get 25 words of text beginning with "lorem ipsum"
$lipsum->getWords(25, true);

// get 3 list items
$lipsum->getLists(3);

License

The MIT License (MIT). Please see License File for more information.