blob: 6c0b2cee80b205cc4b40af62e0373e73e186b29e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
<?php
/**
* TPagedList, TPagedListFetchDataEventParameter, TPagedListPageChangedEventParameter class file
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @link http://www.pradosoft.com/
* @copyright Copyright © 2005-2014 PradoSoft
* @license http://www.pradosoft.com/license/
* @package Prado\Collections
*/
namespace Prado\Collections;
/**
* TPagedListFetchDataEventParameter class.
*
* TPagedListFetchDataEventParameter is used as the parameter for
* {@link TPagedList::onFetchData OnFetchData} event.
* To obtain the new page index, use {@link getNewPageIndex NewPageIndex}.
* The {@link getOffset Offset} property refers to the index
* of the first item in the new page, while {@link getLimit Limit}
* specifies how many items are requested for the page.
* Newly fetched data should be saved in {@link setData Data} property.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @package Prado\Collections
* @since 3.0
*/
class TPagedListFetchDataEventParameter extends \Prado\TEventParameter
{
private $_pageIndex;
private $_offset;
private $_limit;
private $_data=null;
/**
* Constructor.
* @param integer new page index
* @param integer offset of the first item in the new page
* @param integer number of items in the new page desired
*/
public function __construct($pageIndex,$offset,$limit)
{
$this->_pageIndex=$pageIndex;
$this->_offset=$offset;
$this->_limit=$limit;
}
/**
* @return integer the zero-based index of the new page
*/
public function getNewPageIndex()
{
return $this->_pageIndex;
}
/**
* @return integer offset of the first item in the new page
*/
public function getOffset()
{
return $this->_offset;
}
/**
* @return integer number of items in the new page
*/
public function getLimit()
{
return $this->_limit;
}
/**
* @return mixed new page data
*/
public function getData()
{
return $this->_data;
}
/**
* @param mixed new page data
*/
public function setData($value)
{
$this->_data=$value;
}
}
|
