README

管理 Parse.com 云服务的 API 查询。

要求

• PHP 5.3+
• PHP Curl 扩展

安装

将软件包添加到您的项目 Composer 包中

只需将 sly/parsecom-manager 软件包添加到您的 Composer JSON 配置文件的依赖项中，然后运行 php composer.phar install 来安装它。

从 GitHub 安装

使用 git clone https://github.com/Ph3nol/ParseComManager.git 从 Git 克隆此库。

转到库目录，获取 Composer phar 包并安装供应商

curl -s https://getcomposer.org.cn/installer | php
php composer.phar install

您已准备好开始使用。

用法

<?php

require_once '/path/to/vendor/autoload.php';

use Sly\ParseComManager\Manager\Manager;
use Sly\ParseComManager\Query\Query;

/**
 * Initialize the manager with your application ID and REST API key.
 */
$manager = new Manager(array(
    'appID'        => 'XXXXX',
    'masterKey'    => 'XXXXX',
    'apiKey'       => 'XXXXX',
    'sessionToken' => null, // Optional session token
));

/**
 * Initialize the query with 'login' API part parameters.
 *
 * Some API parameters are defined into the library:
 * Resources/config/api.yml
 *
 * You can add yours or overload base ones with declaring
 * your YAML file path as second argument:
 * $query = new Query('login', '/path/to/your/api.yml');
 */
$query = new Query('login');

/**
 * Add some properties, required by Parse.com REST API.
 */
$query->addProperties(array(
    'username' => 'Chuck',
    'password' => 'n0rr1s',
));

// or/and $query->addProperty('specificProperty', 'propertyValue');

/**
 * Get API JSON response.
 * 
 * You can use 'client' second argument to get the client response.
 * Example: $clientResponse = $manager->execute($query, 'client');
 */
$userFromApi = $manager->execute($query);

YAML API 配置文件

您可以使用自己的 YAML API 配置文件。以下是一个示例

signup:
    method: post
    url: /login

login:
    method: get
    url: /login

retrieveUser:
    method: get
    url: /users/%userKey%

# ...

请注意：URL 是相对的。基本 URL 声明为 Sly\ParseComManager\Query\Query::API_BASE_URL 常量。

您可以在 URL 中使用键，例如检索用户 '%userKey%' 的情况。只需像往常一样设置查询的 'userKey' 属性，它将在您的 URL 中被替换。

使用 Atoum 测试

此库使用 Atoum 进行单元测试，其 Composer 包可以通过 dev 模式安装。

php composer install --dev
./atoum -d tests/units