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 265 266 267 268 269 270 271 272 273 274 275 276 |
<?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\Router; /** * Interface RouteCollectionInterface * * A Route Collection's sole job is to hold a series of routes. The required * number of methods is kept very small on purpose, but implementors may * add a number of additional methods to customize how the routes are defined. * * The RouteCollection provides the Router with the routes so that it can determine * which controller should be ran. * * @package CodeIgniter\Router */ interface RouteCollectionInterface { /** * Adds a single route to the collection. * * @param string $from * @param array|string $to * @param array $options * * @return mixed */ public function add(string $from, $to, array $options = null); //-------------------------------------------------------------------- /** * Registers a new constraint with the system. Constraints are used * by the routes as placeholders for regular expressions to make defining * the routes more human-friendly. * * You can pass an associative array as $placeholder, and have * multiple placeholders added at once. * * @param string|array $placeholder * @param string $pattern * * @return mixed */ public function addPlaceholder($placeholder, string $pattern = null); //-------------------------------------------------------------------- /** * Sets the default namespace to use for Controllers when no other * namespace has been specified. * * @param $value * * @return mixed */ public function setDefaultNamespace(string $value); //-------------------------------------------------------------------- /** * Sets the default controller to use when no other controller has been * specified. * * @param $value * * @return mixed */ public function setDefaultController(string $value); //-------------------------------------------------------------------- /** * Sets the default method to call on the controller when no other * method has been set in the route. * * @param $value * * @return mixed */ public function setDefaultMethod(string $value); //-------------------------------------------------------------------- /** * Tells the system whether to convert dashes in URI strings into * underscores. In some search engines, including Google, dashes * create more meaning and make it easier for the search engine to * find words and meaning in the URI for better SEO. But it * doesn't work well with PHP method names.... * * @param boolean $value * * @return mixed */ public function setTranslateURIDashes(bool $value); //-------------------------------------------------------------------- /** * If TRUE, the system will attempt to match the URI against * Controllers by matching each segment against folders/files * in APPPATH/Controllers, when a match wasn't found against * defined routes. * * If FALSE, will stop searching and do NO automatic routing. * * @param boolean $value * * @return RouteCollectionInterface */ public function setAutoRoute(bool $value): self; //-------------------------------------------------------------------- /** * Sets the class/method that should be called if routing doesn't * find a match. It can be either a closure or the controller/method * name exactly like a route is defined: Users::index * * This setting is passed to the Router class and handled there. * * @param callable|null $callable * * @return RouteCollectionInterface */ public function set404Override($callable = null): self; //-------------------------------------------------------------------- /** * Returns the 404 Override setting, which can be null, a closure * or the controller/string. * * @return string|\Closure|null */ public function get404Override(); //-------------------------------------------------------------------- /** * Returns the name of the default controller. With Namespace. * * @return string */ public function getDefaultController(); //-------------------------------------------------------------------- /** * Returns the name of the default method to use within the controller. * * @return string */ public function getDefaultMethod(); //-------------------------------------------------------------------- /** * Returns the current value of the translateURIDashes setting. * * @return mixed */ public function shouldTranslateURIDashes(); //-------------------------------------------------------------------- /** * Returns the flag that tells whether to autoRoute URI against Controllers. * * @return boolean */ public function shouldAutoRoute(); //-------------------------------------------------------------------- /** * Returns the raw array of available routes. * * @return mixed */ public function getRoutes(); //-------------------------------------------------------------------- /** * Returns the current HTTP Verb being used. * * @return string */ public function getHTTPVerb(); //-------------------------------------------------------------------- /** * Attempts to look up a route based on it's destination. * * If a route exists: * * 'path/(:any)/(:any)' => 'Controller::method/$1/$2' * * This method allows you to know the Controller and method * and get the route that leads to it. * * // Equals 'path/$param1/$param2' * reverseRoute('Controller::method', $param1, $param2); * * @param string $search * @param array ...$params * * @return string|false */ public function reverseRoute(string $search, ...$params); //-------------------------------------------------------------------- /** * Determines if the route is a redirecting route. * * @param string $from * * @return boolean */ public function isRedirect(string $from): bool; //-------------------------------------------------------------------- /** * Grabs the HTTP status code from a redirecting Route. * * @param string $from * * @return integer */ public function getRedirectCode(string $from): int; //-------------------------------------------------------------------- } |
Commits for paulgoughbooks_old/trunk/system/Router/RouteCollectionInterface.php
Revision | Author | Commited | Message |
---|---|---|---|
2 | tporter | Tue 03 Nov, 2020 08:50:21 +0000 | Migration of Paul Goughs Books site to Codeignitor 4 |