Colymba\RESTfulAPI\Authenticators\Authenticator
Basic required structure for any RESTfulAPI Authenticator
- Author: Thierry Francois @colymba thierry@colymba.com
- Copyright: Copyright (c) 2013, Thierry Francois
- License: http://opensource.org/licenses/BSD-3-Clause BSD Simplified
Synopsis
interface Authenticator
{
- // methods
- public true|RESTfulAPIError authenticate()
- public null|DataObject getOwner()
Methods
public
- authenticate() — Checks if a request to the API is authenticated
- getOwner() — Returns the DataObject related to the authenticated request