APIManager Class Reference

Public Member Functions
	ApiManager ()
	validateAPILogin ()
	extendToken ()

Static Public Member Functions
static	registerEndPoint ($endpoint, $handler)
static	getEndPoint ($endpoint)
static	dispatch ($endpoint)
static	registerAPIEndPoints ()
static	setDefaults ()
static	registerSectionContentManager ()
static	upgradeComponent ($version)

Detailed Description

Definition at line 164 of file api_manager.inc.

Member Function Documentation

ApiManager()

APIManager::ApiManager

(

)

Definition at line 168 of file api_manager.inc.

     {
 
     }

dispatch()

static APIManager::dispatch (   $endpoint )

static

Definition at line 189 of file api_manager.inc.

     {
          global $method;
          global $user;
          
          $handler = APIManager::getEndPoint($endpoint);
          if (!$handler)
          {
               throw new FakoliException("API Endpoint not found");
          }
          
          $m = strtolower($method);
          if (!method_exists($handler, $m))
          {
               throw new FakoliException("Unsupported HTTP Verb");
          }
          
          if ($handler->allowAnonymous())
          {
               $handler->$m();
               return;
          }
          
          $t = checkIdentifier($_GET["token"]);
          
          if (!$t)
          {
               throw new FakoliException("No Authentication Token Provided");
          }
          
          $token = APIToken::getToken($t);
          if (!$token)
          {
               throw new FakoliException("Authentication Token Not Found");
          }
          
          if (!$token->active)
          {
               throw new FakoliException("Invalid Token");
          }
          
          $user = $token->User();
          
          if (!$handler->checkAccess())
          {
               throw new FakoliException("Permission Denied");
          }
          
          $handler->$m();
     }

extendToken()

APIManager::extendToken

(

)

Definition at line 304 of file api_manager.inc.

     {
          $t = checkIdentifier($_GET["token"]);
          
          $token = APIToken::getToken($t);
          
          $tokenLifetime = Settings::getValue("api", "token_lifetime");
          if ($tokenLifetime)
          {
               $expiryDate = new DateTime();
               $expiryDate->modify("+".$tokenLifetime);
               $token->expiry_date = $expiryDate->format("Y-m-d H:i:s T");
               $token->save();
          }
     }

getEndPoint()

static APIManager::getEndPoint (   $endpoint )

static

Definition at line 178 of file api_manager.inc.

     {
          if (!APIManager::$endpoints)
          {
               APIManager::$endpoints = array();
               ComponentManager::fireEvent('RegisterAPIEndPoints');
          }
          
          return APIManager::$endpoints[$endpoint];
     }

registerAPIEndPoints()

static APIManager::registerAPIEndPoints ( )

static

Definition at line 320 of file api_manager.inc.

     {
          APIManager::registerEndPoint("authenticate", new AuthenticateAPIEndPoint());
          APIManager::registerEndPoint("extend", new AuthenticateAPIEndPoint());
     }

registerEndPoint()

static APIManager::registerEndPoint (   $endpoint,   $handler  )

static

Definition at line 173 of file api_manager.inc.

     {
          APIManager::$endpoints[$endpoint] = $handler;
     }

registerSectionContentManager()

static APIManager::registerSectionContentManager ( )

static

Definition at line 331 of file api_manager.inc.

     {
          SectionContentManagerMap::registerManager("API", new APIContentManager());
     }

setDefaults()

static APIManager::setDefaults ( )

static

Definition at line 326 of file api_manager.inc.

     {
          Settings::setDefaultValue("api", "token_lifetime", "30 days", "String",  "Specifies how long API authorization tokens stay valid. Leave blank to have tokens never expire");
     }

upgradeComponent()

static APIManager::upgradeComponent (   $version )

static

Definition at line 336 of file api_manager.inc.

     {
          $mgr = new APIUpgradeManager();
          $mgr->upgrade($version);
     }

validateAPILogin()

APIManager::validateAPILogin

(

)

Definition at line 240 of file api_manager.inc.

     {
          global $user;
          
          $mgr = new UserManager();
          
          $username = $_REQUEST[$mgr->getUsernameField()];
          $password = $_REQUEST["password"];
          
          if (Settings::getValue("login", "reject_all_blank_passwords"))
          {
               // JDG - guard against data not found exception
               if(!$username OR !$password)
               {
                    LoginManager::recordLoginAttempt($username, "api", null, "failure");
                    LoginManager::$error = "Incorrect user name or password.";
                    return "ERROR|".LoginManager::$error;
               }
          }
          else
          {
               if(!$username)
               {
                    LoginManager::recordLoginAttempt($username, "api", null, "failure");
                    LoginManager::$error = "Incorrect user name or password.";
                    return "ERROR|".LoginManager::$error;
               }
          }
          
          ComponentManager::fireEvent("OnLoginSubmit");
          
          $user = $mgr->validatePassword($username, $password);
          if ($user)
          {
               $token = APIToken::getUserToken($user->user_id);
               if (!$token)
               {
                    $token = new APIToken();
                    $token->token = plainGUID();
                    $token->user_id = $user->user_id;
                    $token->created_date = now();
                    $token->expiry_date = null;
                    $token->active = true;
                    $token->last_access = now();
                    $token->save();
               }
               
               $tokenLifetime = Settings::getValue("api", "token_lifetime");
               if ($tokenLifetime)
               {
                    $expiryDate = new DateTime();
                    $expiryDate->modify("+".$tokenLifetime);
                    $token->expiry_date = $expiryDate->format("Y-m-d H:i:s T");
               }
               
               LoginManager::recordLoginAttempt($username, "api", null, "success");
               Fakoli::JSONReturn($token, true);
          }
          else
          {
               return "ERROR";
          }
     }

---

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

• C:/code/cms.sonjara.com/cms/components/api/api_manager.inc