SEARCH_QUERY_KEY
SEARCH_QUERY_KEY = '_px_q'
Model pagination
Model paginator is used to select and perform an action on part of models in the model collection.
این صفحه بند روش‌های متفاوتی را برای تولید یک نمایش از فهرست مدلها دارد که از این میان می‌تواند به روش تولید یک جدول اشاره کرد. علاوه بر این، این صفحه بند آزادی عمل مناسبی را برای کاربران ایجاد می‌کند تا داده‌های موجود در فهرست را به سادگی نمایش دهند.
Here is an example showes how to use the class:
$pag = new Pluf_Paginator(new Pluf_Model());
// Get the paginator parameters from the request
$pag->setFromRequest($request);
print $pag->render();
در نمونه بالا یک روش سریع برای نمایش داده‌ها آورده شده است. به بیان دیگر تمام خصوصیت‌های مورد نیاز برای صفحه بندی داده‌ها بر اساس خصوصیت‌های پیش فرض صفحه‌بند تعیین می‌شود.
$model : \Pluf_Model
Data model of the items
$list_display :
The fields being shown.
If no fields are given, the __toString representation of the item will be used to show the item.
If an item in the list_display is an array the format is the following: array('field', 'Custom_Function_ToApply', 'custom header name')
The signature of the the Custom_Function_ToApply is: string = Custom_Function_ToApply('field', $item);
By using for example 'id' as field with a custom header name you can create new columns in the table.
$sort_reverse_order :
Keys where the sort is reversed.
Let say, you have a column using a timestamp but displaying the information as an age. If you sort "ASC" you espect to get the youngest first, but as the timestamp is used, you get the oldest. But the key here and the sort will be reverted.
__construct(\Pluf_Model $model = null, array $list_display = array(), array $search_fields = array())
Creates new instance of paginator
| \Pluf_Model | $model | The main pagination model |
| array | $list_display | fields to display |
| array | $search_fields | fields to search in |
configure(array $list_display, array $search_fields = array(), array $sort_fields = array())
Configure paginated list
| array | $list_display | تمام سرآیندهایی که باید نمایش داده شود. |
| array | $search_fields | پارامترهایی که می‌تواند جستجو شود. |
| array | $sort_fields | از داده‌ها که قابلیت مرتب شدن را دارند. |
render_array() : \Array.
Creates data array from the request
آرایه ایجاد شده هیچ محدودیتی ندارد و شامل تمام مواردی است که قبل در سیستم ایجاد می‌شود. علاوه بر این داده‌هایی که از پایگاه داده به دست آمده اند به صورت مستقیم برگردانده می‌شوند و شامل هیچ ساختاری نیستند. این روش برای استفاده از داده‌ها در ساختارهایی مانند JSON بسیار مناسب خواهد بود.
getOrders() : NULL|string
Generates an order list and return
All sort options will be loaded form $this->sort_order.
You can set soert order as follow
$pag->sort_order = array(
'param',
'DESC'
);The result value is
param DESC
For moltiple options:
$pag->sort_order = array(
array(
'param1',
'DESC'
),
array(
'param2',
'ASC'
)
);The result value is
param1 DESC, param2 ASC