├── LICENSE ├── README.md ├── composer.json └── src └── Link.hh /LICENSE: -------------------------------------------------------------------------------- 1 | Creative Commons 2 | Attribution-ShareAlike 3.0 Unported 3 | 4 | http://creativecommons.org/licenses/by-sa/3.0/ 5 | 6 | License 7 | 8 | THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED. 9 | 10 | BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. TO THE EXTENT THIS LICENSE MAY BE CONSIDERED TO BE A CONTRACT, THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS. 11 | 12 | 1. Definitions 13 | 14 | "Adaptation" means a work based upon the Work, or upon the Work and other pre-existing works, such as a translation, adaptation, derivative work, arrangement of music or other alterations of a literary or artistic work, or phonogram or performance and includes cinematographic adaptations or any other form in which the Work may be recast, transformed, or adapted including in any form recognizably derived from the original, except that a work that constitutes a Collection will not be considered an Adaptation for the purpose of this License. For the avoidance of doubt, where the Work is a musical work, performance or phonogram, the synchronization of the Work in timed-relation with a moving image ("synching") will be considered an Adaptation for the purpose of this License. 15 | "Collection" means a collection of literary or artistic works, such as encyclopedias and anthologies, or performances, phonograms or broadcasts, or other works or subject matter other than works listed in Section 1(f) below, which, by reason of the selection and arrangement of their contents, constitute intellectual creations, in which the Work is included in its entirety in unmodified form along with one or more other contributions, each constituting separate and independent works in themselves, which together are assembled into a collective whole. A work that constitutes a Collection will not be considered an Adaptation (as defined below) for the purposes of this License. 16 | "Creative Commons Compatible License" means a license that is listed at http://creativecommons.org/compatiblelicenses that has been approved by Creative Commons as being essentially equivalent to this License, including, at a minimum, because that license: (i) contains terms that have the same purpose, meaning and effect as the License Elements of this License; and, (ii) explicitly permits the relicensing of adaptations of works made available under that license under this License or a Creative Commons jurisdiction license with the same License Elements as this License. 17 | "Distribute" means to make available to the public the original and copies of the Work or Adaptation, as appropriate, through sale or other transfer of ownership. 18 | "License Elements" means the following high-level license attributes as selected by Licensor and indicated in the title of this License: Attribution, ShareAlike. 19 | "Licensor" means the individual, individuals, entity or entities that offer(s) the Work under the terms of this License. 20 | "Original Author" means, in the case of a literary or artistic work, the individual, individuals, entity or entities who created the Work or if no individual or entity can be identified, the publisher; and in addition (i) in the case of a performance the actors, singers, musicians, dancers, and other persons who act, sing, deliver, declaim, play in, interpret or otherwise perform literary or artistic works or expressions of folklore; (ii) in the case of a phonogram the producer being the person or legal entity who first fixes the sounds of a performance or other sounds; and, (iii) in the case of broadcasts, the organization that transmits the broadcast. 21 | "Work" means the literary and/or artistic work offered under the terms of this License including without limitation any production in the literary, scientific and artistic domain, whatever may be the mode or form of its expression including digital form, such as a book, pamphlet and other writing; a lecture, address, sermon or other work of the same nature; a dramatic or dramatico-musical work; a choreographic work or entertainment in dumb show; a musical composition with or without words; a cinematographic work to which are assimilated works expressed by a process analogous to cinematography; a work of drawing, painting, architecture, sculpture, engraving or lithography; a photographic work to which are assimilated works expressed by a process analogous to photography; a work of applied art; an illustration, map, plan, sketch or three-dimensional work relative to geography, topography, architecture or science; a performance; a broadcast; a phonogram; a compilation of data to the extent it is protected as a copyrightable work; or a work performed by a variety or circus performer to the extent it is not otherwise considered a literary or artistic work. 22 | "You" means an individual or entity exercising rights under this License who has not previously violated the terms of this License with respect to the Work, or who has received express permission from the Licensor to exercise rights under this License despite a previous violation. 23 | "Publicly Perform" means to perform public recitations of the Work and to communicate to the public those public recitations, by any means or process, including by wire or wireless means or public digital performances; to make available to the public Works in such a way that members of the public may access these Works from a place and at a place individually chosen by them; to perform the Work to the public by any means or process and the communication to the public of the performances of the Work, including by public digital performance; to broadcast and rebroadcast the Work by any means including signs, sounds or images. 24 | "Reproduce" means to make copies of the Work by any means including without limitation by sound or visual recordings and the right of fixation and reproducing fixations of the Work, including storage of a protected performance or phonogram in digital form or other electronic medium. 25 | 2. Fair Dealing Rights. Nothing in this License is intended to reduce, limit, or restrict any uses free from copyright or rights arising from limitations or exceptions that are provided for in connection with the copyright protection under copyright law or other applicable laws. 26 | 27 | 3. License Grant. Subject to the terms and conditions of this License, Licensor hereby grants You a worldwide, royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to exercise the rights in the Work as stated below: 28 | 29 | to Reproduce the Work, to incorporate the Work into one or more Collections, and to Reproduce the Work as incorporated in the Collections; 30 | to create and Reproduce Adaptations provided that any such Adaptation, including any translation in any medium, takes reasonable steps to clearly label, demarcate or otherwise identify that changes were made to the original Work. For example, a translation could be marked "The original work was translated from English to Spanish," or a modification could indicate "The original work has been modified."; 31 | to Distribute and Publicly Perform the Work including as incorporated in Collections; and, 32 | to Distribute and Publicly Perform Adaptations. 33 | For the avoidance of doubt: 34 | 35 | Non-waivable Compulsory License Schemes. In those jurisdictions in which the right to collect royalties through any statutory or compulsory licensing scheme cannot be waived, the Licensor reserves the exclusive right to collect such royalties for any exercise by You of the rights granted under this License; 36 | Waivable Compulsory License Schemes. In those jurisdictions in which the right to collect royalties through any statutory or compulsory licensing scheme can be waived, the Licensor waives the exclusive right to collect such royalties for any exercise by You of the rights granted under this License; and, 37 | Voluntary License Schemes. The Licensor waives the right to collect royalties, whether individually or, in the event that the Licensor is a member of a collecting society that administers voluntary licensing schemes, via that society, from any exercise by You of the rights granted under this License. 38 | The above rights may be exercised in all media and formats whether now known or hereafter devised. The above rights include the right to make such modifications as are technically necessary to exercise the rights in other media and formats. Subject to Section 8(f), all rights not expressly granted by Licensor are hereby reserved. 39 | 40 | 4. Restrictions. The license granted in Section 3 above is expressly made subject to and limited by the following restrictions: 41 | 42 | You may Distribute or Publicly Perform the Work only under the terms of this License. You must include a copy of, or the Uniform Resource Identifier (URI) for, this License with every copy of the Work You Distribute or Publicly Perform. You may not offer or impose any terms on the Work that restrict the terms of this License or the ability of the recipient of the Work to exercise the rights granted to that recipient under the terms of the License. You may not sublicense the Work. You must keep intact all notices that refer to this License and to the disclaimer of warranties with every copy of the Work You Distribute or Publicly Perform. When You Distribute or Publicly Perform the Work, You may not impose any effective technological measures on the Work that restrict the ability of a recipient of the Work from You to exercise the rights granted to that recipient under the terms of the License. This Section 4(a) applies to the Work as incorporated in a Collection, but this does not require the Collection apart from the Work itself to be made subject to the terms of this License. If You create a Collection, upon notice from any Licensor You must, to the extent practicable, remove from the Collection any credit as required by Section 4(c), as requested. If You create an Adaptation, upon notice from any Licensor You must, to the extent practicable, remove from the Adaptation any credit as required by Section 4(c), as requested. 43 | You may Distribute or Publicly Perform an Adaptation only under the terms of: (i) this License; (ii) a later version of this License with the same License Elements as this License; (iii) a Creative Commons jurisdiction license (either this or a later license version) that contains the same License Elements as this License (e.g., Attribution-ShareAlike 3.0 US)); (iv) a Creative Commons Compatible License. If you license the Adaptation under one of the licenses mentioned in (iv), you must comply with the terms of that license. If you license the Adaptation under the terms of any of the licenses mentioned in (i), (ii) or (iii) (the "Applicable License"), you must comply with the terms of the Applicable License generally and the following provisions: (I) You must include a copy of, or the URI for, the Applicable License with every copy of each Adaptation You Distribute or Publicly Perform; (II) You may not offer or impose any terms on the Adaptation that restrict the terms of the Applicable License or the ability of the recipient of the Adaptation to exercise the rights granted to that recipient under the terms of the Applicable License; (III) You must keep intact all notices that refer to the Applicable License and to the disclaimer of warranties with every copy of the Work as included in the Adaptation You Distribute or Publicly Perform; (IV) when You Distribute or Publicly Perform the Adaptation, You may not impose any effective technological measures on the Adaptation that restrict the ability of a recipient of the Adaptation from You to exercise the rights granted to that recipient under the terms of the Applicable License. This Section 4(b) applies to the Adaptation as incorporated in a Collection, but this does not require the Collection apart from the Adaptation itself to be made subject to the terms of the Applicable License. 44 | If You Distribute, or Publicly Perform the Work or any Adaptations or Collections, You must, unless a request has been made pursuant to Section 4(a), keep intact all copyright notices for the Work and provide, reasonable to the medium or means You are utilizing: (i) the name of the Original Author (or pseudonym, if applicable) if supplied, and/or if the Original Author and/or Licensor designate another party or parties (e.g., a sponsor institute, publishing entity, journal) for attribution ("Attribution Parties") in Licensor's copyright notice, terms of service or by other reasonable means, the name of such party or parties; (ii) the title of the Work if supplied; (iii) to the extent reasonably practicable, the URI, if any, that Licensor specifies to be associated with the Work, unless such URI does not refer to the copyright notice or licensing information for the Work; and (iv) , consistent with Ssection 3(b), in the case of an Adaptation, a credit identifying the use of the Work in the Adaptation (e.g., "French translation of the Work by Original Author," or "Screenplay based on original Work by Original Author"). The credit required by this Section 4(c) may be implemented in any reasonable manner; provided, however, that in the case of a Adaptation or Collection, at a minimum such credit will appear, if a credit for all contributing authors of the Adaptation or Collection appears, then as part of these credits and in a manner at least as prominent as the credits for the other contributing authors. For the avoidance of doubt, You may only use the credit required by this Section for the purpose of attribution in the manner set out above and, by exercising Your rights under this License, You may not implicitly or explicitly assert or imply any connection with, sponsorship or endorsement by the Original Author, Licensor and/or Attribution Parties, as appropriate, of You or Your use of the Work, without the separate, express prior written permission of the Original Author, Licensor and/or Attribution Parties. 45 | Except as otherwise agreed in writing by the Licensor or as may be otherwise permitted by applicable law, if You Reproduce, Distribute or Publicly Perform the Work either by itself or as part of any Adaptations or Collections, You must not distort, mutilate, modify or take other derogatory action in relation to the Work which would be prejudicial to the Original Author's honor or reputation. Licensor agrees that in those jurisdictions (e.g. Japan), in which any exercise of the right granted in Section 3(b) of this License (the right to make Adaptations) would be deemed to be a distortion, mutilation, modification or other derogatory action prejudicial to the Original Author's honor and reputation, the Licensor will waive or not assert, as appropriate, this Section, to the fullest extent permitted by the applicable national law, to enable You to reasonably exercise Your right under Section 3(b) of this License (right to make Adaptations) but not otherwise. 46 | 5. Representations, Warranties and Disclaimer 47 | 48 | UNLESS OTHERWISE MUTUALLY AGREED TO BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU. 49 | 50 | 6. Limitation on Liability. EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 51 | 52 | 7. Termination 53 | 54 | This License and the rights granted hereunder will terminate automatically upon any breach by You of the terms of this License. Individuals or entities who have received Adaptations or Collections from You under this License, however, will not have their licenses terminated provided such individuals or entities remain in full compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will survive any termination of this License. 55 | Subject to the above terms and conditions, the license granted here is perpetual (for the duration of the applicable copyright in the Work). Notwithstanding the above, Licensor reserves the right to release the Work under different license terms or to stop distributing the Work at any time; provided, however that any such election will not serve to withdraw this License (or any other license that has been, or is required to be, granted under the terms of this License), and this License will continue in full force and effect unless terminated as stated above. 56 | 8. Miscellaneous 57 | 58 | Each time You Distribute or Publicly Perform the Work or a Collection, the Licensor offers to the recipient a license to the Work on the same terms and conditions as the license granted to You under this License. 59 | Each time You Distribute or Publicly Perform an Adaptation, Licensor offers to the recipient a license to the original Work on the same terms and conditions as the license granted to You under this License. 60 | If any provision of this License is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this License, and without further action by the parties to this agreement, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable. 61 | No term or provision of this License shall be deemed waived and no breach consented to unless such waiver or consent shall be in writing and signed by the party to be charged with such waiver or consent. 62 | This License constitutes the entire agreement between the parties with respect to the Work licensed here. There are no understandings, agreements or representations with respect to the Work not specified here. Licensor shall not be bound by any additional provisions that may appear in any communication from You. This License may not be modified without the mutual written agreement of the Licensor and You. 63 | The rights granted under, and the subject matter referenced, in this License were drafted utilizing the terminology of the Berne Convention for the Protection of Literary and Artistic Works (as amended on September 28, 1979), the Rome Convention of 1961, the WIPO Copyright Treaty of 1996, the WIPO Performances and Phonograms Treaty of 1996 and the Universal Copyright Convention (as revised on July 24, 1971). These rights and subject matter take effect in the relevant jurisdiction in which the License terms are sought to be enforced according to the corresponding provisions of the implementation of those treaty provisions in the applicable national law. If the standard suite of rights granted under applicable copyright law includes additional rights not granted under this License, such additional rights are deemed to be included in the License; this License is not intended to restrict the license of any rights under applicable law. 64 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## Link-Hack is a __Hack Lang HHVM version__ of Amanpreet Singh's __minimal__ PHP Router https://github.com/apsdehal/Link 2 | A __minimal__ router for your webapps and APIs that effortlessly links all of your project. Its fast and to the point. 3 | 4 | # Features 5 | - RESTful routing 6 | - Wildcards to help simplify writing routes 7 | - Regex routes to unleash any possibility 8 | - Named routes to help you create links easily 9 | - Before and after routes function support 10 | - Tested with Ubuntu 14.04, hhvm 3.2.0-dev+2014.06.18 (rel), nginx 1.4.6 11 | 12 | # Dependencies 13 | 14 | ## Hack HHVM 15 | http://docs.hhvm.com/manual/en/install.php 16 | 17 | ## Nginx 18 | http://wiki.nginx.org/Install 19 | 20 | # Install 21 | 22 | ## Manual Include 23 | 24 | ```php 25 | require("Link-Hack/src/Link.hh"); 26 | ``` 27 | 28 | ## Composer 29 | 30 | ```bash 31 | composer require link-hack/router 32 | ``` 33 | 34 | # Config 35 | 36 | ## Nginx 37 | ``` 38 | server { 39 | listen 80 default_server; 40 | listen [::]:80 default_server ipv6only=on; 41 | 42 | root /path/Link-Hack/src/; # Changet to path of your environment 43 | server_name _; #catchall 44 | 45 | if (!-e $request_filename) 46 | { 47 | rewrite ^/(.*)$ /YourRouter.hh?/$1 last; 48 | break; 49 | } 50 | 51 | location / { 52 | 53 | root /path/Link-Hack/src/; # Changet to path of your environment 54 | fastcgi_pass 127.0.0.1:9000; #Whatever HHVM daemon is set to run on. 55 | # or if you used a unix socket 56 | # fastcgi_pass unix:/var/run/hhvm/hhvm.sock; 57 | fastcgi_index YourRouter.hh; 58 | fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; 59 | include fastcgi_params; 60 | 61 | } 62 | 63 | } 64 | ``` 65 | 66 | # Basics 67 | 68 | ## Simple Routing 69 | 70 | ```php 71 | 72 | function routeMe(): void 73 | { 74 | echo 'I am routed'; 75 | } 76 | 77 | Link::all( Map{ 78 | '/' => Map{'routeMe' => []} 79 | }); 80 | ``` 81 | 82 | ## Named Routing 83 | 84 | In Link-Hack routes can be named and then further used generating links in a simple and elegant way. 85 | 86 | 87 | ```php 88 | 89 | function nameMe() :void 90 | { 91 | echo 'I am named'; 92 | } 93 | 94 | Link::all( Map{ 95 | '/named' => Map{'nameMe' => [], 'Its my name' => []} 96 | }); 97 | ``` 98 | 99 | Names to routes must be given as second argument in array while the first being the route handler. 100 | 101 | ### Usage 102 | 103 | These named routes can be used in creating in hassle free links. 104 | 105 | ```html 106 | Go to named route 107 | ``` 108 | 109 | ## Routing with classes 110 | 111 | Link can handle classes as Route handler easily, but remember non-static class will be handled both on construct and RESTfully. 112 | 113 | ```php 114 | 115 | $routes = Map{ 116 | '/' => Map{'IndexController::getMeHome' => []}, // Static function 117 | '/home' => Map{'HomeController' => []}, // Class 118 | '/office' => Map{'OfficeController' => []} // Class 119 | }); 120 | 121 | Link::all($routes); 122 | 123 | ``` 124 | 125 | ## RESTful routing 126 | 127 | RESTful routing is a breeze for Link-Hack. 128 | 129 | ```php 130 | 131 | class HomeController 132 | { 133 | 134 | function get() :void 135 | { 136 | echo 'You have got to home :)'; 137 | } 138 | 139 | function post() :void 140 | { 141 | echo 'You have posted to home'; 142 | } 143 | 144 | function put() :void 145 | { 146 | echo 'You have put to home'; 147 | } 148 | 149 | function delete() :void 150 | { 151 | echo 'You have deleted the home :('; 152 | } 153 | } 154 | 155 | Link::all( Map{ 156 | '/' => Map{'HomeController' => [], 'HomeRoute' => []} 157 | }); 158 | ``` 159 | 160 | # Dynamic Routes 161 | 162 | ## Regex Shorthands 163 | 164 | Link-Hack supports numbers, string and alphanumeric wildcards which can be used as `{i} {s} {a}` respectively. 165 | 166 | ```php 167 | $routes = Map{ 168 | '/' => Map{'IndexController' => []}, 169 | '/{i}' => Map{'IndexController' => []}, 170 | // Parameter in place of {i} will be passed to IndexController 171 | '/posts/{a}/{i}/{s}' => Map{'PostsController' => []} 172 | }; 173 | 174 | Link::all($routes); 175 | ``` 176 | 177 | ## Pure Regex 178 | 179 | Link-Hack supports writing your own regex based routes. 180 | 181 | ```php 182 | $routes = Map{ 183 | '/regex/([\d]+)/([a-zA-Z]+)/([a-zA-Z]+)' => Map{'regexController' => []} 184 | }; 185 | 186 | Link::all($routes); 187 | ``` 188 | 189 | ## Supplementary Handlers 190 | 191 | Through Link-Hack, universal before and after handlers can be added, such that these are executed always before and after any route is routed. This can be done as follows: 192 | 193 | ```php 194 | 195 | function universalBeforeHandler( $id ) :void 196 | { 197 | echo 'Hello I occurred before with ' . $id . '\n'; 198 | } 199 | 200 | function universalAfterHandler( ?$id ) :void 201 | { 202 | if( $id ) 203 | echo 'Hello I occurred after with ' . $id; 204 | else 205 | echo 'I simply occurred after'; 206 | } 207 | 208 | function main() :void 209 | { 210 | echo 'I simply occurred\n' 211 | } 212 | 213 | Link::before( Map{'universalBeforeHandler' => array('12')} ); // If you want to pass parameters to them, pass them as arrays 214 | Link::after( Map{'universalAfterHandler' => []} ); // else just don't specify them. 215 | 216 | Link::all( Map{ 217 | '/' => Map{'main' => []} 218 | }) 219 | ``` 220 | 221 | Now go to '/' in your browser to find: 222 | 223 | ```sh 224 | Hello I occurred before with 12 225 | 226 | I simply occurred 227 | 228 | I simply occurred after. 229 | ``` 230 | 231 | ## Passing Parameters to Named Routes 232 | 233 | You can pass parameters to named routes if the have wildcards in the route path, this will thus generate dynamic links through a single named route. 234 | 235 | ```php 236 | 237 | function nameMe( $i, $s ) :void 238 | { 239 | echo 'I am named and I have been passed ' . $i . $s ; 240 | } 241 | 242 | Link::all( Map{ 243 | '/named/{i}/{s}' => Map{'nameMe' => [], 'Its my name' => []} 244 | }); 245 | ``` 246 | 247 | Now generate a link through Link 248 | 249 | ```php 250 | 251 | echo Link::route( 'Its my name', array(1, 'Me') ); 252 | ``` 253 | 254 | This in turn will generate `/named/1/Me` and the browser will return `I am named and I have been passed 1Me` 255 | 256 | ## [404,500] Errors 257 | 258 | You should probably add a 404 handler to your routes Map, Link will take care of handling routes that are not found. In case, Link-Hack doesn't find a 404/500 route defined, it will just send the appropriate header. The 500 route will be executed if there is any exceptions thrown from the controllers/methods/functions/closure called. 259 | 260 | ```php 261 | 262 | function notFound() :void 263 | { 264 | echo 'This page is missing'; 265 | } 266 | 267 | function errorFound() :void 268 | { 269 | echo 'Oops, something went wrong, try again later'; 270 | } 271 | 272 | function mainPage() :void 273 | { 274 | throw new Exception('Meh? :('); 275 | } 276 | 277 | Link::all( Map{ 278 | '/' => Map{'mainPage' => []}, 279 | '404' => Map{'notFound' => []}, 280 | '500' => Map{'errorFound' => []} 281 | }); 282 | ``` 283 | 284 | # License 285 | ### Creative Commons Attribution-ShareAlike 3.0 Unported 286 | http://creativecommons.org/licenses/by-sa/3.0/ 287 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "link-hack/router", 3 | "type": "library", 4 | "description": "Link-Hack is a Hack Lang HHVM version of Amanpreet Singh's Simple PHP Router", 5 | "keywords": ["hhvm", "router"], 6 | "homepage": "https://github.com/a904guy/Link-Hack", 7 | "license": "CC-BY-SA", 8 | "authors": [ 9 | { 10 | "name": "Andy Hawkins", 11 | "email": "andy@a904guy.com", 12 | "homepage": "http://a904guy.com/", 13 | "role": "Developer" 14 | } 15 | ], 16 | "require": { 17 | "hhvm": ">=2.3.3" 18 | }, 19 | "autoload": { 20 | "files": [ 21 | "src/Link.hh" 22 | ] 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /src/Link.hh: -------------------------------------------------------------------------------- 1 | ; 29 | 30 | class Link { 31 | 32 | private static Route $routes; 33 | private static Route $beforeFuncs; 34 | private static Route $afterFuncs; 35 | private static string $path = '/'; 36 | private static string $method = 'get'; 37 | private static array $regex = array('~{i}~', '~{s}~', '~{a}~'); // Can't Vector because of preg_replace 38 | private static array $replace = array('([\d]+)', '([ a-zA-Z\+]+)', '([\w-\+ ]+)'); 39 | 40 | public static function all(Route $routes): void { 41 | 42 | self::IterateRoutes(self::$beforeFuncs); 43 | self::$routes = $routes; 44 | self::$method = strtolower($_SERVER['REQUEST_METHOD']); 45 | self::$path = urldecode(parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH)); 46 | 47 | /* All Routes */ 48 | foreach (self::$routes as $path => $route) { 49 | 50 | /* Static Routes */ 51 | if ($path === self::$path) { 52 | self::IterateRoutes($route); 53 | break; 54 | } 55 | 56 | /* Static Dynamic Routes */ 57 | if (false !== strpos($path,'{')) { 58 | $routePath = preg_replace(self::$regex, self::$replace, $path); 59 | if ($routePath !== $path) { 60 | if (preg_match('~^/?' . $routePath . '/?$~', self::$path, $matches)) { 61 | unset($matches['0']); 62 | $route[array_keys($route)['0']] = $matches; 63 | self::IterateRoutes($route); 64 | break; 65 | } 66 | } 67 | } 68 | 69 | /* Pure Regex Routes*/ 70 | if ( 71 | false !== strpos($path, '(') 72 | && preg_match('~^' . $path . '$~', self::$path, $matches) 73 | ) { // Has matching regex syntax 74 | unset($matches['0']); 75 | $route[array_keys($route)['0']] = $matches; 76 | self::IterateRoutes($route); 77 | break; 78 | } 79 | 80 | } 81 | 82 | self::IterateRoutes(self::$afterFuncs); 83 | } 84 | 85 | public static function addRegex(string $match, string $regex): void { 86 | self::$regex[] = $match; 87 | self::$replace[] = $regex; 88 | } 89 | 90 | public static function before(Route $r): void { 91 | self::$beforeFuncs = self::assignFunc($r, self::$beforeFuncs); 92 | } 93 | 94 | public static function after(Route $r): void { 95 | self::$afterFuncs = self::assignFunc($r, self::$afterFuncs); 96 | } 97 | 98 | public static function route(string $name, array $params) : string { 99 | $href = ''; 100 | foreach (self::$routes as $path => $route) { 101 | foreach (array_keys($route) as $route_name) { 102 | if ($route_name !== $name) { 103 | continue; 104 | } 105 | $href = $path; 106 | for ($i = 0; $i < count($params); $i++) { 107 | $href = preg_replace('/{(.*?)}/', urlencode($params[$i]), $href, 1); 108 | } 109 | } 110 | } 111 | return (string) $href; 112 | } 113 | 114 | private static function assignFunc(Route $r, ?Route $d): Route { 115 | if (is_null($d)) { 116 | $d = $r; 117 | } else { 118 | foreach ($r as $k => $v) { 119 | $d[$k] = $v; 120 | } 121 | } 122 | return $d; 123 | } 124 | 125 | public static function handle404(): void { 126 | if (self::$routes.contains('404')) { 127 | self::IterateRoutes(Route('404', self::$routes.get('404'))); 128 | } else { 129 | header($_SERVER['SERVER_PROTOCOL'] . ' 404 Not Found'); 130 | } 131 | } 132 | 133 | public static function handle500(): void { 134 | if (self::$routes.contains('500')) { 135 | self::IterateRoutes(Route('500', self::$routes.get('500'))); 136 | } else { 137 | header($_SERVER['SERVER_PROTOCOL'] . ' 500 Server Error'); 138 | } 139 | } 140 | 141 | private static function IterateRoutes(?Route $funcs): void { 142 | if (!is_null($funcs)) { 143 | $funcs->mapWithKey( 144 | function ($k, $v) { 145 | self::launch_class($k, $v); 146 | self::launch_function($k,$v); 147 | } 148 | ); 149 | } 150 | } 151 | 152 | private static function launch_class(string $k, mixed $v): void { 153 | if (class_exists($k)) { 154 | try { 155 | $name = new ReflectionClass($k); 156 | if (isset($v)) { 157 | $class = $name->newInstanceArgs($v); 158 | } else { 159 | $class = $name->newInstance(); 160 | } 161 | // Check for RESTful methods in class 162 | if (method_exists($class, self::$method)) { 163 | call_user_func_array(array($class, self::$method), $v); 164 | } 165 | } catch (Exception $e) { 166 | error_log(var_export($e, true)); 167 | self::handle500(); 168 | } 169 | } 170 | } 171 | 172 | private static function launch_function(string $k, mixed $v): void { 173 | try { 174 | if (function_exists($k) && is_array($v)) { 175 | call_user_func_array($k, $v); 176 | } elseif (function_exists($k)) { 177 | call_user_func($k); 178 | } 179 | } catch (Exception $e) { 180 | error_log(var_export($e, true)); 181 | self::handle500(); 182 | } 183 | } 184 | 185 | } 186 | --------------------------------------------------------------------------------