https://github.com/casdoor/casdoor-php-sdk

PHP client SDK for Casdoor
https://github.com/casdoor/casdoor-php-sdk

auth authentication authn casdoor oauth oidc php saml sso

Last synced: about 1 month ago
JSON representation

PHP client SDK for Casdoor

• Host: GitHub
• URL: https://github.com/casdoor/casdoor-php-sdk
• Owner: casdoor
• License: apache-2.0
• Created: 2021-05-25T16:21:07.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-06-13T10:51:40.000Z (8 months ago)
• Last Synced: 2024-12-08T02:12:54.477Z (about 2 months ago)
• Topics: auth, authentication, authn, casdoor, oauth, oidc, php, saml, sso
• Language: PHP
• Homepage: https://github.com/casdoor/casdoor
• Size: 52.7 KB
• Stars: 18
• Watchers: 5
• Forks: 10
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# casdoor-php-sdk

[![Latest Stable Version](http://poser.pugx.org/casdoor/casdoor-php-sdk/v)](https://packagist.org/packages/casdoor/casdoor-php-sdk) [![Total Downloads](http://poser.pugx.org/casdoor/casdoor-php-sdk/downloads)](https://packagist.org/packages/casdoor/casdoor-php-sdk) [![Latest Unstable Version](http://poser.pugx.org/casdoor/casdoor-php-sdk/v/unstable)](https://packagist.org/packages/casdoor/casdoor-php-sdk) [![License](http://poser.pugx.org/casdoor/casdoor-php-sdk/license)](https://packagist.org/packages/casdoor/casdoor-php-sdk) [![PHP Version Require](http://poser.pugx.org/casdoor/casdoor-php-sdk/require/php)](https://packagist.org/packages/casdoor/casdoor-php-sdk)

Casdoor PHP SDK will allow you to easily connect your application to Casdoor authentication system without having to start from scratch.

# Step 1: Composer install casdoor-php-sdk 

In your php application directory, run the following command:

```

composer require casdoor/casdoor-php-sdk

```

Or use composer.json to add the following code:

```

{

    "require": {

        "vendor/package": "*",

    }

}

```

Then run composer install to make it take effect.

Create a OauthTest. Php file and import the SDK package.

```php

initConfig();

    $token = new Token();

    $accessToken = $token->getOAuthToken($this->code, $this->state);

    $this->assertIsString($accessToken->getToken());

}

```

The JWT token represents the user's identity and has the right to call relevant APIs.

# Step 4: verify and parse the user token

When a user passes in a JWT token, testParseJwtToken function calls the public key to verify the JWT token. If the verification is passed, the Array object is returned, which contains the account information of the user.

```php

public function testParseJwtToken()

{

    $this->initConfig();

    $token = "eyJhxxxx";	// from testGetOauthToken()

    $jwt = new Jwt();

    $result = $jwt->parseJwtToken($token, User::$authConfig);

    $this->assertIsArray();

}

```

# Step 5: update user information

testModifyUser call the application configuration (non-user token) as the update permission to perform CURD operations on user information.

```php

public function testModifyUser()

{

    $this->initConfig();

    $user = new User();

    # Delete User

    $user->name = 'user_hn99qa';

    $response = $user->deleteUser($user);

    $this->assertTrue($response);

    # Add User

    $response = $user->addUser($user);

    $this->assertTrue($response);

    # Update User

    $user->phone = 'phone';

    $user->displayName = 'display name';

    $response = $user->updateUser($user);

    $this->assertTrue($response);

}

```

# Others: User interaction

- User::getUser() , obtain User information by User name

- User::getUsers() to obtain information about all users.

- User::getUserCount() to obtain the current number of users.