README

此 SDK 允许您一次性生成 1 到 2048 个用户

安装

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

API

KielD01\RandomUser::__construct($version = null)
如果 $version 为空或抛出 Exception，则设置最新版本。

KielD01\RandomUser::asJson()
设置 Content-Type 头为 application/json。

KielD01\RandomUser::setVersion($version = null)
将 $this->version 设置为 $version。抛出 Exception。

KielD01\RandomUser::setOutputFormat($format = null)
设置输出格式为 'json', 'xml', 'pretty', 'yaml', 'csv' 之间

KielD01\RandomUser::setResultsCount($results = null)
设置结果计数。有效范围为 1 到 2048。

KielD01\RandomUser::setPage($page = 1)
设置结果页面

KielD01\RandomUser::setSeed($seed = null)
设置种子

KielD01\RandomUser::setNoInfo($noInfo = false)
禁用或启用 info 对象。

KielD01\RandomUser::setNationalityOnly($nationality = null, $value = false)
设置国籍值或值到 $value

KielD01\RandomUser::setIncludedOrExcludedFields($type = 'inc', $fields = null, $value = true)
设置包含或排除字段

KielD01\RandomUser::getVersion()
返回版本

KielD01\RandomUser::getNationalities()
根据版本返回国籍列表

KielD01\RandomUser::getQuery()
返回要发送的请求查询

KielD01\RandomUser::getResults()
返回 KielD01\RandomUser\Helpers\Collection，其中包含 items 数组，该数组为 KielD01\RandomUser\Helpers\Entity

KielD01\RandomUser::fetch($debug = false)
从 API 获取结果并将其转换为 KielD01\RandomUser\Helpers\Collection

示例

<?php

use KielD01\RandomUser\RandomUser;

try {
    $randomUser = new RandomUser('1.1');

    $results = $randomUser
        ->setNationalityOnly('us', true)
        ->setResultsCount(50)
        ->fetch()
        ->getResults();

    // ToDo : Process with $results
} catch (Exception $e) {
    echo "<pre>{$e->getMessage()}</pre>";
}