HumHub Documentation (unofficial)

Person extends Person
in package

Application

Constants

GENDER_FEMALE = 'female'
GENDER_MALE = 'male'

Properties

$femaleKanaNameFormats : mixed
$femaleNameFormats : mixed
$firstKanaNameFemale : mixed
$firstKanaNameFormat : mixed
$firstKanaNameMale : mixed
$firstNameFemale : mixed: {@link} http://dic.nicovideo.jp/a/%E6%97%A5%E6%9C%AC%E4%BA%BA%E3%81%AE%E5%90%8D%E5%89%8D%E4%B8%80%E8%A6%A7 {@link} http://www.meijiyasuda.co.jp/enjoy/ranking/
$firstNameFormat : mixed
$firstNameMale : mixed: {@link} http://dic.nicovideo.jp/a/%E6%97%A5%E6%9C%AC%E4%BA%BA%E3%81%AE%E5%90%8D%E5%89%8D%E4%B8%80%E8%A6%A7 {@link} http://www.meijiyasuda.co.jp/enjoy/ranking/
$generator : Generator
$lastKanaName : mixed
$lastName : mixed: {@link} http://dic.nicovideo.jp/a/%E6%97%A5%E6%9C%AC%E3%81%AE%E8%8B%97%E5%AD%97%28%E5%90%8D%E5%AD%97%29%E3%81%AE%E4%B8%80%E8%A6%A7
$maleKanaNameFormats : mixed
$maleNameFormats : mixed
$titleFemale : mixed
$titleFormat : mixed
$titleMale : mixed
$unique : UniqueGenerator

Methods

__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
firstKanaName() : string
firstKanaNameFemale() : mixed
firstKanaNameMale() : mixed
firstName() : string
firstNameFemale() : string
firstNameMale() : string
kanaName() : string
lastKanaName() : mixed
lastName() : string
lexify() : string: Replaces all question mark ('?') occurrences with a random letter
name() : string
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.
title() : string
titleFemale() : string
titleMale() : 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

GENDER_FEMALE


    public
        mixed
    GENDER_FEMALE
    = 'female'

GENDER_MALE


    public
        mixed
    GENDER_MALE
    = 'male'

$femaleKanaNameFormats


    protected
    static    mixed
    $femaleKanaNameFormats
     = ['{{lastKanaName}} {{firstKanaNameFemale}}']

$femaleNameFormats


    protected
    static    mixed
    $femaleNameFormats
     = ['{{lastName}} {{firstNameFemale}}']

$firstKanaNameFemale


    protected
    static    mixed
    $firstKanaNameFemale
     = ['アケミ', 'アスカ', 'カオリ', 'カナ', 'クミコ', 'サユリ', 'サトミ', 'チヨ', 'ナオコ', 'ナナミ', 'ハナコ', 'ハルカ', 'マアヤ', 'マイ', 'ミカコ', 'ミキ', 'モモコ', 'ユイ', 'ユミコ', 'ヨウコ', 'リカ']

$firstKanaNameFormat


    protected
    static    mixed
    $firstKanaNameFormat
     = ['{{firstKanaNameMale}}', '{{firstKanaNameFemale}}']

$firstKanaNameMale


    protected
    static    mixed
    $firstKanaNameMale
     = ['アキラ', 'アツシ', 'オサム', 'カズヤ', 'キョウスケ', 'ケンイチ', 'シュウヘイ', 'ショウタ', 'ジュン', 'ソウタロウ', 'タイチ', 'タロウ', 'タクマ', 'ツバサ', 'トモヤ', 'ナオキ', 'ナオト', 'ヒデキ', 'ヒロシ', 'マナブ', 'ミツル', 'ミノル', 'ユウキ', 'ユウタ', 'ヤスヒロ', 'ヨウイチ', 'ヨウスケ', 'リョウスケ', 'リョウヘイ', 'レイ']

$firstNameFemale

{@link} http://dic.nicovideo.jp/a/%E6%97%A5%E6%9C%AC%E4%BA%BA%E3%81%AE%E5%90%8D%E5%89%8D%E4%B8%80%E8%A6%A7 {@link} http://www.meijiyasuda.co.jp/enjoy/ranking/


    protected
    static    mixed
    $firstNameFemale
     = ['明美', 'あすか', '香織', '加奈', 'くみ子', 'さゆり', '知実', '千代', '直子', '七夏', '花子', '春香', '真綾', '舞', '美加子', '幹', '桃子', '結衣', '裕美子', '陽子', '里佳']

$firstNameFormat


    protected
    static    mixed
    $firstNameFormat
     = ['{{firstNameMale}}', '{{firstNameFemale}}']

$firstNameMale

{@link} http://dic.nicovideo.jp/a/%E6%97%A5%E6%9C%AC%E4%BA%BA%E3%81%AE%E5%90%8D%E5%89%8D%E4%B8%80%E8%A6%A7 {@link} http://www.meijiyasuda.co.jp/enjoy/ranking/


    protected
    static    mixed
    $firstNameMale
     = ['晃', '篤司', '治', '和也', '京助', '健一', '修平', '翔太', '淳', '聡太郎', '太一', '太郎', '拓真', '翼', '智也', '直樹', '直人', '英樹', '浩', '学', '充', '稔', '裕樹', '裕太', '康弘', '陽一', '洋介', '亮介', '涼平', '零']

$generator


    protected
        Generator
    $generator

$lastKanaName


    protected
    static    mixed
    $lastKanaName
     = ['アオタ', 'アオヤマ', 'イシダ', 'イダカ', 'イトウ', 'ウノ', 'エコダ', 'オオガキ', 'カノウ', 'カノウ', 'キジマ', 'キムラ', 'キリヤマ', 'クドウ', 'コイズミ', 'コバヤシ', 'コンドウ', 'サイトウ', 'サカモト', 'ササキ', 'サトウ', 'ササダ', 'スズキ', 'スギヤマ', 'タカハシ', 'タナカ', 'タナベ', 'ツダ', 'ナカジマ', 'ナカムラ', 'ナギサ', 'ナカツガワ', 'ニシノソノ', 'ノムラ', 'ハラダ', 'ハマダ', 'ヒロカワ', 'フジモト', 'マツモト', 'ミヤケ', 'ミヤザワ', 'ムラヤマ', 'ヤマギシ', 'ヤマグチ', 'ヤマダ', 'ヤマモト', 'ヨシダ', 'ヨシモト', 'ワカマツ', 'ワタナベ']

$lastName

{@link} http://dic.nicovideo.jp/a/%E6%97%A5%E6%9C%AC%E3%81%AE%E8%8B%97%E5%AD%97%28%E5%90%8D%E5%AD%97%29%E3%81%AE%E4%B8%80%E8%A6%A7


    protected
    static    mixed
    $lastName
     = ['青田', '青山', '石田', '井高', '伊藤', '井上', '宇野', '江古田', '大垣', '加藤', '加納', '喜嶋', '木村', '桐山', '工藤', '小泉', '小林', '近藤', '斉藤', '坂本', '佐々木', '佐藤', '笹田', '鈴木', '杉山', '高橋', '田中', '田辺', '津田', '中島', '中村', '渚', '中津川', '西之園', '野村', '原田', '浜田', '廣川', '藤本', '松本', '三宅', '宮沢', '村山', '山岸', '山口', '山田', '山本', '吉田', '吉本', '若松', '渡辺']

$maleKanaNameFormats


    protected
    static    mixed
    $maleKanaNameFormats
     = ['{{lastKanaName}} {{firstKanaNameMale}}']

$maleNameFormats


    protected
    static    mixed
    $maleNameFormats
     = ['{{lastName}} {{firstNameMale}}']

$titleFemale


    protected
    static    mixed
    $titleFemale
     = ['Mrs.', 'Ms.', 'Miss', 'Dr.', 'Prof.']

$titleFormat


    protected
    static    mixed
    $titleFormat
     = ['{{titleMale}}', '{{titleFemale}}']

$titleMale


    protected
    static    mixed
    $titleMale
     = ['Mr.', 'Dr.', 'Prof.']

$unique


    protected
        UniqueGenerator
    $unique

__construct()


    public
                    __construct(Generator $generator) : mixed

Parameters

$generator : Generator

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 be parsed

Return values

string

firstKanaName()


    public
                    firstKanaName([string|null $gender = null ]) : string

Parameters

$gender : string|null = null: 'male', 'female' or null for any

Return values

string

firstKanaNameFemale()


    public
            static        firstKanaNameFemale() : mixed

firstKanaNameMale()


    public
            static        firstKanaNameMale() : mixed

firstName()


    public
                    firstName([string|null $gender = null ]) : string

Parameters

$gender : string|null = null: 'male', 'female' or null for any

Return values

string

firstNameFemale()


    public
            static        firstNameFemale() : string

Return values

string

firstNameMale()


    public
            static        firstNameMale() : string

Return values

string

kanaName()


    public
                    kanaName([string|null $gender = null ]) : string

Parameters

$gender : string|null = null: 'male', 'female' or null for any

Return values

string

lastKanaName()


    public
            static        lastKanaName() : mixed

lastName()


    public
                    lastName() : 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

name()


    public
                    name([string|null $gender = null ]) : string

Parameters

$gender : string|null = null: 'male', 'female' or null for any

Return values

string

numberBetween()

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


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

Parameters

$int1 : int = 0: 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

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>|class-string|Traversable $array = ['a', 'b', 'c'] ]) : mixed

Parameters

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

randomElements()

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


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

Parameters

$array : array<string|int, mixed>|class-string|Traversable = ['a', 'b', 'c']: Array to take elements from. Defaults to a-c
$count : int|null = 1: Number of elements to take. If null then returns random number of elements
$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 = 0 ][, float|int $max = null ]) : float

Parameters

$nbMaxDecimals : int = null
$min : float|int = 0
$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

title()


    public
                    title([string|null $gender = null ]) : string

Parameters

$gender : string|null = null: 'male', 'female' or null for any

Return values

string

titleFemale()


    public
            static        titleFemale() : string

Return values

string

titleMale()


    public
            static        titleMale() : string

Return values

string

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) : mixed

Parameters

$string : mixed
$wildcard : mixed
$callback : mixed

Person extends Person in package Application

Table of Contents

Constants

Properties

Methods

Constants

GENDER_FEMALE

GENDER_MALE

Properties

$femaleKanaNameFormats

$femaleNameFormats

$firstKanaNameFemale

$firstKanaNameFormat

$firstKanaNameMale

$firstNameFemale

$firstNameFormat

$firstNameMale

$generator

$lastKanaName

$lastName

$maleKanaNameFormats

$maleNameFormats

$titleFemale

$titleFormat

$titleMale

$unique

Methods

__construct()

Parameters

asciify()

Parameters

Tags

Return values

bothify()

Parameters

Return values

firstKanaName()

Parameters

Tags

Return values

firstKanaNameFemale()

Tags

firstKanaNameMale()

Tags

firstName()

Parameters

Tags

Return values

firstNameFemale()

Return values

firstNameMale()

Return values

kanaName()

Parameters

Tags

Return values

lastKanaName()

Tags

lastName()

Tags

Return values

lexify()

Parameters

Return values

name()

Parameters

Tags

Return values

numberBetween()

Parameters

Tags

Return values

numerify()

Person extends Person
in package

Application