paulgoughbooks_old
This repository has no backups
This repository's network speed is throttled to 100KB/sec
Upgrade your account to fix these warnings, or use backups.vc for automated backups
@ 2
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 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 |
<?php /** * CodeIgniter * * An open source application development framework for PHP * * This content is released under the MIT License (MIT) * * Copyright (c) 2014-2019 British Columbia Institute of Technology * Copyright (c) 2019-2020 CodeIgniter Foundation * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. * * @package CodeIgniter * @author CodeIgniter Dev Team * @copyright 2019-2020 CodeIgniter Foundation * @license https://opensource.org/licenses/MIT MIT License * @link https://codeigniter.com * @since Version 4.0.0 * @filesource */ namespace CodeIgniter\Pager; /** * Expected behavior for a Pager */ interface PagerInterface { /** * Handles creating and displaying the * * @param string $group * @param string $template The output template alias to render. * * @return string */ public function links(string $group = 'default', string $template = 'default'): string; //-------------------------------------------------------------------- /** * Creates simple Next/Previous links, instead of full pagination. * * @param string $group * @param string $template * * @return string */ public function simpleLinks(string $group = 'default', string $template = 'default'): string; //-------------------------------------------------------------------- /** * Allows for a simple, manual, form of pagination where all of the data * is provided by the user. The URL is the current URI. * * @param integer $page * @param integer $perPage * @param integer $total * @param string $template The output template alias to render. * * @return string */ public function makeLinks(int $page, int $perPage, int $total, string $template = 'default'): string; //-------------------------------------------------------------------- /** * Stores a set of pagination data for later display. Most commonly used * by the model to automate the process. * * @param string $group * @param integer $page * @param integer $perPage * @param integer $total * * @return mixed */ public function store(string $group, int $page, int $perPage, int $total); //-------------------------------------------------------------------- /** * Sets the path that an aliased group of links will use. * * @param string $path * @param string $group * * @return mixed */ public function setPath(string $path, string $group = 'default'); //-------------------------------------------------------------------- /** * Returns the total number of pages. * * @param string|null $group * * @return integer */ public function getPageCount(string $group = 'default'): int; //-------------------------------------------------------------------- /** * Returns the number of the current page of results. * * @param string|null $group * * @return integer */ public function getCurrentPage(string $group = 'default'): int; //-------------------------------------------------------------------- /** * Returns the URI for a specific page for the specified group. * * @param integer|null $page * @param string $group * @param boolean $returnObject * * @return string|\CodeIgniter\HTTP\URI */ public function getPageURI(int $page = null, string $group = 'default', bool $returnObject = false); //-------------------------------------------------------------------- /** * Tells whether this group of results has any more pages of results. * * @param string|null $group * * @return boolean */ public function hasMore(string $group = 'default'): bool; //-------------------------------------------------------------------- /** * Returns the first page. * * @param string $group * * @return integer */ public function getFirstPage(string $group = 'default'); //-------------------------------------------------------------------- /** * Returns the last page, if we have a total that we can calculate with. * * @param string $group * * @return integer|null */ public function getLastPage(string $group = 'default'); //-------------------------------------------------------------------- /** * Returns the full URI to the next page of results, or null. * * @param string $group * * @return string|null */ public function getNextPageURI(string $group = 'default'); //-------------------------------------------------------------------- /** * Returns the full URL to the previous page of results, or null. * * @param string $group * * @return string|null */ public function getPreviousPageURI(string $group = 'default'); //-------------------------------------------------------------------- /** * Returns the number of results per page that should be shown. * * @param string $group * * @return integer */ public function getPerPage(string $group = 'default'): int; //-------------------------------------------------------------------- /** * Returns an array with details about the results, including * total, per_page, current_page, last_page, next_url, prev_url, from, to. * Does not include the actual data. This data is suitable for adding * a 'data' object to with the result set and converting to JSON. * * @param string $group * * @return array */ public function getDetails(string $group = 'default'): array; //-------------------------------------------------------------------- } |
Commits for paulgoughbooks_old/trunk/system/Pager/PagerInterface.php
Revision | Author | Commited | Message |
---|---|---|---|
2 | tporter | Tue 03 Nov, 2020 08:50:21 +0000 | Migration of Paul Goughs Books site to Codeignitor 4 |