Documentation

Company extends Company
in package

Application

$catchPhrase : array<string|int, mixed>
$companyPrefix : mixed
$companySuffix : mixed
$formats : mixed
$generator : Generator
$jobTitleFormat : mixed
$unique : UniqueGenerator
__construct() : mixed
asciify() : string: Replaces * signs with random numbers and letters and special characters
bothify() : string: Replaces hash signs ('#') and question marks ('?') with random numbers and letters An asterisk ('*') is replaced with either a random number or a random letter
catchPhrase() : mixed
company() : string
companyPrefix() : mixed
companySuffix() : string
jobTitle() : string
lexify() : string: Replaces all question mark ('?') occurrences with a random letter
numberBetween() : int: Returns a random number between $int1 and $int2 (any order)
numerify() : string: Replaces all hash sign ('#') occurrences with a random number Replaces all percentage sign ('%') occurrences with a not null number
optional() : mixed|null: Chainable method for making any formatter optional.
passthrough() : mixed: Returns the passed value
randomAscii() : string: Returns a random ASCII character (excluding accents and special chars)
randomDigit() : int: Returns a random number between 0 and 9
randomDigitNot() : int: Generates a random digit, which cannot be $except
randomDigitNotNull() : int: Returns a random number between 1 and 9
randomElement() : mixed: Returns a random element from a passed array
randomElements() : array<string|int, mixed>: Returns randomly ordered subsequence of $count elements from a provided array
randomFloat() : float: Return a random float number
randomKey() : int|string|null: Returns a random key from a passed associative array
randomLetter() : string: Returns a random letter from a to z
randomNumber() : int: Returns a random integer with 0 to $nbDigits digits.
regexify() : string: Transforms a basic regular expression into a random string satisfying the expression.
shuffle() : array<string|int, mixed>|string: Returns a shuffled version of the argument.
shuffleArray() : array<string|int, mixed>: Returns a shuffled version of the array.
shuffleString() : string: Returns a shuffled version of the string.
toLower() : string: Converts string to lowercase.
toUpper() : string: Converts string to uppercase.
unique() : UniqueGenerator: Chainable method for making any formatter unique.
valid() : ValidGenerator: Chainable method for forcing any formatter to return only valid values.
replaceWildcard() : mixed

$catchPhrase


    protected
    static    array<string|int, mixed>
    $catchPhrase
     = ['燕舞，燕舞，一曲歌来一片情。', '康师傅方便面，好吃看得见。', '不要太潇洒！', '让一亿人先聪明起来。', '共创美的前程，共度美的人生。', '省优，部优，葛优？', '喝孔府宴酒，做天下文章。', '健康成就未来。', '牙好，胃口就好，身体倍儿棒，吃嘛嘛香。', '永远的绿色，永远的秦池。', '坐红旗车，走中国路。', '要想皮肤好，早晚用大宝。', '孔府家酒，叫人想家。', '补钙新观念，吸收是要害。', '喝汇源果汁，走健康之路。', '爱的就是你!', '一种可以世袭的古典浪漫', '实力创造价值', '爱生活，爱拉芳！', '人类失去联想，世界将会怎样？', '做女人挺好！', '世界在你眼中？', '今天你有否亿唐？', '只溶在口，不溶在手。', '三千烦恼丝，健康新开始。', '维维豆奶，欢乐开怀。', '我们的光彩来自你的风采。', '钻石恒久远，一颗永流传。', '放我的真心在你的手心。', '小身材，大味道。', '牛奶香浓，丝般感受。', '聆听并不代表沉默，有时安静也是一种力量。', '滴滴香浓，意犹未尽。', '水晶之恋，一生不变。', '中国移动通信，沟通从心开始！', '网易，网聚人的力量！', '科技以人为本，诺基亚', '我们一直在努力！', '阳光总在风雨后', '男人对西服的要求，就是女人对男人的要求', '晚报，不晚报', '原来生活可以更美的', '明天的明天，你还会送我“水晶之恋”吗？', '卫浴出出进进的快感', '有家就有联合利华', '减脂减肥，其实是一种生活态度', '人头马一开，好事自然来。', '假如五指一样长，怎能满足用户不同需求？', '新飞广告做的好，不好新飞冰箱好', '传奇品质，百年张裕', '李宁：把出色留给自己', '一旦拥有，别无选择', '科技让你更轻松', '情系中国结，联通四海心', '海尔，中国造', 'SOHU：足迹生活每一天', '果冻我要喜之郎', '国宝大熊猫，心纯天自高', '世界因为不同', '放低偏见，你会有出色发现！', 'Just', '创意似金，敬业如牛', '不要让男人一手把握', '如同情人的手', '金窝银窝，不如自己的安乐窝。', '没有什么大不了的', '时间因我存在', '只要有梦想', '南方周末', '时间改变一切', '地球人都知道了', '众里寻他千百度，想要几度就几度', '您身边的银行，可信赖的银行', '三叶钢琴：学琴的孩子不会变坏', '柯达：串起生活每一刻', '大众甲克虫汽车：想想还是小的好', '一直被模拟,从未被超越', '幸福生活', '朗讯的创造力科技的原动力', '事事因你而出色', '运动之美，世界共享', '鹤舞白沙', '想知道“清嘴”的味道吗？', '弹指一挥间，世界皆互联', '更多选择、更多欢笑', '方太，让家的感觉更好', '世上仅此一件，今生与你结缘！', '白里透红与众不同', '没有蛀牙-佳洁士', '有线的价值', '享受快乐科技', '四海一家的解决之道', '娃哈哈纯净水：爱你等于爱自己', '农民山泉：有点甜', '博大精深，西门子', '一切尽在把握', '声声百思特，遥遥两相知', '一呼天下应', '让我们做得更好！', '暖和亲情，金龙鱼的大家庭。', '自然最健康，绿色好心情', '支起网络世界', '立邦漆：处处放光彩！', 'fm365:真情互动！', '庄重一生，吉祥一生。', '人人都为礼品愁，我送北极海狗油。', '假如说人生的离合是一场戏，那么百年的好合更是早有安排！', '一品黄山天高云淡', '上上下下的享受！', '我是、我行、我素', '让无力者有力，让悲观者前行', '金利来—-男人的世界！', '百衣百顺', '聪明何必绝顶，慧根长留', '水往高处流', '大石化小，小石化了！', '“闲”妻良母', '“口服”，“心服”！', '盛满青春的秘密！', '三十六计走为上', '为了她的节日，献上您纯金般的心！', '用我们的钓线，你可以在鱼儿发现你之前先找到它', '生活就是一场运动，喝下它。', '选择维聚阿尔，已经表明你心明眼亮。', '佳能，我们看得见你想表达什么。', '天天都是春天', '假如你不来，广告明星就是他', '享受黑夜中偷拍的快感！', '彩信发送动人一刻', '灵感点亮生活!', '聪明演绎，无处不在！', '事业我一定争取，对你我从未放弃!', '波导手机，手机中的战斗机', '鄂尔多斯羊绒衫暖和全世界', '洁婷245再大的动作也不要紧', '做光明的牛，产光明的奶', '假如你的汽车会游泳的话，请照直开，不必刹车。', '永远要让驾驶执照比你自己先到期。', '请记住，上帝并不是十全十美的，它给汽车预备了备件，而人没有。', '小别意酸酸，欢聚心甜甜。', '除钞票外，承印一切。', '更多欢乐，更多选择', '美由你做主', '由我天地宽', 'Sun是太阳，Java是月亮。', '不断创新，因为专心', '趁早下『斑』，请勿『痘』留。', '请不要同刚刚走出本院的女人调情，她或许就是你的外祖母。', '创新就是生活', '有一个漂亮的地方，万科四季花城', '建筑无限生活', '臭名远扬，香飘万里', '尝尝欢笑，经常麦当劳', '深入成就深度', '出色湖南，红网了然！', '因为网络，地球如村！', '一种质感', '恒久期盼', '繁荣民族文化', '不信，死给你看！', '天生的，强生的', '雪津啤酒，真情的味道！', '听世界，打天下', '雅芳比女人更了解女人', 'Sun是太阳，Java是月亮。', '中国网通', '无线你的无限', '家有三洋，冬暖夏凉', '倾诉冬日暖语', '谁让我心动？', '灵活，让篮球场不再是一个平面', '别吻我，我怕修。', '一呼四应！', '无所不包！', '当之无愧', '以帽取人！', '一毛不拔！', '自讨苦吃！', '成功与科技共辉映', '没有最']

$companyPrefix


    protected
    static    mixed
    $companyPrefix
     = ['超艺', '和泰', '九方', '鑫博腾飞', '戴硕电子', '济南亿次元', '海创', '创联世纪', '凌云', '泰麒麟', '彩虹', '兰金电子', '晖来计算机', '天益', '恒聪百汇', '菊风公司', '惠派国际公司', '创汇', '思优', '时空盒数字', '易动力', '飞海科技', '华泰通安', '盟新', '商软冠联', '图龙信息', '易动力', '华远软件', '创亿', '时刻', '开发区世创', '明腾', '良诺', '天开', '毕博诚', '快讯', '凌颖信息', '黄石金承', '恩悌', '雨林木风计算机', '双敏电子', '维旺明', '网新恒天', '数字100', '飞利信', '立信电子', '联通时科', '中建创业', '新格林耐特', '新宇龙信息', '浙大万朋', 'MBP软件', '昂歌信息', '万迅电脑', '方正科技', '联软', '七喜', '南康', '银嘉', '巨奥', '佳禾', '国讯', '信诚致远', '浦华众城', '迪摩', '太极', '群英', '合联电子', '同兴万点', '襄樊地球村', '精芯', '艾提科信', '昊嘉', '鸿睿思博', '四通', '富罳', '商软冠联', '诺依曼软件', '东方峻景', '华成育卓', '趋势', '维涛', '通际名联']

$companySuffix


    protected
    static    mixed
    $companySuffix
     = ['科技', '网络', '信息', '传媒']

$formats


    protected
    static    mixed
    $formats
     = ['{{companyPrefix}}{{companySuffix}}']

$generator


    protected
        Generator
    $generator

$jobTitleFormat


    protected
    static    mixed
    $jobTitleFormat
     = ['{{word}}']

$unique


    protected
        UniqueGenerator
    $unique

__construct()


    public
                __construct(Generator $generator) : mixed

Parameters

$generator : Generator

Return values

mixed —

asciify()

Replaces * signs with random numbers and letters and special characters


    public
            static    asciify([string $string = '****' ]) : string

Parameters

$string : string = '****': String that needs to bet parsed

Return values

string —

bothify()

Replaces hash signs ('#') and question marks ('?') with random numbers and letters An asterisk ('*') is replaced with either a random number or a random letter


    public
            static    bothify([string $string = '## ??' ]) : string

Parameters

$string : string = '## ??': String that needs to bet parsed

Return values

string —

catchPhrase()


    public
                catchPhrase() : mixed

Return values

mixed —

company()


    public
                company() : string

Return values

string —

companyPrefix()


    public
            static    companyPrefix() : mixed

Return values

mixed —

companySuffix()


    public
            static    companySuffix() : string

Return values

string —

jobTitle()


    public
                jobTitle() : string

Return values

string —

lexify()

Replaces all question mark ('?') occurrences with a random letter


    public
            static    lexify([string $string = '????' ]) : string

Parameters

$string : string = '????': String that needs to bet parsed

Return values

string —

numberBetween()

Returns a random number between $int1 and $int2 (any order)


    public
            static    numberBetween(int $int1[, int $int2 = 2147483647 ]) : int

Parameters

$int1 : int: default to 0
$int2 : int = 2147483647: defaults to 32 bit max integer, ie 2147483647

Return values

int —

numerify()

Replaces all hash sign ('#') occurrences with a random number Replaces all percentage sign ('%') occurrences with a not null number


    public
            static    numerify([string $string = '###' ]) : string

Parameters

$string : string = '###': String that needs to bet parsed

Return values

string —

optional()

Chainable method for making any formatter optional.


    public
                optional([float|int $weight = 0.5 ][, mixed $default = null ]) : mixed|null

Parameters

$weight : float|int = 0.5: Set the probability of receiving a null value. "0" will always return null, "1" will always return the generator. If $weight is an integer value, then the same system works between 0 (always get false) and 100 (always get true).
$default : mixed = null

Return values

mixed|null —

passthrough()

Returns the passed value


    public
            static    passthrough(mixed $value) : mixed

Parameters

$value : mixed

Return values

mixed —

randomAscii()

Returns a random ASCII character (excluding accents and special chars)


    public
            static    randomAscii() : string

Return values

string —

randomDigit()

Returns a random number between 0 and 9


    public
            static    randomDigit() : int

Return values

int —

randomDigitNot()

Generates a random digit, which cannot be $except


    public
            static    randomDigitNot(int $except) : int

Parameters

$except : int

Return values

int —

randomDigitNotNull()

Returns a random number between 1 and 9


    public
            static    randomDigitNotNull() : int

Return values

int —

randomElement()

Returns a random element from a passed array


    public
            static    randomElement([array<string|int, mixed> $array = ['a', 'b', 'c'] ]) : mixed

Parameters

$array : array<string|int, mixed> = ['a', 'b', 'c']

Return values

mixed —

randomElements()

Returns randomly ordered subsequence of $count elements from a provided array


    public
            static    randomElements([array<string|int, mixed> $array = ['a', 'b', 'c'] ][, int $count = 1 ][, bool $allowDuplicates = false ]) : array<string|int, mixed>

Parameters

$array : array<string|int, mixed> = ['a', 'b', 'c']: Array to take elements from. Defaults to a-c
$count : int = 1: Number of elements to take.
$allowDuplicates : bool = false: Allow elements to be picked several times. Defaults to false

Return values

array<string|int, mixed> —

New array with $count elements from $array

randomFloat()

Return a random float number


    public
            static    randomFloat([int $nbMaxDecimals = null ], float|int $min[, float|int $max = null ]) : float

Parameters

$nbMaxDecimals : int = null
$min : float|int
$max : float|int = null

Return values

float —

randomKey()

Returns a random key from a passed associative array


    public
            static    randomKey([array<string|int, mixed> $array = [] ]) : int|string|null

Parameters

$array : array<string|int, mixed> = []

Return values

int|string|null —

randomLetter()

Returns a random letter from a to z


    public
            static    randomLetter() : string

Return values

string —

randomNumber()

Returns a random integer with 0 to $nbDigits digits.


    public
            static    randomNumber([int $nbDigits = null ][, bool $strict = false ]) : int

The maximum value returned is mt_getrandmax()

Parameters

$nbDigits : int = null: Defaults to a random number between 1 and 9
$strict : bool = false: Whether the returned number should have exactly $nbDigits

Return values

int —

regexify()

Transforms a basic regular expression into a random string satisfying the expression.


    public
            static    regexify([string $regex = '' ]) : string

Parameters

$regex : string = '': A regular expression (delimiters are optional)

Return values

string —

shuffle()

Returns a shuffled version of the argument.


    public
            static    shuffle([array<string|int, mixed>|string $arg = '' ]) : array<string|int, mixed>|string

This function accepts either an array, or a string.

Parameters

$arg : array<string|int, mixed>|string = '': The set to shuffle

Return values

array<string|int, mixed>|string —

The shuffled set

shuffleArray()

Returns a shuffled version of the array.


    public
            static    shuffleArray([array<string|int, mixed> $array = [] ]) : array<string|int, mixed>

This function does not mutate the original array. It uses the Fisher–Yates algorithm, which is unbiased, together with a Mersenne twister random generator. This function is therefore more random than PHP's shuffle() function, and it is seedable.

Parameters

$array : array<string|int, mixed> = []: The set to shuffle

Return values

array<string|int, mixed> —

The shuffled set

shuffleString()

Returns a shuffled version of the string.


    public
            static    shuffleString([string $string = '' ][, string $encoding = 'UTF-8' ]) : string

This function does not mutate the original string. It uses the Fisher–Yates algorithm, which is unbiased, together with a Mersenne twister random generator. This function is therefore more random than PHP's shuffle() function, and it is seedable. Additionally, it is UTF8 safe if the mb extension is available.

Parameters

$string : string = '': The set to shuffle
$encoding : string = 'UTF-8': The string encoding (defaults to UTF-8)

Return values

string —

The shuffled set

toLower()

Converts string to lowercase.


    public
            static    toLower([string $string = '' ]) : string

Uses mb_string extension if available.

Parameters

$string : string = '': String that should be converted to lowercase

Return values

string —

toUpper()

Converts string to uppercase.


    public
            static    toUpper([string $string = '' ]) : string

Uses mb_string extension if available.

Parameters

$string : string = '': String that should be converted to uppercase

Return values

string —

unique()

Chainable method for making any formatter unique.


    public
                unique([bool $reset = false ][, int $maxRetries = 10000 ]) : UniqueGenerator


// will never return twice the same value
$faker->unique()->randomElement(array(1, 2, 3));

Parameters

$reset : bool = false: If set to true, resets the list of existing values
$maxRetries : int = 10000: Maximum number of retries to find a unique value, After which an OverflowException is thrown.

Return values

UniqueGenerator —

A proxy class returning only non-existing values

valid()

Chainable method for forcing any formatter to return only valid values.


    public
                valid([Closure $validator = null ][, int $maxRetries = 10000 ]) : ValidGenerator

The value validity is determined by a function passed as first argument.


$values = array();
$evenValidator = function ($digit) {
  return $digit % 2 === 0;
};
for ($i=0; $i < 10; $i++) {
  $values []= $faker->valid($evenValidator)->randomDigit;
}
print_r($values); // [0, 4, 8, 4, 2, 6, 0, 8, 8, 6]

Parameters

$validator : Closure = null: A function returning true for valid values
$maxRetries : int = 10000: Maximum number of retries to find a unique value, After which an OverflowException is thrown.

Return values

ValidGenerator —

A proxy class returning only valid values

replaceWildcard()


    private
            static    replaceWildcard(mixed $string[, mixed $wildcard = '#' ][, mixed $callback = 'static::randomDigit' ]) : mixed

Parameters

$string : mixed
$wildcard : mixed = '#'
$callback : mixed = 'static::randomDigit'

Return values

mixed —

Company extends Company in package Application

Table of Contents

Properties

$catchPhrase

Tags

$companyPrefix

$companySuffix

$formats

$generator

$jobTitleFormat

$unique

Methods

__construct()

Parameters

Return values

asciify()

Parameters

Tags

Return values

bothify()

Parameters

Return values

catchPhrase()

Return values

company()

Tags

Return values

companyPrefix()

Return values

companySuffix()

Return values

jobTitle()

Tags

Return values

lexify()

Parameters

Return values

numberBetween()

Parameters

Tags

Return values

numerify()

Parameters

Return values

optional()

Parameters

Return values

passthrough()

Parameters

Return values

randomAscii()

Return values

randomDigit()

Return values

randomDigitNot()

Parameters

Return values

randomDigitNotNull()

Return values

randomElement()

Parameters

Return values

randomElements()

Parameters

Tags

Return values

randomFloat()

Parameters

Tags

Return values

randomKey()

Parameters

Return values

randomLetter()

Return values

randomNumber()

Parameters

Tags

Return values

regexify()

Company extends Company
in package

Application