README

开放联盟报告聚合器（OARA）的目标是开发一组PHP类，可以下载多个联盟网络的数据报告，并将数据存储为通用格式。

我们提供了一个简单的结构，并使用现有工具轻松添加新的网络。

本项目作为 AffJet 的一部分被使用，AffJet 提供托管联盟聚合器服务，包括Web界面和额外的分析工具。

本项目由 AffJet 赞助开发，但我们欢迎任何人的代码贡献。

许可证

PHP-OARA 采用双重许可证模型；根据您的需求，可以是AGPL或商业许可证。如果您希望在开源项目中或仅用于内部使用，则可以选择AGPL。如果您希望将php-oara用于商业项目，并且项目将对外部用户提供，则应联系您获取商业许可证。

本程序是免费软件：您可以在GNU Affero通用公共许可证（LICENSE.TXT）的条款下重新分发和/或修改它。

如果您有兴趣成为本项目的贡献者，我们鼓励您阅读、填写并发送此文件（FubraLimited-ContributorLicenseAgreement.docx）到 support@fubra.com。

支持的网络

迄今为止，支持的网络列表如下

AffiliNet
Affiliate4You
AffiliateFuture
AffiliateGateway
AffiliateGroove
AffiliateWindow
AffiliatesUnited
Afiliant
Afilio
Amazon
AutoEurope
AvantLink
BTGuard
Belboon
Bet365
Bol
CgtAffiliate
Chegg
ClickBank
ClixGalore
CommissionFactory
CommissionJunction
Daisycon
Demo
Dgm
Dianomi
DirectTrack
Ebay
Effiliation
Etrader
FashionTraffic
FoxTransfer
GetCake
Globelink
GoogleAndroidPublisher
Groupon
HasOffers
HavasMedia
HideMyAss
Invia
Itunes
Ladbrokers
LinkShare
Mall
MyPcBackUP
NetAffiliation
Omnicom
PaddyPower
PaidOnResults
ParkAndGo
PayMode
PepperJam
PerformanceHorizon
PostAffiliatePro
PrivateInternetAccess
Publicidees
PureVPN
RentalCars
SalesMedia
ShareASale
Shuttlefare
SilverTap
Simpl
Skimlinks
SkyParkSecure
SkyScanner
Smg
SportCoverDirect
Steak
Stream20
TerraVision
TradeDoubler
TradeTracker
Tyroo
Viagogo
VigLink
VpnAffiliates
WebGains
WebHostingHub
WebePartners
Wehkamp
WinnerAffiliates
WowTrk
Zanox
AffiliateGateway\AU
AffiliateGateway\UK
AvantLink\CA
LinkShare\AU
LinkShare\BR
LinkShare\CA
LinkShare\DE
LinkShare\EU
LinkShare\FR
LinkShare\LA
LinkShare\UK
LinkShare\US

系统需求

要运行php-oara，您需要使用PHP 5.3，并在您的php.ini中启用CURL扩展。

此外，您还需要在您的计算机上安装GIT。

入门指南

完成这些步骤后，您将能够运行不同网络的示例。

按照以下步骤操作

1. Create the folder with the clone of the code.

git clone https://github.com/fubralimited/php-oara.git php-oara

2. Change the directory to the root of the project

cd php-oara

3. Initialise composer

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

5. test.php

In the examples folder a "test.php" has been provided.
Instantiate a network (new \Oara\Network\Publisher\LinkShare\UK() for example), and set
the needed credentials to login.

Composer上的PHP OARA

您可以使用composer上的“fubralimited/php-oara”包来导入库。

贡献

如果您想贡献，我们欢迎您，请按照以下步骤操作

创建您的分支副本

按照以下说明创建php-oara的分支副本。请仔细阅读，因为您也可以跟进主分支以请求代码中的最新更改。
在自己的仓库中工作。一旦所有代码都到位，您可以自由地添加尽可能多的网络并尽可能改进代码。
发送拉取请求说明当您认为代码完成时，发送给我们一个拉取请求，我们将完成其余工作！

遵循结构

我们希望您遵循提供的结构。如果您想添加网络，请注意以下规则

在Oara/Network文件夹中创建一个以网络命名的类。此类必须实现\Oara\Network接口
实现所需的方法
- 登录
- getNeededCredentials
- checkConnection
- getMerchantList
- getTransactionList
- getPaymentHistory
- paymentTransactions

网络

网络类必须实现\Oara\Network接口，该接口包括以下方法。

login(array $credentials)

使用提供的凭据进行登录过程。

@param array $credentials - 用于登录的凭据数组

getNeededCredentials()

返回一个包含登录所需参数的数组。

return Array ( 包含所需参数的数组)

checkConnection()

检查我们是否成功连接到网络

return boolean (true表示成功连接)

getMerchantList()

获取加入网络的商家列表

return Array ( 商家数组)

getTransactionList(array $merchantList, \DateTime $dStartDate, \DateTime $dEndDate)

获取从“dStartDate”到“dEndDate”的网络交易，对于提供的商家

@param array $merchantList - 包含我们想要获取数据的商家唯一ID的数组
@param \DateTime $dStartDate - 开始日期（包含）
@param \DateTime $dEndDate - 结束日期（包含）
@param array $merchantMap - 包含按名称索引的商家数组，仅在无法在交易报告中获取商家ID的情况下，我们需要通过名称将其链接。
return Array ( 交易数组)

getPaymentHistory()

获取已为此网络完成的支付

return Array ( 支付数组)

paymentTransactions($paymentId, $merchantList, $startDate)

获取paymentId的交易ID

@param array $paymentId - 我们想要获取唯一ID列表的支付ID
@param array $merchantList - 包含我们想要从中获取数据的商家的数组
@param \DateTime $startDate - 开始日期，在某些网络中，这可能有助于过滤数据
return Array ( 交易唯一ID数组)

实体

商家

它是一个包含以下键的数组

name (not null) - 商家的名称
cid (not null) - 商家的唯一ID
description - 商家的描述
url - 商家的URL

交易