Alternc  latest
Alternc logiel libre pour l'h├ębergement
 All Classes Namespaces Files Functions Variables Pages
Alternc_Api_Auth_Interface Interface Reference

Authentication API used by server to authenticate a user using a specific method. More...

+ Inheritance diagram for Alternc_Api_Auth_Interface:

Public Member Functions

 __construct ($service)
 contructor : $service is an Alternc_Api_Service object having a getDb() method More...
 
 auth ($options)
 auth takes options specific to the auth itself returns an Alternc_Api_Token object More...
 
 instructions ()
 instructions on how to use this Auth class More...
 

Detailed Description

Authentication API used by server to authenticate a user using a specific method.

Definition at line 7 of file Interface.php.

Constructor & Destructor Documentation

Alternc_Api_Auth_Interface::__construct (   $service)

contructor : $service is an Alternc_Api_Service object having a getDb() method

Implemented in Alternc_Api_Auth_Sharedsecret, and Alternc_Api_Auth_Login.

Member Function Documentation

Alternc_Api_Auth_Interface::auth (   $options)

auth takes options specific to the auth itself returns an Alternc_Api_Token object

Implemented in Alternc_Api_Auth_Sharedsecret, and Alternc_Api_Auth_Login.

Alternc_Api_Auth_Interface::instructions ( )

instructions on how to use this Auth class

Returns
array("fields" => array("fields to send, required or not"), "description" => "description of this auth")

Implemented in Alternc_Api_Auth_Sharedsecret, and Alternc_Api_Auth_Login.


The documentation for this interface was generated from the following file: