├── .htaccess ├── .phpstorm.meta.php ├── LICENSE ├── README.md ├── app ├── Bootstrap.php ├── configs │ └── example.config.php ├── controllers │ └── Controller.php ├── models │ ├── Model.php │ └── ModelsCollection.php └── services │ ├── AuthorizationInterface.php │ ├── CommandInterface.php │ ├── Config.php │ ├── ConfigInterface.php │ ├── Console.php │ ├── ConsoleInterface.php │ ├── Container.php │ ├── ContainerInterface.php │ ├── Database.php │ ├── DatabaseInterface.php │ ├── Logger.php │ ├── LoggerInterface.php │ ├── Request.php │ ├── RequestInterface.php │ ├── Response.php │ ├── ResponseException.php │ ├── ResponseInterface.php │ ├── Router.php │ ├── RouterInterface.php │ ├── Validation.php │ ├── ValidationInterface.php │ ├── Validator.php │ └── ValidatorInterface.php └── composer.json /.htaccess: -------------------------------------------------------------------------------- 1 | RewriteEngine On 2 | 3 | RewriteRule ^(app|logs|\.git)\/|\.md|\.meta\.php|\.gitignore|composer\.json$ - [R=404] 4 | 5 | RewriteCond %{REQUEST_FILENAME} !-l 6 | RewriteCond %{REQUEST_FILENAME} !-f 7 | RewriteCond %{REQUEST_FILENAME} !-d 8 | RewriteRule .* index.php [L,QSA] 9 | RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization},L] 10 | -------------------------------------------------------------------------------- /.phpstorm.meta.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * Project home: https://github.com/alevar88/simpleapi 8 | * 9 | * This source file is subject to the license that is bundled 10 | * with this source code in the file LICENSE. 11 | * 12 | * @copyright Copyright 2019, Alexander Varnikov , Alexander Groza 13 | * 14 | */ 15 | 16 | namespace PHPSTORM_META { 17 | 18 | use app\services\AuthorizationInterface; 19 | use app\services\ConfigInterface; 20 | use app\services\ConsoleInterface; 21 | use app\services\ContainerInterface; 22 | use app\services\DatabaseInterface; 23 | use app\services\LoggerInterface; 24 | use app\services\ResponseInterface; 25 | use app\services\ValidationInterface; 26 | use app\services\ConsoleInterface; 27 | 28 | override(ContainerInterface::get(0), map(array( 29 | 'config' => app\services\ConfigInterface::class, 30 | 'request' => app\services\RequestInterface::class, 31 | 'response' => app\services\ResponseInterface::class, 32 | 'validation' => app\services\ValidationInterface::class, 33 | 'database' => app\services\DatabaseInterface::class, 34 | 'authorization' => app\services\AuthorizationInterface::class, 35 | 'logger' => app\services\LoggerInterface::class, 36 | 'console' => app\services\ConsoleInterface::class, 37 | ))); 38 | 39 | } -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Simple RESTful-API PHP skeleton 2 | Easy to use and lightweight RESTful-API skeleton written on PHP7 with authorization by token in header. 3 | Supports HTTP-methods: GET, POST, PUT, DELETE and validation the data transmitted in the request. 4 | 5 | [![CodeFactor](https://www.codefactor.io/repository/github/alevar88/simpleapi/badge)](https://www.codefactor.io/repository/github/alevar88/simpleapi) 6 | 7 | ## Introduction 8 | * [Install](https://github.com/alevar88/simpleapi#install) 9 | * [Usage](https://github.com/alevar88/simpleapi#usage) 10 | * [Example Model](https://github.com/alevar88/simpleapi#example-model) 11 | * [Example Controller](https://github.com/alevar88/simpleapi#example-controller) 12 | * [Request and Response](https://github.com/alevar88/simpleapi#request-and-response) 13 | * [Authorization by token](https://github.com/alevar88/simpleapi#authorization-by-token) 14 | * [Validation and validators](https://github.com/alevar88/simpleapi#validation-and-validators) 15 | * [Command line interface](https://github.com/alevar88/simpleapi#command-line-interface) 16 | 17 | ## Install 18 | Clone source code from the repository 19 | ```shell script 20 | git clone https://github.com/alevar88/simpleapi.git 21 | ``` 22 | then create a class loader through the composer 23 | ```shell script 24 | cd ./simpleapi; composer dump-autoload --optimize 25 | ``` 26 | ## Usage 27 | Copy configuration file and edit 28 | ```shell script 29 | cp app/configs/example.config.php app/configs/your_api_name.config.php 30 | ``` 31 | ```php 32 | 'router' => array( 33 | /** 34 | * If you use subdirectories in your virtual host 35 | * configuration "https://domain.tld/api/my-api-method" 36 | * enter the name of the subdirectory "/api" or leave it blank 37 | */ 38 | 'escPath' => '/api', 39 | 'routes' => array( 40 | //Name and settings of the API method 41 | '/my-api-method' => array( 42 | 'handler' => 'app\controllers\ExampleController', 43 | //Request validation rules (optional) 44 | //You can leave these settings blank 45 | 'rules' => array( 46 | //By default for all types of requests 47 | 'default' => array( 48 | 'id' => 'integer', //or combine 'integer|required' 49 | 'field1' => 'alphanum', 50 | 'field2' => 'integer', 51 | ), 52 | 'get' => array( 53 | 'field1' => 'required', 54 | ), 55 | 'post' => array( 56 | 'field1' => 'required', 57 | 'field2' => 'required', 58 | ), 59 | 'put' => array( 60 | 'id' => 'required', 61 | ), 62 | 'delete' => array( 63 | 'id' => 'required', 64 | ), 65 | ), 66 | ), 67 | ), 68 | '/my-other-api-method' => array( 69 | ... 70 | ), 71 | ), 72 | 'database' => array( 73 | 'dsn' => 'mysql:dbname=your_db;host=your_host', 74 | 'username' => 'your_db_user', 75 | 'password' => 'secret', 76 | //PDO options. Array or NULL 77 | 'options' => null, 78 | //Do something on connect to db (optional) 79 | 'onConnect' => function(\PDO $pdo) {} 80 | ) 81 | ``` 82 | create `index.php` as entry point for the application 83 | ```php 84 | beforeRun(function ($container) { 95 | //Do something before 96 | }); 97 | 98 | //And also you can do something on shutdown the application (optional) 99 | $bootstrap->onShutdown(function ($container) { 100 | //Do something on shutdown 101 | }); 102 | 103 | //Run an application entry point 104 | $bootstrap->run(); 105 | ``` 106 | 107 | ## Example model 108 | Example model class `app/models/ExampleModel.php` 109 | 110 | _Note: Each model has base methods `load()`, `loadAll()`, `save()` and `delete()` for CRUD operations which yourself can override._ 111 | ```php 112 | getModel(ExampleModel::class)->loadAll($this->request->getParams())->toArray(); 156 | 157 | //Or you can use without request params. Params automatically added in the model. 158 | //Also toArray accepts field names, example: toArray(array('id', 'field1', 'field2', etc...)) 159 | $result = $this->getModel(ExampleModel::class)->loadAll()->toArray(); 160 | 161 | if (empty($result)) { 162 | return $this->response->sendNotFound(); 163 | } 164 | 165 | //Short version 166 | return $this->response->sendResult($result); 167 | 168 | //Full version 169 | return $this->response 170 | ->withCode(/* Status code */) 171 | ->withError(/* Error message or errors array */) 172 | ->withResponse(/* Response data. */) 173 | ->send(); 174 | } 175 | 176 | public function post(): string 177 | { 178 | $model = $this->getModel(ExampleModel::class)->load(); 179 | if ($model->isLoaded()) { 180 | return $this->response->sendAlreadyExists(); 181 | } 182 | //Last insert id or 0 183 | $result = $model->save(); 184 | return $this->response 185 | ->withCode(201) //Send with Created status if successful. 186 | ->sendResult($result); 187 | } 188 | 189 | public function put(): string 190 | { 191 | $model = $this->getModel(ExampleModel::class)->load(array('id' => $this->request->getParam('id'))); 192 | if (!$model->isLoaded()) { 193 | return $this->response->sendNotFound(); 194 | } 195 | //Value in Primary key or 0 196 | $result = $model->import($this->request->getParams())->save(); 197 | return $this->response->sendResult($result); 198 | } 199 | 200 | public function delete(): string 201 | { 202 | $model = $this->getModel(ExampleModel::class)->load($this->request->getParams(array('id'))); 203 | if (!$model->isLoaded()) { 204 | return $this->response->sendNotFound(); 205 | } 206 | //Boolean 207 | $result = $model->delete(); 208 | return $this->response->sendResult($result); 209 | } 210 | } 211 | ``` 212 | 213 | ## Request and Response 214 | cURL POST request 215 | ```shell script 216 | curl -d "field1=some data 1&field2=some data 2&field3=some data 3" -X POST http://hostname:port/my-api-method 217 | ``` 218 | JSON response: 219 | ```json 220 | { 221 | "requestId": "5dcc662ab4afa", 222 | "requestMethod": "POST", 223 | "apiName": "my-api-method", 224 | "status": 201, 225 | "errors": [], 226 | "response": 10249, 227 | "request": { 228 | "field1": "some data 1", 229 | "field2": "some data 2", 230 | "field3": "some data 3" 231 | } 232 | } 233 | ``` 234 | 235 | ## Authorization by token 236 | Implement the `app\services\AuthorizationInterface` in your model or other handler and create `isAuth()` method 237 | ```php 238 | container->get('request')->getToken(); 255 | $this->load(array('api_token' => $token)); 256 | return $this->isLoaded(); 257 | } 258 | } 259 | ``` 260 | then configure in the config `app/configs/your_api_name.config.php` 261 | ```php 262 | return array( 263 | ... 264 | 'authorization' => array( 265 | 'enable' => true, 266 | 'header' => 'Authorization', //Name of header 267 | 'handler' => '\app\models\UsersModel', 268 | ), 269 | ... 270 | ); 271 | ``` 272 | 273 | ## Validation and validators 274 | You can add the necessary validators yourself in configuration file 275 | ```php 276 | array( 281 | //Validator 282 | array( 283 | 'Validator name', 284 | 'Error message', //Message on validation failure 285 | /** 286 | * @param $value validation data. 287 | * @param app\services\ValidationInterface $validation optional for nested validators. 288 | * @return bool callable must return only boolean type. 289 | */ 290 | function ($value, $validation):bool { 291 | /* Do something for validation */ 292 | } 293 | ), 294 | ), 295 | ... 296 | ); 297 | ``` 298 | or use `app\services\Validator` class in your code 299 | ```php 300 | get('validation')->registerValidator( 303 | new Validator( 304 | 'integer', //Validator name 305 | 'Must be integer type', //Error message 306 | function ($value):bool { 307 | return (!is_array($value) && preg_match('/^\d+$/', "{$value}")); 308 | } 309 | ) 310 | ); 311 | ``` 312 | example validation in your code 313 | ```php 314 | get('validation'); 317 | $validationRules = array('id' => 'integer'); 318 | $validationParams = $container->get('request')->getParams(array('id')); 319 | $validation->withRules($validationRules)->withParams($validationParams); 320 | if (!$validation->validate()) { 321 | return $container->get('response')->sendFailedValidate(); 322 | } 323 | ``` 324 | response to client looks like this: 325 | ``` 326 | Sent headers: 327 | HTTP/1.1 400 Client Error: Bad Request 328 | Content-Type: application/json 329 | ``` 330 | and JSON response 331 | ```json 332 | { 333 | "requestId": "5dd435e18743c", 334 | "requestMethod": "POST", 335 | "apiName": "my-api-method", 336 | "status": 400, 337 | "errors": { 338 | "id": "Must be integer type" 339 | }, 340 | "response": [], 341 | "request": { 342 | "id": "some string" 343 | } 344 | } 345 | ``` 346 | 347 | ## Command line interface 348 | Create example command `app/commands/ExampleCommand.php` and implement `app\services\CommandInterface` 349 | ```php 350 | container = $container; 368 | } 369 | 370 | public function getName(): string 371 | { 372 | return $this->name; 373 | } 374 | 375 | public function getStatus(): int 376 | { 377 | return $this->status; 378 | } 379 | 380 | //Help text for --help command 381 | public function getHelp() : string 382 | { 383 | return ""; 384 | } 385 | 386 | public function run() 387 | { 388 | $request = $this->container->get('request'); 389 | $param1 = $request->getParam('param1', FILTER_SANITIZE_STRING); 390 | $param2 = $request->getParam('param2', FILTER_SANITIZE_STRING); 391 | echo "{$param1} {$param2}!\r\n"; 392 | } 393 | } 394 | ``` 395 | register command in config 396 | ```php 397 | array( 398 | ... 399 | 'commands' => array( 400 | 'app\commands\ExampleCommand', 401 | ), 402 | ... 403 | ); 404 | ``` 405 | and call command in shell 406 | ```shell script 407 | # php index.php --command example --param1 Hello --param2 world 408 | Hello world! 409 | ``` -------------------------------------------------------------------------------- /app/Bootstrap.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * Project home: https://github.com/alevar88/simpleapi 8 | * 9 | * This source file is subject to the license that is bundled 10 | * with this source code in the file LICENSE. 11 | * 12 | * @copyright Copyright 2019, Alexander Varnikov , Alexander Groza 13 | * 14 | */ 15 | 16 | declare(strict_types = 1); 17 | 18 | namespace app; 19 | 20 | use app\services\AuthorizationInterface; 21 | use app\services\Config; 22 | use app\services\Console; 23 | use app\services\Container; 24 | use app\services\ContainerInterface; 25 | use app\services\Database; 26 | use app\services\Logger; 27 | use app\services\Request; 28 | use app\services\Response; 29 | use app\services\Router; 30 | use app\services\RouterInterface; 31 | use app\services\Validation; 32 | use app\services\Validator; 33 | 34 | /** 35 | * Class Bootstrap 36 | * @package app 37 | */ 38 | class Bootstrap 39 | { 40 | 41 | /** 42 | * @param array $config 43 | * @return RouterInterface 44 | */ 45 | public static function load(array $config): RouterInterface 46 | { 47 | $container = Container::getContainer(); 48 | $container->add('config', function (ContainerInterface $container) use ($config) { 49 | return new Config($config); 50 | }); 51 | $container->add('request', function (ContainerInterface $container) { 52 | return new Request($container); 53 | }); 54 | $container->add('response', function (ContainerInterface $container) { 55 | return new Response($container); 56 | }); 57 | $container->add('validation', function (ContainerInterface $container) { 58 | $validation = new Validation($container); 59 | foreach ($container->get('config')->validators as list($name, $message, $callable)) { 60 | $validation->registerValidator(new Validator($name, $message, $callable)); 61 | } 62 | return $validation; 63 | }); 64 | $container->add('database', function (ContainerInterface $container) { 65 | return new Database($container->get('config')->database); 66 | }); 67 | if ($container->get('config')->authorization['enable']) { 68 | $container->add('authorization', function (ContainerInterface $container) { 69 | $handler = $container->get('config')->authorization['handler']; 70 | if (class_exists($handler)) { 71 | $handler = new $handler($container); 72 | if (!$handler instanceof AuthorizationInterface) { 73 | die(sprintf('Authorization handler "%s" is not implement AuthorizationInterface', get_class($handler))); 74 | } 75 | return $handler; 76 | } 77 | die(sprintf('Authorization Handler "%s" not found', $handler)); 78 | }); 79 | } 80 | $container->add('logger', function (ContainerInterface $container) { 81 | return new Logger($container); 82 | }); 83 | $container->add('console', function (ContainerInterface $container) { 84 | return new Console($container); 85 | }); 86 | if (PHP_SAPI === 'cli') { 87 | $container->get('console')->dispatch(); 88 | } 89 | return new Router($container); 90 | } 91 | 92 | } -------------------------------------------------------------------------------- /app/configs/example.config.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * Project home: https://github.com/alevar88/simpleapi 8 | * 9 | * This source file is subject to the license that is bundled 10 | * with this source code in the file LICENSE. 11 | * 12 | * @copyright Copyright 2019, Alexander Varnikov , Alexander Groza 13 | * 14 | */ 15 | 16 | return array( 17 | 'allowEmptyRequests' => false, 18 | 'authorization' => array( 19 | 'enable' => false, 20 | 'header' => 'Authorization', 21 | 'handler' => 'Your handler class name witch implement AuthorizationInterface', 22 | ), 23 | 'logger' => array( 24 | 'dir' => '/logs/', 25 | 'name' => 'request.log', 26 | 'requests' => false, 27 | ), 28 | 'validators' => array( 29 | array('integer', 'Must be integer type', function ($value) { 30 | return (!is_array($value) && preg_match('/^\d+$/', "{$value}")); 31 | }), 32 | array('float', 'Must be float type', function ($value) { 33 | return (!is_array($value) && preg_match('/^\d+\.\d+$/', "{$value}")); 34 | }), 35 | array('alphanum', 'Must contains alpha or numbers', function ($value) { 36 | return (!is_array($value) && preg_match('/^[A-Za-zА-Яа-я0-9\s]+$/u', "{$value}")); 37 | }), 38 | array('alphanum_dash', 'Must contains alpha, numbers or dash', function ($value) { 39 | return (!is_array($value) && preg_match('/^[A-Za-zА-Яа-я0-9\s\-]+$/u', "{$value}")); 40 | }), 41 | array('required', 'Required', function ($value) { 42 | return (!is_array($value) && preg_match('/^.+$/', "{$value}")); 43 | }), 44 | array('array', 'Must be array type', function ($value) { 45 | return is_array($value); 46 | }), 47 | ), 48 | 'router' => array( 49 | 'escPath' => '', 50 | 'routes' => array( 51 | '/path' => array( 52 | 'handler' => 'Your controller class name', 53 | 'rules' => array( 54 | 'default' => array(), 55 | 'get' => array(), 56 | 'post' => array(), 57 | 'put' => array(), 58 | 'delete' => array(), 59 | ), 60 | ), 61 | ), 62 | ), 63 | 'commands' => array(), 64 | 'database' => array( 65 | 'dsn' => '', 66 | 'username' => '', 67 | 'password' => '', 68 | 'options' => null, 69 | 'onConnect' => function(\PDO $pdo) {} 70 | ), 71 | ); -------------------------------------------------------------------------------- /app/controllers/Controller.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * Project home: https://github.com/alevar88/simpleapi 8 | * 9 | * This source file is subject to the license that is bundled 10 | * with this source code in the file LICENSE. 11 | * 12 | * @copyright Copyright 2019, Alexander Varnikov , Alexander Groza 13 | * 14 | */ 15 | 16 | declare(strict_types = 1); 17 | 18 | namespace app\controllers; 19 | 20 | use app\services\ContainerInterface; 21 | use app\services\RequestInterface; 22 | use app\services\ResponseInterface; 23 | use app\models\Model; 24 | 25 | /** 26 | * Class Controller 27 | * @package app\controllers 28 | */ 29 | abstract class Controller 30 | { 31 | 32 | /** 33 | * @var ContainerInterface 34 | */ 35 | protected $container; 36 | 37 | /** 38 | * @var RequestInterface 39 | */ 40 | protected $request; 41 | 42 | /** 43 | * @var ResponseInterface 44 | */ 45 | protected $response; 46 | 47 | /** 48 | * Controller constructor. 49 | * @param ContainerInterface $container 50 | */ 51 | public function __construct(ContainerInterface $container) 52 | { 53 | $this->request = $container->get('request'); 54 | $this->response = $container->get('response'); 55 | $this->container = $container; 56 | } 57 | 58 | /** 59 | * @param string $model 60 | * @return Model 61 | */ 62 | protected function getModel(string $model): Model 63 | { 64 | if (!class_exists($model)) { 65 | die(sprintf('Model "%s" not found', $model)); 66 | } 67 | return new $model($this->container); 68 | } 69 | 70 | /** 71 | * Action before 72 | */ 73 | public function onRequest() {} 74 | 75 | /** 76 | * @return string 77 | */ 78 | abstract public function get(): string; 79 | 80 | /** 81 | * @return string 82 | */ 83 | abstract public function post(): string; 84 | 85 | /** 86 | * @return string 87 | */ 88 | abstract public function put(): string; 89 | 90 | /** 91 | * @return string 92 | */ 93 | abstract public function delete(): string; 94 | 95 | /** 96 | * Action after 97 | */ 98 | public function onResponse() {} 99 | 100 | } -------------------------------------------------------------------------------- /app/models/Model.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * Project home: https://github.com/alevar88/simpleapi 8 | * 9 | * This source file is subject to the license that is bundled 10 | * with this source code in the file LICENSE. 11 | * 12 | * @copyright Copyright 2019, Alexander Varnikov , Alexander Groza 13 | * 14 | */ 15 | 16 | declare(strict_types = 1); 17 | 18 | namespace app\models; 19 | 20 | use app\services\ContainerInterface; 21 | use app\services\DatabaseInterface; 22 | 23 | /** 24 | * Class Model 25 | * @package app\models 26 | */ 27 | abstract class Model 28 | { 29 | 30 | /** 31 | * @var ContainerInterface 32 | */ 33 | protected $container; 34 | 35 | /** 36 | * @var string 37 | */ 38 | protected $table; 39 | 40 | /** 41 | * @var string 42 | */ 43 | protected $pkey; 44 | 45 | /** 46 | * @var array 47 | */ 48 | protected $fields = array(); 49 | 50 | /** 51 | * @var DatabaseInterface 52 | */ 53 | protected $db; 54 | 55 | /** 56 | * @var bool 57 | */ 58 | private $isLoaded = false; 59 | 60 | /** 61 | * Model constructor. 62 | * @param ContainerInterface $container 63 | */ 64 | public function __construct(ContainerInterface $container) 65 | { 66 | $this->db = $container->get('database'); 67 | $this->db->setTable($this->table); 68 | $this->db->setPrimaryKey($this->pkey ?? 'id'); 69 | $this->container = $container; 70 | } 71 | 72 | /** 73 | * @param string $key 74 | * @return mixed|null 75 | */ 76 | public function __get(string $key) 77 | { 78 | return $this->get($key) ?? null; 79 | } 80 | 81 | /** 82 | * @param string $key 83 | * @param $value 84 | */ 85 | public function __set(string $key, $value) 86 | { 87 | $this->set($key, $value); 88 | } 89 | 90 | /** 91 | * @param string $key 92 | * @return bool 93 | */ 94 | public function __isset(string $key): bool 95 | { 96 | return $this->has($key); 97 | } 98 | 99 | /** 100 | * @param string $key 101 | * @return bool 102 | */ 103 | public function has(string $key): bool 104 | { 105 | return (in_array($key, $this->fields)); 106 | } 107 | 108 | /** 109 | * @param string $key 110 | * @return mixed|null 111 | */ 112 | public function get(string $key) 113 | { 114 | return ($this->has($key)) ? $this->{$key} : null; 115 | } 116 | 117 | /** 118 | * @param string $key 119 | * @param $value 120 | */ 121 | public function set(string $key, $value) 122 | { 123 | if ($this->has($key)) { 124 | $this->{$key} = $value; 125 | } 126 | } 127 | 128 | /** 129 | * @return bool 130 | */ 131 | public function isLoaded(): bool 132 | { 133 | return $this->isLoaded; 134 | } 135 | 136 | /** 137 | * @param array $params 138 | */ 139 | private function makeProperties(array $params = array()) 140 | { 141 | if (!empty($this->fields)) { 142 | foreach ($this->fields as $key) { 143 | if (in_array($key, array_keys($params))) { 144 | $this->{$key} = $params[$key] ?? null; 145 | } 146 | } 147 | } 148 | } 149 | 150 | /** 151 | * @param array $params 152 | * @return ModelsCollection 153 | */ 154 | public function loadAll(array $params = array()): ModelsCollection 155 | { 156 | if (empty($params)) { 157 | $params = $this->container->get('request')->getParams(); 158 | } 159 | $this->makeProperties($params); 160 | $collection = new ModelsCollection; 161 | $results = $this->db->get($this->toArray()); 162 | if (!empty($results)) { 163 | foreach ($results as $result) { 164 | foreach ($result as $key => $value) { 165 | $this->{$key} = $value; 166 | } 167 | $this->isLoaded = true; 168 | $collection->addToCollection($this); 169 | } 170 | } else { 171 | $collection->addToCollection($this); 172 | } 173 | return $collection; 174 | } 175 | 176 | /** 177 | * @param array $params 178 | * @return Model|null 179 | */ 180 | public function load(array $params = array()) 181 | { 182 | return $this->loadAll($params)->getFirstModel(); 183 | } 184 | 185 | /** 186 | * @param array $keys 187 | * @return array 188 | */ 189 | public function toArray(array $keys = array()): array 190 | { 191 | $vars = get_object_vars($this); 192 | $result = array(); 193 | foreach ($vars as $key => $value) { 194 | if (in_array($key, $this->fields)) { 195 | if (!empty($keys) && !in_array($key, $keys)) { 196 | continue; 197 | } 198 | $result[$key] = $value; 199 | } 200 | } 201 | return $result; 202 | } 203 | 204 | /** 205 | * @return void 206 | */ 207 | public function reset() 208 | { 209 | foreach ($this->fields as $key) { 210 | $this->{$key} = null; 211 | } 212 | } 213 | 214 | /** 215 | * @return void 216 | */ 217 | public function unload() 218 | { 219 | $this->isLoaded = false; 220 | } 221 | 222 | /** 223 | * @return int 224 | */ 225 | public function save(): int 226 | { 227 | if ($this->isLoaded) { 228 | return $this->db->update($this->toArray()); 229 | } 230 | return $this->db->insert($this->toArray()); 231 | } 232 | 233 | /** 234 | * @return bool 235 | */ 236 | public function delete(): bool 237 | { 238 | if ($this->isLoaded) { 239 | $result = $this->db->delete($this->toArray()); 240 | $this->reset(); 241 | } 242 | return $result ?? false; 243 | } 244 | 245 | /** 246 | * @param array $params 247 | * @return $this 248 | */ 249 | public function import(array $params): Model 250 | { 251 | foreach ($params as $key => $value) { 252 | $this->set($key, $value); 253 | } 254 | return $this; 255 | } 256 | 257 | } -------------------------------------------------------------------------------- /app/models/ModelsCollection.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * Project home: https://github.com/alevar88/simpleapi 8 | * 9 | * This source file is subject to the license that is bundled 10 | * with this source code in the file LICENSE. 11 | * 12 | * @copyright Copyright 2019, Alexander Varnikov , Alexander Groza 13 | * 14 | */ 15 | 16 | declare(strict_types = 1); 17 | 18 | namespace app\models; 19 | 20 | /** 21 | * Class ModelsCollection 22 | * @package app\models 23 | */ 24 | class ModelsCollection 25 | { 26 | 27 | /** 28 | * @var Model[] 29 | */ 30 | private $collection = array(); 31 | 32 | /** 33 | * @param Model $model 34 | * @return void 35 | */ 36 | public function addToCollection(Model $model) 37 | { 38 | $this->collection[] = $model; 39 | } 40 | 41 | /** 42 | * @return bool 43 | */ 44 | public function isEmpty(): bool 45 | { 46 | return (empty($this->collection)); 47 | } 48 | 49 | /** 50 | * @return void 51 | */ 52 | public function destroyCollection() 53 | { 54 | $this->collection = array(); 55 | } 56 | 57 | /** 58 | * @return Model|null 59 | */ 60 | public function getFirstModel() 61 | { 62 | return $this->collection[0] ?? null; 63 | } 64 | 65 | /** 66 | * @param array $params 67 | * @return array 68 | */ 69 | public function toArray(array $params = array()): array 70 | { 71 | $result = array(); 72 | foreach ($this->collection as $key => $model) { 73 | if ($model->isLoaded()) { 74 | $result[] = $model->toArray($params); 75 | } 76 | } 77 | return $result; 78 | } 79 | 80 | /** 81 | * @param string $name 82 | * @param array $arguments 83 | */ 84 | public function __call(string $name, $arguments = array()) 85 | { 86 | foreach ($this->collection as $model) { 87 | if (method_exists($model, $name)) { 88 | call_user_func_array(array($model, $name), $arguments); 89 | } 90 | } 91 | } 92 | 93 | } -------------------------------------------------------------------------------- /app/services/AuthorizationInterface.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * Project home: https://github.com/alevar88/simpleapi 8 | * 9 | * This source file is subject to the license that is bundled 10 | * with this source code in the file LICENSE. 11 | * 12 | * @copyright Copyright 2019, Alexander Varnikov , Alexander Groza 13 | * 14 | */ 15 | 16 | declare(strict_types = 1); 17 | 18 | namespace app\services; 19 | 20 | /** 21 | * Interface AuthorizationInterface 22 | * @package app\services 23 | */ 24 | interface AuthorizationInterface 25 | { 26 | 27 | /** 28 | * AuthorizationInterface constructor. 29 | * @param ContainerInterface $container 30 | */ 31 | public function __construct(ContainerInterface $container); 32 | 33 | /** 34 | * @return bool 35 | */ 36 | public function isAuth(): bool; 37 | 38 | } -------------------------------------------------------------------------------- /app/services/CommandInterface.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * Project home: https://github.com/alevar88/simpleapi 8 | * 9 | * This source file is subject to the license that is bundled 10 | * with this source code in the file LICENSE. 11 | * 12 | * @copyright Copyright 2019, Alexander Varnikov , Alexander Groza 13 | * 14 | */ 15 | 16 | declare(strict_types = 1); 17 | 18 | namespace app\services; 19 | 20 | /** 21 | * Interface CommandInterface 22 | * @package app\services 23 | */ 24 | interface CommandInterface 25 | { 26 | 27 | /** 28 | * CommandInterface constructor. 29 | * @param ContainerInterface $container 30 | */ 31 | public function __construct(ContainerInterface $container); 32 | 33 | /** 34 | * @return string 35 | */ 36 | public function getName(): string; 37 | 38 | /** 39 | * @return int 40 | */ 41 | public function getStatus(): int; 42 | 43 | /** 44 | * @return string 45 | */ 46 | public function getHelp(): string; 47 | 48 | /** 49 | * @return void 50 | */ 51 | public function run(); 52 | 53 | } -------------------------------------------------------------------------------- /app/services/Config.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * Project home: https://github.com/alevar88/simpleapi 8 | * 9 | * This source file is subject to the license that is bundled 10 | * with this source code in the file LICENSE. 11 | * 12 | * @copyright Copyright 2019, Alexander Varnikov , Alexander Groza 13 | * 14 | */ 15 | 16 | declare(strict_types = 1); 17 | 18 | namespace app\services; 19 | 20 | /** 21 | * Class Config 22 | * @package app\services 23 | */ 24 | class Config implements ConfigInterface 25 | { 26 | 27 | /** 28 | * @var array 29 | */ 30 | private $config = array(); 31 | 32 | /** 33 | * Config constructor. 34 | * @param array $config 35 | */ 36 | public function __construct(array $config) 37 | { 38 | $this->config = $config; 39 | } 40 | 41 | /** 42 | * @param $name 43 | * @return bool 44 | */ 45 | public function has($name): bool 46 | { 47 | return (isset($this->config[$name])); 48 | } 49 | 50 | /** 51 | * @param $name 52 | * @return mixed|null 53 | */ 54 | public function __get($name) 55 | { 56 | return $this->config[$name] ?? null; 57 | } 58 | 59 | /** 60 | * @param $name 61 | * @return bool 62 | */ 63 | public function __isset($name): bool 64 | { 65 | return $this->has($name); 66 | } 67 | 68 | } -------------------------------------------------------------------------------- /app/services/ConfigInterface.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * Project home: https://github.com/alevar88/simpleapi 8 | * 9 | * This source file is subject to the license that is bundled 10 | * with this source code in the file LICENSE. 11 | * 12 | * @copyright Copyright 2019, Alexander Varnikov , Alexander Groza 13 | * 14 | */ 15 | 16 | declare(strict_types = 1); 17 | 18 | namespace app\services; 19 | 20 | /** 21 | * Interface ConfigInterface 22 | * @package app\services 23 | */ 24 | interface ConfigInterface 25 | { 26 | 27 | /** 28 | * ConfigInterface constructor. 29 | * @param array $config 30 | */ 31 | public function __construct(array $config); 32 | 33 | /** 34 | * @param $name 35 | * @return bool 36 | */ 37 | public function has($name): bool; 38 | 39 | /** 40 | * @param $name 41 | * @return mixed 42 | */ 43 | public function __get($name); 44 | 45 | /** 46 | * @param $name 47 | * @return bool 48 | */ 49 | public function __isset($name): bool; 50 | 51 | } -------------------------------------------------------------------------------- /app/services/Console.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * Project home: https://github.com/alevar88/simpleapi 8 | * 9 | * This source file is subject to the license that is bundled 10 | * with this source code in the file LICENSE. 11 | * 12 | * @copyright Copyright 2019, Alexander Varnikov , Alexander Groza 13 | * 14 | */ 15 | 16 | declare(strict_types = 1); 17 | 18 | namespace app\services; 19 | 20 | /** 21 | * Class Console 22 | * @package app\services 23 | */ 24 | class Console implements ConsoleInterface 25 | { 26 | 27 | /** 28 | * @var ContainerInterface 29 | */ 30 | private $container; 31 | 32 | /** 33 | * @var array 34 | */ 35 | private $commands = array(); 36 | 37 | /** 38 | * Commands constructor. 39 | * @param ContainerInterface $container 40 | */ 41 | public function __construct(ContainerInterface $container) 42 | { 43 | $commands = $container->get('config')->commands ?? array(); 44 | foreach ($commands as $command) { 45 | $this->registerCommand(new $command($container)); 46 | } 47 | $this->container = $container; 48 | } 49 | 50 | /** 51 | * @param CommandInterface $command 52 | * @return ConsoleInterface 53 | */ 54 | public function registerCommand(CommandInterface $command): ConsoleInterface 55 | { 56 | $this->commands[$command->getName()] = $command; 57 | return $this; 58 | } 59 | 60 | /** 61 | * @param string $name 62 | * @return bool 63 | */ 64 | public function hasCommand(string $name): bool 65 | { 66 | return (isset($this->commands[$name])); 67 | } 68 | 69 | /** 70 | * @param string $name 71 | * @return CommandInterface 72 | */ 73 | public function getCommand(string $name): CommandInterface 74 | { 75 | return $this->commands[$name] ?? null; 76 | } 77 | 78 | /** 79 | * @return bool 80 | */ 81 | public function isEmptyCommands(): bool 82 | { 83 | return (empty($this->commands)); 84 | } 85 | 86 | /** 87 | * @return array 88 | */ 89 | private function getLongOptions(): array 90 | { 91 | $longOptions = array('commands', 'help', 'command:'); 92 | foreach ($_SERVER['argv'] as $arg) { 93 | if (preg_match('/^--.+$/', $arg)) { 94 | $arg = str_replace('--', '', $arg); 95 | $longOptions[] = "{$arg}:"; 96 | } 97 | } 98 | return $longOptions; 99 | } 100 | 101 | /** 102 | * Run command 103 | * 104 | * @return void 105 | */ 106 | public function dispatch() 107 | { 108 | $options = getopt('', $this->getLongOptions()); 109 | if (isset($options['commands'])) { 110 | echo 'Registered commands: ' . join(', ', array_keys($this->commands)) . PHP_EOL; 111 | exit(0); 112 | } 113 | $command = $options['command'] ?? ''; 114 | if (!empty($command)) { 115 | unset($options['command']); 116 | if ($this->hasCommand($command)) { 117 | foreach ($options as $key => $value) { 118 | $this->container->get('request')->{$key} = $value; 119 | } 120 | $command = $this->getCommand($command); 121 | if (isset($options['help'])) { 122 | echo $command->getHelp() . PHP_EOL; 123 | exit(0); 124 | } 125 | ob_start(); 126 | $command->run(); 127 | $output = ob_get_contents(); 128 | ob_clean(); 129 | if (!empty($output)) { 130 | echo $output; 131 | } 132 | exit($command->getStatus()); 133 | } 134 | } 135 | echo sprintf("Command %s not found\n", $command); 136 | exit(1); 137 | } 138 | 139 | } -------------------------------------------------------------------------------- /app/services/ConsoleInterface.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * Project home: https://github.com/alevar88/simpleapi 8 | * 9 | * This source file is subject to the license that is bundled 10 | * with this source code in the file LICENSE. 11 | * 12 | * @copyright Copyright 2019, Alexander Varnikov , Alexander Groza 13 | * 14 | */ 15 | 16 | declare(strict_types = 1); 17 | 18 | namespace app\services; 19 | 20 | /** 21 | * Interface ConsoleInterface 22 | * @package app\services 23 | */ 24 | interface ConsoleInterface 25 | { 26 | 27 | /** 28 | * ConsoleInterface constructor. 29 | * @param ContainerInterface $container 30 | */ 31 | public function __construct(ContainerInterface $container); 32 | 33 | /** 34 | * @param CommandInterface $command 35 | * @return ConsoleInterface 36 | */ 37 | public function registerCommand(CommandInterface $command): ConsoleInterface; 38 | 39 | /** 40 | * @param string $name 41 | * @return bool 42 | */ 43 | public function hasCommand(string $name): bool; 44 | 45 | /** 46 | * @param string $name 47 | * @return CommandInterface 48 | */ 49 | public function getCommand(string $name): CommandInterface; 50 | 51 | /** 52 | * @return bool 53 | */ 54 | public function isEmptyCommands(): bool; 55 | 56 | /** 57 | * @return void 58 | */ 59 | public function dispatch(); 60 | 61 | } -------------------------------------------------------------------------------- /app/services/Container.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * Project home: https://github.com/alevar88/simpleapi 8 | * 9 | * This source file is subject to the license that is bundled 10 | * with this source code in the file LICENSE. 11 | * 12 | * @copyright Copyright 2019, Alexander Varnikov , Alexander Groza 13 | * 14 | */ 15 | 16 | declare(strict_types = 1); 17 | 18 | namespace app\services; 19 | 20 | /** 21 | * Class Container 22 | * @package app\services 23 | */ 24 | class Container implements ContainerInterface 25 | { 26 | 27 | /** 28 | * @var ContainerInterface 29 | */ 30 | private static $instance; 31 | 32 | /** 33 | * @var array 34 | */ 35 | private $container = array(); 36 | 37 | /** 38 | * Closed by Singleton 39 | */ 40 | private function __clone() {} 41 | private function __wakeup() {} 42 | private function __construct() {} 43 | 44 | /** 45 | * @return ContainerInterface 46 | */ 47 | public static function getContainer(): ContainerInterface 48 | { 49 | if (self::$instance === null) { 50 | self::$instance = new self(); 51 | } 52 | return self::$instance; 53 | } 54 | 55 | /** 56 | * @param string $name 57 | * @param callable $callable 58 | * @return void 59 | */ 60 | public function add(string $name, callable $callable) 61 | { 62 | $this->container[$name] = $callable; 63 | } 64 | 65 | /** 66 | * @param string $name 67 | * @return bool 68 | */ 69 | public function has(string $name): bool 70 | { 71 | return (isset($this->container[$name])); 72 | } 73 | 74 | /** 75 | * @param string $name 76 | * @return mixed|null 77 | */ 78 | public function get(string $name) 79 | { 80 | if ($this->has($name) && is_callable($this->container[$name])) { 81 | $this->container[$name] = call_user_func($this->container[$name], $this); 82 | } 83 | return $this->container[$name] ?? null; 84 | } 85 | 86 | } -------------------------------------------------------------------------------- /app/services/ContainerInterface.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * Project home: https://github.com/alevar88/simpleapi 8 | * 9 | * This source file is subject to the license that is bundled 10 | * with this source code in the file LICENSE. 11 | * 12 | * @copyright Copyright 2019, Alexander Varnikov , Alexander Groza 13 | * 14 | */ 15 | 16 | declare(strict_types = 1); 17 | 18 | namespace app\services; 19 | 20 | /** 21 | * Interface ContainerInterface 22 | * @package app\services 23 | */ 24 | interface ContainerInterface 25 | { 26 | 27 | /** 28 | * @return static 29 | */ 30 | public static function getContainer(): ContainerInterface; 31 | 32 | /** 33 | * @param string $name 34 | * @param callable $callable 35 | * @return void 36 | */ 37 | public function add(string $name, callable $callable); 38 | 39 | /** 40 | * @param string $name 41 | * @return mixed 42 | */ 43 | public function get(string $name); 44 | 45 | /** 46 | * @param string $name 47 | * @return bool 48 | */ 49 | public function has(string $name): bool; 50 | 51 | } -------------------------------------------------------------------------------- /app/services/Database.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * Project home: https://github.com/alevar88/simpleapi 8 | * 9 | * This source file is subject to the license that is bundled 10 | * with this source code in the file LICENSE. 11 | * 12 | * @copyright Copyright 2019, Alexander Varnikov , Alexander Groza 13 | * 14 | */ 15 | 16 | declare(strict_types = 1); 17 | 18 | namespace app\services; 19 | 20 | /** 21 | * Class Database 22 | * @package app\services 23 | */ 24 | class Database implements DatabaseInterface 25 | { 26 | 27 | /** 28 | * @var \PDO 29 | */ 30 | private $db; 31 | 32 | /** 33 | * @var string 34 | */ 35 | private $table; 36 | 37 | /** 38 | * @var string 39 | */ 40 | private $pkey = 'id'; 41 | 42 | /** 43 | * Database constructor. 44 | * @param array $config 45 | */ 46 | public function __construct(array $config) 47 | { 48 | try { 49 | $this->db = new \PDO($config['dsn'], $config['username'], $config['password'], $config['options']); 50 | if (is_callable($config['onConnect'] ?? null)) { 51 | call_user_func($config['onConnect'], $this->db); 52 | } 53 | } catch (\PDOException $e) { 54 | die($e->getMessage()); 55 | } 56 | } 57 | 58 | /** 59 | * @param string $table 60 | */ 61 | public function setTable(string $table) 62 | { 63 | $this->table = $table; 64 | } 65 | 66 | /** 67 | * @param string $pkey 68 | */ 69 | public function setPrimaryKey(string $pkey) 70 | { 71 | $this->pkey = $pkey; 72 | } 73 | 74 | /** 75 | * @return \PDO 76 | */ 77 | public function pdo(): \PDO 78 | { 79 | return $this->db; 80 | } 81 | 82 | /** 83 | * @param array $params 84 | * @return array 85 | */ 86 | public function getPlaceholder(array $params): array 87 | { 88 | $placeholder = array(array(), array()); 89 | foreach ($params as $key => $value) { 90 | if (is_array($value)) { 91 | $placeholder[0][] = "`{$key}` IN (" . rtrim(str_repeat('?,', count($value)), ',') . ")"; 92 | foreach ($value as $item) { 93 | $placeholder[1][] = $item; 94 | } 95 | } else { 96 | $placeholder[0][] = "`{$key}` = ?"; 97 | $placeholder[1][] = $value; 98 | } 99 | } 100 | return $placeholder; 101 | } 102 | 103 | /** 104 | * @param array $params 105 | * @return array 106 | */ 107 | public function get(array $params): array 108 | { 109 | list($slots, $inputs) = $this->getPlaceholder($params); 110 | $sql = sprintf("SELECT * FROM `{$this->table}` WHERE %s", join(' AND ', $slots)); 111 | $stmt = $this->db->prepare($sql); 112 | if ($stmt instanceof \PDOStatement) { 113 | $stmt->execute($inputs); 114 | $result = $stmt->fetchAll(\PDO::FETCH_ASSOC); 115 | } 116 | return $result ?? array(); 117 | } 118 | 119 | /** 120 | * @param array $params 121 | * @return int 122 | */ 123 | public function insert(array $params): int 124 | { 125 | if (in_array($this->pkey, array_keys($params))) { 126 | unset($params[$this->pkey]); 127 | } 128 | list($slots, $inputs) = $this->getPlaceholder($params); 129 | $sql = sprintf("INSERT INTO `{$this->table}` SET %s", join(', ', $slots)); 130 | $stmt = $this->db->prepare($sql); 131 | if ($stmt instanceof \PDOStatement) { 132 | $stmt->execute($inputs); 133 | $result = intval($this->db->lastInsertId()); 134 | } 135 | return $result ?? 0; 136 | } 137 | 138 | /** 139 | * @param array $params 140 | * @return int 141 | */ 142 | public function update(array $params): int 143 | { 144 | if (isset($params[$this->pkey])) { 145 | $pkey = $params[$this->pkey]; 146 | unset($params[$this->pkey]); 147 | list($slots, $inputs) = $this->getPlaceholder($params); 148 | array_push($inputs, $pkey); 149 | $sql = sprintf("UPDATE `{$this->table}` SET %s WHERE %s = ? LIMIT 1", join(', ', $slots), $this->pkey); 150 | $stmt = $this->db->prepare($sql); 151 | if ($stmt instanceof \PDOStatement) { 152 | if ($stmt->execute($inputs)) { 153 | $result = intval($pkey); 154 | } 155 | } 156 | } 157 | return $result ?? 0; 158 | } 159 | 160 | /** 161 | * @param array $params 162 | * @return bool 163 | */ 164 | public function delete(array $params): bool 165 | { 166 | if (isset($params[$this->pkey])) { 167 | $stmt = $this->db->prepare(sprintf("DELETE FROM `{$this->table}` WHERE %s = ? LIMIT 1", $this->pkey)); 168 | if ($stmt instanceof \PDOStatement) { 169 | $result = $stmt->execute(array($params[$this->pkey])); 170 | } 171 | } 172 | return $result ?? false; 173 | } 174 | 175 | } -------------------------------------------------------------------------------- /app/services/DatabaseInterface.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * Project home: https://github.com/alevar88/simpleapi 8 | * 9 | * This source file is subject to the license that is bundled 10 | * with this source code in the file LICENSE. 11 | * 12 | * @copyright Copyright 2019, Alexander Varnikov , Alexander Groza 13 | * 14 | */ 15 | 16 | declare(strict_types = 1); 17 | 18 | namespace app\services; 19 | 20 | /** 21 | * Interface DatabaseInterface 22 | * @package app\services 23 | */ 24 | interface DatabaseInterface 25 | { 26 | 27 | /** 28 | * DatabaseInterface constructor. 29 | * @param array $config 30 | */ 31 | public function __construct(array $config); 32 | 33 | /** 34 | * @param string $table 35 | * @return void 36 | */ 37 | public function setTable(string $table); 38 | 39 | /** 40 | * @param string $pkey 41 | * @return void 42 | */ 43 | public function setPrimaryKey(string $pkey); 44 | 45 | /** 46 | * @return \PDO 47 | */ 48 | public function pdo(): \PDO; 49 | 50 | /** 51 | * @param array $params 52 | * @return array 53 | */ 54 | public function getPlaceholder(array $params): array; 55 | 56 | /** 57 | * @param array $params 58 | * @return array 59 | */ 60 | public function get(array $params): array; 61 | 62 | /** 63 | * @param array $params 64 | * @return int 65 | */ 66 | public function insert(array $params): int; 67 | 68 | /** 69 | * @param array $params 70 | * @return int 71 | */ 72 | public function update(array $params): int; 73 | 74 | /** 75 | * @param array $params 76 | * @return bool 77 | */ 78 | public function delete(array $params): bool; 79 | 80 | } -------------------------------------------------------------------------------- /app/services/Logger.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * Project home: https://github.com/alevar88/simpleapi 8 | * 9 | * This source file is subject to the license that is bundled 10 | * with this source code in the file LICENSE. 11 | * 12 | * @copyright Copyright 2019, Alexander Varnikov , Alexander Groza 13 | * 14 | */ 15 | 16 | declare(strict_types = 1); 17 | 18 | namespace app\services; 19 | 20 | /** 21 | * Class Logger 22 | * @package app\services 23 | */ 24 | class Logger implements LoggerInterface 25 | { 26 | 27 | /** 28 | * @var ContainerInterface 29 | */ 30 | private $container; 31 | 32 | /** 33 | * @var string 34 | */ 35 | private $dir; 36 | 37 | /** 38 | * @var string 39 | */ 40 | private $name; 41 | 42 | /** 43 | * Logger constructor. 44 | * @param ContainerInterface $container 45 | */ 46 | public function __construct(ContainerInterface $container) 47 | { 48 | $this->dir = $container->get('config')->logger['dir']; 49 | $this->name = $container->get('config')->logger['name']; 50 | $this->container = $container; 51 | } 52 | 53 | /** 54 | * @param string $name 55 | */ 56 | public function setLogName(string $name) 57 | { 58 | $this->name = $name; 59 | } 60 | 61 | /** 62 | * @param string $message 63 | * @param string $type 64 | * @return bool 65 | */ 66 | private function toLog(string $message, string $type): bool 67 | { 68 | $format = '%s [%s] %s | %s' . PHP_EOL; 69 | $this->dir = $_SERVER['DOCUMENT_ROOT'] . $this->dir; 70 | if (file_exists($this->dir) && is_writable($this->dir)) { 71 | $message = sprintf($format, date('d.m.Y H:i:s'), $type, $_SERVER['REMOTE_ADDR'], $message); 72 | $result = (file_put_contents($this->dir . $this->name, $message, FILE_APPEND) > 0); 73 | } 74 | return $result ?? false; 75 | } 76 | 77 | /** 78 | * @param string $message 79 | * @return bool 80 | */ 81 | public function info(string $message): bool 82 | { 83 | return $this->toLog($message, 'INFO'); 84 | } 85 | 86 | /** 87 | * @param string $message 88 | * @return bool 89 | */ 90 | public function warning(string $message): bool 91 | { 92 | return $this->toLog($message, 'WARNING'); 93 | } 94 | 95 | /** 96 | * @param string $message 97 | * @return bool 98 | */ 99 | public function error(string $message): bool 100 | { 101 | return $this->toLog($message, 'ERROR'); 102 | } 103 | 104 | /** 105 | * @param string $message 106 | * @return bool 107 | */ 108 | public function debug(string $message): bool 109 | { 110 | return $this->toLog($message, 'DEBUG'); 111 | } 112 | 113 | } -------------------------------------------------------------------------------- /app/services/LoggerInterface.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * Project home: https://github.com/alevar88/simpleapi 8 | * 9 | * This source file is subject to the license that is bundled 10 | * with this source code in the file LICENSE. 11 | * 12 | * @copyright Copyright 2019, Alexander Varnikov , Alexander Groza 13 | * 14 | */ 15 | 16 | declare(strict_types = 1); 17 | 18 | namespace app\services; 19 | 20 | /** 21 | * Interface LoggerInterface 22 | * @package app\services 23 | */ 24 | interface LoggerInterface 25 | { 26 | 27 | /** 28 | * LoggerInterface constructor. 29 | * @param ContainerInterface $container 30 | */ 31 | public function __construct(ContainerInterface $container); 32 | 33 | /** 34 | * @param string $name 35 | * @return void 36 | */ 37 | public function setLogName(string $name); 38 | 39 | /** 40 | * @param string $message 41 | * @return bool 42 | */ 43 | public function info(string $message): bool; 44 | 45 | /** 46 | * @param string $message 47 | * @return bool 48 | */ 49 | public function warning(string $message): bool; 50 | 51 | /** 52 | * @param string $message 53 | * @return bool 54 | */ 55 | public function error(string $message): bool; 56 | 57 | /** 58 | * @param string $message 59 | * @return bool 60 | */ 61 | public function debug(string $message): bool; 62 | 63 | } -------------------------------------------------------------------------------- /app/services/Request.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * Project home: https://github.com/alevar88/simpleapi 8 | * 9 | * This source file is subject to the license that is bundled 10 | * with this source code in the file LICENSE. 11 | * 12 | * @copyright Copyright 2019, Alexander Varnikov , Alexander Groza 13 | * 14 | */ 15 | 16 | declare(strict_types = 1); 17 | 18 | namespace app\services; 19 | 20 | /** 21 | * Class Request 22 | * @package app\services 23 | */ 24 | class Request implements RequestInterface 25 | { 26 | 27 | /** 28 | * @var ContainerInterface 29 | */ 30 | private $container; 31 | 32 | /** 33 | * @var array 34 | */ 35 | private $request = array(); 36 | 37 | /** 38 | * @var string 39 | */ 40 | private $apiName = ''; 41 | 42 | /** 43 | * @var string 44 | */ 45 | private $requestId; 46 | 47 | /** 48 | * Request constructor. 49 | * @param ContainerInterface $container 50 | */ 51 | public function __construct(ContainerInterface $container) 52 | { 53 | $this->container = $container; 54 | $this->requestId = uniqid(); //Generate unique request ID 55 | parse_str(file_get_contents('php://input'), $this->request); 56 | } 57 | 58 | /** 59 | * @param $name 60 | * @return mixed|null 61 | */ 62 | public function __get($name) 63 | { 64 | return $this->request[$name] ?? null; 65 | } 66 | 67 | /** 68 | * @param string $name 69 | * @param mixed $value 70 | */ 71 | public function __set(string $name, $value) 72 | { 73 | $this->request[$name] = $value; 74 | } 75 | 76 | /** 77 | * @return bool 78 | */ 79 | public function isEmptyRequest(): bool 80 | { 81 | return (empty($this->request)); 82 | } 83 | 84 | /** 85 | * @param $name 86 | * @return bool 87 | */ 88 | public function has($name): bool 89 | { 90 | return (isset($this->request[$name])); 91 | } 92 | 93 | /** 94 | * @param $name 95 | * @return bool 96 | */ 97 | public function __isset($name): bool 98 | { 99 | return $this->has($name); 100 | } 101 | 102 | /** 103 | * @return string 104 | */ 105 | public function getRequestId(): string 106 | { 107 | return $this->requestId; 108 | } 109 | 110 | /** 111 | * @return string 112 | */ 113 | public function getMethod(): string 114 | { 115 | return strtoupper($_SERVER['REQUEST_METHOD'] ?? ''); 116 | } 117 | 118 | /** 119 | * @return string 120 | */ 121 | public function getPath(): string 122 | { 123 | return parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH); 124 | } 125 | 126 | /** 127 | * @param array $keys 128 | * @param array $filters 129 | * @return array 130 | */ 131 | public function getParams(array $keys = array(), array $filters = array()): array 132 | { 133 | $result = array(); 134 | foreach ($this->request as $key => $value) { 135 | if (!empty($keys) && !in_array($key, $keys)) { 136 | continue; 137 | } 138 | $result[$key] = $value; 139 | } 140 | return (!empty($filters)) ? filter_var_array($result, $filters) : $result; 141 | 142 | } 143 | 144 | /** 145 | * @param string $name 146 | * @param int $filter 147 | * @return mixed|null 148 | */ 149 | public function getParam(string $name, int $filter = FILTER_DEFAULT) 150 | { 151 | $param = $this->request[$name] ?? null; 152 | return (!is_null($param)) ? filter_var($param, $filter) : $param; 153 | } 154 | 155 | /** 156 | * @return string 157 | */ 158 | public function getToken(): string 159 | { 160 | $header = $this->container->get('config')->authorization['header'] ?? 'Authorization'; 161 | foreach (getallheaders() as $name => $value) { 162 | if ($name === $header) { 163 | $token = $value; 164 | break; 165 | } 166 | } 167 | return $token ?? ''; 168 | } 169 | 170 | /** 171 | * @param string $name 172 | */ 173 | public function setApiName(string $name) 174 | { 175 | $this->apiName = str_replace('/', '_', ltrim($name, '/'));; 176 | } 177 | 178 | /** 179 | * @return string 180 | */ 181 | public function getApiName(): string 182 | { 183 | return $this->apiName; 184 | } 185 | 186 | } -------------------------------------------------------------------------------- /app/services/RequestInterface.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * Project home: https://github.com/alevar88/simpleapi 8 | * 9 | * This source file is subject to the license that is bundled 10 | * with this source code in the file LICENSE. 11 | * 12 | * @copyright Copyright 2019, Alexander Varnikov , Alexander Groza 13 | * 14 | */ 15 | 16 | declare(strict_types = 1); 17 | 18 | namespace app\services; 19 | 20 | /** 21 | * Interface RequestInterface 22 | * @package app\services 23 | */ 24 | interface RequestInterface 25 | { 26 | 27 | /** 28 | * RequestInterface constructor. 29 | * @param ContainerInterface $container 30 | */ 31 | public function __construct(ContainerInterface $container); 32 | 33 | /** 34 | * @param $name 35 | * @return mixed 36 | */ 37 | public function __get($name); 38 | 39 | /** 40 | * @param string $name 41 | * @param mixed $value 42 | */ 43 | public function __set(string $name, $value); 44 | 45 | /** 46 | * @param $name 47 | * @return bool 48 | */ 49 | public function __isset($name): bool; 50 | 51 | /** 52 | * @return bool 53 | */ 54 | public function isEmptyRequest(): bool; 55 | 56 | /** 57 | * @return string 58 | */ 59 | public function getRequestId(): string; 60 | 61 | /** 62 | * @param $name 63 | * @return bool 64 | */ 65 | public function has($name): bool; 66 | 67 | /** 68 | * @return string 69 | */ 70 | public function getPath(): string; 71 | 72 | /** 73 | * @param array $keys 74 | * @param array $filters 75 | * @return array 76 | */ 77 | public function getParams(array $keys = array(), array $filters = array()): array; 78 | 79 | /** 80 | * @param string $name 81 | * @param int $filter 82 | * @return mixed|null 83 | */ 84 | public function getParam(string $name, int $filter = FILTER_DEFAULT); 85 | 86 | /** 87 | * @return string 88 | */ 89 | public function getMethod(): string; 90 | 91 | /** 92 | * @return string 93 | */ 94 | public function getToken(): string; 95 | 96 | /** 97 | * @param string $name 98 | * @return void 99 | */ 100 | public function setApiName(string $name); 101 | 102 | /** 103 | * @return string 104 | */ 105 | public function getApiName(): string; 106 | 107 | } -------------------------------------------------------------------------------- /app/services/Response.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * Project home: https://github.com/alevar88/simpleapi 8 | * 9 | * This source file is subject to the license that is bundled 10 | * with this source code in the file LICENSE. 11 | * 12 | * @copyright Copyright 2019, Alexander Varnikov , Alexander Groza 13 | * 14 | */ 15 | 16 | declare(strict_types = 1); 17 | 18 | namespace app\services; 19 | 20 | /** 21 | * Class Response 22 | * @package app\services 23 | */ 24 | class Response implements ResponseInterface 25 | { 26 | 27 | /** 28 | * Errors messages 29 | */ 30 | const 31 | E_CONTROLLER_NOT_FOUND = 'Controller not found', 32 | E_API_METHOD_NOT_FOUND = 'Method not found', 33 | E_HTTP_METHOD_NOT_ALLOWED = 'Method not allowed', 34 | E_NOT_FOUND = 'Not found', 35 | E_FORBIDDEN = 'Forbidden', 36 | E_BAD_TOKEN = 'Bad token', 37 | E_RECORD_ALREADY_EXISTS = 'Already exists', 38 | E_EMPTY_REQUEST_BODY = 'Request body is empty'; 39 | 40 | /** 41 | * HTTP status text 42 | */ 43 | const STATUS_TEXT = array( 44 | 100 => 'Informational: Continue', 45 | 101 => 'Informational: Switching Protocols', 46 | 102 => 'Informational: Processing', 47 | 200 => 'Successful: OK', 48 | 201 => 'Successful: Created', 49 | 202 => 'Successful: Accepted', 50 | 203 => 'Successful: Non-Authoritative Information', 51 | 204 => 'Successful: No Content', 52 | 205 => 'Successful: Reset Content', 53 | 206 => 'Successful: Partial Content', 54 | 207 => 'Successful: Multi-Status', 55 | 208 => 'Successful: Already Reported', 56 | 226 => 'Successful: IM Used', 57 | 300 => 'Redirection: Multiple Choices', 58 | 301 => 'Redirection: Moved Permanently', 59 | 302 => 'Redirection: Found', 60 | 303 => 'Redirection: See Other', 61 | 304 => 'Redirection: Not Modified', 62 | 305 => 'Redirection: Use Proxy', 63 | 306 => 'Redirection: Switch Proxy', 64 | 307 => 'Redirection: Temporary Redirect', 65 | 308 => 'Redirection: Permanent Redirect', 66 | 400 => 'Client Error: Bad Request', 67 | 401 => 'Client Error: Unauthorized', 68 | 402 => 'Client Error: Payment Required', 69 | 403 => 'Client Error: Forbidden', 70 | 404 => 'Client Error: Not Found', 71 | 405 => 'Client Error: Method Not Allowed', 72 | 406 => 'Client Error: Not Acceptable', 73 | 407 => 'Client Error: Proxy Authentication Required', 74 | 408 => 'Client Error: Request Timeout', 75 | 409 => 'Client Error: Conflict', 76 | 410 => 'Client Error: Gone', 77 | 411 => 'Client Error: Length Required', 78 | 412 => 'Client Error: Precondition Failed', 79 | 413 => 'Client Error: Request Entity Too Large', 80 | 414 => 'Client Error: Request-URI Too Long', 81 | 415 => 'Client Error: Unsupported Media Type', 82 | 416 => 'Client Error: Requested Range Not Satisfiable', 83 | 417 => 'Client Error: Expectation Failed', 84 | 418 => 'Client Error: I\'m a teapot', 85 | 419 => 'Client Error: Authentication Timeout', 86 | 422 => 'Client Error: Unprocessable Entity', 87 | 423 => 'Client Error: Locked', 88 | 424 => 'Client Error: Failed Dependency', 89 | 425 => 'Client Error: Unordered Collection', 90 | 426 => 'Client Error: Upgrade Required', 91 | 428 => 'Client Error: Precondition Required', 92 | 429 => 'Client Error: Too Many Requests', 93 | 431 => 'Client Error: Request Header Fields Too Large', 94 | 444 => 'Client Error: No Response', 95 | 449 => 'Client Error: Retry With', 96 | 450 => 'Client Error: Blocked by Windows Parental Controls', 97 | 451 => 'Client Error: Unavailable For Legal Reasons', 98 | 494 => 'Client Error: Request Header Too Large', 99 | 495 => 'Client Error: Cert Error', 100 | 496 => 'Client Error: No Cert', 101 | 497 => 'Client Error: HTTP to HTTPS', 102 | 499 => 'Client Error: Client Closed Request', 103 | 500 => 'Server Error: Internal Server Error', 104 | 501 => 'Server Error: Not Implemented', 105 | 502 => 'Server Error: Bad Gateway', 106 | 503 => 'Server Error: Service Unavailable', 107 | 504 => 'Server Error: Gateway Timeout', 108 | 505 => 'Server Error: HTTP Version Not Supported', 109 | 506 => 'Server Error: Variant Also Negotiates', 110 | 507 => 'Server Error: Insufficient Storage', 111 | 508 => 'Server Error: Loop Detected', 112 | 509 => 'Server Error: Bandwidth Limit Exceeded', 113 | 510 => 'Server Error: Not Extended', 114 | 511 => 'Server Error: Network Authentication Required', 115 | 598 => 'Server Error: Network read timeout error', 116 | 599 => 'Server Error: Network connect timeout error', 117 | ); 118 | 119 | /** 120 | * @var ContainerInterface 121 | */ 122 | private $container; 123 | 124 | /** 125 | * @var array 126 | */ 127 | private $response = array( 128 | 'requestId' => null, 129 | 'requestMethod' => 'GET', 130 | 'apiName' => null, 131 | 'status' => 200, 132 | 'errors' => array(), 133 | 'response' => array(), 134 | 'request' => array(), 135 | ); 136 | 137 | /** 138 | * Response constructor. 139 | * @param ContainerInterface $container 140 | */ 141 | public function __construct(ContainerInterface $container) 142 | { 143 | $request = $container->get('request'); 144 | $this->response['requestId'] = $request->getRequestId(); 145 | $this->response['requestMethod'] = $request->getMethod(); 146 | $this->response['request'] = $request->getParams(); 147 | $this->container = $container; 148 | } 149 | 150 | /** 151 | * @param int $code 152 | * @return ResponseInterface 153 | */ 154 | public function withCode(int $code): ResponseInterface 155 | { 156 | $this->response['status'] = $code; 157 | return $this; 158 | } 159 | 160 | /** 161 | * @param array|string $error 162 | * @return ResponseInterface 163 | */ 164 | public function withError($error): ResponseInterface 165 | { 166 | if (is_array($error)) { 167 | $this->response['errors'] = $error; 168 | } else { 169 | $this->response['errors'][] = $error; 170 | } 171 | return $this; 172 | } 173 | 174 | /** 175 | * @param array|string|int|bool|null $response 176 | * @return ResponseInterface 177 | */ 178 | public function withResponse($response): ResponseInterface 179 | { 180 | $this->response['response'] = $response; 181 | return $this; 182 | } 183 | 184 | /** 185 | * @return array 186 | */ 187 | public function getResponse(): array 188 | { 189 | return $this->response; 190 | } 191 | 192 | /** 193 | * @return string 194 | */ 195 | public function sendNotFound(): string 196 | { 197 | throw new ResponseException(self::E_NOT_FOUND, 404); 198 | } 199 | 200 | /** 201 | * @return string 202 | */ 203 | public function sendAlreadyExists(): string 204 | { 205 | throw new ResponseException(self::E_RECORD_ALREADY_EXISTS, 400); 206 | } 207 | 208 | /** 209 | * @return string 210 | */ 211 | public function sendFailedValidate(): string 212 | { 213 | throw new ResponseException($this->container->get('validation')->getErrors(), 400); 214 | } 215 | 216 | /** 217 | * @param $value 218 | * @return string 219 | */ 220 | public function sendResult($value): string 221 | { 222 | if (empty($value) || !$value) { 223 | $this->response['status'] = 400; 224 | } 225 | $this->response['response'] = $value; 226 | return $this->send(); 227 | } 228 | 229 | /** 230 | * @return string 231 | */ 232 | public function send(): string 233 | { 234 | $statusText = self::STATUS_TEXT[$this->response['status']] ?? 'Empty status text'; 235 | header('Content-Type: application/json'); 236 | header(sprintf('HTTP/1.1 %s %s', $this->response['status'], $statusText)); 237 | $this->response['apiName'] = $this->container->get('request')->getApiName(); 238 | $response = json_encode($this->response); 239 | if ($this->container->get('config')->logger['requests']) { 240 | $this->container->get('logger')->debug($response); 241 | } 242 | return $response; 243 | } 244 | 245 | } -------------------------------------------------------------------------------- /app/services/ResponseException.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * Project home: https://github.com/alevar88/simpleapi 8 | * 9 | * This source file is subject to the license that is bundled 10 | * with this source code in the file LICENSE. 11 | * 12 | * @copyright Copyright 2019, Alexander Varnikov , Alexander Groza 13 | * 14 | */ 15 | 16 | declare(strict_types = 1); 17 | 18 | namespace app\services; 19 | 20 | use Throwable; 21 | 22 | /** 23 | * Class ResponseException 24 | * @package app\services 25 | */ 26 | class ResponseException extends \LogicException 27 | { 28 | 29 | /** 30 | * ResponseException constructor. 31 | * @param array|string $message 32 | * @param int $code 33 | * @param Throwable|null $previous 34 | */ 35 | public function __construct($message, $code = 500, Throwable $previous = null) 36 | { 37 | parent::__construct((is_array($message) ? join(', ', $message) : $message), $code, $previous); 38 | $container = Container::getContainer(); 39 | /** @var ResponseInterface $response */ 40 | $response = $container->get('response')->withCode($this->getCode())->withError($message); 41 | exit($response->send()); 42 | } 43 | 44 | } -------------------------------------------------------------------------------- /app/services/ResponseInterface.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * Project home: https://github.com/alevar88/simpleapi 8 | * 9 | * This source file is subject to the license that is bundled 10 | * with this source code in the file LICENSE. 11 | * 12 | * @copyright Copyright 2019, Alexander Varnikov , Alexander Groza 13 | * 14 | */ 15 | 16 | declare(strict_types = 1); 17 | 18 | namespace app\services; 19 | 20 | /** 21 | * Interface ResponseInterface 22 | * @package app\services 23 | */ 24 | interface ResponseInterface 25 | { 26 | 27 | /** 28 | * ResponseInterface constructor. 29 | * @param ContainerInterface $container 30 | */ 31 | public function __construct(ContainerInterface $container); 32 | 33 | /** 34 | * @param int $code 35 | * @return ResponseInterface 36 | */ 37 | public function withCode(int $code): ResponseInterface; 38 | 39 | /** 40 | * @param string $error 41 | * @return ResponseInterface 42 | */ 43 | public function withError(string $error): ResponseInterface; 44 | 45 | /** 46 | * @param array|string|int|bool|null $response 47 | * @return ResponseInterface 48 | */ 49 | public function withResponse($response): ResponseInterface; 50 | 51 | /** 52 | * @return array 53 | */ 54 | public function getResponse(): array; 55 | 56 | /** 57 | * @return string 58 | */ 59 | public function send(): string; 60 | 61 | /** 62 | * @return string 63 | */ 64 | public function sendNotFound(): string; 65 | 66 | /** 67 | * @return string 68 | */ 69 | public function sendAlreadyExists(): string; 70 | 71 | /** 72 | * @return string 73 | */ 74 | public function sendFailedValidate(): string; 75 | 76 | /** 77 | * @param int|string|array|bool|null $value 78 | * @return string 79 | */ 80 | public function sendResult($value): string; 81 | 82 | } -------------------------------------------------------------------------------- /app/services/Router.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * Project home: https://github.com/alevar88/simpleapi 8 | * 9 | * This source file is subject to the license that is bundled 10 | * with this source code in the file LICENSE. 11 | * 12 | * @copyright Copyright 2019, Alexander Varnikov , Alexander Groza 13 | * 14 | */ 15 | 16 | declare(strict_types = 1); 17 | 18 | namespace app\services; 19 | 20 | use app\controllers\Controller; 21 | 22 | /** 23 | * Class Router 24 | * @package app\services 25 | */ 26 | class Router implements RouterInterface 27 | { 28 | 29 | /** 30 | * Supports HTTP methods 31 | */ 32 | const ALLOWED_HTTP_METHODS = array( 33 | 'GET', 'POST', 'PUT', 'DELETE' 34 | ); 35 | 36 | /** 37 | * @var ContainerInterface 38 | */ 39 | private $container; 40 | 41 | /** 42 | * @var RequestInterface 43 | */ 44 | private $request; 45 | 46 | /** 47 | * @var ResponseInterface 48 | */ 49 | private $response; 50 | 51 | /** 52 | * @var ValidationInterface 53 | */ 54 | private $validation; 55 | 56 | /** 57 | * @var array 58 | */ 59 | private $beforeRun = array(); 60 | 61 | /** 62 | * @var array 63 | */ 64 | private $routes = array(); 65 | 66 | /** 67 | * Escape the path before method 68 | *

/api/users - here /api is escaped path

69 | * 70 | * @var string 71 | */ 72 | private $escPath = ''; 73 | 74 | /** 75 | * Router constructor. 76 | * @param ContainerInterface $container 77 | */ 78 | public function __construct(ContainerInterface $container) 79 | { 80 | $this->routes = $container->get('config')->router['routes']; 81 | $this->escPath = $container->get('config')->router['escPath']; 82 | $this->request = $container->get('request'); 83 | $this->response = $container->get('response'); 84 | $this->validation = $container->get('validation'); 85 | $this->container = $container; 86 | } 87 | 88 | /** 89 | * @param callable $function 90 | * @return RouterInterface 91 | */ 92 | public function beforeRun(callable $function): RouterInterface 93 | { 94 | $this->beforeRun[] = $function; 95 | return $this; 96 | } 97 | 98 | /** 99 | * @param callable $function 100 | * @return RouterInterface 101 | */ 102 | public function onShutdown(callable $function): RouterInterface 103 | { 104 | register_shutdown_function(function () use ($function) { 105 | call_user_func($function, $this->container); 106 | }); 107 | return $this; 108 | } 109 | 110 | /** 111 | * Run router dispatcher 112 | * 113 | * @throws ResponseException 114 | */ 115 | public function run() 116 | { 117 | $method = $this->request->getMethod(); 118 | $path = $this->request->getPath(); 119 | if (!empty($this->escPath)) { 120 | $path = str_replace($this->escPath, '', $path); 121 | } 122 | $this->request->setApiName($path); 123 | foreach ($this->beforeRun as $function) { 124 | call_user_func($function, $this->container); 125 | } 126 | if (!in_array($method, self::ALLOWED_HTTP_METHODS)) { 127 | throw new ResponseException(Response::E_HTTP_METHOD_NOT_ALLOWED, 405); 128 | } 129 | if ($this->container->has('authorization')) { 130 | if (!$this->container->get('authorization')->isAuth()) { 131 | throw new ResponseException(Response::E_BAD_TOKEN, 401); 132 | } 133 | } 134 | if (!$this->container->get('config')->allowEmptyRequests) { 135 | if (empty($this->request->getParams())) { 136 | throw new ResponseException(Response::E_EMPTY_REQUEST_BODY, 400); 137 | } 138 | } 139 | if (isset($this->routes[$path])) { 140 | $handler = $this->routes[$path]['handler']; 141 | if (class_exists($handler)) { 142 | //Validation 143 | $rules = $this->routes[$path]['rules'] ?? array(); 144 | if ($this->validation->withRules($rules)->validate()) { 145 | /** @var Controller $controller */ 146 | $controller = new $handler($this->container); 147 | $controller->onRequest(); 148 | $response = call_user_func(array($controller, strtolower($method))); 149 | $controller->onResponse(); 150 | exit($response); 151 | } 152 | //Failed validation, send errors 153 | $this->response->sendFailedValidate(); 154 | } 155 | throw new ResponseException(Response::E_CONTROLLER_NOT_FOUND, 501); 156 | } 157 | throw new ResponseException(Response::E_API_METHOD_NOT_FOUND, 501); 158 | } 159 | 160 | } -------------------------------------------------------------------------------- /app/services/RouterInterface.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * Project home: https://github.com/alevar88/simpleapi 8 | * 9 | * This source file is subject to the license that is bundled 10 | * with this source code in the file LICENSE. 11 | * 12 | * @copyright Copyright 2019, Alexander Varnikov , Alexander Groza 13 | * 14 | */ 15 | 16 | declare(strict_types = 1); 17 | 18 | namespace app\services; 19 | 20 | /** 21 | * Interface RouterInterface 22 | * @package app\services 23 | */ 24 | interface RouterInterface 25 | { 26 | 27 | /** 28 | * RouterInterface constructor. 29 | * @param ContainerInterface $container 30 | */ 31 | public function __construct(ContainerInterface $container); 32 | 33 | /** 34 | * @param callable $function 35 | * @return RouterInterface 36 | */ 37 | public function beforeRun(callable $function): RouterInterface; 38 | 39 | /** 40 | * @param callable $function 41 | * @return RouterInterface 42 | */ 43 | public function onShutdown(callable $function): RouterInterface; 44 | 45 | /** 46 | * @return void; 47 | */ 48 | public function run(); 49 | 50 | } -------------------------------------------------------------------------------- /app/services/Validation.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * Project home: https://github.com/alevar88/simpleapi 8 | * 9 | * This source file is subject to the license that is bundled 10 | * with this source code in the file LICENSE. 11 | * 12 | * @copyright Copyright 2019, Alexander Varnikov , Alexander Groza 13 | * 14 | */ 15 | 16 | declare(strict_types = 1); 17 | 18 | namespace app\services; 19 | 20 | /** 21 | * Class Validation 22 | * @package app\services 23 | */ 24 | class Validation implements ValidationInterface 25 | { 26 | 27 | /** 28 | * @var ContainerInterface 29 | */ 30 | private $container; 31 | 32 | /** 33 | * @var array 34 | */ 35 | private $validators = array(); 36 | 37 | /** 38 | * @var array 39 | */ 40 | private $errors = array(); 41 | 42 | /** 43 | * @var array 44 | */ 45 | private $rules = array(); 46 | 47 | /** 48 | * @var array 49 | */ 50 | private $params = array(); 51 | 52 | /** 53 | * Validation constructor. 54 | * @param ContainerInterface $container 55 | */ 56 | public function __construct(ContainerInterface $container) 57 | { 58 | $this->params = $container->get('request')->getParams(); 59 | $this->container = $container; 60 | } 61 | 62 | /** 63 | * @param ValidatorInterface $validator 64 | */ 65 | public function registerValidator(ValidatorInterface $validator) 66 | { 67 | $this->validators[$validator->getName()] = $validator($this); 68 | } 69 | 70 | /** 71 | * @param string $name 72 | * @return mixed|null 73 | */ 74 | public function getValidator(string $name) 75 | { 76 | return $this->validators[$name] ?? null; 77 | } 78 | 79 | /** 80 | * @param string $key 81 | * @param string $message 82 | */ 83 | private function addError(string $key, string $message) 84 | { 85 | $this->errors[$key] = $message; 86 | } 87 | 88 | /** 89 | * @return array 90 | */ 91 | public function getErrors(): array 92 | { 93 | return $this->errors; 94 | } 95 | 96 | /** 97 | * @param array $rules 98 | * @return ValidationInterface 99 | */ 100 | public function withRules(array $rules = array()): ValidationInterface 101 | { 102 | if (!empty($rules)) { 103 | $methods = array_map('strtolower', Router::ALLOWED_HTTP_METHODS); 104 | array_push($methods, 'default'); 105 | foreach ($rules as $key => $value) { 106 | if (!in_array($key, $methods)) { 107 | $this->rules[$key] = $value; 108 | } elseif (in_array($key, array('default', strtolower($this->container->get('request')->getMethod())))) { 109 | $this->rules = array_merge($this->rules, $value); 110 | } 111 | } 112 | } 113 | return $this; 114 | } 115 | 116 | /** 117 | * @param array $params 118 | * @return ValidationInterface 119 | */ 120 | public function withParams(array $params): ValidationInterface 121 | { 122 | $this->params = $params; 123 | return $this; 124 | } 125 | 126 | /** 127 | * @return bool 128 | */ 129 | public function validate(): bool 130 | { 131 | if (!empty($this->params)) { 132 | foreach ($this->rules as $key => $value) { 133 | $rules = explode('|', $value); 134 | foreach($rules as $rule) { 135 | $validator = $this->getValidator($rule); 136 | if ($validator instanceof ValidatorInterface) { 137 | if (isset($this->params[$key])) { 138 | if (!$validator->validate($this->params[$key])) { 139 | $this->addError($key, $validator->getMessage()); 140 | continue 2; 141 | } 142 | } elseif ($value === 'required') { 143 | $this->addError($key, $validator->getMessage()); 144 | } 145 | } 146 | } 147 | } 148 | } 149 | return (empty($this->getErrors())); 150 | } 151 | 152 | } -------------------------------------------------------------------------------- /app/services/ValidationInterface.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * Project home: https://github.com/alevar88/simpleapi 8 | * 9 | * This source file is subject to the license that is bundled 10 | * with this source code in the file LICENSE. 11 | * 12 | * @copyright Copyright 2019, Alexander Varnikov , Alexander Groza 13 | * 14 | */ 15 | 16 | declare(strict_types = 1); 17 | 18 | namespace app\services; 19 | 20 | /** 21 | * Interface ValidationInterface 22 | * @package app\services 23 | */ 24 | interface ValidationInterface 25 | { 26 | 27 | /** 28 | * ValidationInterface constructor. 29 | * @param ContainerInterface $container 30 | */ 31 | public function __construct(ContainerInterface $container); 32 | 33 | /** 34 | * @param ValidatorInterface $validator 35 | * @return mixed 36 | */ 37 | public function registerValidator(ValidatorInterface $validator); 38 | 39 | /** 40 | * @param string $name 41 | * @return ValidatorInterface 42 | */ 43 | public function getValidator(string $name); 44 | 45 | /** 46 | * @return array 47 | */ 48 | public function getErrors(): array; 49 | 50 | /** 51 | * @param array $rules 52 | * @return ValidationInterface 53 | */ 54 | public function withRules(array $rules = array()): ValidationInterface; 55 | 56 | /** 57 | * @param array $params 58 | * @return ValidationInterface 59 | */ 60 | public function withParams(array $params): ValidationInterface; 61 | 62 | /** 63 | * @return bool 64 | */ 65 | public function validate(); 66 | 67 | } -------------------------------------------------------------------------------- /app/services/Validator.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * Project home: https://github.com/alevar88/simpleapi 8 | * 9 | * This source file is subject to the license that is bundled 10 | * with this source code in the file LICENSE. 11 | * 12 | * @copyright Copyright 2019, Alexander Varnikov , Alexander Groza 13 | * 14 | */ 15 | 16 | declare(strict_types = 1); 17 | 18 | namespace app\services; 19 | 20 | /** 21 | * Class Validator 22 | * @package app\services 23 | */ 24 | class Validator implements ValidatorInterface 25 | { 26 | 27 | /** 28 | * @var string 29 | */ 30 | private $name; 31 | 32 | /** 33 | * @var string 34 | */ 35 | private $message; 36 | 37 | /** 38 | * @var callable 39 | */ 40 | private $callable; 41 | 42 | /** 43 | * @var ValidationInterface 44 | */ 45 | private $validation; 46 | 47 | /** 48 | * Validation constructor. 49 | * @param string $name 50 | * @param string $message 51 | * @param callable $callable 52 | */ 53 | public function __construct(string $name, string $message, callable $callable) 54 | { 55 | $this->name = $name; 56 | $this->message = $message; 57 | $this->callable = $callable; 58 | } 59 | 60 | /** 61 | * @param ValidationInterface $validation 62 | * @return ValidatorInterface 63 | */ 64 | public function __invoke(ValidationInterface $validation): ValidatorInterface 65 | { 66 | $this->validation = $validation; 67 | return $this; 68 | } 69 | 70 | /** 71 | * @return string 72 | */ 73 | public function getName(): string 74 | { 75 | return $this->name; 76 | } 77 | 78 | /** 79 | * @return string 80 | */ 81 | public function getMessage(): string 82 | { 83 | return $this->message; 84 | } 85 | 86 | /** 87 | * @param mixed $value 88 | * @return bool 89 | */ 90 | public function validate($value): bool 91 | { 92 | return (bool)call_user_func_array($this->callable, array($value, $this->validation)); 93 | } 94 | 95 | } -------------------------------------------------------------------------------- /app/services/ValidatorInterface.php: -------------------------------------------------------------------------------- 1 | 6 | * 7 | * Project home: https://github.com/alevar88/simpleapi 8 | * 9 | * This source file is subject to the license that is bundled 10 | * with this source code in the file LICENSE. 11 | * 12 | * @copyright Copyright 2019, Alexander Varnikov , Alexander Groza 13 | * 14 | */ 15 | 16 | declare(strict_types = 1); 17 | 18 | namespace app\services; 19 | 20 | /** 21 | * Interface ValidatorInterface 22 | * @package app\services 23 | */ 24 | interface ValidatorInterface 25 | { 26 | 27 | /** 28 | * ValidationInterface constructor. 29 | * @param string $name 30 | * @param string $message 31 | * @param callable $callable 32 | */ 33 | public function __construct(string $name, string $message, callable $callable); 34 | 35 | /** 36 | * @param ValidationInterface $validation 37 | * @return mixed 38 | */ 39 | public function __invoke(ValidationInterface $validation): ValidatorInterface; 40 | 41 | /** 42 | * @return string 43 | */ 44 | public function getName(): string; 45 | 46 | /** 47 | * @return string 48 | */ 49 | public function getMessage(): string; 50 | 51 | /** 52 | * @param mixed $value 53 | * @return bool 54 | */ 55 | public function validate($value): bool; 56 | 57 | } -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "autoload": { 3 | "psr-4": { 4 | "app\\": "app" 5 | } 6 | } 7 | } 8 | --------------------------------------------------------------------------------