public function GeneratorInterface::lorem in Style Guide 8

Same name and namespace in other branches

1. 2.x src/GeneratorInterface.php \Drupal\styleguide\GeneratorInterface::lorem()

Lorum ipsum text, used to generate words and phrases.

Parameters

int $size: The size of the list to return.

int $words: The number of words to return. Pass 0 for a whole paragraph.

string $case: The case of the text. Options are 'mixed', 'upper' and 'lower'.

bool $returns: Indicates whether line returns should not be stripped out of the result.

bool $punctuation: Indicates whether punctuation should not be stripped out of the result.

bool $array: Indicates that the return value should be an array instead of a string.

Return value

string|array A string or array of content.

1 method overrides GeneratorInterface::lorem()

Generator::lorem in src/Generator.php

Lorum ipsum text, used to generate words and phrases.

File

src/GeneratorInterface.php, line 79

Class

GeneratorInterface

Interface GeneratorInterface.

Namespace

Drupal\styleguide

Code

public function lorem($size = 5, $words = 0, $case = 'mixed', $returns = TRUE, $punctuation = TRUE, $array = FALSE);