README

这是一个用于简化应用程序使用印度尼西亚大学SSO登录功能的PHP库。

安装

1. 使用Composer安装（推荐）

推荐安装此库的方法是使用Composer。Composer是PHP的包管理器。这种方法的好处是您可以通过一个命令composer update轻松获取更新。此外，如果您使用的是也使用Composer的框架，例如Laravel或Yii2.0，您也可以轻松访问此库。您可以在这里了解更多关于Composer的信息。

要安装此库，请按照以下步骤操作。

安装Composer。（查看安装方法）
将以下依赖项添加到您项目根目录下的composer.json文件中（如果尚不存在，则创建新文件）。
```
 {
     "require": {
         "ristek/sso": "*"
     }
 }
```
通过在终端运行以下命令安装此库：
```
 composer install
```
此步骤可能需要几分钟，具体取决于您的网络连接。
从Composer中自动加载autoload.php文件到您的文件中（如果您使用的是基于Composer的框架，如Laravel，则可跳过此步骤）
```
 <?php
     require "vendor/autoload.php";
```

现在您可以使用此库了。

2. 手动安装

要手动使用此库（不使用Composer），请按照以下步骤操作。

从这里下载phpCAS库，并将其解压缩到您的项目目录中，例如在vendor目录下。
将项目作为zip文件下载（查看页面右上角），并将其解压缩到vendor目录。

通过以下操作引入SSO.php：

 <?php
     require "vendor/SSO/SSO.php";

然后，您必须指定到CAS.php的路径（位于您在步骤1中下载的phpCAS库中），如下所示：
```
 <?php
     $cas_path = "path/to/CAS.php";
     SSO\SSO::setCASPath($cas_path);
```

现在此库就可以使用了。

使用

您可以在example.php和example-manual.php文件中查看使用示例。

1. 身份验证

SSO\SSO::authenticate();

此调用将浏览器重定向到SSO登录。如果用户认证成功，该函数将返回布尔值true。您可以在调用此函数后假定用户已成功认证。

2. 获取用户详细信息

SSO\SSO::getUser();

getUser()函数将返回一个包含已认证用户详细信息的PHP stdClass对象。以下代码片段演示了其用法：

$user = SSO\SSO::getUser();
echo $user->username;             // prints user's username
echo $user->name;                 // prints user's name
echo $user->role;                 // prints user's role

/* jika role sebagai mahasiswa */
echo $user->npm;                  // prints user's npm
echo $user->org_code;             // prints user's organization code
echo $user->faculty;              // prints user's faculty
echo $user->study_program;        // prints user's study program
echo $user->educational_program;  // prints user's educational program

/* jika role sebagai staff */
echo $user->nip;                  // prints user's nip

3. 检查认证

SSO\SSO::check();

如果用户已成功认证，此调用将返回true，否则返回false。

4. 登出

SSO\SSO::logout();

此调用将结束用户认证。您还可以向logout方法添加URL参数，作为从SSO登出后的重定向URL。

SSO\SSO::logout('http://google.com');

5. 设置CAS.php的路径

SSO\SSO::setCASPath($cas_path);

此函数用于在您不通过Composer安装时使用。它设置SSO库将使用的CAS.php文件的位置。

提示：移除命名空间

您在这里经常看到SSO\SSO的调用。有时这会使您的代码变得难以阅读。您可以通过以下语句将其移除：

use SSO\SSO;

之后，您就可以移除前缀SSO\，如下所示：

SSO::authenticate();
$user = SSO::getUser();

ristek / sso

维护者

详细信息