smtech / canvaspest

src/CanvasArray_Exception.php

Indentation +2 added lines, -2 removed lines

@@ -10,6 +10,6 @@
  * @author Seth Battis <SethBattis@stmarksschool.org>
  **/
 class CanvasArray_Exception extends CanvasObject_Exception {
-    const INVALID_PAGE_NUMBER = 200;
-    const INVALID_ARRAY_KEY = 201;
+	const INVALID_PAGE_NUMBER = 200;
+	const INVALID_ARRAY_KEY = 201;
 }

src/CanvasObject_Exception.php

Indentation +2 added lines, -2 removed lines

@@ -11,6 +11,6 @@
  **/
 class CanvasObject_Exception extends CanvasPest_Exception
 {
-    /** Response values are read-only */
-    const IMMUTABLE = 101;
+	/** Response values are read-only */
+	const IMMUTABLE = 101;
 }

src/CanvasPageLink_Exception.php

Indentation +2 added lines, -2 removed lines

@@ -11,6 +11,6 @@
  **/
 class CanvasPageLink_Exception extends CanvasArray_Exception
 {
-    /** Invalid parameters were passed to the constructor */
-    const INVALID_CONSTRUCTOR = 301;
+	/** Invalid parameters were passed to the constructor */
+	const INVALID_CONSTRUCTOR = 301;
 }

src/CanvasObject.php

Indentation +201 added lines, -201 removed lines

@@ -18,214 +18,214 @@
 class CanvasObject implements \ArrayAccess, \Serializable
 {
 
-    /** @var array $data Backing store */
-    private $data;
-
-    /**
-     * Construct a CanvasObject
-     *
-     * @param string|string[] $response JSON-encoded response from the Canvas
-     *                                  API or the resulting JSON-decoded
-     *                                  associative array
-     **/
-    public function __construct($response)
-    {
-        if (is_array($response)) {
-            $this->data = $response;
-        } else {
-            $this->data = json_decode($response, true);
-        }
-    }
-
-    /***************************************************************************
+	/** @var array $data Backing store */
+	private $data;
+
+	/**
+	 * Construct a CanvasObject
+	 *
+	 * @param string|string[] $response JSON-encoded response from the Canvas
+	 *                                  API or the resulting JSON-decoded
+	 *                                  associative array
+	 **/
+	public function __construct($response)
+	{
+		if (is_array($response)) {
+			$this->data = $response;
+		} else {
+			$this->data = json_decode($response, true);
+		}
+	}
+
+	/***************************************************************************
      * Object methods
      */
 
-    /**
-     * Whether a property exists
-     *
-     * @param string $key
-     *
-     * @return bool
-     *
-     * @see http://php.net/manual/en/language.oop5.overloading.php#language.oop5.overloading.members Property overloading
-     **/
-    public function __isset($key)
-    {
-        return isset($this->data[$key]);
-    }
-
-    /**
-     * Property to retrieve
-     *
-     * @param string $key
-     *
-     * @return mixed
-     *
-     * @see http://php.net/manual/en/language.oop5.overloading.php#language.oop5.overloading.members Property overloading
-     **/
-    public function __get($key)
-    {
-        return $this->data[$key];
-    }
-
-    /**
-     * Whether a property exists
-     *
-     * @deprecated Canvas objects are immutable
-     *
-     * @param string $key
-     * @param mixed $value
-     *
-     * @return void
-     *
-     * @throws CanvasObject_Exception IMMUTABLE All calls to this method will cause an exception
-     *
-     * @see http://php.net/manual/en/language.oop5.overloading.php#language.oop5.overloading.members Property overloading
-     **/
-    public function __set($key, $value)
-    {
-        throw new CanvasObject_Exception(
-            'Canvas objects are immutable',
-            CanvasObject_Exception::IMMUTABLE
-        );
-    }
-
-    /**
-     * Unset a property
-     *
-     * @deprecated Canvas objects are immutable
-     *
-     * @param string $key
-     *
-     * @return void
-     *
-     * @throws CanvasObject_Exception IMMUTABLE All calls to this method will cause an exception
-     *
-     * @see http://php.net/manual/en/language.oop5.overloading.php#language.oop5.overloading.members Property overloading
-     **/
-    public function __unset($key)
-    {
-        throw new CanvasObject_Exception(
-            'Canvas objects are immutable',
-            CanvasObject_Exception::IMMUTABLE
-        );
-    }
-
-    /***************************************************************************
+	/**
+	 * Whether a property exists
+	 *
+	 * @param string $key
+	 *
+	 * @return bool
+	 *
+	 * @see http://php.net/manual/en/language.oop5.overloading.php#language.oop5.overloading.members Property overloading
+	 **/
+	public function __isset($key)
+	{
+		return isset($this->data[$key]);
+	}
+
+	/**
+	 * Property to retrieve
+	 *
+	 * @param string $key
+	 *
+	 * @return mixed
+	 *
+	 * @see http://php.net/manual/en/language.oop5.overloading.php#language.oop5.overloading.members Property overloading
+	 **/
+	public function __get($key)
+	{
+		return $this->data[$key];
+	}
+
+	/**
+	 * Whether a property exists
+	 *
+	 * @deprecated Canvas objects are immutable
+	 *
+	 * @param string $key
+	 * @param mixed $value
+	 *
+	 * @return void
+	 *
+	 * @throws CanvasObject_Exception IMMUTABLE All calls to this method will cause an exception
+	 *
+	 * @see http://php.net/manual/en/language.oop5.overloading.php#language.oop5.overloading.members Property overloading
+	 **/
+	public function __set($key, $value)
+	{
+		throw new CanvasObject_Exception(
+			'Canvas objects are immutable',
+			CanvasObject_Exception::IMMUTABLE
+		);
+	}
+
+	/**
+	 * Unset a property
+	 *
+	 * @deprecated Canvas objects are immutable
+	 *
+	 * @param string $key
+	 *
+	 * @return void
+	 *
+	 * @throws CanvasObject_Exception IMMUTABLE All calls to this method will cause an exception
+	 *
+	 * @see http://php.net/manual/en/language.oop5.overloading.php#language.oop5.overloading.members Property overloading
+	 **/
+	public function __unset($key)
+	{
+		throw new CanvasObject_Exception(
+			'Canvas objects are immutable',
+			CanvasObject_Exception::IMMUTABLE
+		);
+	}
+
+	/***************************************************************************
      * ArrayAccess methods
      */
 
-    /**
-     * Whether an offset exists
-     *
-     * @param int|string $offset
-     *
-     * @return bool
-     *
-     * @see http://php.net/manual/en/arrayaccess.offsetexists.php ArrayAccess::offsetExists()
-     **/
-    public function offsetExists($offset)
-    {
-        return isset($this->data[$offset]);
-    }
-
-    /**
-     * Offset to retrieve
-     *
-     * @param int|string $offset
-     *
-     * @return mixed|null
-     *
-     * @see http://php.net/manual/en/arrayaccess.offsetexists.php ArrayAccess::offsetGet()
-     **/
-    public function offsetGet($offset)
-    {
-        return $this->data[$offset];
-    }
-
-    /**
-     * Assign a value to the specified offset
-     *
-     * @deprecated Canvas objects are immutable
-     *
-     * @param int|string $offset
-     * @param mixed $value
-     *
-     * @return void
-     *
-     * @throws CanvasObject_Exception IMMUTABLE All calls to this method will cause an exception
-     *
-     * @see http://php.net/manual/en/arrayaccess.offsetset.php ArrayAccess::offsetSet()
-     **/
-    public function offsetSet($offset, $value)
-    {
-        throw new CanvasObject_Exception(
-            'Canvas objects are immutable',
-            CanvasObject_Exception::IMMUTABLE
-        );
-    }
-
-    /**
-     * Unset an offset
-     *
-     * @deprecated Canvas objects are immutable
-     *
-     * @param int|string $offset
-     *
-     * @return void
-     *
-     * @throws CanvasObject_Exception IMMUTABLE All calls to this method will cause an exception
-     *
-     * @see http://php.net/manual/en/arrayaccess.offsetunset.php ArrayAccess::offsetUnset()
-     **/
-    public function offsetUnset($offset)
-    {
-        throw new CanvasObject_Exception(
-            'Canvas objects are immutable',
-            CanvasObject_Exception::IMMUTABLE
-        );
-    }
-
-    /***************************************************************************
+	/**
+	 * Whether an offset exists
+	 *
+	 * @param int|string $offset
+	 *
+	 * @return bool
+	 *
+	 * @see http://php.net/manual/en/arrayaccess.offsetexists.php ArrayAccess::offsetExists()
+	 **/
+	public function offsetExists($offset)
+	{
+		return isset($this->data[$offset]);
+	}
+
+	/**
+	 * Offset to retrieve
+	 *
+	 * @param int|string $offset
+	 *
+	 * @return mixed|null
+	 *
+	 * @see http://php.net/manual/en/arrayaccess.offsetexists.php ArrayAccess::offsetGet()
+	 **/
+	public function offsetGet($offset)
+	{
+		return $this->data[$offset];
+	}
+
+	/**
+	 * Assign a value to the specified offset
+	 *
+	 * @deprecated Canvas objects are immutable
+	 *
+	 * @param int|string $offset
+	 * @param mixed $value
+	 *
+	 * @return void
+	 *
+	 * @throws CanvasObject_Exception IMMUTABLE All calls to this method will cause an exception
+	 *
+	 * @see http://php.net/manual/en/arrayaccess.offsetset.php ArrayAccess::offsetSet()
+	 **/
+	public function offsetSet($offset, $value)
+	{
+		throw new CanvasObject_Exception(
+			'Canvas objects are immutable',
+			CanvasObject_Exception::IMMUTABLE
+		);
+	}
+
+	/**
+	 * Unset an offset
+	 *
+	 * @deprecated Canvas objects are immutable
+	 *
+	 * @param int|string $offset
+	 *
+	 * @return void
+	 *
+	 * @throws CanvasObject_Exception IMMUTABLE All calls to this method will cause an exception
+	 *
+	 * @see http://php.net/manual/en/arrayaccess.offsetunset.php ArrayAccess::offsetUnset()
+	 **/
+	public function offsetUnset($offset)
+	{
+		throw new CanvasObject_Exception(
+			'Canvas objects are immutable',
+			CanvasObject_Exception::IMMUTABLE
+		);
+	}
+
+	/***************************************************************************
      * Serializable methods
      */
 
-    /**
-     * String representation of CanvasObject
-     *
-     * @return string
-     *
-     * @see http://php.net/manual/en/serializable.serialize.php Serializable::serialize()
-     **/
-    public function serialize()
-    {
-        return serialize($this->data);
-    }
-
-    /**
-     * Construct a CanvasObject from its string representation
-     *
-     * @param string $data
-     *
-     * @return void
-     *
-     * @see http://php.net/manual/en/serializable.unserialize.php Serializable::unsserialize()
-     **/
-    public function unserialize($data)
-    {
-        $this->data = unserialize($data);
-    }
-
-    /**************************************************************************/
-
-    /**
-     * An array representation of the CanvasObject
-     *
-     * @return array
-     **/
-    public function getArrayCopy()
-    {
-        return $this->data;
-    }
+	/**
+	 * String representation of CanvasObject
+	 *
+	 * @return string
+	 *
+	 * @see http://php.net/manual/en/serializable.serialize.php Serializable::serialize()
+	 **/
+	public function serialize()
+	{
+		return serialize($this->data);
+	}
+
+	/**
+	 * Construct a CanvasObject from its string representation
+	 *
+	 * @param string $data
+	 *
+	 * @return void
+	 *
+	 * @see http://php.net/manual/en/serializable.unserialize.php Serializable::unsserialize()
+	 **/
+	public function unserialize($data)
+	{
+		$this->data = unserialize($data);
+	}
+
+	/**************************************************************************/
+
+	/**
+	 * An array representation of the CanvasObject
+	 *
+	 * @return array
+	 **/
+	public function getArrayCopy()
+	{
+		return $this->data;
+	}
 }

src/CanvasPest_Exception.php

Indentation +6 added lines, -6 removed lines

@@ -11,12 +11,12 @@
  **/
 class CanvasPest_Exception extends \Exception
 {
-    /** The API access method is not supported by the Canvas API */
-    const UNSUPPORTED_METHOD = 1;
+	/** The API access method is not supported by the Canvas API */
+	const UNSUPPORTED_METHOD = 1;
 
-    /** The API access token provided is invalid */
-    const INVALID_TOKEN = 2;
+	/** The API access token provided is invalid */
+	const INVALID_TOKEN = 2;
 
-    /** Unanticipated JSON response from API */
-    const INVALID_JSON_RESPONSE = 3;
+	/** Unanticipated JSON response from API */
+	const INVALID_JSON_RESPONSE = 3;
 }

src/CanvasPestImmutable_Exception.php

Indentation +4 added lines, -4 removed lines

@@ -11,8 +11,8 @@
  **/
 class CanvasPestImmutable_Exception extends CanvasPest_Exception
 {
-    /**
-     * @const IMMUTABLE A request to the API that would change data was attempted
-     **/
-    const IMMUTABLE = 1001;
+	/**
+	 * @const IMMUTABLE A request to the API that would change data was attempted
+	 **/
+	const IMMUTABLE = 1001;
 }

src/CanvasPestImmutable.php

Indentation +63 added lines, -63 removed lines

@@ -18,69 +18,69 @@
  **/
 class CanvasPestImmutable extends CanvasPest
 {
-    /**
-     * {@inheritDoc}
-     *
-     * @deprecated CanvasPestImmutable only supports GET calls to the API
-     *
-     * @param string $path Path to the API endpoint of this call
-     * @param string|string[] $data (Optional) Query parameters for this call
-     * @param string|string[] $headers (Optional) Any additional HTTP headers
-     *                                 for this call
-     * @return void
-     *
-     * @throws CanvasPestImmutable_Exception IMMUTABLE All calls to this method
-     *         will cause an exception
-     **/
-    public function put($path, $data = array(), $headers = array())
-    {
-        throw new CanvasPestImmutable_Exception(
-            'Only GET calls to the API are allowed from CanvasPestImmutable.',
-            CanvasPestImmutable_Exception::IMMUTABLE
-        );
-    }
+	/**
+	 * {@inheritDoc}
+	 *
+	 * @deprecated CanvasPestImmutable only supports GET calls to the API
+	 *
+	 * @param string $path Path to the API endpoint of this call
+	 * @param string|string[] $data (Optional) Query parameters for this call
+	 * @param string|string[] $headers (Optional) Any additional HTTP headers
+	 *                                 for this call
+	 * @return void
+	 *
+	 * @throws CanvasPestImmutable_Exception IMMUTABLE All calls to this method
+	 *         will cause an exception
+	 **/
+	public function put($path, $data = array(), $headers = array())
+	{
+		throw new CanvasPestImmutable_Exception(
+			'Only GET calls to the API are allowed from CanvasPestImmutable.',
+			CanvasPestImmutable_Exception::IMMUTABLE
+		);
+	}
 
-    /**
-     * {@inheritDoc}
-     *
-     * @deprecated CanvasPestImmutable only supports GET calls to the API
-     *
-     * @param string $path Path to the API endpoint of this call
-     * @param string|string[] $data (Optional) Query parameters for this call
-     * @param string|string[] $headers (Optional) Any additional HTTP headers
-     *                                 for this call
-     * @return void
-     *
-     * @throws CanvasPestImmutable_Exception IMMUTABLE All calls to this method
-     *         will cause an exception
-     **/
-    public function post($path, $data = array(), $headers = array())
-    {
-        throw new CanvasPestImmutable_Exception(
-            'Only GET calls to the API are allowed from CanvasPestImmutable.',
-            CanvasPestImmutable_Exception::IMMUTABLE
-        );
-    }
+	/**
+	 * {@inheritDoc}
+	 *
+	 * @deprecated CanvasPestImmutable only supports GET calls to the API
+	 *
+	 * @param string $path Path to the API endpoint of this call
+	 * @param string|string[] $data (Optional) Query parameters for this call
+	 * @param string|string[] $headers (Optional) Any additional HTTP headers
+	 *                                 for this call
+	 * @return void
+	 *
+	 * @throws CanvasPestImmutable_Exception IMMUTABLE All calls to this method
+	 *         will cause an exception
+	 **/
+	public function post($path, $data = array(), $headers = array())
+	{
+		throw new CanvasPestImmutable_Exception(
+			'Only GET calls to the API are allowed from CanvasPestImmutable.',
+			CanvasPestImmutable_Exception::IMMUTABLE
+		);
+	}
 
-    /**
-     * {@inheritDoc}
-     *
-     * @deprecated CanvasPestImmutable only supports GET calls to the API
-     *
-     * @param string $path Path to the API endpoint of this call
-     * @param string|string[] $data (Optional) Query parameters for this call
-     * @param string|string[] $headers (Optional) Any additional HTTP headers
-     *                                 for this call
-     * @return void
-     *
-     * @throws CanvasPestImmutable_Exception IMMUTABLE All calls to this method
-     *         will cause an exception
-     **/
-    public function delete($path, $data = array(), $headers = array())
-    {
-        throw new CanvasPestImmutable_Exception(
-            'Only GET calls to the API are allowed from CanvasPestImmutable.',
-            CanvasPestImmutable_Exception::IMMUTABLE
-        );
-    }
+	/**
+	 * {@inheritDoc}
+	 *
+	 * @deprecated CanvasPestImmutable only supports GET calls to the API
+	 *
+	 * @param string $path Path to the API endpoint of this call
+	 * @param string|string[] $data (Optional) Query parameters for this call
+	 * @param string|string[] $headers (Optional) Any additional HTTP headers
+	 *                                 for this call
+	 * @return void
+	 *
+	 * @throws CanvasPestImmutable_Exception IMMUTABLE All calls to this method
+	 *         will cause an exception
+	 **/
+	public function delete($path, $data = array(), $headers = array())
+	{
+		throw new CanvasPestImmutable_Exception(
+			'Only GET calls to the API are allowed from CanvasPestImmutable.',
+			CanvasPestImmutable_Exception::IMMUTABLE
+		);
+	}
 }

src/CanvasPest.php

Indentation +245 added lines, -245 removed lines

@@ -20,261 +20,261 @@
 class CanvasPest extends \Battis\Educoder\Pest
 {
 
-    /** Name of the parameter controlling the number of responses per page */
-    const PARAM_PER_PAGE = 'per_page';
+	/** Name of the parameter controlling the number of responses per page */
+	const PARAM_PER_PAGE = 'per_page';
 
-    /** @var string[] $headers Additional headers to be passed to the API with each call */
-    protected $headers;
+	/** @var string[] $headers Additional headers to be passed to the API with each call */
+	protected $headers;
 
-    /**
-     * Construct a new CanvasPest
-     *
-     * @api
-     *
-     * @param string $apiInstanceUrl URL of the API instance (e.g.
-     *        `'https://canvas.instructure.com/api/v1'`)
-     * @param string $apiAuthorizationToken (Optional) API access token for the
-     *        API instance (if not provided now, it will need to be provided later)
-     *
-     * @see CanvasPest::setupToken() To configure the API access token later
-     **/
-    public function __construct($apiInstanceUrl, $apiAuthorizationToken = null)
-    {
-        parent::__construct($apiInstanceUrl);
-        if (!empty($apiAuthorizationToken)) {
-            $this->setupToken($apiAuthorizationToken);
-        }
-    }
+	/**
+	 * Construct a new CanvasPest
+	 *
+	 * @api
+	 *
+	 * @param string $apiInstanceUrl URL of the API instance (e.g.
+	 *        `'https://canvas.instructure.com/api/v1'`)
+	 * @param string $apiAuthorizationToken (Optional) API access token for the
+	 *        API instance (if not provided now, it will need to be provided later)
+	 *
+	 * @see CanvasPest::setupToken() To configure the API access token later
+	 **/
+	public function __construct($apiInstanceUrl, $apiAuthorizationToken = null)
+	{
+		parent::__construct($apiInstanceUrl);
+		if (!empty($apiAuthorizationToken)) {
+			$this->setupToken($apiAuthorizationToken);
+		}
+	}
 
-    /**
-     * Set up a new API access token to access this instance
-     *
-     * @param string $token API access token
-     *
-     * @throws CanvasPest_Exception INVALID_TOKEN on an empty or non-string token value
-     **/
-    public function setupToken($token)
-    {
-        if (is_string($token) && !empty($token)) {
-            $this->headers['Authorization'] = "Bearer $token";
-        } elseif ($this->throw_exceptions) {
-            throw new CanvasPest_Exception(
-                'API authorization token must be a non-zero-length string',
-                CanvasPest_Exception::INVALID_TOKEN
-            );
-        }
-    }
+	/**
+	 * Set up a new API access token to access this instance
+	 *
+	 * @param string $token API access token
+	 *
+	 * @throws CanvasPest_Exception INVALID_TOKEN on an empty or non-string token value
+	 **/
+	public function setupToken($token)
+	{
+		if (is_string($token) && !empty($token)) {
+			$this->headers['Authorization'] = "Bearer $token";
+		} elseif ($this->throw_exceptions) {
+			throw new CanvasPest_Exception(
+				'API authorization token must be a non-zero-length string',
+				CanvasPest_Exception::INVALID_TOKEN
+			);
+		}
+	}
 
-    /**
-     * Preprocess API call parameters before use
-     *
-     * Force maximum response page size, if not already defined.
-     *
-     * @param string[] $data Array of parameters for the next API call
-     *
-     * @return string[] Updated array of parameters
-     *
-     * @see CanvasArray::MAXIMUM_PER_PAGE Maximum number of responses per page
-     * @see CanvasPest::PARAM_PER_PAGE Page size parameter
-     **/
-    private function preprocessData($data)
-    {
-        if (is_array($data) && !array_key_exists(self::PARAM_PER_PAGE, $data)) {
-            $data[self::PARAM_PER_PAGE] = CanvasArray::MAXIMUM_PER_PAGE;
-        }
-        return $data;
-    }
+	/**
+	 * Preprocess API call parameters before use
+	 *
+	 * Force maximum response page size, if not already defined.
+	 *
+	 * @param string[] $data Array of parameters for the next API call
+	 *
+	 * @return string[] Updated array of parameters
+	 *
+	 * @see CanvasArray::MAXIMUM_PER_PAGE Maximum number of responses per page
+	 * @see CanvasPest::PARAM_PER_PAGE Page size parameter
+	 **/
+	private function preprocessData($data)
+	{
+		if (is_array($data) && !array_key_exists(self::PARAM_PER_PAGE, $data)) {
+			$data[self::PARAM_PER_PAGE] = CanvasArray::MAXIMUM_PER_PAGE;
+		}
+		return $data;
+	}
 
-    /**
-     * Prepare API request headers
-     *
-     * Flatten headers from an associative array to a numerically indexed array
-     * of `"Name: Value"` style entries like `CURLOPT_HTTPHEADER` expects.
-     * Numerically indexed arrays are not modified.
-     *
-     * Extended by CanvasPest to include the API access token in the
-     * `Authorization` header.
-     *
-     * @param string[] $headers
-     * @return string[]
-     **/
-    protected function prepHeaders($headers)
-    {
-        return parent::prepHeaders(array_merge($this->headers, $headers));
-    }
+	/**
+	 * Prepare API request headers
+	 *
+	 * Flatten headers from an associative array to a numerically indexed array
+	 * of `"Name: Value"` style entries like `CURLOPT_HTTPHEADER` expects.
+	 * Numerically indexed arrays are not modified.
+	 *
+	 * Extended by CanvasPest to include the API access token in the
+	 * `Authorization` header.
+	 *
+	 * @param string[] $headers
+	 * @return string[]
+	 **/
+	protected function prepHeaders($headers)
+	{
+		return parent::prepHeaders(array_merge($this->headers, $headers));
+	}
 
-    /**
-     * Parse the API response into an object (or collection of objects).
-     *
-     * For queries to individually identified endpoints (e.g.
-     * `accounts/1/users/123`), return a CanvasObject representing the API response
-     * describing _that_ individually identified object affected by the query.
-     *
-     * For queries to generic endpoints (e.g. `accounts/1/users`), return a
-     * traversable CanvasArray (of CanvasObjects) representing the API response
-     * describing the list of objects affected by the query.
-     *
-     * @param string $response JSON-encoded response from the API
-     *
-     * @return CanvasObject|CanvasArray
-     **/
-    protected function postprocessResponse($response)
-    {
-        if (substr($response, 0, 1) == '{') {
-            return new CanvasObject($response);
-        } elseif (substr($response, 0, 1) == '[') {
-            return new CanvasArray($response, $this);
-        } else {
-            throw new CanvasPest_Exception(
-                $response,
-                CanvasPest_Exception::INVALID_JSON_RESPONSE
-            );
-        }
-    }
+	/**
+	 * Parse the API response into an object (or collection of objects).
+	 *
+	 * For queries to individually identified endpoints (e.g.
+	 * `accounts/1/users/123`), return a CanvasObject representing the API response
+	 * describing _that_ individually identified object affected by the query.
+	 *
+	 * For queries to generic endpoints (e.g. `accounts/1/users`), return a
+	 * traversable CanvasArray (of CanvasObjects) representing the API response
+	 * describing the list of objects affected by the query.
+	 *
+	 * @param string $response JSON-encoded response from the API
+	 *
+	 * @return CanvasObject|CanvasArray
+	 **/
+	protected function postprocessResponse($response)
+	{
+		if (substr($response, 0, 1) == '{') {
+			return new CanvasObject($response);
+		} elseif (substr($response, 0, 1) == '[') {
+			return new CanvasArray($response, $this);
+		} else {
+			throw new CanvasPest_Exception(
+				$response,
+				CanvasPest_Exception::INVALID_JSON_RESPONSE
+			);
+		}
+	}
 
-    /**
-     * Reformat query parameters for Canvas
-     *
-     * Specifically, Canvas expects no numeric indices for base array parameters.
-     *
-     * @param mixed $data
-     *
-     * @return string
-     **/
-    protected function http_build_query($data)
-    {
-        return preg_replace('/%5B\d+%5D/simU', '[]', http_build_query($data));
-    }
+	/**
+	 * Reformat query parameters for Canvas
+	 *
+	 * Specifically, Canvas expects no numeric indices for base array parameters.
+	 *
+	 * @param mixed $data
+	 *
+	 * @return string
+	 **/
+	protected function http_build_query($data)
+	{
+		return preg_replace('/%5B\d+%5D/simU', '[]', http_build_query($data));
+	}
 
-    /**
-     * Make a GET call to the API
-     *
-     * For queries to individually identified endpoints (e.g.
-     * `accounts/1/users/123`), return a CanvasObject representing the API response
-     * describing _that_ individually identified object affected by the query.
-     *
-     * For queries to generic endpoints (e.g. `accounts/1/users`), return a
-     * traversable CanvasArray (of CanvasObjects) representing the API response
-     * describing the list of objects affected by the query.
-     *
-     * @api
-     *
-     * @param string $path Path to the API endpoint of this call
-     * @param string|string[] $data (Optional) Query parameters for this call
-     * @param string|string[] $headers (Optional) Any additional HTTP headers for this call
-     *
-     * @return CanvasObject|CanvasArray
-     **/
-    public function get($path, $data = array(), $headers = array())
-    {
-        return $this->postprocessResponse(
-            parent::get($path, $this->preprocessData($data), $headers)
-        );
-    }
+	/**
+	 * Make a GET call to the API
+	 *
+	 * For queries to individually identified endpoints (e.g.
+	 * `accounts/1/users/123`), return a CanvasObject representing the API response
+	 * describing _that_ individually identified object affected by the query.
+	 *
+	 * For queries to generic endpoints (e.g. `accounts/1/users`), return a
+	 * traversable CanvasArray (of CanvasObjects) representing the API response
+	 * describing the list of objects affected by the query.
+	 *
+	 * @api
+	 *
+	 * @param string $path Path to the API endpoint of this call
+	 * @param string|string[] $data (Optional) Query parameters for this call
+	 * @param string|string[] $headers (Optional) Any additional HTTP headers for this call
+	 *
+	 * @return CanvasObject|CanvasArray
+	 **/
+	public function get($path, $data = array(), $headers = array())
+	{
+		return $this->postprocessResponse(
+			parent::get($path, $this->preprocessData($data), $headers)
+		);
+	}
 
-    /**
-     * Make a POST call to the API
-     *
-     * For queries to individually identified endpoints (e.g.
-     * `accounts/1/users/123`), return a CanvasObject representing the API response
-     * describing _that_ individually identified object affected by the query.
-     *
-     * For queries to generic endpoints (e.g. `accounts/1/users`), return a
-     * traversable CanvasArray (of CanvasObjects) representing the API response
-     * describing the list of objects affected by the query.
-     *
-     * @api
-     *
-     * @param string $path Path to the API endpoint of this call
-     * @param string|string[] $data (Optional) Query parameters for this call
-     * @param string|string[] $headers (Optional) Any additional HTTP headers for this call
-     *
-     * @return CanvasObject|CanvasArray
-     **/
-    public function post($path, $data = array(), $headers = array())
-    {
-        return $this->postprocessResponse(
-            parent::post($path, $this->preprocessData($data), $headers)
-        );
-    }
+	/**
+	 * Make a POST call to the API
+	 *
+	 * For queries to individually identified endpoints (e.g.
+	 * `accounts/1/users/123`), return a CanvasObject representing the API response
+	 * describing _that_ individually identified object affected by the query.
+	 *
+	 * For queries to generic endpoints (e.g. `accounts/1/users`), return a
+	 * traversable CanvasArray (of CanvasObjects) representing the API response
+	 * describing the list of objects affected by the query.
+	 *
+	 * @api
+	 *
+	 * @param string $path Path to the API endpoint of this call
+	 * @param string|string[] $data (Optional) Query parameters for this call
+	 * @param string|string[] $headers (Optional) Any additional HTTP headers for this call
+	 *
+	 * @return CanvasObject|CanvasArray
+	 **/
+	public function post($path, $data = array(), $headers = array())
+	{
+		return $this->postprocessResponse(
+			parent::post($path, $this->preprocessData($data), $headers)
+		);
+	}
 
-    /**
-     * Make a PUT call to the API
-     *
-     * For queries to individually identified endpoints (e.g.
-     * `accounts/1/users/123`), return a CanvasObject representing the API response
-     * describing _that_ individually identified object affected by the query.
-     *
-     * For queries to generic endpoints (e.g. `accounts/1/users`), return a
-     * traversable CanvasArray (of CanvasObjects) representing the API response
-     * describing the list of objects affected by the query.
-     *
-     * @api
-     *
-     * @param string $path Path to the API endpoint of this call
-     * @param string|string[] $data (Optional) Query parameters for this call
-     * @param string|string[] $headers (Optional) Any additional HTTP headers for this call
-     *
-     * @return CanvasObject|CanvasArray
-     **/
-    public function put($path, $data = array(), $headers = array())
-    {
-        return $this->postprocessResponse(
-            parent::put($path, $this->preprocessData($data), $headers)
-        );
-    }
+	/**
+	 * Make a PUT call to the API
+	 *
+	 * For queries to individually identified endpoints (e.g.
+	 * `accounts/1/users/123`), return a CanvasObject representing the API response
+	 * describing _that_ individually identified object affected by the query.
+	 *
+	 * For queries to generic endpoints (e.g. `accounts/1/users`), return a
+	 * traversable CanvasArray (of CanvasObjects) representing the API response
+	 * describing the list of objects affected by the query.
+	 *
+	 * @api
+	 *
+	 * @param string $path Path to the API endpoint of this call
+	 * @param string|string[] $data (Optional) Query parameters for this call
+	 * @param string|string[] $headers (Optional) Any additional HTTP headers for this call
+	 *
+	 * @return CanvasObject|CanvasArray
+	 **/
+	public function put($path, $data = array(), $headers = array())
+	{
+		return $this->postprocessResponse(
+			parent::put($path, $this->preprocessData($data), $headers)
+		);
+	}
 
-    /**
-     * Make a DELETE call to the API
-     *
-     * For queries to individually identified endpoints (e.g.
-     * `accounts/1/users/123`), return a CanvasObject representing the API response
-     * describing _that_ individually identified object affected by the query.
-     *
-     * For queries to generic endpoints (e.g. `accounts/1/users`), return a
-     * traversable CanvasArray (of CanvasObjects) representing the API response
-     * describing the list of objects affected by the query.
-     *
-     * @api
-     *
-     * @param string $path Path to the API endpoint of this call
-     * @param string|string[] $data (Optional) Query parameters for this call
-     * @param string|string[] $headers (Optional) Any additional HTTP headers for this call
-     *
-     * @return CanvasObject|CanvasArray
-     **/
-    public function delete($path, $data = array(), $headers = array())
-    {
-        if (!empty($data)) {
-            $pos = strpos($path, '?');
-            if ($pos !== false) {
-                $path = substr($path, 0, $pos);
-            }
-            $path .= '?' . $this->http_build_query($data);
-        }
-        return $this->postprocessResponse(
-            parent::delete($path, $headers)
-        );
-    }
+	/**
+	 * Make a DELETE call to the API
+	 *
+	 * For queries to individually identified endpoints (e.g.
+	 * `accounts/1/users/123`), return a CanvasObject representing the API response
+	 * describing _that_ individually identified object affected by the query.
+	 *
+	 * For queries to generic endpoints (e.g. `accounts/1/users`), return a
+	 * traversable CanvasArray (of CanvasObjects) representing the API response
+	 * describing the list of objects affected by the query.
+	 *
+	 * @api
+	 *
+	 * @param string $path Path to the API endpoint of this call
+	 * @param string|string[] $data (Optional) Query parameters for this call
+	 * @param string|string[] $headers (Optional) Any additional HTTP headers for this call
+	 *
+	 * @return CanvasObject|CanvasArray
+	 **/
+	public function delete($path, $data = array(), $headers = array())
+	{
+		if (!empty($data)) {
+			$pos = strpos($path, '?');
+			if ($pos !== false) {
+				$path = substr($path, 0, $pos);
+			}
+			$path .= '?' . $this->http_build_query($data);
+		}
+		return $this->postprocessResponse(
+			parent::delete($path, $headers)
+		);
+	}
 
-    /**
-     * Make a PATCH call to the API
-     *
-     * @deprecated The Canvas API does not currently support PATCH calls
-     *
-     * @param string $path Path to the API endpoint of this call
-     * @param string|string[] $data (Optional) Query parameters for this call
-     * @param string|string[] $headers (Optional) Any additional HTTP headers for this call
-     *
-     * @return void
-     *
-     * @throws CanvasPest_Exception UNSUPPORTED_METHOD All calls to this method will cause an exception
-     **/
-    public function patch($path, $data = array(), $headers = array())
-    {
-        throw new CanvasPest_Exception(
-            'The Canvas API does not support the PATCH method',
-            CanvasPest_Exception::UNSUPPORTED_METHOD
-        );
-    }
+	/**
+	 * Make a PATCH call to the API
+	 *
+	 * @deprecated The Canvas API does not currently support PATCH calls
+	 *
+	 * @param string $path Path to the API endpoint of this call
+	 * @param string|string[] $data (Optional) Query parameters for this call
+	 * @param string|string[] $headers (Optional) Any additional HTTP headers for this call
+	 *
+	 * @return void
+	 *
+	 * @throws CanvasPest_Exception UNSUPPORTED_METHOD All calls to this method will cause an exception
+	 **/
+	public function patch($path, $data = array(), $headers = array())
+	{
+		throw new CanvasPest_Exception(
+			'The Canvas API does not support the PATCH method',
+			CanvasPest_Exception::UNSUPPORTED_METHOD
+		);
+	}
 }

src/CanvasArray.php

Doc Comments +1 added lines, -1 removed lines

@@ -258,7 +258,7 @@
     /**
      * Whether an offset exists
      *
-     * @param int|string $offset
+     * @param integer $offset
      *
      * @return bool
      *

Indentation +429 added lines, -429 removed lines

@@ -12,445 +12,445 @@
  **/
 class CanvasArray implements \Iterator, \ArrayAccess, \Serializable
 {
-    /** The maximum supported number of responses per page */
-    const MAXIMUM_PER_PAGE = 100;
-
-    /** @var CanvasPest $api Canvas API (for paging through the array) */
-    protected $api;
-
-    /**
-     * @var string $endpoint API endpoint whose response is represented by this
-     *      object
-     **/
-    private $endpoint = null;
-
-    /**
-     * @var CanvasPageLink[] $pagination The canonical (first, last, next,
-     *      prev, current) pages relative to the current page of responses
-     **/
-    private $pagination = [];
-
-    /**
-     * @var array Cached pagination per each page response
-     */
-    private $paginationPerPage = [];
-
-    /** @var CanvasObject[] $data Backing store */
-    private $data = [];
-
-    /** @var int $page Page number corresponding to current $key */
-    private $page = null;
-
-    /** @var int $key Current key-value of iterator */
-    private $key = null;
-
-    /**
-     * Construct a CanvasArray
-     *
-     * @param string $jsonResponse A JSON-encoded response array from the
-     *                             Canvas API
-     * @param CanvasPest $canvasPest An API object for making pagination calls
-     **/
-    public function __construct($jsonResponse, $canvasPest)
-    {
-        $this->api = $canvasPest;
-
-        $this->pagination = $this->parsePageLinks();
-
-        /* locate ourselves */
-        if (isset($this->pagination[CanvasPageLink::CURRENT])) {
-            $this->page = $this->pagination[CanvasPageLink::CURRENT]->getPageNumber();
-        } else {
-            $this->page = 1; // assume only one page (since no pagination)
-        }
-        $this->key = $this->pageNumberToKey($this->page);
-        $this->paginationPerPage[$this->page] = $this->pagination;
-
-        /* parse the JSON response string */
-        $key = $this->key;
-        foreach (json_decode($jsonResponse, true) as $item) {
-            $this->data[$key++] = new CanvasObject($item, $this->api);
-        }
-    }
-
-    /**
-     * Parse the API response link headers into pagination information
-     *
-     * @param  boolean|string[] $headers (Optional, defaults to `$this->api->lastHeader('link')`)
-     * @return CanvasPageLink[]
-     */
-    protected function parsePageLinks($headers = false)
-    {
-        $pagination = [];
-        if (!$headers) {
-            $headers = $this->api->lastHeader('link');
-        }
-
-        /* parse Canvas page links */
-        if (preg_match_all('%<([^>]*)>\s*;\s*rel="([^"]+)"%', $headers, $links, PREG_SET_ORDER)) {
-            foreach ($links as $link) {
-                $pagination[$link[2]] = new CanvasPageLink($link[1], $link[2]);
-            }
-        }
-
-        return $pagination;
-    }
-    /**
-     * Convert a page number to an array key
-     *
-     * @param int $pageNumber 1-indexed page number
-     *
-     * @return int
-     *
-     * @throws CanvasArray_Exception INVALID_PAGE_NUMBER If $pageNumber < 1
-     **/
-    protected function pageNumberToKey($pageNumber)
-    {
-        if ($pageNumber < 1) {
-            throw new CanvasArray_Exception(
-                "{$pageNumber} is not a valid page number",
-                CanvasArray_Exception::INVALID_PAGE_NUMBER
-            );
-        }
-        if (isset($this->pagination[CanvasPageLink::CURRENT])) {
-            return ($pageNumber - 1) * $this->pagination[CanvasPageLink::CURRENT]->getPerPage();
-        } else {
-            return 0; // assume only one page (since no pagination);
-        }
-    }
-
-    /**
-     * Convert an array key to a page number
-     *
-     * @param int $key Non-negative array key
-     *
-     * @return int
-     *
-     * @throws CanvasArray_Exception INVALID_ARRAY_KEY If $key < 0
-     **/
-    protected function keyToPageNumber($key)
-    {
-        if ($key < 0) {
-            throw new CanvasArray_Exception(
-                "$key is not a valid array key",
-                CanvasArray_Exception::INVALID_ARRAY_KEY
-            );
-        }
-
-        if (isset($this->pagination[CanvasPageLink::CURRENT])) {
-            return ((int) ($key / $this->pagination[CanvasPageLink::CURRENT]->getPerPage())) + 1;
-        } else {
-            return 1; // assume single page if no pagination
-        }
-    }
-
-    /**
-     * Request a page of responses from the API
-     *
-     * A page of responses will be requested if it appears that that page has
-     * not yet been loaded (tested by checking if the initial element of the
-     * page has been initialized in the $data array).
-     *
-     * @param int $pageNumber Page number to request
-     * @param bool $forceRefresh (Optional) Force a refresh of backing data,
-     *                           even if cached (defaults to `FALSE`)
-     *
-     * @return bool `TRUE` if the page is requested, `FALSE` if it is already
-     *                     cached (and therefore not requested)
-     **/
-    protected function requestPageNumber($pageNumber, $forceRefresh = false)
-    {
-        if (!isset($this->data[$this->pageNumberToKey($pageNumber)]) || ($forceRefresh && isset($this->api))) {
-            // assume one page if no pagination (and already loaded)
-            if (isset($this->pagination[CanvasPageLink::CURRENT])) {
-                $params = $this->pagination[CanvasPageLink::CURRENT]->getParams();
-                $params[CanvasPageLink::PARAM_PAGE_NUMBER] = $pageNumber;
-                $page = $this->api->get($this->pagination[CanvasPageLink::CURRENT]->getEndpoint(), $params);
-                $this->data = array_replace($this->data, $page->data);
-                $pagination = $this->parsePageLinks();
-                $this->paginationPerPage[$pagination[CanvasPageLink::CURRENT]->getPageNumber()] = $pagination;
-                return true;
-            }
-        }
-        return false;
-    }
-
-    /**
-     * Request all pages from API
-     *
-     * This stores the entire API response locally, in preparation for, most
-     * likely, serializing this object.
-     *
-     * @param bool $forceRefresh (Optional) Force a refresh of backing data,
-     *                           even if cached (defaults to `FALSE`)
-     *
-     * @return void
-     */
-    protected function requestAllPages($forceRefresh = false)
-    {
-        $_page = $this->page;
-        $_key = $this->key;
-
-        /* first fall-back: just keep going from where we are */
-        $nextPageNumber = false;
-        if (isset($this->pagination[CanvasPageLink::NEXT])) {
-            $nextPageNumber = $this->pagination[CanvasPageLink::NEXT]->getPageNumber();
-        }
-
-        /* best case: start at the beginning and request every page */
-        if (isset($this->pagination[CanvasPageLink::FIRST])) {
-            $first = $this->pagination[CanvasPageLink::FIRST]->getPageNumber();
-            $this->requestPageNumber($first, $forceRefresh);
-            if (isset($this->paginationPerPage[$first][CanvasPageLink::NEXT])) {
-                $nextPageNumber = $this->paginationPerPage[$first][CanvasPageLink::NEXT]->getPageNumber();
-            }
-        }
-
-        /* welp, here goes... let's hope we have a next page! */
-        while ($nextPageNumber !== false) {
-            $this->requestPageNumber($nextPageNumber, true);
-            if (isset($this->paginationPerPage[$nextPageNumber][CanvasPageLink::NEXT])) {
-                $nextPageNumber = $this->paginationPerPage[$nextPageNumber][CanvasPageLink::NEXT]->getPageNumber();
-            } else {
-                $nextPageNumber = false;
-            }
-        }
-
-        $this->page = $_page;
-        $this->key = $_key;
-    }
-
-    /***************************************************************************
+	/** The maximum supported number of responses per page */
+	const MAXIMUM_PER_PAGE = 100;
+
+	/** @var CanvasPest $api Canvas API (for paging through the array) */
+	protected $api;
+
+	/**
+	 * @var string $endpoint API endpoint whose response is represented by this
+	 *      object
+	 **/
+	private $endpoint = null;
+
+	/**
+	 * @var CanvasPageLink[] $pagination The canonical (first, last, next,
+	 *      prev, current) pages relative to the current page of responses
+	 **/
+	private $pagination = [];
+
+	/**
+	 * @var array Cached pagination per each page response
+	 */
+	private $paginationPerPage = [];
+
+	/** @var CanvasObject[] $data Backing store */
+	private $data = [];
+
+	/** @var int $page Page number corresponding to current $key */
+	private $page = null;
+
+	/** @var int $key Current key-value of iterator */
+	private $key = null;
+
+	/**
+	 * Construct a CanvasArray
+	 *
+	 * @param string $jsonResponse A JSON-encoded response array from the
+	 *                             Canvas API
+	 * @param CanvasPest $canvasPest An API object for making pagination calls
+	 **/
+	public function __construct($jsonResponse, $canvasPest)
+	{
+		$this->api = $canvasPest;
+
+		$this->pagination = $this->parsePageLinks();
+
+		/* locate ourselves */
+		if (isset($this->pagination[CanvasPageLink::CURRENT])) {
+			$this->page = $this->pagination[CanvasPageLink::CURRENT]->getPageNumber();
+		} else {
+			$this->page = 1; // assume only one page (since no pagination)
+		}
+		$this->key = $this->pageNumberToKey($this->page);
+		$this->paginationPerPage[$this->page] = $this->pagination;
+
+		/* parse the JSON response string */
+		$key = $this->key;
+		foreach (json_decode($jsonResponse, true) as $item) {
+			$this->data[$key++] = new CanvasObject($item, $this->api);
+		}
+	}
+
+	/**
+	 * Parse the API response link headers into pagination information
+	 *
+	 * @param  boolean|string[] $headers (Optional, defaults to `$this->api->lastHeader('link')`)
+	 * @return CanvasPageLink[]
+	 */
+	protected function parsePageLinks($headers = false)
+	{
+		$pagination = [];
+		if (!$headers) {
+			$headers = $this->api->lastHeader('link');
+		}
+
+		/* parse Canvas page links */
+		if (preg_match_all('%<([^>]*)>\s*;\s*rel="([^"]+)"%', $headers, $links, PREG_SET_ORDER)) {
+			foreach ($links as $link) {
+				$pagination[$link[2]] = new CanvasPageLink($link[1], $link[2]);
+			}
+		}
+
+		return $pagination;
+	}
+	/**
+	 * Convert a page number to an array key
+	 *
+	 * @param int $pageNumber 1-indexed page number
+	 *
+	 * @return int
+	 *
+	 * @throws CanvasArray_Exception INVALID_PAGE_NUMBER If $pageNumber < 1
+	 **/
+	protected function pageNumberToKey($pageNumber)
+	{
+		if ($pageNumber < 1) {
+			throw new CanvasArray_Exception(
+				"{$pageNumber} is not a valid page number",
+				CanvasArray_Exception::INVALID_PAGE_NUMBER
+			);
+		}
+		if (isset($this->pagination[CanvasPageLink::CURRENT])) {
+			return ($pageNumber - 1) * $this->pagination[CanvasPageLink::CURRENT]->getPerPage();
+		} else {
+			return 0; // assume only one page (since no pagination);
+		}
+	}
+
+	/**
+	 * Convert an array key to a page number
+	 *
+	 * @param int $key Non-negative array key
+	 *
+	 * @return int
+	 *
+	 * @throws CanvasArray_Exception INVALID_ARRAY_KEY If $key < 0
+	 **/
+	protected function keyToPageNumber($key)
+	{
+		if ($key < 0) {
+			throw new CanvasArray_Exception(
+				"$key is not a valid array key",
+				CanvasArray_Exception::INVALID_ARRAY_KEY
+			);
+		}
+
+		if (isset($this->pagination[CanvasPageLink::CURRENT])) {
+			return ((int) ($key / $this->pagination[CanvasPageLink::CURRENT]->getPerPage())) + 1;
+		} else {
+			return 1; // assume single page if no pagination
+		}
+	}
+
+	/**
+	 * Request a page of responses from the API
+	 *
+	 * A page of responses will be requested if it appears that that page has
+	 * not yet been loaded (tested by checking if the initial element of the
+	 * page has been initialized in the $data array).
+	 *
+	 * @param int $pageNumber Page number to request
+	 * @param bool $forceRefresh (Optional) Force a refresh of backing data,
+	 *                           even if cached (defaults to `FALSE`)
+	 *
+	 * @return bool `TRUE` if the page is requested, `FALSE` if it is already
+	 *                     cached (and therefore not requested)
+	 **/
+	protected function requestPageNumber($pageNumber, $forceRefresh = false)
+	{
+		if (!isset($this->data[$this->pageNumberToKey($pageNumber)]) || ($forceRefresh && isset($this->api))) {
+			// assume one page if no pagination (and already loaded)
+			if (isset($this->pagination[CanvasPageLink::CURRENT])) {
+				$params = $this->pagination[CanvasPageLink::CURRENT]->getParams();
+				$params[CanvasPageLink::PARAM_PAGE_NUMBER] = $pageNumber;
+				$page = $this->api->get($this->pagination[CanvasPageLink::CURRENT]->getEndpoint(), $params);
+				$this->data = array_replace($this->data, $page->data);
+				$pagination = $this->parsePageLinks();
+				$this->paginationPerPage[$pagination[CanvasPageLink::CURRENT]->getPageNumber()] = $pagination;
+				return true;
+			}
+		}
+		return false;
+	}
+
+	/**
+	 * Request all pages from API
+	 *
+	 * This stores the entire API response locally, in preparation for, most
+	 * likely, serializing this object.
+	 *
+	 * @param bool $forceRefresh (Optional) Force a refresh of backing data,
+	 *                           even if cached (defaults to `FALSE`)
+	 *
+	 * @return void
+	 */
+	protected function requestAllPages($forceRefresh = false)
+	{
+		$_page = $this->page;
+		$_key = $this->key;
+
+		/* first fall-back: just keep going from where we are */
+		$nextPageNumber = false;
+		if (isset($this->pagination[CanvasPageLink::NEXT])) {
+			$nextPageNumber = $this->pagination[CanvasPageLink::NEXT]->getPageNumber();
+		}
+
+		/* best case: start at the beginning and request every page */
+		if (isset($this->pagination[CanvasPageLink::FIRST])) {
+			$first = $this->pagination[CanvasPageLink::FIRST]->getPageNumber();
+			$this->requestPageNumber($first, $forceRefresh);
+			if (isset($this->paginationPerPage[$first][CanvasPageLink::NEXT])) {
+				$nextPageNumber = $this->paginationPerPage[$first][CanvasPageLink::NEXT]->getPageNumber();
+			}
+		}
+
+		/* welp, here goes... let's hope we have a next page! */
+		while ($nextPageNumber !== false) {
+			$this->requestPageNumber($nextPageNumber, true);
+			if (isset($this->paginationPerPage[$nextPageNumber][CanvasPageLink::NEXT])) {
+				$nextPageNumber = $this->paginationPerPage[$nextPageNumber][CanvasPageLink::NEXT]->getPageNumber();
+			} else {
+				$nextPageNumber = false;
+			}
+		}
+
+		$this->page = $_page;
+		$this->key = $_key;
+	}
+
+	/***************************************************************************
      * ArrayObject methods
      */
 
-    /**
-     * Get the number of CanvasObjects in the Canvas response
-     *
-     * @return int
-     *
-     * @see http://php.net/manual/en/arrayobject.count.php ArrayObject::count
-     **/
-    public function count()
-    {
-        $this->requestAllPages();
-        return count($this->data);
-    }
-
-    /**
-     * Creates a copy of the CanvasArray
-     *
-     * @return CanvasObject[]
-     *
-     * @see http://php.net/manual/en/arrayobject.getarraycopy.php
-     *      ArrayObject::getArrayCopy
-     **/
-    public function getArrayCopy()
-    {
-        $this->requestAllPages();
-        return $this->data;
-    }
-
-    /***************************************************************************
+	/**
+	 * Get the number of CanvasObjects in the Canvas response
+	 *
+	 * @return int
+	 *
+	 * @see http://php.net/manual/en/arrayobject.count.php ArrayObject::count
+	 **/
+	public function count()
+	{
+		$this->requestAllPages();
+		return count($this->data);
+	}
+
+	/**
+	 * Creates a copy of the CanvasArray
+	 *
+	 * @return CanvasObject[]
+	 *
+	 * @see http://php.net/manual/en/arrayobject.getarraycopy.php
+	 *      ArrayObject::getArrayCopy
+	 **/
+	public function getArrayCopy()
+	{
+		$this->requestAllPages();
+		return $this->data;
+	}
+
+	/***************************************************************************
      * ArrayAccess methods
      */
 
-    /**
-     * Whether an offset exists
-     *
-     * @param int|string $offset
-     *
-     * @return bool
-     *
-     * @see http://php.net/manual/en/arrayaccess.offsetexists.php
-     *      ArrayAccess::offsetExists
-     **/
-    public function offsetExists($offset)
-    {
-        if (!isset($this->data[$offset])) {
-            $this->requestAllPages();
-        }
-        return isset($this->data[$offset]);
-    }
-
-    /**
-     * Offset to retrieve
-     *
-     * @param int|string $offset
-     *
-     * @return CanvasObject|null
-     *
-     * @see http://php.net/manual/en/arrayaccess.offsetexists.php
-     *      ArrayAccess::offsetGet
-     **/
-    public function offsetGet($offset)
-    {
-        return $this->data[$offset];
-    }
-
-    /**
-     * Assign a value to the specified offset
-     *
-     * @deprecated CanvasObject and CanvasArray responses are immutable
-     *
-     * @param int|string $offset
-     * @param CanvasObject $value
-     *
-     * @return void
-     *
-     * @throws CanvasArray_Exception IMMUTABLE All calls to this method will cause an exception
-     *
-     * @see http://php.net/manual/en/arrayaccess.offsetset.php
-     *      ArrayAccess::offsetSet
-     **/
-    public function offsetSet($offset, $value)
-    {
-        throw new CanvasArray_Exception(
-            'Canvas responses are immutable',
-            CanvasArray_Exception::IMMUTABLE
-        );
-    }
-
-    /**
-     * Unset an offset
-     *
-     * @deprecated CanvasObject and CanvasArray responses are immutable
-     *
-     * @param int|string $offset
-     *
-     * @return void
-     *
-     * @throws CanvasArray_Exception IMMUTABLE All calls to this method will
-     *         cause an exception
-     *
-     * @see http://php.net/manual/en/arrayaccess.offsetunset.php
-     *      ArrayAccess::offsetUnset
-     **/
-    public function offsetUnset($offset)
-    {
-        throw new CanvasArray_Exception(
-            'Canvas responses are immutable',
-            CanvasArray_Exception::IMMUTABLE
-        );
-    }
-
-    /**************************************************************************/
-
-    /**************************************************************************
+	/**
+	 * Whether an offset exists
+	 *
+	 * @param int|string $offset
+	 *
+	 * @return bool
+	 *
+	 * @see http://php.net/manual/en/arrayaccess.offsetexists.php
+	 *      ArrayAccess::offsetExists
+	 **/
+	public function offsetExists($offset)
+	{
+		if (!isset($this->data[$offset])) {
+			$this->requestAllPages();
+		}
+		return isset($this->data[$offset]);
+	}
+
+	/**
+	 * Offset to retrieve
+	 *
+	 * @param int|string $offset
+	 *
+	 * @return CanvasObject|null
+	 *
+	 * @see http://php.net/manual/en/arrayaccess.offsetexists.php
+	 *      ArrayAccess::offsetGet
+	 **/
+	public function offsetGet($offset)
+	{
+		return $this->data[$offset];
+	}
+
+	/**
+	 * Assign a value to the specified offset
+	 *
+	 * @deprecated CanvasObject and CanvasArray responses are immutable
+	 *
+	 * @param int|string $offset
+	 * @param CanvasObject $value
+	 *
+	 * @return void
+	 *
+	 * @throws CanvasArray_Exception IMMUTABLE All calls to this method will cause an exception
+	 *
+	 * @see http://php.net/manual/en/arrayaccess.offsetset.php
+	 *      ArrayAccess::offsetSet
+	 **/
+	public function offsetSet($offset, $value)
+	{
+		throw new CanvasArray_Exception(
+			'Canvas responses are immutable',
+			CanvasArray_Exception::IMMUTABLE
+		);
+	}
+
+	/**
+	 * Unset an offset
+	 *
+	 * @deprecated CanvasObject and CanvasArray responses are immutable
+	 *
+	 * @param int|string $offset
+	 *
+	 * @return void
+	 *
+	 * @throws CanvasArray_Exception IMMUTABLE All calls to this method will
+	 *         cause an exception
+	 *
+	 * @see http://php.net/manual/en/arrayaccess.offsetunset.php
+	 *      ArrayAccess::offsetUnset
+	 **/
+	public function offsetUnset($offset)
+	{
+		throw new CanvasArray_Exception(
+			'Canvas responses are immutable',
+			CanvasArray_Exception::IMMUTABLE
+		);
+	}
+
+	/**************************************************************************/
+
+	/**************************************************************************
      * Iterator methods
      */
 
-    /**
-     * Return the current element
-     *
-     * @return CanvasObject
-     *
-     * @see http://php.net/manual/en/iterator.current.php Iterator::current
-     **/
-    public function current()
-    {
-        if (!isset($this->data[$this->key])) {
-            $this->requestPageNumber($this->keyToPageNumber($this->key));
-        }
-        return $this->data[$this->key];
-    }
-
-    /**
-     * Return the key of the current element
-     *
-     * @return int
-     *
-     * @see http://php.net/manual/en/iterator.key.php Iterator::key
-     **/
-    public function key()
-    {
-        return $this->key;
-    }
-
-    /**
-     * Move forward to next element
-     *
-     * @return void
-     *
-     * @see http://php.net/manual/en/iterator.next.php Iterator::next
-     **/
-    public function next()
-    {
-        $this->key++;
-    }
-
-    /**
-     * Rewind the iterator to the first element
-     *
-     * @return void
-     *
-     * @see http://php.net/manual/en/iterator.rewind.php Iterator::rewind
-     **/
-    public function rewind()
-    {
-        $this->key = 0;
-    }
-
-    /**
-     * Checks if current position is valid
-     *
-     * @return bool
-     *
-     * @see http://php.net/manual/en/iterator.valid.php Iterator::valid
-     **/
-    public function valid()
-    {
-        return ($this->offsetExists($this->key));
-    }
-
-    /**************************************************************************/
-
-    /***************************************************************************
+	/**
+	 * Return the current element
+	 *
+	 * @return CanvasObject
+	 *
+	 * @see http://php.net/manual/en/iterator.current.php Iterator::current
+	 **/
+	public function current()
+	{
+		if (!isset($this->data[$this->key])) {
+			$this->requestPageNumber($this->keyToPageNumber($this->key));
+		}
+		return $this->data[$this->key];
+	}
+
+	/**
+	 * Return the key of the current element
+	 *
+	 * @return int
+	 *
+	 * @see http://php.net/manual/en/iterator.key.php Iterator::key
+	 **/
+	public function key()
+	{
+		return $this->key;
+	}
+
+	/**
+	 * Move forward to next element
+	 *
+	 * @return void
+	 *
+	 * @see http://php.net/manual/en/iterator.next.php Iterator::next
+	 **/
+	public function next()
+	{
+		$this->key++;
+	}
+
+	/**
+	 * Rewind the iterator to the first element
+	 *
+	 * @return void
+	 *
+	 * @see http://php.net/manual/en/iterator.rewind.php Iterator::rewind
+	 **/
+	public function rewind()
+	{
+		$this->key = 0;
+	}
+
+	/**
+	 * Checks if current position is valid
+	 *
+	 * @return bool
+	 *
+	 * @see http://php.net/manual/en/iterator.valid.php Iterator::valid
+	 **/
+	public function valid()
+	{
+		return ($this->offsetExists($this->key));
+	}
+
+	/**************************************************************************/
+
+	/***************************************************************************
      * Serializable methods
      */
 
-    /**
-     * String representation of CanvasArray
-     *
-     * @return string
-     *
-     * @see http://php.net/manual/en/serializable.serialize.php
-     *      Serializable::serialize()
-     **/
-    public function serialize()
-    {
-        $this->requestAllPages();
-        return serialize(
-            array(
-                'page' => $this->page,
-                'key' => $this->key,
-                'data' => $this->data
-            )
-        );
-    }
-
-    /**
-     * Construct a CanvasArray from its string representation
-     *
-     * The data in the unserialized CanvasArray is static and cannot be
-     * refreshed, as the CanvasPest API connection is _not_ serialized to
-     * preserve the security of API access tokens.
-     *
-     * @param string $data
-     *
-     * @return string
-     *
-     * @see http://php.net/manual/en/serializable.unserialize.php
-     *      Serializable::unserialize()
-     **/
-    public function unserialize($data)
-    {
-        $_data = unserialize($data);
-        $this->page = $_data['page'];
-        $this->key = $_data['key'];
-        $this->data = $_data['data'];
-        $this->api = null;
-        $this->endpoint = null;
-        $this->pagination = array();
-    }
+	/**
+	 * String representation of CanvasArray
+	 *
+	 * @return string
+	 *
+	 * @see http://php.net/manual/en/serializable.serialize.php
+	 *      Serializable::serialize()
+	 **/
+	public function serialize()
+	{
+		$this->requestAllPages();
+		return serialize(
+			array(
+				'page' => $this->page,
+				'key' => $this->key,
+				'data' => $this->data
+			)
+		);
+	}
+
+	/**
+	 * Construct a CanvasArray from its string representation
+	 *
+	 * The data in the unserialized CanvasArray is static and cannot be
+	 * refreshed, as the CanvasPest API connection is _not_ serialized to
+	 * preserve the security of API access tokens.
+	 *
+	 * @param string $data
+	 *
+	 * @return string
+	 *
+	 * @see http://php.net/manual/en/serializable.unserialize.php
+	 *      Serializable::unserialize()
+	 **/
+	public function unserialize($data)
+	{
+		$_data = unserialize($data);
+		$this->page = $_data['page'];
+		$this->key = $_data['key'];
+		$this->data = $_data['data'];
+		$this->api = null;
+		$this->endpoint = null;
+		$this->pagination = array();
+	}
 }