CloudCastle Faker API

Generator
in package

FinalYes

Фасад генератора фейковых данных.

Связывает источник случайности (RandomEngineInterface), локаль и инфлектор, предоставляя эргономичные примитивы (числа, булевы, выбор из набора, перемешивание) поверх Randomizer. Провайдеры доменных данных (имена, адреса, тексты) подключаются отдельными методами-акцессорами.

Экземпляр создаётся фабрикой Faker::create(). Дополнительные встроенные провайдеры научно-инженерных сфер доступны как методы-акцессоры через механизм расширения (extend()); их регистрация — в BUILTIN.

Table of Contents

Methods

__call()  : ProviderInterface
Разрешить вызов зарегистрированного провайдера как метода генератора.
__construct()  : mixed
acoustics()  : Acoustics
address()  : Address
aerospace()  : Aerospace
agriculture()  : Agriculture
algebra()  : Algebra
animal()  : Animal
architecture()  : Architecture
asciify()  : string
Заменить `*` на случайный печатный ASCII-символ в шаблоне.
astronomy()  : Astronomy
automotive()  : Automotive
aviation()  : Aviation
barcode()  : Barcode
biology()  : Biology
blockchain()  : Blockchain
book()  : Book
boolean()  : bool
Булево значение с заданной вероятностью истины в процентах.
bothify()  : string
Применить к шаблону numerify и lexify.
calendar()  : Calendar
chemistry()  : Chemistry
cloudComputing()  : CloudComputing
color()  : Color
commerce()  : Commerce
company()  : Company
construction()  : Construction
cybersecurity()  : Cybersecurity
database()  : Database
dataScience()  : DataScience
developer()  : Developer
devOps()  : DevOps
education()  : Education
electronics()  : Electronics
energy()  : Energy
extend()  : $this
Зарегистрировать пользовательский провайдер данных под именем.
file()  : File
finance()  : Finance
food()  : Food
geology()  : Geology
geometry()  : Geometry
http()  : Http
identifier()  : Identifier
image()  : Image
inflector()  : Inflector
Инфлектор языка локали (склонение, плюрализация, числа прописью).
instrumentation()  : Instrumentation
internet()  : Internet
lexify()  : string
Заменить `?` на случайную строчную латинскую букву в шаблоне.
locale()  : Locale
Локаль генератора.
logistics()  : Logistics
manufacturing()  : Manufacturing
materials()  : Materials
math()  : Math
mechanicalEngineering()  : MechanicalEngineering
medical()  : Medical
meteorology()  : Meteorology
miscellaneous()  : Miscellaneous
music()  : Music
nanotechnology()  : Nanotechnology
nautical()  : Nautical
network()  : Network
numberBetween()  : int
Целое число в диапазоне [$min, $max] включительно.
numerify()  : string
Заменить `#` на цифру (0–9), `%` — на цифру 1–9 в шаблоне.
operatingSystem()  : OperatingSystem
optional()  : TValue|TDefault
Значение генератора с заданной вероятностью, иначе значение по умолчанию.
payment()  : Payment
person()  : Person
pharmacy()  : Pharmacy
phoneNumber()  : PhoneNumber
physics()  : Physics
randomAscii()  : string
Случайный печатный ASCII-символ (33–126).
randomDigit()  : int
Случайная цифра 0–9.
randomDigitNotZero()  : int
Случайная цифра 1–9 (без нуля).
randomElement()  : TValue
Случайный элемент массива.
randomElements()  : array<int, TValue>
Несколько случайных элементов массива.
randomFloat()  : float
Число с плавающей точкой в [$min, $max), при желании округлённое.
randomizer()  : Randomizer
Ядро случайности для тонкой настройки/провайдеров.
randomKey()  : int|string
Случайный ключ массива.
randomLetter()  : string
Случайная строчная латинская буква.
randomNumber()  : int
Случайное целое с заданным числом десятичных разрядов (1–9).
regexify()  : string
Строка по упрощённому регулярному выражению (`[A-Z]{3}`, `\d{4}-\w+` и т.п.).
robotics()  : Robotics
science()  : Science
seed()  : self
Зафиксировать зерно последовательности для воспроизводимости.
shuffle()  : array<int, TValue>
Перемешать массив, вернув 0-индексированный список значений.
shuffleString()  : string
Перемешать символы строки (корректно для многобайтовых символов).
software()  : Software
space()  : Space
sport()  : Sport
statistics()  : Statistics
telecommunications()  : Telecommunications
text()  : Text
trigonometry()  : Trigonometry
unique()  : UniqueGenerator
Обёртка, отдающая только уникальные значения на протяжении своей жизни.
userAgent()  : UserAgent
valid()  : TValue
Значение генератора, удовлетворяющее предикату (с ограничением попыток).
vehicle()  : Vehicle
weather()  : Weather
webTechnology()  : WebTechnology

Methods

__call()

Разрешить вызов зарегистрированного провайдера как метода генератора.

public __call(string $name, array<string|int, mixed> $arguments) : ProviderInterface
Parameters
$name : string

имя провайдера

$arguments : array<string|int, mixed>

аргументы вызова (аксессоры их не принимают)

Tags
throws
UnknownProviderException

если провайдер с таким именем не зарегистрирован

InvalidArgumentException

если переданы аргументы

Return values
ProviderInterface —

экземпляр провайдера (кэшируется по классу)

__construct()

public __construct(RandomEngineInterface $engine, Locale $locale, Inflector $inflector) : mixed
Parameters
$engine : RandomEngineInterface

источник псевдослучайных битов

$locale : Locale

язык генерируемых данных

$inflector : Inflector

инфлектор языка локали

algebra()

public algebra() : Algebra

провайдер алгебраических данных

Return values
Algebra

animal()

public animal() : Animal

провайдер данных о животных

Return values
Animal

asciify()

Заменить `*` на случайный печатный ASCII-символ в шаблоне.

public asciify(string $pattern) : string
Parameters
$pattern : string

шаблон

Return values
string

biology()

public biology() : Biology

провайдер биологических данных

Return values
Biology

book()

public book() : Book

провайдер книжных данных

Return values
Book

boolean()

Булево значение с заданной вероятностью истины в процентах.

public boolean([int $chanceOfTrue = 50 ]) : bool
Parameters
$chanceOfTrue : int = 50

вероятность true (0–100)

Return values
bool

bothify()

Применить к шаблону numerify и lexify.

public bothify(string $pattern) : string
Parameters
$pattern : string

шаблон

Return values
string

energy()

public energy() : Energy

провайдер данных энергетики

Return values
Energy

extend()

Зарегистрировать пользовательский провайдер данных под именем.

public extend(string $name, ProviderInterface> $class) : $this

После регистрации провайдер доступен как обычный метод-аксессор: $faker->extend('crypto', MyCrypto::class); $faker->crypto()->coin();. Класс обязан реализовывать ProviderInterface — проще всего наследованием AbstractProvider, дающего доступ к контексту. Повторная регистрация имени переопределяет провайдер и сбрасывает кэш.

Parameters
$name : string

имя метода-аксессора

$class : ProviderInterface>

класс провайдера

Return values
$this —

этот генератор (для цепочек вызовов)

file()

public file() : File

провайдер файловых атрибутов

Return values
File

food()

public food() : Food

провайдер кулинарных данных

Return values
Food

geology()

public geology() : Geology

провайдер геологических данных

Return values
Geology

image()

public image() : Image

провайдер изображений-заглушек

Return values
Image

inflector()

Инфлектор языка локали (склонение, плюрализация, числа прописью).

public inflector() : Inflector
Return values
Inflector

lexify()

Заменить `?` на случайную строчную латинскую букву в шаблоне.

public lexify(string $pattern) : string
Parameters
$pattern : string

шаблон

Return values
string

math()

public math() : Math

провайдер математических данных

Return values
Math

music()

public music() : Music

провайдер музыкальных данных

Return values
Music

numberBetween()

Целое число в диапазоне [$min, $max] включительно.

public numberBetween([int $min = 0 ][, int $max = 2147483647 ]) : int
Parameters
$min : int = 0

нижняя граница

$max : int = 2147483647

верхняя граница

Return values
int

numerify()

Заменить `#` на цифру (0–9), `%` — на цифру 1–9 в шаблоне.

public numerify(string $pattern) : string
Parameters
$pattern : string

шаблон

Return values
string

optional()

Значение генератора с заданной вероятностью, иначе значение по умолчанию.

public optional(callable(): TValue $generator[, float $weight = 0.5 ][, TDefault $default = null ]) : TValue|TDefault
Parameters
$generator : callable(): TValue

источник значения

$weight : float = 0.5

вероятность вернуть значение (0.0–1.0)

$default : TDefault = null

значение при «пропуске»

Tags
template
Return values
TValue|TDefault —

значение генератора либо $default

person()

public person() : Person

провайдер персональных данных

Return values
Person

pharmacy()

public pharmacy() : Pharmacy

провайдер фармацевтических данных

Return values
Pharmacy

randomAscii()

Случайный печатный ASCII-символ (33–126).

public randomAscii() : string
Return values
string

randomDigit()

Случайная цифра 0–9.

public randomDigit() : int
Return values
int

randomDigitNotZero()

Случайная цифра 1–9 (без нуля).

public randomDigitNotZero() : int
Return values
int

randomElement()

Случайный элемент массива.

public randomElement(array<string|int, TValue> $array) : TValue
Parameters
$array : array<string|int, TValue>

исходный массив

Tags
template
throws
InvalidArgumentException

если массив пуст

Return values
TValue

randomElements()

Несколько случайных элементов массива.

public randomElements(array<string|int, TValue> $array[, int $count = 1 ][, bool $allowDuplicates = false ]) : array<int, TValue>
Parameters
$array : array<string|int, TValue>

исходный массив

$count : int = 1

сколько вернуть

$allowDuplicates : bool = false

разрешить повторы

Tags
template
throws
InvalidArgumentException

при некорректных аргументах

Return values
array<int, TValue>

randomFloat()

Число с плавающей точкой в [$min, $max), при желании округлённое.

public randomFloat([int|null $decimals = null ][, float $min = 0.0 ][, float $max = 1.0 ]) : float
Parameters
$decimals : int|null = null

число знаков после запятой (null — без округления)

$min : float = 0.0

нижняя граница включительно

$max : float = 1.0

верхняя граница исключительно

Return values
float

randomizer()

Ядро случайности для тонкой настройки/провайдеров.

public randomizer() : Randomizer
Return values
Randomizer

randomKey()

Случайный ключ массива.

public randomKey(array<string|int, mixed> $array) : int|string
Parameters
$array : array<string|int, mixed>
Return values
int|string

randomLetter()

Случайная строчная латинская буква.

public randomLetter() : string
Return values
string

randomNumber()

Случайное целое с заданным числом десятичных разрядов (1–9).

public randomNumber([int $digits = 5 ]) : int
Parameters
$digits : int = 5

число разрядов

Return values
int

regexify()

Строка по упрощённому регулярному выражению (`[A-Z]{3}`, `\d{4}-\w+` и т.п.).

public regexify(string $pattern) : string
Parameters
$pattern : string

шаблон-регулярное выражение

Return values
string

seed()

Зафиксировать зерно последовательности для воспроизводимости.

public seed(int $seed) : self
Parameters
$seed : int

зерно

Tags
throws
InvalidArgumentException

если движок не поддерживает сидирование (например, криптостойкий SecureEngine)

Return values
self

shuffle()

Перемешать массив, вернув 0-индексированный список значений.

public shuffle(array<string|int, TValue> $array) : array<int, TValue>
Parameters
$array : array<string|int, TValue>

исходный массив

Tags
template
Return values
array<int, TValue>

shuffleString()

Перемешать символы строки (корректно для многобайтовых символов).

public shuffleString(string $value) : string
Parameters
$value : string

исходная строка

Return values
string

space()

public space() : Space

провайдер данных космонавтики

Return values
Space

sport()

public sport() : Sport

провайдер спортивных данных

Return values
Sport

unique()

Обёртка, отдающая только уникальные значения на протяжении своей жизни.

public unique([bool $reset = false ]) : UniqueGenerator
Parameters
$reset : bool = false

начать новый набор уникальных значений

Return values
UniqueGenerator

valid()

Значение генератора, удовлетворяющее предикату (с ограничением попыток).

public valid(callable(): TValue $generator, callable(TValue): bool $validator[, int $maxRetries = UniqueGenerator::DEFAULT_MAX_RETRIES ]) : TValue
Parameters
$generator : callable(): TValue

источник значений

$validator : callable(TValue): bool

предикат приёмки

$maxRetries : int = UniqueGenerator::DEFAULT_MAX_RETRIES

предельное число попыток

Tags
template
throws
OverflowException

если валидное значение не получено за $maxRetries

Return values
TValue —

первое значение, прошедшее $validator

On this page

Search results