2017 © Pedro Peláez
 

library php-loremipsum

Lorem ipsum generator in PHP without dependencies

image

joshtronic/php-loremipsum

Lorem ipsum generator in PHP without dependencies

  • Tuesday, January 9, 2018
  • by joshtronic
  • Repository
  • 9 Watchers
  • 68 Stars
  • 58,914 Installations
  • PHP
  • 8 Dependents
  • 0 Suggesters
  • 14 Forks
  • 0 Open issues
  • 6 Versions
  • 7 % Grown

The README.md

php-loremipsum

Build Status Coverage Status Total Downloads, (*1)

Lorem ipsum generator in PHP without dependencies. Compatible with PHP 5.3+ as well as HHVM., (*2)

Origins

Once upon a time, I was attempting to find a lorem ipsum generator over on Packagist. I was presented with many options, and some of those options were good. Unfortunately, the bulk of those options depended on Symphony or the Zend Framework. This wouldn’t have been a big deal but under the circumstances, I wanted something that was not tightly coupled to these frameworks because I wanted to use the generator in my own framework., (*3)

I had decided to use badcow/lorem-ipsum because it did not have any dependencies nor did it rely on any external APIs. As I started to use the library, I found that I was going to have to fight with it to get it to do what I wanted. After digging through the code, I realized that I was going to end up gutting most of it to bend it to my will. I know when you overhaul someone’s code the liklihood of them accepting a pull request goes down dramatically, hence building this library while taking cues from it’s predecessor., (*4)

Also, the aforementioned package had a bunch of “setter” and “getter” methods that were grossing me out :scream:, (*5)

Installation

The preferred installation method is via composer. First add the following to your composer.json, (*6)

"require": {
    "joshtronic/php-loremipsum": "dev-master"
}

Then run composer update, (*7)

Usage

Getting Started

$lipsum = new joshtronic\LoremIpsum();

Generating Words

echo '1 word: '  . $lipsum->word();
echo '5 words: ' . $lipsum->words(5);

Generating sentences

echo '1 sentence:  ' . $lipsum->sentence();
echo '5 sentences: ' . $lipsum->sentences(5);

Generating paragraphs

echo '1 paragraph:  ' . $lipsum->paragraph();
echo '5 paragraphs: ' . $lipsum->paragraphs(5);

Wrapping text with HTML tags

If you would like to wrap the generated text with a tag, pass it as the second parameter:, (*8)

echo $lipsum->paragraphs(3, 'p');

// Generates: 

Lorem ipsum..., (*9)

..., (*10)

..., (*11)

Multiple tags can also be specified:, (*12)

echo $lipsum->sentences(3, ['article', 'p']);

// Generates: <article>

..., (*13)

</article><article>

..., (*14)

</article><article>

..., (*15)

</article>

And you can back reference using $1:, (*16)

echo $lipsum->words(3, '<li><a href="$1">$1</a></li>');

// Generates: <li><a href="...">...</a></li><li><a href="...">...</a></li><li><a href="...">...</a></li>

Return as an array

Perhaps you want an array instead of a string:, (*17)

print_r($lipsum->wordsArray(5));
print_r($lipsum->sentencesArray(5));
print_r($lipsum->paragraphsArray(5));

You can still wrap with markup when returning an array:, (*18)

print_r($lipsum->wordsArray(5, 'li'));

Assumptions

Instead of having an option as to whether or not a string should start the generated output with “Lorem ipsum dolor sit amet, consectetur adipiscing elit.” a few assumptions are baked in. The first string generated will always start with the traditional “Lorem ipsum…”. Subsequent strings may contain those words but will not explicitly start with them., (*19)

Contributing

Suggestions and bug reports are always welcome, but karma points are earned for pull requests., (*20)

Unit tests are required for all contributions. You can run the test suite from the tests directory simply by running phpunit ., (*21)

The Versions

09/01 2018

dev-development

dev-development https://github.com/joshtronic/php-loremipsum

Lorem ipsum generator in PHP without dependencies

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

The Development Requires

generator lorem ipsum

09/01 2018

dev-master

9999999-dev https://github.com/joshtronic/php-loremipsum

Lorem ipsum generator in PHP without dependencies

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

The Development Requires

generator lorem ipsum

09/01 2018

1.0.3

1.0.3.0 https://github.com/joshtronic/php-loremipsum

Lorem ipsum generator in PHP without dependencies

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

The Development Requires

generator lorem ipsum

29/05 2017

1.0.2

1.0.2.0 https://github.com/joshtronic/php-loremipsum

Lorem ipsum generator in PHP without dependencies

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

The Development Requires

generator lorem ipsum

09/06 2016

1.0.1

1.0.1.0 https://github.com/joshtronic/php-loremipsum

Lorem ipsum generator in PHP without dependencies

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

The Development Requires

generator lorem ipsum

13/09 2014

1.0.0

1.0.0.0 https://github.com/joshtronic/php-loremipsum

Lorem ipsum generator in PHP without dependencies

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

The Development Requires

generator lorem ipsum