Download the PHP package uconn-its/caspian without Composer

On this page you can find all versions of the php package uconn-its/caspian. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of uconn-its/caspian

Informations about the package caspian

CASpian

CASpian is an authentication library for Central Authentication Service (CAS) 3.0 protocol.

CASpian is inspired by the original apereo/phpCAS, but designed to be more flexible and easier to use for our needs.

Installation

Usage

For the most part, CASpian is a drop-in replacement for phpCAS, with only slight differences in the method names and parameters.

The first step is to decide on a storage backend for the CASpian client. The storage backend is used to store the CAS session information.

Storage Backends

CASpian comes with two storage backends out of the box: CASPian\Storage\SessionStorageProvider and CASPian\Storage\RedisStorageProvider which use PHP's $_SESSION and Redis respectively.

You can use the CASPian\Storage\SessionStorageProvider by calling the CASPian\Caspian::sessionProvider() method.

You can use the CASPian\Storage\RedisStorageProvider by calling the CASPian\Caspian::redisProvider() method.

You can also implement your own storage backend by implementing the CASPian\CaspianStorageProvider interface.

Client Setup

Once you have a storage backend, you can set up the CASpian client by calling the CASPian\Caspian::client() method.

There are also some configuration options that you can set on the client.

Using the Client

Once the client is set up, here are some of the methods you can use to authenticate users.

The isAuthenticated() method checks if the user is authenticated.

The forceAuthentication() method ensures that any code that follows it will only be executed if the user is authenticated. If the user is not authenticated, the user will be redirected to the CAS server to log in.

The logout() method logs the user out and redirects them to the CAS server to log out. You can also pass a URL to redirect the user to after logging out. If you want to log the user out and stay on the same page, you can pass the current URL as the redirect URL. After the logout() method is called, code execution will stop.

The getUser() method returns the username of the authenticated user. If the user is not authenticated, it will return null. Note: you must call isAuthenticated() or forceAuthentication() at some point before calling getUser() otherwise the existing session may not be loaded into the client.

The getAttributes() method returns an array of attributes for the authenticated user if configured by the CAS server. If the user is not authenticated, it will return an empty array. Note: you must call isAuthenticated() or forceAuthentication() at some point before calling getAttributes() otherwise the existing session may not be loaded into the client.

All versions of caspian with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1
ext-curl Version *
ext-dom Version *
ext-redis Version *
psr/log Version ^1.0 || ^2.0 || ^3.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package uconn-its/caspian contains the following files

Loading the files please wait ...