PHPackages                             kield-01/random-user-php-sdk - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. kield-01/random-user-php-sdk

ActiveLibrary[API Development](/categories/api)

kield-01/random-user-php-sdk
============================

PHP SDK for the RandomUser.me service (https://randomuser.me/api/)

v1.0(7y ago)133MITPHP

Since Oct 30Pushed 7y ago1 watchersCompare

[ Source](https://github.com/KielD-01/random-user-php-sdk)[ Packagist](https://packagist.org/packages/kield-01/random-user-php-sdk)[ RSS](/packages/kield-01-random-user-php-sdk/feed)WikiDiscussions master Synced yesterday

READMEChangelog (1)Dependencies (3)Versions (2)Used By (0)

Random User PHP SDK
===================

[](#random-user-php-sdk)

[![Latest Stable Version](https://camo.githubusercontent.com/55360dce8fafa4f982aac31e2c399fc64a0a704e29a72893ba9499eb895b35fc/68747470733a2f2f706f7365722e707567782e6f72672f6b69656c642d30312f72616e646f6d2d757365722d7068702d73646b2f762f737461626c65)](https://packagist.org/packages/kield-01/random-user-php-sdk)[![Total Downloads](https://camo.githubusercontent.com/49798939db2c011eca1865c6dbebdcd148a3c2eeed21b84f220fb6c1998b3cc7/68747470733a2f2f706f7365722e707567782e6f72672f6b69656c642d30312f72616e646f6d2d757365722d7068702d73646b2f646f776e6c6f616473)](https://packagist.org/packages/kield-01/random-user-php-sdk)[![Daily Downloads](https://camo.githubusercontent.com/c00b3cd43d24b93168f66cf667f692b26f5d66c56ce6de49e4110190d070e515/68747470733a2f2f706f7365722e707567782e6f72672f6b69656c642d30312f72616e646f6d2d757365722d7068702d73646b2f642f6461696c79)](https://packagist.org/packages/kield-01/random-user-php-sdk)[![composer.lock](https://camo.githubusercontent.com/acfdbb73d78cf3968487e277d915c774c63b90aca0a722b94404a2ffdd7d89f4/68747470733a2f2f706f7365722e707567782e6f72672f6b69656c642d30312f72616e646f6d2d757365722d7068702d73646b2f636f6d706f7365726c6f636b)](https://packagist.org/packages/kield-01/random-user-php-sdk)

This SDK allows You to generate from 1 to 2048 users at one time

Installation
------------

[](#installation)

`composer require kield-01/random-user-php-sdk`

API
---

[](#api)

`KielD01\RandomUser::__construct($version = null)`
Sets the latest version, if `$version` is null or throws an `Exception`.

`KielD01\RandomUser::asJson()`
Sets the header of Content-Type to `application/json`.

`KielD01\RandomUser::setVersion($version = null)`
Sets the `$this->version` to `$version`. Throws an `Exception`.

`KielD01\RandomUser::setOutputFormat($format = null)`
Sets the output format between `'json', 'xml', 'pretty', 'yaml', 'csv'`

`KielD01\RandomUser::setResultsCount($results = null)`
Sets results count. Available range is from 1 to 2048.

`KielD01\RandomUser::setPage($page = 1)`
Sets results page

`KielD01\RandomUser::setSeed($seed = null)`
Sets seed

`KielD01\RandomUser::setNoInfo($noInfo = false)`
Disable or Enable `info` object.

`KielD01\RandomUser::setNationalityOnly($nationality = null, $value = false)`
Set nationality value or values to `$value`

`KielD01\RandomUser::setIncludedOrExcludedFields($type = 'inc', $fields = null, $value = true)`
Sets included or excluded fields

`KielD01\RandomUser::getVersion()`
Returns version

`KielD01\RandomUser::getNationalities()`
Returns nationalities list due to version

`KielD01\RandomUser::getQuery()`
Returns request query to be sent

`KielD01\RandomUser::getResults()`
Returns `KielD01\RandomUser\Helpers\Colelction`, which contains `items` array of an `KielD01\RandomUser\Helpers\Entity`

`KielD01\RandomUser::fetch($debug = false)`
Fetch the results from the API and transform it into `KielD01\RandomUser\Helpers\Collection`

Example
-------

[](#example)

```