PHP Class Faker\Provider\Text

Inheritance: extends Faker\Provider\Base
Show file Open project: fzaninotto/faker Class Usage Examples

Protected Properties

Property Type Description
$baseText
$consecutiveWords
$explodedText
$separator
$separatorLen
$textStartsWithUppercase

Public Methods

Method Description
realText ( integer $maxNbChars = 200, integer $indexSize = 2 ) : string Generate a text string by the Markov chain algorithm.

Protected Methods

Method Description
appendEnd ( $text )
explode ( $text )
getConsecutiveWords ( $indexSize )
getExplodedText ( )
implode ( $words )
strlen ( $text )
validStart ( $word )

Method Details

appendEnd() protected static method

protected static appendEnd ( $text )

explode() protected static method

protected static explode ( $text )

getConsecutiveWords() protected method

protected getConsecutiveWords ( $indexSize )

getExplodedText() protected method

protected getExplodedText ( )

implode() protected static method

protected static implode ( $words )

realText() public method

Depending on the $maxNbChars, returns a random valid looking text. The algorithm generates a weighted table with the specified number of words as the index and the possible following words as the value.
public realText ( integer $maxNbChars = 200, integer $indexSize = 2 ) : string
$maxNbChars integer Maximum number of characters the text should contain (minimum: 10)
$indexSize integer Determines how many words are considered for the generation of the next word. The minimum is 1, and it produces the higher level of randomness, although the generated text usually doesn't make sense. Higher index sizes (up to 5) produce more correct text, at the price of less randomness.
return string

strlen() protected static method

protected static strlen ( $text )

validStart() protected static method

protected static validStart ( $word )

Property Details

$baseText protected static property

protected static $baseText

$consecutiveWords protected property

protected $consecutiveWords

$explodedText protected property

protected $explodedText

$separator protected static property

protected static $separator

$separatorLen protected static property

protected static $separatorLen

$textStartsWithUppercase protected static property

protected static $textStartsWithUppercase