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 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 |
<?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\Database; /** * Interface ResultInterface */ interface ResultInterface { /** * Retrieve the results of the query. Typically an array of * individual data rows, which can be either an 'array', an * 'object', or a custom class name. * * @param string $type The row type. Either 'array', 'object', or a class name to use * * @return mixed */ public function getResult(string $type = 'object'): array; //-------------------------------------------------------------------- /** * Returns the results as an array of custom objects. * * @param string $className The name of the class to use. * * @return mixed */ public function getCustomResultObject(string $className); //-------------------------------------------------------------------- /** * Returns the results as an array of arrays. * * If no results, an empty array is returned. * * @return array */ public function getResultArray(): array; //-------------------------------------------------------------------- /** * Returns the results as an array of objects. * * If no results, an empty array is returned. * * @return array */ public function getResultObject(): array; //-------------------------------------------------------------------- /** * Wrapper object to return a row as either an array, an object, or * a custom class. * * If row doesn't exist, returns null. * * @param mixed $n The index of the results to return * @param string $type The type of result object. 'array', 'object' or class name. * * @return mixed */ public function getRow($n = 0, string $type = 'object'); //-------------------------------------------------------------------- /** * Returns a row as a custom class instance. * * If row doesn't exists, returns null. * * @param integer $n * @param string $className * * @return mixed */ public function getCustomRowObject(int $n, string $className); //-------------------------------------------------------------------- /** * Returns a single row from the results as an array. * * If row doesn't exist, returns null. * * @param integer $n * * @return mixed */ public function getRowArray(int $n = 0); //-------------------------------------------------------------------- /** * Returns a single row from the results as an object. * * If row doesn't exist, returns null. * * @param integer $n * * @return mixed */ public function getRowObject(int $n = 0); //-------------------------------------------------------------------- /** * Assigns an item into a particular column slot. * * @param $key * @param null $value * * @return mixed */ public function setRow($key, $value = null); //-------------------------------------------------------------------- /** * Returns the "first" row of the current results. * * @param string $type * * @return mixed */ public function getFirstRow(string $type = 'object'); //-------------------------------------------------------------------- /** * Returns the "last" row of the current results. * * @param string $type * * @return mixed */ public function getLastRow(string $type = 'object'); //-------------------------------------------------------------------- /** * Returns the "next" row of the current results. * * @param string $type * * @return mixed */ public function getNextRow(string $type = 'object'); //-------------------------------------------------------------------- /** * Returns the "previous" row of the current results. * * @param string $type * * @return mixed */ public function getPreviousRow(string $type = 'object'); //-------------------------------------------------------------------- /** * Returns an unbuffered row and move the pointer to the next row. * * @param string $type * * @return mixed */ public function getUnbufferedRow(string $type = 'object'); //-------------------------------------------------------------------- /** * Gets the number of fields in the result set. * * @return integer */ public function getFieldCount(): int; //-------------------------------------------------------------------- /** * Generates an array of column names in the result set. * * @return array */ public function getFieldNames(): array; //-------------------------------------------------------------------- /** * Generates an array of objects representing field meta-data. * * @return array */ public function getFieldData(): array; //-------------------------------------------------------------------- /** * Frees the current result. * * @return void */ public function freeResult(); //-------------------------------------------------------------------- /** * Moves the internal pointer to the desired offset. This is called * internally before fetching results to make sure the result set * starts at zero. * * @param integer $n * * @return mixed */ public function dataSeek(int $n = 0); //-------------------------------------------------------------------- } |
Commits for paulgoughbooks_old/trunk/system/Database/ResultInterface.php
Revision | Author | Commited | Message |
---|---|---|---|
2 | tporter | Tue 03 Nov, 2020 08:50:21 +0000 | Migration of Paul Goughs Books site to Codeignitor 4 |