joshtronic/php-loremipsum
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Dropped HHVM reference, misc. cleanup

Browse source
This commit is contained in:
Josh Sherman 2019-01-02 23:34:34 -06:00
parent 099b421d0d
commit 405b5a404d
No known key found for this signature in database
GPG key ID: 55B058A80530EF22
1 changed files with 28 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

57
README.md
View file

@ -4,36 +4,35 @@
[![Coverage Status](https://coveralls.io/repos/github/joshtronic/php-loremipsum/badge.svg?branch=master)](https://coveralls.io/github/joshtronic/php-loremipsum?branch=master) [![Coverage Status](https://coveralls.io/repos/github/joshtronic/php-loremipsum/badge.svg?branch=master)](https://coveralls.io/github/joshtronic/php-loremipsum?branch=master)
[![Total Downloads](https://poser.pugx.org/joshtronic/php-loremipsum/downloads)](https://packagist.org/packages/joshtronic/php-loremipsum) [![Total Downloads](https://poser.pugx.org/joshtronic/php-loremipsum/downloads)](https://packagist.org/packages/joshtronic/php-loremipsum)
Lorem ipsum generator in PHP without dependencies. Compatible with PHP 5.3+ as Lorem ipsum generator in PHP without dependencies. Compatible with PHP 5.3+.
well as HHVM.
## Origins ## Origins
Once upon a time, I was attempting to find a lorem ipsum generator over on Once upon a time, I was attempting to find a lorem ipsum generator over on
[Packagist](https://packagist.org/search/?q=lorem%20ipsum). I was presented [Packagist](https://packagist.org/search/?q=lorem%20ipsum). I was presented with
with many options, and some of those options were good. Unfortunately, the many options, and some of those options were good. Unfortunately, the bulk of
bulk of those options depended on Symphony or the Zend Framework. This those options depended on Symphony or the Zend Framework. This wouldn’t have
wouldn’t have been a big deal but under the circumstances, I wanted something been a big deal but under the circumstances, I wanted something that was not
that was not tightly coupled to these frameworks because I wanted to use the tightly coupled to these frameworks because I wanted to use the generator in my
generator in my _own_ framework. _own_ framework.
I had decided to use I had decided to use
[badcow/lorem-ipsum](https://packagist.org/packages/badcow/lorem-ipsum) [badcow/lorem-ipsum](https://packagist.org/packages/badcow/lorem-ipsum) because
because it did not have any dependencies nor did it rely on any external APIs. it did not have any dependencies nor did it rely on any external APIs. As I
As I started to use the library, I found that I was going to have to fight started to use the library, I found that I was going to have to fight with it to
with it to get it to do what I wanted. After digging through the code, I get it to do what I wanted. After digging through the code, I realized that I
realized that I was going to end up gutting most of it to bend it to my will. was going to end up gutting most of it to bend it to my will. I know when you
I know when you overhaul someone’s code the liklihood of them accepting a pull overhaul someone’s code the likelihood of them accepting a pull request goes
request goes down dramatically, hence building this library while taking cues down dramatically, hence building this library while taking cues from it’s
from it’s predecessor. predecessor.
Also, the aforementioned package had a bunch of “setter” and “getter” methods Also, the aforementioned package had a bunch of “setter” and “getter” methods
that were grossing me out :scream: that were grossing me out :scream:
## Installation ## Installation
The preferred installation method is via `composer`. First add the following The preferred installation method is via `composer`. First add the following to
to your `composer.json` your `composer.json`
```json ```json
"require": { "require": {
@ -54,21 +53,21 @@ $lipsum = new joshtronic\LoremIpsum();
### Generating Words ### Generating Words
```php ```php
echo '1 word: ' . $lipsum->word(); echo '1 word: ' . $lipsum->word();
echo '5 words: ' . $lipsum->words(5); echo '5 words: ' . $lipsum->words(5);
``` ```
### Generating sentences ### Generating sentences
```php ```php
echo '1 sentence: ' . $lipsum->sentence(); echo '1 sentence: ' . $lipsum->sentence();
echo '5 sentences: ' . $lipsum->sentences(5); echo '5 sentences: ' . $lipsum->sentences(5);
``` ```
### Generating paragraphs ### Generating paragraphs
```php ```php
echo '1 paragraph: ' . $lipsum->paragraph(); echo '1 paragraph: ' . $lipsum->paragraph();
echo '5 paragraphs: ' . $lipsum->paragraphs(5); echo '5 paragraphs: ' . $lipsum->paragraphs(5);
``` ```
@ -118,15 +117,15 @@ print_r($lipsum->wordsArray(5, 'li'));
## Assumptions ## Assumptions
Instead of having an option as to whether or not a string should start the 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 generated output with “Lorem ipsum dolor sit amet, consectetur adipiscing elit.”
elit.” a few assumptions are baked in. The first string generated will always a few assumptions are baked in. The first string generated will always start
start with the traditional “Lorem ipsum…”. Subsequent strings may contain with the traditional “Lorem ipsum…”. Subsequent strings may contain those words
those words but will not explicitly start with them. but will not explicitly start with them.
## Contributing ## Contributing
Suggestions and bug reports are always welcome, but karma points are earned Suggestions and bug reports are always welcome, but karma points are earned for
for pull requests. pull requests.
Unit tests are required for all contributions. You can run the test suite Unit tests are required for all contributions. You can run the test suite from
from the `tests` directory simply by running `phpunit .` the `tests` directory simply by running `phpunit .`