HumHub Documentation (unofficial)

Color extends Color
in package

Application

Properties

$allColorNames : mixed
$generator : Generator
$safeColorNames : 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
colorName() : string
hexColor() : string
hslColor() : string
hslColorAsArray() : array<string|int, mixed>
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.
rgbaCssColor() : string
rgbColor() : string
rgbColorAsArray() : array<string|int, mixed>
rgbCssColor() : string
safeColorName() : string
safeHexColor() : string
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

$allColorNames


    protected
    static    mixed
    $allColorNames
     = ['黑色', '昏灰', '灰色', '暗灰', '银色', '亮灰色', '庚斯博罗灰', '白烟色', '白色', '雪色', '铁灰色', '沙棕', '玫瑰褐', '亮珊瑚色', '印度红', '褐色', '耐火砖红', '栗色', '暗红', '鲜红', '红色', '柿子橙', '雾玫瑰色', '鲑红', '腥红', '蕃茄红', '暗鲑红', '珊瑚红', '橙红', '亮鲑红', '朱红', '赭黄', '热带橙', '驼色', '杏黄', '椰褐', '海贝色', '鞍褐', '巧克力色', '燃橙', '阳橙', '粉扑桃色', '沙褐', '古铜色', '亚麻色', '蜜橙', '秘鲁色', '乌贼墨色', '赭色', '陶坯黄', '橘色', '暗橙', '古董白', '日晒色', '硬木色', '杏仁白', '那瓦霍白', '万寿菊黄', '蕃木瓜色', '灰土色', '卡其色', '鹿皮鞋色', '旧蕾丝色', '小麦色', '桃色', '橙色', '花卉白', '金菊色', '暗金菊色', '咖啡色', '茉莉黄', '琥珀色', '玉米丝色', '铬黄', '金色', '柠檬绸色', '亮卡其色', '灰金菊色', '暗卡其色', '含羞草黄', '奶油色', '象牙色', '米黄色', '亮黄', '亮金菊黄', '香槟黄', '芥末黄', '月黄', '橄榄色', '鲜黄', '黄色', '苔藓绿', '亮柠檬绿', '橄榄军服绿', '黄绿', '暗橄榄绿', '苹果绿', '绿黄', '草绿', '草坪绿', '查特酒绿', '叶绿', '嫩绿', '明绿', '钴绿', '蜜瓜绿', '暗海绿', '亮绿', '灰绿', '常春藤绿', '森林绿', '柠檬绿', '暗绿', '绿色', '鲜绿色', '孔雀石绿', '薄荷绿', '青瓷绿', '碧绿', '绿松石绿', '铬绿', '苍色', '海绿', '中海绿', '薄荷奶油色', '春绿', '孔雀绿', '中春绿色', '中碧蓝色', '碧蓝色', '青蓝', '水蓝', '绿松石蓝', '绿松石色', '亮海绿', '中绿松石色', '亮青', '浅蓝', '灰绿松石色', '暗岩灰', '凫绿', '暗青', '青色', '水色', '暗绿松石色', '军服蓝', '孔雀蓝', '婴儿粉蓝', '浓蓝', '亮蓝', '灰蓝', '萨克斯蓝', '深天蓝', '天蓝', '亮天蓝', '水手蓝', '普鲁士蓝', '钢青色', '爱丽丝蓝', '岩灰', '亮岩灰', '道奇蓝', '矿蓝', '湛蓝', '韦奇伍德瓷蓝', '亮钢蓝', '钴蓝', '灰丁宁蓝', '矢车菊蓝', '鼠尾草蓝', '暗婴儿粉蓝', '蓝宝石色', '国际奇连蓝', '蔚蓝', '品蓝', '暗矿蓝', '极浓海蓝', '天青石蓝', '幽灵白', '薰衣草紫', '长春花色', '午夜蓝', '藏青', '暗蓝', '中蓝', '蓝色', '紫藤色', '暗岩蓝', '岩蓝', '中岩蓝', '木槿紫', '紫丁香色', '中紫红', '紫水晶色', '浅灰紫红', '缬草紫', '矿紫', '蓝紫', '紫罗兰色', '靛色', '暗兰紫', '暗紫', '三色堇紫', '锦葵紫', '优品紫红', '中兰紫', '淡紫丁香色', '蓟紫', '铁线莲紫', '梅红色', '亮紫', '紫色', '暗洋红', '洋红', '品红', '兰紫', '浅珍珠红', '陈玫红', '浅玫瑰红', '中青紫红', '洋玫瑰红', '玫瑰红', '红宝石色', '山茶红', '深粉红', '火鹤红', '浅珊瑚红', '暖粉红', '勃根第酒红', '尖晶石红', '胭脂红', '浅粉红', '枢机红', '薰衣草紫红', '灰紫红', '樱桃红', '浅鲑红', '绯红', '粉红', '亮粉红', '壳黄红', '茜红']

$generator


    protected
        Generator
    $generator

$safeColorNames


    protected
    static    mixed
    $safeColorNames
     = ['黑色', '粟色', '绿色', '藏青', '橄榄色', '紫', '凫绿', '鲜绿色', '蓝色', '银色', '灰色', '黄色', '品红', '水色', '白色']

$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

colorName()


    public
            static        colorName() : string

Return values

string

hexColor()


    public
            static        hexColor() : string

Return values

string

hslColor()


    public
            static        hslColor() : string

Return values

string

hslColorAsArray()


    public
            static        hslColorAsArray() : array<string|int, mixed>

Return values

array<string|int, mixed>

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 = 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

rgbaCssColor()


    public
            static        rgbaCssColor() : string

Return values

string

rgbColor()


    public
            static        rgbColor() : string

Return values

string

rgbColorAsArray()


    public
            static        rgbColorAsArray() : array<string|int, mixed>

Return values

array<string|int, mixed>

rgbCssColor()


    public
            static        rgbCssColor() : string

Return values

string

safeColorName()


    public
            static        safeColorName() : string

Return values

string

safeHexColor()


    public
            static        safeHexColor() : string

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

Parameters

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

Color extends Color in package Application

Table of Contents

Properties

Methods

Properties

$allColorNames

$generator

$safeColorNames

Tags

$unique

Methods

__construct()

Parameters

asciify()

Parameters

Tags

Return values

bothify()

Parameters

Return values

colorName()

Tags

Return values

hexColor()

Tags

Return values

hslColor()

Tags

Return values

hslColorAsArray()

Tags

Return values

lexify()

Parameters

Return values

numberBetween()

Parameters

Tags

Return values

numerify()

Parameters

Return values

optional()

Parameters

Return values

passthrough()

Parameters

randomAscii()

Return values

randomDigit()

Return values

randomDigitNot()

Parameters

Return values

randomDigitNotNull()

Return values

randomElement()

Parameters

Tags

randomElements()

Parameters

Tags

Return values

randomFloat()

Parameters

Tags

Return values

randomKey()

Parameters

Return values

randomLetter()

Return values

randomNumber()

Color extends Color
in package

Application