Service API used by server to export API methods this class can be used to implement an API service / endpoint a REST and POST api is provided as an example. More...

Public Member Functions
	__construct ($options)
	Constructor of the Api Service Wrapper. More...

	auth ($auth)
	Authenticate into an AlternC server. More...

	call ($request)
	Manage an API Call. More...

	doc ($element)
	Return documentation of the API, either general (no parameters) or for a specific action or auth class. More...

	getDb ()
	Getter for the databaseAdapter (used by authAdapter) More...

Public Attributes
	$db

	$token

const	ERR_INVALID_ARGUMENT = 111801

const	ERR_METHOD_DENIED = 111802

const	ERR_INVALID_ANSWER = 111803

const	ERR_SETUID_FORBIDDEN = 111804

const	ERR_SETUID_USER_NOT_FOUND = 111805

const	ERR_OBJECT_NOT_FOUND = 111806

const	ERR_ACTION_NOT_FOUND = 111807

const	ERR_INVALID_TOKEN = 111808

Private Attributes
	$loggerList

	$allowedAuth

Detailed Description

Service API used by server to export API methods this class can be used to implement an API service / endpoint a REST and POST api is provided as an example.

Definition at line 11 of file Service.php.

Constructor & Destructor Documentation

◆ __construct()

Alternc_Api_Service::__construct ( $options )

Constructor of the Api Service Wrapper.

Parameters

$options an hash with databaseAdapter: an already initialized PDO object see http://php.net/PDO loginAdapterList: (not mandatory) list of allowed authentication adapters (their codename) see Alternc/Api/Auth/* loggerAdapter: (not mandatory), a PSR3-Interface-compliant class or a list of it. see https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md for more information

Returns: create the object

Definition at line 40 of file Service.php.

                                    {
  
         // What DB shall we connect to?
         // Note: it MUST be in this mode : $dbh->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
         if (isset($options["databaseAdapter"]) && $options["databaseAdapter"] instanceof PDO) {
             $this->db = $options["databaseAdapter"];
         } else {
             throw new \Exception("Missing required parameter databaseAdapter", self::ERR_INVALID_ARGUMENT);
         }
  
         // Which login is allowed?
         $this->allowedAuth = array();
         if (isset($options["loginAdapterList"]) && is_array($options["loginAdapterList"])) {
             foreach ($options["loginAdapterList"] as $lal) {
                 $this->allowedAuth[] = (string) $lal;
             }
         }
  
         // To which logger(s) shall we log to?
         if (isset($options["loggerAdapter"])) {
             if (!is_array($options["loggerAdapter"]))
                 $options["loggerAdapter"] = array($options["loggerAdapter"]);
             foreach ($options["loggerAdapter"] as $la) {
                 if ($la instanceof Psr\Log\LoggerInterface)
                     $this->loggerList[] = $la;
             }
         }
     }

Member Function Documentation

◆ auth()

Alternc_Api_Service::auth ( $auth )

Authenticate into an AlternC server.

Parameters

$auth hash with method: string describing the authentication name (in Alternc_Api_Auth_xxx) options: array list of parameters for the corresponding auth. if 'uid' is set in the option hash, the account MUST be an administrator one and as a result, the returned Api_Token will be set to this UID and not the admin one.

Returns: Alternc_Api_Token an API Token

Definition at line 78 of file Service.php.

                          {
         if (!isset($auth["method"]) || !is_string($auth["method"])) {
             throw new \Exception("Missing required parameter method", self::ERR_INVALID_ARGUMENT);
         }
         if (!isset($auth["options"]) || !is_array($auth["options"])) {
             throw new \Exception("Missing required parameter options", self::ERR_INVALID_ARGUMENT);
         }
  
         if (count($this->allowedAuth) && !in_array($auth["method"], $this->allowedAuth)) {
             throw new \Exception("Method not allowed", self::ERR_METHOD_DENIED);
         }
         if (isset($auth["options"]["uid"]) && !intval($auth["options"]["uid"])) {
             throw new \Exception("Invalid UID", self::ERR_INVALID_ARGUMENT);
         }
  
         $adapterName = "Alternc_Api_Auth_" . ucfirst(strtolower($auth["method"]));
  
         $authAdapter = new $adapterName($this);
  
         $token = $authAdapter->auth($auth["options"]);
  
         // something went wrong user-side
         if ($token instanceof Alternc_Api_Response)
             return $token;
         // something went *really* wrong (bad type): 
         if (!$token instanceof Alternc_Api_Token)
             throw new \Exception("Invalid answer from Api_Auth_Interface", self::ERR_INVALID_ANSWER);
  
         if (isset($auth["options"]["uid"])) {
             if (!$token->isAdmin) {
                 // Non-admin are not allowed to setuid
                 return new Alternc_Api_Response(array("code" => self::ERR_SETUID_FORBIDDEN, "message" => "This user is not allowed to set his uid"));
             }
             // Search for the requested user. We allow using *disabled* account here since we are admin 
             foreach ($this->db->query("SELECT uid FROM membres WHERE uid=" . intval($auth["options"]["uid"])) as $setuid) {
                 $token->uid = intval($setuid['uid']);
                 $stmt = $this->db->prepare("UPDATE token SET data=? WHERE token=?");
                 $stmt->execute(array($token->toJson(), $token->token));
                 return $token;
             }
             return new Alternc_Api_Response(array("code" => self::ERR_SETUID_USER_NOT_FOUND, "message" => "Can't find the user you want to setuid to"));
         }
         return $token;
     }

References $token.

◆ call()

Alternc_Api_Service::call ( $request )

Manage an API Call.

Parameters

Alternc_Api_Request $request The API call the request must have "object" and "action" elements, and a "token" to authenticate "options" are sent as it is to the Api Call.

Returns: Alternc_Api_Response an API response

Definition at line 130 of file Service.php.

                             {
         if (!$request instanceof Alternc_Api_Request)
             throw new \Exception("request must be an Alternc_Api_Request object", self::ERR_INVALID_ARGUMENT);
  
         // we set the token in the Service object, so that other classes can use it :) 
         $this->token = Alternc_Api_Token::tokenGet($request->token_hash, $this->db);
         if ($this->token instanceof Alternc_Api_Response)  // bad token
             return $this->token;
  
         $className = "Alternc_Api_Object_" . ucfirst(strtolower($request->object));
         if (!class_exists($className))
             return new Alternc_Api_Response(array("code" => self::ERR_OBJECT_NOT_FOUND, "message" => "Object not found in this AlternC's instance"));
  
         $object = new $className($this);
  
         $action = $request->action;
  
         if (strpos($action, "-") !== false) {
             // replace - by an uppercase letter:
             $action = lcfirst(str_replace(" ", "", implode("", array_map("ucfirst", explode("-", $action)))));
         }
         if (!method_exists($object, $action))
             return new Alternc_Api_Response(array("code" => self::ERR_ACTION_NOT_FOUND, "message" => "Action not found for this object in this AlternC's instance"));
  
         $request->token = $this->token; // we receive $request->token_hash as a STRING, but we transmit its object as an Alternc_Api_Token.
         // TODO: log this Api Call
         return $object->$action($request->options);
     }

References $request, $token, and Alternc_Api_Token\tokenGet().

◆ doc()

Alternc_Api_Service::doc ( $element )

Return documentation of the API, either general (no parameters) or for a specific action or auth class.

Parameters

string $element the name of the object for which documentation is requested

Returns: array a documentation hash (key/value)

Definition at line 165 of file Service.php.

                            {
         if (substr($element, 0, 5) == "auth/") {
             $adapterName = "Alternc_Api_Auth_" . ucfirst(strtolower(substr($element, 5)));
             if (!class_exists($adapterName))
                 return false;
             $authAdapter = new $adapterName($this);
             return $authAdapter->documentation();
         } else {
             list($class, $action) = explode("/", $element);
             $className = "Alternc_Api_Object_" . ucfirst(strtolower($class));
             if (!class_exists($className))
                 return false;
             $object = new $className($this);
             if (!$action) {
                 return $authAdapter->documentation();
             } else {
                 return $authAdapter->documentation($action);
             }
         }
     }

◆ getDb()

Alternc_Api_Service::getDb ( )

Getter for the databaseAdapter (used by authAdapter)

Definition at line 190 of file Service.php.

                      {
         return $this->db;
     }

References $db.

Member Data Documentation

◆ $allowedAuth

Alternc_Api_Service::$allowedAuth

private

Definition at line 15 of file Service.php.

◆ $db

Alternc_Api_Service::$db

Definition at line 13 of file Service.php.

Referenced by getDb().

◆ $loggerList

Alternc_Api_Service::$loggerList

private

Definition at line 14 of file Service.php.

◆ $token

Alternc_Api_Service::$token

Definition at line 16 of file Service.php.

Referenced by auth(), and call().

◆ ERR_ACTION_NOT_FOUND

const Alternc_Api_Service::ERR_ACTION_NOT_FOUND = 111807

Definition at line 24 of file Service.php.

◆ ERR_INVALID_ANSWER

const Alternc_Api_Service::ERR_INVALID_ANSWER = 111803

Definition at line 20 of file Service.php.

◆ ERR_INVALID_ARGUMENT

const Alternc_Api_Service::ERR_INVALID_ARGUMENT = 111801

Definition at line 18 of file Service.php.

◆ ERR_INVALID_TOKEN

const Alternc_Api_Service::ERR_INVALID_TOKEN = 111808

Definition at line 25 of file Service.php.

◆ ERR_METHOD_DENIED

const Alternc_Api_Service::ERR_METHOD_DENIED = 111802

Definition at line 19 of file Service.php.

◆ ERR_OBJECT_NOT_FOUND

const Alternc_Api_Service::ERR_OBJECT_NOT_FOUND = 111806

Definition at line 23 of file Service.php.

◆ ERR_SETUID_FORBIDDEN

const Alternc_Api_Service::ERR_SETUID_FORBIDDEN = 111804

Definition at line 21 of file Service.php.

◆ ERR_SETUID_USER_NOT_FOUND

const Alternc_Api_Service::ERR_SETUID_USER_NOT_FOUND = 111805

Definition at line 22 of file Service.php.

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

lib/Alternc/Api/Service.php

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ auth()

◆ call()

◆ doc()

◆ getDb()

Member Data Documentation

◆ $allowedAuth

◆ $db

◆ $loggerList

◆ $token

◆ ERR_ACTION_NOT_FOUND

◆ ERR_INVALID_ANSWER

◆ ERR_INVALID_ARGUMENT

◆ ERR_INVALID_TOKEN

◆ ERR_METHOD_DENIED

◆ ERR_OBJECT_NOT_FOUND

◆ ERR_SETUID_FORBIDDEN

◆ ERR_SETUID_USER_NOT_FOUND