smtech / canvaspest

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();
+	}
 }

src/CanvasPageLink.php

Indentation +177 added lines, -177 removed lines

@@ -16,181 +16,181 @@
  **/
 class CanvasPageLink
 {
-    /** Name of the current page link */
-    const CURRENT = 'current';
-
-    /** Name of the first page link */
-    const FIRST = 'first';
-
-    /** Name of the last page link */
-    const LAST = 'last';
-
-    /** Name of the next page link */
-    const NEXT = 'next';
-
-    /** Name of the previous page link */
-    const PREV = 'prev';
-
-
-    /** @var string $name Name of the page link */
-    private $name;
-
-    /** @var string $endpoint Path of the API endpoint being paginated */
-    private $endpoint;
-
-    /** @var array $params Query parameters for the page link API call */
-    private $params;
-
-    /** Name of the page number parameter in the page link */
-    const PARAM_PAGE_NUMBER = 'page';
-
-    /** Name of the parameter describing the number of responses per page in the page link */
-    const PARAM_PER_PAGE = 'per_page';
-
-    /**
-     * Construct a new Canvas page link object.
-     *
-     * CanvasPageLinks can be constructed with two possible parameter lists:
-     *
-     * 1. `__construct(string $pageUrl, string $pageName)` which expects a
-     * non-empty string representing the URL of the API endpoint to retrieve the
-     * page and a non-empty string representing the canonical name of the page
-     * relative to the current page.
-     * 2. `__construct(int $pageNumber, CanvasPageLink $modelCanvasPageLink, string $pageName)`
-     * which expects a page number greater than zero, any CanvasPageLink object
-     * relative to the current page (to be used as a model) and a non-empty string
-     * representing the canonical name of the page relative to the current page.
-     *
-     * @throws CanvasPageLink_Exception INVALID_CONSTRUCTOR If $pageUrl or
-     *         $pageName is empty or a non-string
-     * @throws CanvasPageLink_Exception INVALID_CONSTRUCTOR If $pageNumber is
-     *         not a number greater than zero, $modelCanvasPageLink is not an
-     *         instance of CanvasPageLink or $pageName is empty or a non-string
-     */
-    public function __construct()
-    {
-        switch (func_num_args()) {
-            case 2: /* __construct($pageUrl, $pageName) */
-                $pageUrl = func_get_arg(0);
-                $this->name = func_get_arg(1);
-                if (is_string($pageUrl) && !empty($pageUrl) && is_string($this->name) && !empty($this->name)) {
-                    $this->endpoint = preg_replace('%.*/api/v1(/.*)$%', '$1', parse_url($pageUrl, PHP_URL_PATH));
-                    parse_str(parse_url($pageUrl, PHP_URL_QUERY), $this->params);
-                } else {
-                    throw new CanvasPageLink_Exception(
-                        'Expected two non-empty strings for page URL and name',
-                        CanvasPageLink_Exception::INVALID_CONSTRUCTOR
-                    );
-                }
-                break;
-
-            case 3: /* __construct($pageNumber, $modelCanvasPageLink, $pageName) */
-                $pageNumber = func_get_arg(0);
-                $model = func_get_arg(1);
-                $this->name = func_get_arg(2);
-                if (is_int($pageNumber) &&
-                    $pageNumber > 0 &&
-                    $model instanceof CanvasPageLink &&
-                    is_string($this->name) &&
-                    !empty($this->name)
-                ) {
-                    $this->endpoint = $model->endpoint;
-                    $this->params = $model->params;
-                    switch ($this->name) {
-                        case self::PREV:
-                            $this->params[self::PARAM_PAGE_NUMBER] = $pageNumber - 1;
-                            break;
-
-                        case self::NEXT:
-                            $this->params[self::PARAM_PAGE_NUMBER] = $pageNumber + 1;
-                            break;
-
-                        case self::FIRST:
-                            $this->params[self::PARAM_PAGE_NUMBER] = 1;
-                            break;
-
-                        case self::LAST:
-                        default:
-                            throw new CanvasPageLink_Exception(
-                                "'{$this->name}' cannot be converted to a page number",
-                                CanvasPageLink_Exception::INVALID_CONSTRUCTOR
-                            );
-                    }
-                } else {
-                    throw new CanvasPageLink_Exception(
-                        'Expected a page number, a model CanvasPageLink object and a non-empty string page name',
-                        CanvasPageLink_Exception::INVALID_CONSTRUCTOR
-                    );
-                }
-                break;
-        }
-    }
-
-    /**
-     * Canonical name of this page link
-     *
-     * @return string
-     **/
-    public function getName()
-    {
-        return $this->name;
-    }
-
-    /**
-     * API endpoint being paginated
-     *
-     * @return string
-     **/
-    public function getEndpoint()
-    {
-        return $this->endpoint;
-    }
-
-    /**
-     * Query parameters to retrieve the linked page
-     *
-     * @return array
-     **/
-    public function getParams()
-    {
-        return $this->params;
-    }
-
-    /**
-     * The (1-indexed) page number of this page
-     *
-     * @return int
-     **/
-    public function getPageNumber()
-    {
-        return $this->params[self::PARAM_PAGE_NUMBER];
-    }
-
-    /**
-     * The number of responses per page generating this pagination
-     *
-     * @return int
-     **/
-    public function getPerPage()
-    {
-        return $this->params[self::PARAM_PER_PAGE];
-    }
-
-    /**
-     * An array representation of the CanvasArray
-     *
-     * @return array
-     **/
-    public function getArrayCopy()
-    {
-        $arr = array();
-        $_key = $this->key;
-        $_page = $this->page;
-        foreach ($this as $obj) {
-            $arr[] = $obj->getArrayCopy();
-        }
-        $this->page = $_page;
-        $this->key = $_key;
-        return $arr;
-    }
+	/** Name of the current page link */
+	const CURRENT = 'current';
+
+	/** Name of the first page link */
+	const FIRST = 'first';
+
+	/** Name of the last page link */
+	const LAST = 'last';
+
+	/** Name of the next page link */
+	const NEXT = 'next';
+
+	/** Name of the previous page link */
+	const PREV = 'prev';
+
+
+	/** @var string $name Name of the page link */
+	private $name;
+
+	/** @var string $endpoint Path of the API endpoint being paginated */
+	private $endpoint;
+
+	/** @var array $params Query parameters for the page link API call */
+	private $params;
+
+	/** Name of the page number parameter in the page link */
+	const PARAM_PAGE_NUMBER = 'page';
+
+	/** Name of the parameter describing the number of responses per page in the page link */
+	const PARAM_PER_PAGE = 'per_page';
+
+	/**
+	 * Construct a new Canvas page link object.
+	 *
+	 * CanvasPageLinks can be constructed with two possible parameter lists:
+	 *
+	 * 1. `__construct(string $pageUrl, string $pageName)` which expects a
+	 * non-empty string representing the URL of the API endpoint to retrieve the
+	 * page and a non-empty string representing the canonical name of the page
+	 * relative to the current page.
+	 * 2. `__construct(int $pageNumber, CanvasPageLink $modelCanvasPageLink, string $pageName)`
+	 * which expects a page number greater than zero, any CanvasPageLink object
+	 * relative to the current page (to be used as a model) and a non-empty string
+	 * representing the canonical name of the page relative to the current page.
+	 *
+	 * @throws CanvasPageLink_Exception INVALID_CONSTRUCTOR If $pageUrl or
+	 *         $pageName is empty or a non-string
+	 * @throws CanvasPageLink_Exception INVALID_CONSTRUCTOR If $pageNumber is
+	 *         not a number greater than zero, $modelCanvasPageLink is not an
+	 *         instance of CanvasPageLink or $pageName is empty or a non-string
+	 */
+	public function __construct()
+	{
+		switch (func_num_args()) {
+			case 2: /* __construct($pageUrl, $pageName) */
+				$pageUrl = func_get_arg(0);
+				$this->name = func_get_arg(1);
+				if (is_string($pageUrl) && !empty($pageUrl) && is_string($this->name) && !empty($this->name)) {
+					$this->endpoint = preg_replace('%.*/api/v1(/.*)$%', '$1', parse_url($pageUrl, PHP_URL_PATH));
+					parse_str(parse_url($pageUrl, PHP_URL_QUERY), $this->params);
+				} else {
+					throw new CanvasPageLink_Exception(
+						'Expected two non-empty strings for page URL and name',
+						CanvasPageLink_Exception::INVALID_CONSTRUCTOR
+					);
+				}
+				break;
+
+			case 3: /* __construct($pageNumber, $modelCanvasPageLink, $pageName) */
+				$pageNumber = func_get_arg(0);
+				$model = func_get_arg(1);
+				$this->name = func_get_arg(2);
+				if (is_int($pageNumber) &&
+					$pageNumber > 0 &&
+					$model instanceof CanvasPageLink &&
+					is_string($this->name) &&
+					!empty($this->name)
+				) {
+					$this->endpoint = $model->endpoint;
+					$this->params = $model->params;
+					switch ($this->name) {
+						case self::PREV:
+							$this->params[self::PARAM_PAGE_NUMBER] = $pageNumber - 1;
+							break;
+
+						case self::NEXT:
+							$this->params[self::PARAM_PAGE_NUMBER] = $pageNumber + 1;
+							break;
+
+						case self::FIRST:
+							$this->params[self::PARAM_PAGE_NUMBER] = 1;
+							break;
+
+						case self::LAST:
+						default:
+							throw new CanvasPageLink_Exception(
+								"'{$this->name}' cannot be converted to a page number",
+								CanvasPageLink_Exception::INVALID_CONSTRUCTOR
+							);
+					}
+				} else {
+					throw new CanvasPageLink_Exception(
+						'Expected a page number, a model CanvasPageLink object and a non-empty string page name',
+						CanvasPageLink_Exception::INVALID_CONSTRUCTOR
+					);
+				}
+				break;
+		}
+	}
+
+	/**
+	 * Canonical name of this page link
+	 *
+	 * @return string
+	 **/
+	public function getName()
+	{
+		return $this->name;
+	}
+
+	/**
+	 * API endpoint being paginated
+	 *
+	 * @return string
+	 **/
+	public function getEndpoint()
+	{
+		return $this->endpoint;
+	}
+
+	/**
+	 * Query parameters to retrieve the linked page
+	 *
+	 * @return array
+	 **/
+	public function getParams()
+	{
+		return $this->params;
+	}
+
+	/**
+	 * The (1-indexed) page number of this page
+	 *
+	 * @return int
+	 **/
+	public function getPageNumber()
+	{
+		return $this->params[self::PARAM_PAGE_NUMBER];
+	}
+
+	/**
+	 * The number of responses per page generating this pagination
+	 *
+	 * @return int
+	 **/
+	public function getPerPage()
+	{
+		return $this->params[self::PARAM_PER_PAGE];
+	}
+
+	/**
+	 * An array representation of the CanvasArray
+	 *
+	 * @return array
+	 **/
+	public function getArrayCopy()
+	{
+		$arr = array();
+		$_key = $this->key;
+		$_page = $this->page;
+		foreach ($this as $obj) {
+			$arr[] = $obj->getArrayCopy();
+		}
+		$this->page = $_page;
+		$this->key = $_key;
+		return $arr;
+	}
 }