Alternc_Api_Request Class Reference

Standard Request object for the AlternC API. More...

Public Member Functions
	__construct ($options)

Public Attributes
	$token
	$token_hash
	$object
	$action
	$options
	$metadata
const	ERR_MISSING_PARAMETER = 111801

Detailed Description

Standard Request object for the AlternC API.

Helps streamlining the calls by checking parameters

Definition at line 8 of file Request.php.

Constructor & Destructor Documentation

__construct()

Alternc_Api_Request::__construct

(

$options

)

Definition at line 53 of file Request.php.

                                   {
 
 
        // Attempts to retrieve object
        if (isset($options["object"]) && is_string($options["object"])) {
            $this->object = $options["object"];
        } else {
            throw new \Exception("Missing parameter object", self::ERR_MISSING_PARAMETER);
        }
 
        // Attempts to retrieve action
        if (isset($options["action"]) && is_string($options["action"])) {
            $this->action = $options["action"];
        } else {
            throw new \Exception("Missing parameter action", self::ERR_MISSING_PARAMETER);
        }
 
        // Attempts to retrieve options
        if (isset($options["options"])) {
            if (is_array($options)) {
                $this->options = $options["options"];
            } else {
                throw new \Exception("Missing parameter options", self::ERR_MISSING_PARAMETER);
            }
        } else {
            $this->options = array();
        }
 
        // Attempts to retrieve token
        if (isset($options["token"])) {
            if (is_a($options["token"], Alternc_Api_Token)) {
                $this->token = $options["token"];
            } else {
                throw new \Exception("Bad parameter token", self::ERR_MISSING_PARAMETER);
            }
        } else {
            // Attempts to retrieve token_hash then
            if (isset($options["token_hash"]) && is_string($options["token_hash"])) {
                $this->token_hash = $options["token_hash"];
            } else {
                throw new \Exception("Missing parameter token OR token_hash", self::ERR_MISSING_PARAMETER);
            }
        }
 
        // Attempts to retrieve metadata (eg: API version)
        if (isset($options["metadata"])) {
            $this->metadata = $options["metadata"];
        }
    }

References $options.

Member Data Documentation

$action

Alternc_Api_Request::$action

Definition at line 34 of file Request.php.

$metadata

Alternc_Api_Request::$metadata

Definition at line 49 of file Request.php.

$object

Alternc_Api_Request::$object

Definition at line 27 of file Request.php.

$options

Alternc_Api_Request::$options

Definition at line 41 of file Request.php.

Referenced by __construct().

$token

Alternc_Api_Request::$token

Definition at line 14 of file Request.php.

$token_hash

Alternc_Api_Request::$token_hash

Definition at line 20 of file Request.php.

ERR_MISSING_PARAMETER

const Alternc_Api_Request::ERR_MISSING_PARAMETER = 111801

Definition at line 51 of file Request.php.

---

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

• lib/Alternc/Api/Request.php