/zf/library/Zend/Service/Amazon/SimpleDb/Page.php

 1<?php
 2/**
 3 * Zend Framework
 4 *
 5 * LICENSE
 6 *
 7 * This source file is subject to the new BSD license that is bundled
 8 * with this package in the file LICENSE.txt.
 9 * It is also available through the world-wide-web at this URL:
10 * http://framework.zend.com/license/new-bsd
11 * If you did not receive a copy of the license and are unable to
12 * obtain it through the world-wide-web, please send an email
13 * to license@zend.com so we can send you a copy immediately.
14 *
15 * @category   Zend
16 * @package    Zend_Service_Amazon
17 * @subpackage SimpleDb
18 * @copyright  Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
19 * @license    http://framework.zend.com/license/new-bsd     New BSD License
20 */
21
22/**
23 * @see Zend_Service_Amazon_Exception
24 */
25require_once 'Zend/Service/Amazon/Exception.php';
26
27/**
28 * The Custom Exception class that allows you to have access to the AWS Error Code.
29 *
30 * @category   Zend
31 * @package    Zend_Service_Amazon
32 * @subpackage SimpleDb
33 * @copyright  Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
34 * @license    http://framework.zend.com/license/new-bsd     New BSD License
35 */
36class Zend_Service_Amazon_SimpleDb_Page
37{
38    /** @var string Page data */
39    protected $_data;
40
41    /** @var string|null Token identifying page */
42    protected $_token;
43
44    /**
45     * Constructor
46     *
47     * @param  string $data
48     * @param  string|null $token
49     * @return void
50     */
51    public function __construct($data, $token = null)
52    {
53        $this->_data  = $data;
54        $this->_token = $token;
55    }
56
57    /**
58     * Retrieve page data
59     *
60     * @return string
61     */
62    public function getData()
63    {
64        return $this->_data;
65    }
66
67    /**
68     * Retrieve token
69     *
70     * @return string|null
71     */
72    public function getToken()
73    {
74        return $this->_token;
75    }
76
77    /**
78     * Determine whether this is the last page of data
79     *
80     * @return void
81     */
82    public function isLast()
83    {
84        return (null === $this->_token);
85    }
86
87    /**
88     * Cast to string
89     *
90     * @return string
91     */
92    public function __toString()
93    {
94        return "Page with token: " . $this->_token
95             . "\n and data: " . $this->_data;
96    }
97}