elchroy/ose

这是一个开源倡导者应用程序。它根据标准对GitHub用户进行排名。

dev-develop 2016-06-17 15:57 UTC

README

Coverage Status Build Status StyleCI

Open-Source-Evangelist

##检查点1B - 开源倡导者非PHP包 这是一个开源倡导者的仓库。

这是一个显示任何用户GitHub排名和状态的包。

##安装

为了运行此包,您必须安装PHP 5.5+和Composer

首先下载包。

$ composer require Elchroy/OSE

安装Composer。

$ composer install

##使用方法

使用此包有两种主要方式。

请确保拥有有效的GitHub用户名。

###1. 通过EvangelistStatus类

  • 使用(导入)此包。
use Elchroy\OSE\EvangelistStatus;
  • 创建一个新的状态实例。(您需要一个GitHub.com用户名。)
$evangelistStatus = new EvangelistStatus('andela-celisha-wigwe');
  • 请求用户的状态。
echo $evangelistStatus->getStatus();
// Damn It!!! Please make the world better, Oh Ye Prodigal Junior Evangelist

###2. 通过Evangelist类

  • 导入此包。
use Elchroy\OSE\Evangelist;
  • 创建一个新的倡导者。(您需要一个GitHub.com用户名。)
$evangelist = new Evangelist('andela-celisha-wigwe');
  • 请求用户的状态。
echo $evangelist->status();
==> Damn It!!! Please make the world better, Oh Ye Prodigal Junior Evangelist

您还可以这样获取状态

echo $evangelist->status; // Without using the parentheses.
==> Damn It!!! Please make the world better, Oh Ye Prodigal Junior Evangelist

您可以通过这种方式获取更多用户详细信息,只要GitHub上有此类信息即可。

echo $evangelist->url;
==> "https://api.github.com/users/andela-celisha-wigwe"
echo $evangelist->company;
==> "Andela"
echo $evangelist->type;
==> "User"
echo $evangelist->rank;
==> 1
echo $evangelist->following;
==> 1
echo $evangelist->organizations_url;
==> "https://api.github.com/users/andela-celisha-wigwe/orgs"

##测试

要测试此包,您可以使用PHPUnit,从命令行(WindowsOS)或终端(MacOS)。

注意:确保您在应用程序目录中。

$ phpunit