Documentation

Text extends Text
in package

Application

$baseText : string: From kk.wikipedia.org
$consecutiveWords : mixed
$explodedText : mixed
$generator : Generator
$separator : mixed
$separatorLen : mixed
$textStartsWithUppercase : 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
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.
realText() : string: Generate a text string by the Markov chain algorithm.
realTextBetween() : string: Generate a text string by the Markov chain algorithm.
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.
appendEnd() : mixed
explode() : mixed
generateText() : string
getConsecutiveWords() : mixed
getExplodedText() : mixed
implode() : mixed
strlen() : mixed
validStart() : mixed
replaceWildcard() : mixed

$baseText

From kk.wikipedia.org


    protected
    static    string
    $baseText
     = <<<'EOT'
Арыстан баб кесенесі - көне Отырар жеріндегі сәулет өнері ескерткіші.

Түркістан халқының арасында мұсылман дінін таратушы Қожа Ахмет Иасауидің ұстазы болған Арыстан баб ата
қабірінің басына салынған. Кесене дәлізхана, мешіт, құжырахана, азан шақыратын мұнара сияқты жеке бөлмелерден құралған.
Кесененің ең көне бөлігі қабірхана болуы тиіс. Қазір де оның едені басқа бөлмелермен салыстырғанда едәуір биік.
Қабір үстіне алғашқы белгі 12 ғ. шамасында салынған. Мазар 14 ғасырда қайта жөнделген. Арыстан баб кесенесі 20 ғасырдың
басында жергілікті халықтың қаражатымен күйдірілген кірпіштен ауданы 35x12 м, биіктігі 12 м, бұрынғы Меккеге қараған
есігі Түркістанға, Әзірет Сұлтанға бағытталып, Солтүстік жағы кесене, Оңтүстік жағы мешіт есебінде қайта жәнделді.
Дәліз-қақпа маңдайшасына мәрмәр тақта қаланып, бетіне һижра бойынша 1327 жыл, яғни соңғы құрылыс жүрген
уақыт деп көрсетілген.

Қысқаша мәлімет

Бұл кесене XII ғасырда өмір сүрген діни көріпкел Арыстан баб мазарының үстіне салынған.
Кесененің бірінші құрылысы XIV-XV ғасырға жатады. Сол құрылыстан кесілген айван тізбектері қалған.
XVIII ғасырда көне мазардың орнында жер сілкінісінен кейін екі кесілген ағаш тізбекке тірелген айванмен салынған
екі күмбезді құрылыс орнатылды. XVIII ғасырда құрылыс қиратылып, фриз жазбалары бойынша 1909 жылы қайта салынды.
1971 жылы жоғары деңгейдегі грунт сулары салдарынан мешіт құлатылып, қайта орнатылды. Құрылыс алебастр ерітіндісінде
күйдірілген кірпіштен қабырғаның сырт жағына салынды. Қазіргі кезде бұл кесене Орталық Азиядағы қажылық міндетті
өтейтін мұсылман киелі жерлерінің бірі болып саналады Аңыз бойынша Арыстан баб Мұхаммед пайғамбардың елшісі болған.
Бір күні Мұхаммед пайғамбар өзінің шәкірттерімен құрма жеп отырған еді. Бір құрма қайта-қайта ыдыстан құлай беріп,
пайғамбар ішкі дауысты естіді: «Бұл құрма Сізден кейін 400 жыл алдағы уақытта туылатын мұсылман бала Ахметке арналған».
Сонда пайғамбар шәкірттері ішінен бұл құрманы кім иесіне жеткізетінін сұрайды. Ешкім сұранған жоқ. Пайғамбар сұрақты
қайта қойғаннан кейін, Арыстан баб былай деді: «Егер Сіз Алла Тағаладан 400 жыл сұрап берсеңіз мен бұл құрманы
иесіне жеткіземін». Халық аңыздарынан және жазба деректеріне қарағанда («Рисолаи Сарем-Исфижоб» және
Куприлозада кітабы) Арыстан баб Ахмет Яссауидің ұстазы болып құрманы жеткізеді. Қазіргі кезде Арыстан баб мазары
үстінде 30*13 метр аумағы бар кесене тұр. Тарихи деректер бойынша XII-XVIII ғасырларда кесене бірнеше рет қайта
салынып, қайта жаңартылды. Қожа Ахмет Яссауи ұлы әулие мен діни көріпкел 1103 жылы туылып 1166 жылы қайтыс болған.
Арыстанбаб туралы аңыздар

Арыстанбабтың дүние салуы Қожа Ахмет Иасауи хикметінде былайша суреттеледі:
«Бабам айтты: Ей балам, қасымда тұр өлейін,
Жаназамды оқып көм, жан тәсілім қалайын.
Медет берсе Мұстафа, ғарыш биігіне шығайын.
Арыслан бабам сөздерін есітіңіз - тәбәрік.
Жылап айттым: ей бала, жас көдекпін білмеймін.
Көріңізді қазармын, көтеріп сала алмаспын.
Хақ Мұстафа сүндетін, балапанмын, білмеймін.
Бабам айтты: Ей балам, періштелер жиылады.
Жебірейіл имам болып, өзгелер оған ұйиды.
Макаил мен Исрафил көтеріп көрге қояды».Отырар өңірінде біз естіген аңыз байынша Арыстанбаб дүние салған соң,
оның денесін ақ бураға артып, еркіне жіберіп, соңынан ілесіп отырған. Ақ бура жүре-жүре осы жерге шөккен екен.
Сол шөккен жерге Арыстанбаб қойылыпты. «Алпамыс жырының» бір үлгісінде Байбөрі мен Аналық «Самарқанда сансыз баб»,
Бұқарадағы «Баһауәдин Нақишбент» молаларына зират қылады, және
"Түнейді үш күн Байбөрі
Әзіретті сұлтанға.
Түркістанда түмен бап,
Сайрамда бар сансыз бап,
Отырарда отыз бап,
Бабалардың бабын сұрасаң,
Ең үлкені Арыстан бап.
Әулие қоймай қыдырып,
Бабалардың бәрін қылды сап» Әзірет Сұлтан қорық-музейінің сақтаулы тұрған Баян ауылдан бір зияратшылдың
қолжазбасында мынадай қызық мағұлмат бар: Арыстанбаб дүние салған соң, оның моласының басына екі құс – бірі лашын,
бірі қарға ұшып келеді. Бұл әңгіме бізді ежелгі түркі шаманизміне жетелейді. Көне түркілер бұл аталған құстарды киелі
деп санаған. Мысалы, ескі жылнамаларда жазылған аңыз бойынша көне түркілердің Ашина тайпасына жау шауып, жаппай қырып
кетеді. Сонда жалғыз қалған бала ғана аман қалады. Баланы қасқыр емізіп, аспан әлемінің елшісі – қарға ет әкеліп
асыраған. Осы баладан түркілердің ұрпағы деседі. Қазақтардың қарғаны киелі құс санағаны жөнінде дерек ер аз емес.
Қарға сөзімен байланысты мынадай мақал-мәтелдер бар: «Біздің де қолымызға қарға тышар», «Қарға тамырлы қазақ»,
«Қарғам-ау» деген сөз қарағым, қалқам деген мағынада қолданылады. «Қарғам, қарғашым, қарғатайым" деп қарттар
немере-шөберелерін еркелеткен. Қанша балаң бар деп жауап қайтарған.
Құрылымы

Арыстанбаб кесенесі ғасырлар бойы түрлі өндеу-жөндеуді басынан кешірген құрылыс.
Кейде Арыстанбабтың ХІ-ХІІ ғасырларда өмір сүргенін тілге тиек ете отырып, оның кесенесі Арыстанбаб дүние салған соң
іле-шала тұрғызылған деген жорамал айтылады. Алайда бізге жеткен қазіргі кесенеде ХІІ ғасырдың белгілері жоқ.
Бұл арада біз ислам дінінің алғашқы кезде қабыр үстіне төбесі жабық құрылыс тұрғызуға тыйым салғанын есте ұстағанымыз
жөн. Осы тұрғыдан қарағанда, ХІІ ғасырда Арыстанбаб ғимаратының болмауы да мүмкін. А.Черкасовтың жазбаларында
Арыстанбаб кесенесі әулие және шәкірттері жатқан екі бөлмеден, сондай-ақ алдындағы бастырмадан тұрғанын жоғарыда
айтқан болатынбыз. Бұлардың жобасы ХІV ғасырдың құрылысына сай келеді. Осымен қатар бастырмадағы ұстындар да ХІҮ
ғасырдың аяғы мен ХV ғасырдың басында жасалған деген тұжырымды мамандар айтқан болатын. Яғни қазіргі Арыстанбаб құрылыс
кешеніндегі қабырғаналар бөлігі ең көнесі, әуелгісі болып табылады. Бұған қоса халық арасында кең тараған мынадай
аңыз бар: «Қожа Ахмет кесенесінің қабырғалары қаланып болған түні алып жасыл өгіз көтерілген дуалдарды мүйізімен соғып,
құлатады. Ғимарат қабырғалары қайта тұрғызылып, күмбездері қалана бастағанда бұл оқиға тағы да қайталанып, бәрі
үйелген төбеге айналады. Бұл жай Әмір Темірді көп ойландырады. Түсінде бір шал келіп, аян береді, ол Қожа Ахметтің
ең алғашқы ұстазы, Арыстанбаб моласының үстіне мазар көтеруге әмір ететінін жеткізеді. Бұл талап орындалған соң ғана
Әмір Темір Түркістандағы құрылысын ойдағыдай аяқтайды». Арыстанбаб қабірханасының едені басқа бөлмелермен салыстырғанда
едәуір биік. Тігінен көтерілген қабырғалары бір биіктікте сәулет өнерінде «желкен» деп аталатын өріммен иіліп барым
күмбезге ұласады. Күмбез ауқымы кең, һәм биік етіп тұрғызылған. Қабірхананың есігі күнбатысқа, дәлірек айтсақ, Меккеге
бағышталған. Бұл қасиетті қабірлерге тағзым етудің мұсылмандық ережелерінен туындайды: зиярат етушінің беті сағанаға,
арқасы құбылаға қарауға тиіс болған. Оның ұзындығы 3 м. 90 см., ені 1 м. 30 см., биіктігі 1 м. 20 см. Қабаттас, көлемі
5,4м х 5,4 м. Бөлмеде үш қабір бар. Ол да биік күмбезбен жабылған. Алайда күмбездің іші алебастрмен сыланып,
геометриялық үлгідегі өрнектермен нақышталған. Әулиеге кірер есіктің екі жағында екі қабір орналасқан.
Шырақшылар бұларды Лашынбаб пен Қарғабаб дейді. Олар әулие қабірімен салыстырғанда аса шағын болып келген.
Лашын баб қабырының көлемі 1,63м х 0,92м., Қарғабабтікі 1,70 м х 0,90 м. Осы қабарханаларға оңтүстік-батыс жақтан
бірнеше бөлмелер қосылған. Екі қанаттағы бөлмелерді біріктіріп, байланыстырып тұрған дәліз-бастырма бар. Ол әдеттегі
бастырма-айвандардан өзгеше, тұтасымен қыштан өріліп, төбесі иіліп жабылған. Оның көлемі 7,60м х 4,35м. Қабырханалар,
дәліз қышпен қаланып күмбезделсе, мешіт бөлігі негізінен қам кесектен тұрғызылып, төбесін жабуда ағаш кең пайдаланылған.
Мешіттің ортасында В.В.Константинова жасаған жоба бойынша алты ағаш тіреу болған. Олардың үстіне қары қойылып, ағаштан
қырлы күмбез қиыстырылған. Мешіт қабырғасында Мекке бағытын көрсететін ойық-михраб бар
Зерттелуі

Арыстан баб ескерткіші деп аталатын мазарлар басқа аймақтардың бірі – Қырғызстандағы Ош өңірінде.
Бірақ қырғыздардың діни-нанымдарын зерттеген ғалым С.М.Абрамзонның пікірінше, жергілікті халық бұл жерде жерленген
Арыстанбабты қалмақтарға қарсы соғысқан батыр деп таниды. Яғни Оштағы Арыстанбаб XYII-XVII ғасырларда болған адам.
Арыстанбаб қабірінің басына тұрғызылған ғимарат алғаш ғылыми әдебиетте 1898 ж.ж. И.Т.Пославскийдің «Развалины города
Отрара» атты мақаласында аталады. 1903 жылы кесене түркістандық археология әуесқойлар үйірмесінің мүшесі А.Черкасовтың
Отырар төбені көріп айтқаны жөніндегі есебінде аталып өтіледі. А.Черкасовты түкпір бөлмедегі Арсытанбабтың қабірі таң
қалдырады: «Надгробие Арстан – Баба такой же формы, как и остальные, покрыто куском белого коленкора и поражает своими
размерами. Такого роста, по ловам шейха, достигал и сам святой...». А.Черкасовтың деректері кеінірек орыс-француз
тілдерінде жарық көрген. И.А.Кастеньенің «Древности Киргизской степи и Оренбургского края» деген еңбегінде де
қайталанады. Көп үзілістен кейін Арыстанбаб кесенесі жөніндегі ғылыми сипаттама 1950 ж.
В.В.Константинованың «Некоторые архитектурные памятники по среднему течению р.Сырдарьи» деген мақаласында жарияланды.
1987 жылы «Білім мен Еңбекте» М.Сембиннің кесене жайлы мақаласы жарияланды. М.Сембин Арыстанбаб туралы мақаласында
О.Дастановтың «Әулиелі жерлер туралы шындық» атты кітабындағы келтірілген мәліметтерге сүйене отырып, Арыстанбаб
кесенесінің сәулетшісі ташкенттік Ескендір қажы болған деген болатын. «Ол өзінше бір қайта жырау, тыңнан толғау,
немесе ақындық шабыт-шалым сынасып, жырмен жарысу есепті...»,- деген М.Әуезов сөздері Арыстанбаб сәулетшісіне
толығымен тән.
XXI ғасырдағы Арыстан баб кесенесі

Әлемге танымал “Арыстан баб” мавзолейінің құрылысы екі жыл бұрын жаңа архитектуралық кешен тұрғысында басталған.
Идея авторы – белгілі мемлекет және қоғам қайраткері, инженер-ғалым, танымал меценат Асқар Құлыбаев болып табылады.
Бір кездері Асқар Алтынбекұлы халық игілігі үшін рухани құндылық орнатуды армандаған. Бүгінде Асқар Құлыбаевтың және
оның ұлдарының Қазақстанның жан азығы байлығын еселей түсу мақсатындағы сіңірген үлесі зор екендігін айту қажет.
Елбасымыз Н.Ә.Назарбаев өзі бастама көтеріп, бүкіл мемлекеттік деңгейде жүзеге “Мәдени мұра” бағдарламасы асырылып
жатыр.

EOT

Мәтін Creative Commons Attribution-ShareAlike лицензиясы аясында қолжетімді кейбір жағдайларда қосымша шарттардың талаптары атқарылады. Толығырақ қ. Қолдану шарттары.

Title: Арыстан баб кесенесі

Posting Date: 22:55, 2015 ж. сәуірдің 12.

Language: Kazakh

$consecutiveWords


    protected
        mixed
    $consecutiveWords
     = []

$explodedText


    protected
        mixed
    $explodedText

$generator


    protected
        Generator
    $generator

$separator


    protected
    static    mixed
    $separator
     = ' '

$separatorLen


    protected
    static    mixed
    $separatorLen
     = 1

$textStartsWithUppercase


    protected
    static    mixed
    $textStartsWithUppercase
     = true

$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 —

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 —

realText()

Generate a text string by the Markov chain algorithm.


    public
                realText([int $maxNbChars = 200 ][, int $indexSize = 2 ]) : string

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.

Parameters

$maxNbChars : int = 200: Maximum number of characters the text should contain (minimum: 10)
$indexSize : int = 2: Determines how many words are considered for the generation of the next word. The minimum is 1, and it produces a 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 values

string —

realTextBetween()

Generate a text string by the Markov chain algorithm.


    public
                realTextBetween([int $minNbChars = 160 ][, int $maxNbChars = 200 ][, int $indexSize = 2 ]) : string

Parameters

$minNbChars : int = 160: Minimum number of characters the text should contain (maximum: 8)
$maxNbChars : int = 200: Maximum number of characters the text should contain (minimum: 10)
$indexSize : int = 2: Determines how many words are considered for the generation of the next word. The minimum is 1, and it produces a 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 values

string —

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

appendEnd()


    protected
            static    appendEnd(mixed $text) : mixed

Parameters

$text : mixed

Return values

mixed —

explode()


    protected
            static    explode(mixed $text) : mixed

Parameters

$text : mixed

Return values

mixed —

generateText()


    protected
                generateText(int $maxNbChars, array<string|int, mixed> $words) : string

Parameters

$maxNbChars : int
$words : array<string|int, mixed>

Return values

string —

getConsecutiveWords()


    protected
                getConsecutiveWords(mixed $indexSize) : mixed

Parameters

$indexSize : mixed

Return values

mixed —

getExplodedText()


    protected
                getExplodedText() : mixed

Return values

mixed —

implode()


    protected
            static    implode(mixed $words) : mixed

Parameters

$words : mixed

Return values

mixed —

strlen()


    protected
            static    strlen(mixed $text) : mixed

Parameters

$text : mixed

Return values

mixed —

validStart()


    protected
            static    validStart(mixed $word) : mixed

Parameters

$word : mixed

Return values

mixed —

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 —

Text extends Text in package Application

Table of Contents

Properties

$baseText

Tags

$consecutiveWords

$explodedText

$generator

$separator

$separatorLen

$textStartsWithUppercase

$unique

Methods

__construct()

Parameters

Return values

asciify()

Parameters

Tags

Return values

bothify()

Parameters

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

realText()

Parameters

Tags

Return values

realTextBetween()

Parameters

Tags

Return values

regexify()

Parameters

Tags

Return values

Text extends Text
in package

Application