snicksnk / maitavr-api
maitavr.org 的 API
0.0.3
2014-02-25 22:02 UTC
Requires
- php: >=5.3.3
This package is not auto-updated.
Last update: 2024-09-24 06:16:24 UTC
README
maitavr.org api 操作库
通过 composer 安装
在 composer.json 中添加
"require": { "snicksnk/maitavr-api": "0.1.*@dev" }
并执行
php composer.phar update
系统主要组件
- 基本 api 类 MaitavrApi\Api
- 用户列表请求 MaitavrApi\Request\Users\UList
- 用户数量请求 MaitavrApi\Request\Users\Count
- Stream context 传输 MaitavrApi\Transport\StreamContext - 默认请求传输方式
允许更改服务器返回字段的参数
如果没有使用这些参数中的任何一个,则返回所有字段
-
MaitavrApi\Request\Users\UList::__construct(array $rows) - 以数组形式传递字段列表到构造函数(之前设置的字段将被此方法中传递的字段替换)
-
MaitavrApi\Request\Users\UList::setRows(array $rows=null) - 以数组形式设置字段列表
-
MaitavrApi\Request\Users\UList::addRow($rowName) - 在响应中添加一个新字段
过滤
使用示例
<?php use MaitavrApi\Api; use MaitavrApi\Request\Users\Count; use MaitavrApi\Request\Users\UList; //Подключаем автолоадер, если не используется composer require (__DIR__.'/../src/Tools/CompleteAutoloader.php'); //Создаем инстанс API класса $api = new Api('testapi', 'test12345678'); //Создаем объект запроса и передаем в конструктор поля, которые мы хотим видить в ответе $request = new UList(array(UList::ROW_FIRSTNAME, UList::ROW_LASTNAME, UList::ROW_EMAIL)); //Добавляем фильтр по email адресу в запрос $request->addFilter(UList::FILTER_EMAIL, array('andrey_ivanov@ukr.net', 'galkina@i.ua')); // Делаем запрос на сервер и получаем ответ в виде массива $response = $api->request($request); var_dump($response); /* array(2) { [0] => array(3) { 'firstname' => string(18) "Александр" 'lastname' => string(12) "Галкин" 'email' => string(12) "galkina@i.ua" } [1] => array(3) { 'firstname' => string(12) "Михаил" 'lastname' => string(14) "Сидоров" 'email' => string(21) "andrey_ivanov@ukr.net" } } */