├── .gitignore ├── LICENSE ├── README.md ├── composer.json ├── src ├── CurlClient.php ├── DataApi.php ├── DataApiInterface.php ├── Exception │ └── Exception.php └── Response.php └── tests └── DataApiSimpleTest.php /.gitignore: -------------------------------------------------------------------------------- 1 | vendor 2 | composer.lock 3 | .idea 4 | -------------------------------------------------------------------------------- /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 | Lesterius (Claris) FileMaker 19 Data API wrapper - myFMApiLibrary for PHP 2 | ======================= 3 | 4 | # Presentation 5 | 6 | ## Team 7 | [Lesterius](https://www.lesterius.com "Lesterius") is a European Claris (FileMaker) Business Alliance Platinum member that operates in Belgium, France, the Netherlands, Portugal and Spain. We are creative business consultants who co-create FileMaker Platform based solutions with our customers.\ 8 | Sharing knowledge takes part of our DNA, that's why we developed this library to make the FileMaker Data API easy-to-use with PHP.\ 9 | Break the limits of your application!\ 10 | ![Lesterius logo](http://i1.createsend1.com/ei/r/29/D33/DFF/183501/csfinal/Mailing_Lesterius-logo.png "Lesterius") 11 | 12 | ## Description 13 | This library is a PHP wrapper of the (Claris) FileMaker Data API 19.
14 | 15 | You can find the PHP wrapper of the FileMaker Data API 17 on the releases <= v.1.* .
16 | You can find the PHP wrapper of the FileMaker Data API 18 on the releases <= v.2.* .
17 | 18 | You will be able to use every functions like it's documented in your FileMaker server Data Api documentation (accessible via https://[your server domain]/fmi/data/apidoc). 19 | General Claris document on the Data API is available [here](https://help.claris.com/en/data-api-guide/) 20 | 21 | ## Requirements 22 | 23 | - PHP >= 5.5 24 | - PHP cURL extension 25 | - PHP mb_string extension 26 | 27 | ## Installation 28 | 29 | The recommended way to install it is through [Composer](http://getcomposer.org). 30 | 31 | ```bash 32 | composer require myfmbutler/myfmapilibrary-for-php 33 | ``` 34 | 35 | After installing, you need to require Composer's autoloader: 36 | 37 | ```php 38 | require_once __DIR__ . '/vendor/autoload.php'; 39 | ``` 40 | 41 | # Usage 42 | 43 | ## Prepare your Claris (Filmaker) solution 44 | 45 | 1. Enable the (Claris) FileMaker Data API option on your FileMaker server admin console. 46 | 2. Create a specific user in your (Claris) FileMaker database with the 'fmrest' privilege 47 | 3. Define records & layouts access for this user 48 | 49 | ## Use the library 50 | 51 | ### Login 52 | 53 | Login with credentials: 54 | ```php 55 | $dataApi = new \Lesterius\FileMakerApi\DataApi('https://test.fmconnection.com/fmi/data', 'MyDatabase', null, 'filemaker api user', 'filemaker api password'); 56 | ``` 57 | 58 | Login with oauth: 59 | ```php 60 | $dataApi = new \Lesterius\FileMakerApi\DataApi('https://test.fmconnection.com/fmi/data', 'MyDatabase', null, null, true, 'oAuthRequestId', 'oAuthIdentifier'); 61 | ``` 62 | 63 | ### Logout 64 | 65 | ```php 66 | 67 | $dataApi->logout(); 68 | ``` 69 | 70 | ### Validate Session 71 | 72 | ```php 73 | 74 | $dataApi->validateSession(); 75 | ``` 76 | 77 | ### Create record 78 | 79 | ```php 80 | 81 | $data = [ 82 | 'FirstName' => 'John', 83 | 'LastName' => 'Doe', 84 | 'email' => 'johndoe@acme.inc', 85 | 'RepeatingField(1)' => 'Test' 86 | ]; 87 | 88 | $scripts = [ 89 | [ 90 | 'name' => 'ValidateUser', 91 | 'param' => 'johndoe@acme.inc', 92 | 'type' => Lesterius\FileMakerApi\DataApi::SCRIPT_PREREQUEST 93 | ], 94 | [ 95 | 'name' => 'SendEmail', 96 | 'param' => 'johndoe@acme.inc', 97 | 'type' => Lesterius\FileMakerApi\DataApi::SCRIPT_POSTREQUEST 98 | ] 99 | ]; 100 | 101 | $portalData = [ 102 | 'portalName or OccurenceName' => [ 103 | [ 104 | "Occurence::PortalField 1" => "Value", 105 | "Occurence::PortalField 2" => "Value", 106 | ] 107 | ] 108 | ]; 109 | 110 | try { 111 | $recordId = $dataApi->createRecord('layout name', $data, $scripts, $portalData); 112 | } catch(\Exception $e) { 113 | // handle exception 114 | } 115 | ``` 116 | 117 | ### Delete record 118 | 119 | ```php 120 | 121 | try { 122 | $dataApi->deleteRecord('layout name', $recordId, $script); 123 | } catch(\Exception $e) { 124 | // handle exception 125 | } 126 | ``` 127 | 128 | ### Edit record 129 | 130 | ```php 131 | 132 | try { 133 | $recordId = $dataApi->editRecord('layout name', $recordId, $data, $lastModificationId, $portalData, $scripts); 134 | } catch(\Exception $e) { 135 | // handle exception 136 | } 137 | ``` 138 | 139 | ### Duplicate record 140 | 141 | ```php 142 | 143 | try { 144 | $recordId = $dataApi->editRecord('layout name', $recordId, $scripts); 145 | } catch(\Exception $e) { 146 | // handle exception 147 | } 148 | ``` 149 | 150 | ### Get record 151 | 152 | ```php 153 | 154 | $portals = [ 155 | [ 156 | 'name' => 'Portal1', 157 | 'limit' => 10 158 | ], 159 | [ 160 | 'name' => 'Portal2', 161 | 'offset' => 3 162 | ] 163 | ]; 164 | 165 | try { 166 | $record = $dataApi->getRecord('layout name', $recordId, $portals, $scripts); 167 | } catch(\Exception $e) { 168 | // handle exception 169 | } 170 | ``` 171 | 172 | ### Get records 173 | 174 | ```php 175 | 176 | $sort = [ 177 | [ 178 | 'fieldName' => 'FirstName', 179 | 'sortOrder' => 'ascend' 180 | ], 181 | [ 182 | 'fieldName' => 'City', 183 | 'sortOrder' => 'descend' 184 | ] 185 | ]; 186 | 187 | try { 188 | $record = $dataApi->getRecords('layout name', $sort, $offset, $limit, $portals, $scripts); 189 | } catch(\Exception $e) { 190 | // handle exception 191 | } 192 | ``` 193 | 194 | ### Find records 195 | 196 | ```php 197 | 198 | $query = [ 199 | [ 200 | 'fields' => [ 201 | ['fieldname' => 'FirstName', 'fieldvalue' => '==Test'], 202 | ['fieldname' => 'LastName', 'fieldvalue' => '==Test'], 203 | ], 204 | 'options' => [ 205 | 'omit' => false 206 | ] 207 | ] 208 | ]; 209 | 210 | try { 211 | $results = $dataApi->findRecords('layout name', $query, $sort, $offset, $limit, $portals, $scripts, $responseLayout); 212 | } catch(\Exception $e) { 213 | // handle exception 214 | } 215 | ``` 216 | 217 | ### Set global fields 218 | 219 | ```php 220 | 221 | $data = [ 222 | 'FieldName1' => 'value', 223 | 'FieldName2' => 'value' 224 | ]; 225 | 226 | try { 227 | $dataApi->setGlobalFields('layout name', $data); 228 | } catch(\Exception $e) { 229 | // handle exception 230 | } 231 | ``` 232 | 233 | ### Execute script 234 | 235 | ```php 236 | 237 | 238 | try { 239 | $dataApi->executeScript('script name', $scriptsParams); 240 | } catch(\Exception $e) { 241 | // handle exception 242 | } 243 | ``` 244 | 245 | ### Upload file to container 246 | 247 | #### Renaming file 248 | ```php 249 | 250 | $containerFieldName = 'Picture'; 251 | $containerFieldRepetition = 1; 252 | // replace 'upload' below with the name="value" of the file input element of your web form 253 | $filepath = $_FILES['upload']['tmp_name']; 254 | $filename = $_FILES['upload']['name']; 255 | 256 | try { 257 | $dataApi->uploadToContainer('layout name', $recordId, $containerFieldName, $containerFieldRepetition, $filepath, $filename); 258 | } catch(\Exception $e) { 259 | // handle exception 260 | } 261 | ``` 262 | 263 | #### Without checking filename 264 | ```php 265 | 266 | $containerFieldName = 'Picture'; 267 | $containerFieldRepetition = 1; 268 | $filepath = '/usr/home/acme/pictures/photo.jpg'; 269 | 270 | try { 271 | $dataApi->uploadToContainer('layout name', $recordId, $containerFieldName, $containerFieldRepetition, $filepath); 272 | } catch(\Exception $e) { 273 | // handle exception 274 | } 275 | ``` 276 | 277 | ### Metadata Info 278 | 279 | #### Product Info 280 | ```php 281 | 282 | try { 283 | $dataApi->getProductInfo(); 284 | } catch(\Exception $e) { 285 | // handle exception 286 | } 287 | ``` 288 | 289 | #### Database Names 290 | ```php 291 | 292 | try { 293 | $dataApi->getDatabaseNames(); 294 | } catch(\Exception $e) { 295 | // handle exception 296 | } 297 | ``` 298 | 299 | #### Layout Names 300 | ```php 301 | 302 | try { 303 | $dataApi->getLayoutNames(); 304 | } catch(\Exception $e) { 305 | // handle exception 306 | } 307 | ``` 308 | 309 | #### Script Names 310 | ```php 311 | 312 | try { 313 | $dataApi->getScriptNames(); 314 | } catch(\Exception $e) { 315 | // handle exception 316 | } 317 | ``` 318 | 319 | #### Layout Metadata 320 | ```php 321 | 322 | try { 323 | $dataApi->getLayoutMetadata('layout name', $recordId); 324 | } catch(\Exception $e) { 325 | // handle exception 326 | } 327 | ``` 328 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "myfmbutler/myfmapilibrary-for-php", 3 | "type": "library", 4 | "description": "(Claris) FileMaker 19 API PHP wrapper", 5 | "Keywords": ["Lesterius", "FileMaker", "Claris", "API", "REST", "Database", "Wrapper"], 6 | "license": "gpl-3.0", 7 | "version": "3.0.2", 8 | "minimum-stability": "stable", 9 | "authors": [ 10 | { 11 | "name": "Lesterius", 12 | "email": "infoFR@lesterius.com", 13 | "homepage": "https://www.lesterius.com" 14 | } 15 | ], 16 | "autoload": { 17 | "psr-4": { 18 | "Lesterius\\FileMakerApi\\": "src", 19 | "Tests\\": "tests/" 20 | } 21 | }, 22 | "require": { 23 | "php" : ">=5.5.0", 24 | "ext-curl": "*", 25 | "ext-mbstring": "*" 26 | }, 27 | "require-dev": { 28 | "phpunit/phpunit": "^5.6" 29 | }, 30 | "config": { 31 | "sort-packages": true, 32 | "optimize-autoloader": true 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /src/CurlClient.php: -------------------------------------------------------------------------------- 1 | sslVerify = $sslVerify; 26 | $this->baseUrl = $apiUrl; 27 | } 28 | 29 | /** 30 | * Execute a cURL request 31 | * 32 | * @param $method 33 | * @param $url 34 | * @param array $options 35 | * 36 | * @return Response 37 | * @throws Exception 38 | */ 39 | public function request($method, $url, array $options) 40 | { 41 | $ch = curl_init(); 42 | if ($ch === false) { 43 | throw new Exception('Failed to initialize curl'); 44 | } 45 | 46 | $headers = []; 47 | $completeUrl = str_replace('%2F', '/', $this->baseUrl . curl_escape($ch, $url)); 48 | 49 | if (!$this->sslVerify) { 50 | curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0); 51 | curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0); 52 | } 53 | 54 | curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); 55 | curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true); 56 | curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method); 57 | curl_setopt($ch, CURLOPT_POST, ($method === 'POST' ? true : false)); 58 | 59 | $contentLength = 0; 60 | if (isset($options['json']) && !empty($options['json']) && $method !== 'GET') { 61 | $body = "{"; 62 | foreach ($options['json'] as $jsonOptionKey => $jsonOptionData) { 63 | $body.= json_encode($jsonOptionKey) . ':'.( $this->isJson($jsonOptionData) ? $jsonOptionData : json_encode($jsonOptionData)).','; 64 | } 65 | $body = rtrim($body, ','); 66 | $body.= "}"; 67 | 68 | if ($body === false) { 69 | throw new Exception("Failed to json encode parameters"); 70 | } 71 | 72 | curl_setopt($ch, CURLOPT_POSTFIELDS, $body); 73 | 74 | $contentLength = mb_strlen($body); 75 | } 76 | 77 | if (isset($options['file']) && !empty($options['file']) && $method === 'POST') { 78 | $cURLFile = new \CURLFile($options['file']['path'], mime_content_type($options['file']['path']), $options['file']['name']); 79 | 80 | curl_setopt($ch, CURLOPT_POSTFIELDS, ['upload' => $cURLFile]); 81 | 82 | $contentLength = false; 83 | } 84 | 85 | //-- Set headers 86 | if (!isset($options['headers']['Content-Type'])) { 87 | $options['headers']['Content-Type'] = 'application/json'; 88 | } 89 | 90 | if (!isset($options['headers']['Content-Length']) && $contentLength !== false) { 91 | $options['headers']['Content-Length'] = $contentLength; 92 | } 93 | 94 | foreach ($options['headers'] as $headerKey => $headerValue) { 95 | $headers[] = $headerKey.':'.$headerValue; 96 | } 97 | //-- 98 | 99 | curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); 100 | curl_setopt($ch, CURLOPT_HEADER, true); 101 | 102 | if (isset($options['query_params']) && !empty($options['query_params'])) { 103 | $query_params = http_build_query($options['query_params']); 104 | $completeUrl .= (!empty($query_params) ? '?'.$query_params : ''); 105 | } 106 | 107 | curl_setopt($ch, CURLOPT_URL, $completeUrl); 108 | 109 | $result = curl_exec($ch); 110 | 111 | if ($result === false) { 112 | throw new Exception(curl_error($ch), curl_errno($ch)); 113 | } 114 | 115 | $responseHeaders = substr($result, 0, curl_getinfo($ch, CURLINFO_HEADER_SIZE)); 116 | $body = substr($result, curl_getinfo($ch, CURLINFO_HEADER_SIZE)); 117 | $response = Response::parse($responseHeaders, $body); 118 | 119 | curl_close($ch); 120 | 121 | $this->validateResponse($response); 122 | 123 | return $response; 124 | } 125 | 126 | /** 127 | * @param Response $response 128 | * 129 | * @throws Exception 130 | */ 131 | private function validateResponse(Response $response) 132 | { 133 | if ($response->getHttpCode() >= 400 && $response->getHttpCode() < 600 || $response->getHttpCode() === 100) { 134 | if (isset($response->getBody()['messages'][0]['message'])) { 135 | $eMessage = is_array($response->getBody()['messages'][0]['message']) ? implode(' - ', $response->getBody()['messages'][0]['message']) : $response->getBody()['messages'][0]['message']; 136 | $eCode = isset($response->getBody()['messages'][0]['code']) ? $response->getBody()['messages'][0]['code'] : $response->getHttpCode(); 137 | 138 | throw new Exception($eMessage, $eCode); 139 | } 140 | 141 | // A status code 100 with no message is OK 142 | if ($response->getHttpCode() !== 100) { 143 | $message = is_array($response->getBody() || is_object($response->getBody()) ? 144 | json_encode($response->getBody()) : $response->getBody()); 145 | 146 | if (empty($message)) { 147 | $message = $response->getHeader('Status'); 148 | } 149 | 150 | throw new Exception($message, $response->getHttpCode()); 151 | } 152 | } 153 | } 154 | 155 | /** 156 | * @param $string 157 | * @return bool 158 | */ 159 | private function isJson($string) { 160 | json_decode($string); 161 | return (json_last_error() == JSON_ERROR_NONE); 162 | } 163 | } 164 | -------------------------------------------------------------------------------- /src/DataApi.php: -------------------------------------------------------------------------------- 1 | apiDatabase = $apiDatabase; 48 | $this->ClientRequest = new CurlClient($apiUrl, $sslVerify); 49 | $this->apiUsername = $apiUsername; 50 | $this->apiPassword = $apiPassword; 51 | $this->oAuthRequestId = $oAuthRequestId; 52 | $this->oAuthIdentifier = $oAuthIdentifier; 53 | 54 | if ((empty($apiUsername) && empty($apiPassword)) || (empty($oAuthRequestId) && empty($oAuthIdentifier))) { 55 | new \Exception("Data Api needs valid credentials [username;password] or [authRequestId;authIdentifier]"); 56 | } 57 | 58 | if (is_null($version)) { 59 | $this->version = self::LASTVERSION; 60 | } else { 61 | $this->version = $version; 62 | } 63 | 64 | // Basic default Authentication 65 | $this->login(); 66 | } 67 | 68 | // -- Start auth Part -- 69 | 70 | /** 71 | * Login to FileMaker API 72 | * 73 | * 74 | * 75 | * @return $this 76 | * @throws Exception 77 | */ 78 | public function login() 79 | { 80 | $headers = $this->getHeaderAuth(); 81 | 82 | // Send curl request 83 | $response = $this->ClientRequest->request( 84 | 'POST', 85 | "/$this->version/databases/$this->apiDatabase/sessions", 86 | [ 87 | 'headers' => $headers, 88 | 'json' => [] 89 | ] 90 | ); 91 | 92 | $this->apiToken = $response->getHeader('X-FM-Data-Access-Token'); 93 | 94 | return $this; 95 | } 96 | 97 | /** 98 | * Close the connection with FileMaker Server API 99 | * 100 | * @throws Exception 101 | */ 102 | public function logout() 103 | { 104 | // Send curl request 105 | $this->ClientRequest->request( 106 | 'DELETE', 107 | "/$this->version/databases/$this->apiDatabase/sessions/$this->apiToken", 108 | [] 109 | ); 110 | 111 | $this->apiToken = null; 112 | 113 | return $this; 114 | } 115 | 116 | /** 117 | * Validate Session 118 | * 119 | * @return bool 120 | * @throws Exception 121 | */ 122 | public function validateSession() 123 | { 124 | // Send curl request 125 | $response = $this->ClientRequest->request( 126 | 'GET', 127 | "/$this->version/validateSession", 128 | [ 129 | 'headers' => $this->getDefaultHeaders() 130 | ] 131 | ); 132 | 133 | return (isset($response->getBody()['messages'][0]['code']) && $response->getBody()['messages'][0]['code'] == "0"); 134 | } 135 | 136 | // -- End auth Part -- 137 | 138 | // -- Start records Part -- 139 | 140 | /** 141 | * Create a new record 142 | * 143 | * @param $layout 144 | * @param array $data 145 | * @param array $scripts 146 | * @param array $portalData 147 | * 148 | * @return mixed 149 | * @throws Exception 150 | */ 151 | public function createRecord($layout, array $data, array $scripts = [], array $portalData = []) 152 | { 153 | // Prepare options 154 | $jsonOptions = $this->encodeFieldData($data); 155 | 156 | if (!empty($portalData)) { 157 | $jsonOptions['portalData'] = $this->encodePortalData($portalData); 158 | } 159 | 160 | // Send curl request 161 | $response = $this->ClientRequest->request( 162 | 'POST', 163 | "/$this->version/databases/$this->apiDatabase/layouts/$layout/records", 164 | [ 165 | 'headers' => $this->getDefaultHeaders(), 166 | 'json' => array_merge( 167 | $jsonOptions, 168 | $this->prepareScriptOptions($scripts) 169 | ), 170 | ] 171 | ); 172 | 173 | return $response->getBody()['response']['recordId']; 174 | } 175 | 176 | /** 177 | * Duplicate an existing record 178 | * 179 | * @param $layout 180 | * @param $recordId 181 | * @param array $scripts 182 | * @return mixed 183 | * @throws Exception 184 | */ 185 | public function duplicateRecord($layout, $recordId, array $scripts = []) 186 | { 187 | // Send curl request 188 | $response = $this->ClientRequest->request( 189 | 'POST', 190 | "/$this->version/databases/$this->apiDatabase/layouts/$layout/records/$recordId", 191 | [ 192 | 'headers' => $this->getDefaultHeaders(), 193 | 'json' => array_merge( 194 | $this->prepareScriptOptions($scripts) 195 | ), 196 | ] 197 | ); 198 | 199 | return $response->getBody()['response']['recordId']; 200 | } 201 | 202 | /** 203 | * Edit an existing record by ID 204 | * 205 | * @param $layout 206 | * @param $recordId 207 | * @param array $data 208 | * @param null $lastModificationId 209 | * @param array $portalData 210 | * @param array $scripts 211 | * 212 | * @return mixed 213 | * @throws Exception 214 | */ 215 | public function editRecord($layout, $recordId, array $data, $lastModificationId = null, array $portalData = [], array $scripts = []) 216 | { 217 | // Prepare options 218 | $jsonOptions = $this->encodeFieldData($data); 219 | 220 | if (!empty($lastModificationId)) { 221 | $jsonOptions['modId'] = $lastModificationId; 222 | } 223 | 224 | if (!empty($portalData)) { 225 | $jsonOptions['portalData'] = $this->encodePortalData($portalData); 226 | } 227 | 228 | // Send curl request 229 | $response = $this->ClientRequest->request( 230 | 'PATCH', 231 | "/$this->version/databases/$this->apiDatabase/layouts/$layout/records/$recordId", 232 | [ 233 | 'headers' => $this->getDefaultHeaders(), 234 | 'json' => array_merge( 235 | $jsonOptions, 236 | $this->prepareScriptOptions($scripts) 237 | ), 238 | ] 239 | ); 240 | 241 | return $response->getBody()['response']['modId']; 242 | } 243 | 244 | /** 245 | * Delete record by ID 246 | * 247 | * @param $layout 248 | * @param $recordId 249 | * @param array $scripts 250 | * 251 | * @throws Exception 252 | */ 253 | public function deleteRecord($layout, $recordId, array $scripts = []) 254 | { 255 | // Send curl request 256 | $this->ClientRequest->request( 257 | 'DELETE', 258 | "/$this->version/databases/$this->apiDatabase/layouts/$layout/records/$recordId", 259 | [ 260 | 'headers' => $this->getDefaultHeaders(), 261 | 'json' => $this->prepareScriptOptions($scripts), 262 | ] 263 | ); 264 | } 265 | 266 | /** 267 | * Get record detail by ID 268 | * 269 | * @param $layout 270 | * @param $recordId 271 | * @param array $portals 272 | * @param array $scripts 273 | * 274 | * @param null $responseLayout 275 | * @return mixed 276 | * @throws Exception 277 | */ 278 | public function getRecord($layout, $recordId, array $portals = [], array $scripts = [], $responseLayout = null) 279 | { 280 | // Prepare options 281 | $jsonOptions = []; 282 | 283 | // optional parameters 284 | if (!empty($responseLayout)) { 285 | $jsonOptions['layout.response'] = $responseLayout; 286 | } 287 | 288 | // Send curl request 289 | $response = $this->ClientRequest->request( 290 | 'GET', 291 | "/$this->version/databases/$this->apiDatabase/layouts/$layout/records/$recordId", 292 | [ 293 | 'headers' => $this->getDefaultHeaders(), 294 | 'query_params' => array_merge( 295 | $jsonOptions, 296 | $this->prepareScriptOptions($scripts), 297 | $this->preparePortalsOptions($portals) 298 | ), 299 | ] 300 | ); 301 | 302 | return $response->getBody()['response']['data'][0]; 303 | } 304 | 305 | /** 306 | * Get list of records 307 | * 308 | * @param $layout 309 | * @param null $sort 310 | * @param null $offset 311 | * @param null $limit 312 | * @param array $portals 313 | * @param array $scripts 314 | * @param null $responseLayout 315 | * 316 | * @return mixed 317 | * @throws Exception 318 | */ 319 | public function getRecords($layout, $sort = null, $offset = null, $limit = null, array $portals = [], array $scripts = [], $responseLayout = null) 320 | { 321 | // Prepare options 322 | $jsonOptions = []; 323 | 324 | // Search options 325 | $this->prepareJsonOption($jsonOptions, $offset, $limit, $sort, $responseLayout, true); 326 | 327 | // Send curl request 328 | $response = $this->ClientRequest->request( 329 | 'GET', 330 | "/$this->version/databases/$this->apiDatabase/layouts/$layout/records", 331 | [ 332 | 'headers' => $this->getDefaultHeaders(), 333 | 'query_params' => array_merge( 334 | $jsonOptions, 335 | $this->prepareScriptOptions($scripts), 336 | $this->preparePortalsOptions($portals) 337 | ), 338 | ] 339 | ); 340 | 341 | return $response->getBody()['response']['data']; 342 | } 343 | 344 | /** 345 | * Find records 346 | * 347 | * @param $layout 348 | * @param $query 349 | * @param null $sort 350 | * @param null $offset 351 | * @param null $limit 352 | * @param array $portals 353 | * @param array $scripts 354 | * @param null $responseLayout 355 | * 356 | * @return mixed 357 | * @throws Exception 358 | */ 359 | public function findRecords($layout, $query, $sort = null, $offset = null, $limit = null, array $portals = [], array $scripts = [], $responseLayout = null) 360 | { 361 | // Prepare query 362 | if (!is_array($query)) { 363 | $preparedQuery = [$query]; 364 | } else { 365 | $preparedQuery = $this->prepareQueryOptions($query); 366 | } 367 | 368 | // Prepare options 369 | $jsonOptions = [ 370 | 'query' => json_encode($preparedQuery), 371 | ]; 372 | 373 | // Search options 374 | $this->prepareJsonOption($jsonOptions, $offset, $limit, $sort, $responseLayout); 375 | 376 | // Send curl request 377 | try { 378 | $response = $this->ClientRequest->request( 379 | 'POST', 380 | "/$this->version/databases/$this->apiDatabase/layouts/$layout/_find", 381 | [ 382 | 'headers' => $this->getDefaultHeaders(), 383 | 'json' => array_merge( 384 | $jsonOptions, 385 | $this->prepareScriptOptions($scripts), 386 | $this->preparePortalsOptions($portals) 387 | ), 388 | ] 389 | ); 390 | } catch (Exception $e) { 391 | if ($e->getCode() == self::FILEMAKER_NO_RECORDS) { 392 | return []; 393 | } 394 | 395 | throw $e; 396 | } 397 | 398 | return $response->getBody()['response']['data']; 399 | } 400 | 401 | // -- End records Part -- 402 | 403 | // -- Start scripts Part -- 404 | 405 | /** 406 | * Execute script alone 407 | * 408 | * @param $layout 409 | * @param $scriptName 410 | * @param null $scriptParam 411 | * @return mixed 412 | * @throws Exception 413 | */ 414 | public function executeScript($layout, $scriptName, $scriptParam = null) 415 | { 416 | // Prepare options 417 | $jsonOptions = []; 418 | 419 | // optional parameters 420 | if (!empty($scriptParam)) { 421 | $jsonOptions['script.param'] = $scriptParam; 422 | } 423 | 424 | // Send curl request 425 | $response = $this->ClientRequest->request( 426 | 'GET', 427 | "/$this->version/databases/$this->apiDatabase/layouts/$layout/script/$scriptName", 428 | [ 429 | 'headers' => $this->getDefaultHeaders(), 430 | 'query_params' => array_merge( 431 | $jsonOptions 432 | ), 433 | ] 434 | ); 435 | 436 | $result = (isset($response->getBody()['response']['scriptResult'])?$response->getBody()['response']['scriptResult']:$response->getBody()['response']['scriptError']); 437 | return $result; 438 | } 439 | 440 | // -- End scripts Part -- 441 | 442 | // -- Start container Part -- 443 | 444 | /** 445 | * Upload files into container field with or without specific repetition 446 | * 447 | * @param $layout 448 | * @param $recordId 449 | * @param $containerFieldName 450 | * @param $containerFieldRepetition 451 | * @param $filepath 452 | * @param null $filename 453 | * 454 | * @return true 455 | * 456 | * @throws Exception 457 | */ 458 | public function uploadToContainer($layout, $recordId, $containerFieldName, $containerFieldRepetition = null, $filepath, $filename = null) 459 | { 460 | // Prepare options 461 | $containerFieldRepetitionFormat = ""; 462 | 463 | if (empty($filename)) { 464 | $filename = pathinfo($filepath, PATHINFO_FILENAME).'.'.pathinfo($filepath, PATHINFO_EXTENSION); 465 | } 466 | 467 | if (!empty($containerFieldRepetition)) { 468 | $containerFieldRepetitionFormat = '/'.intval($containerFieldRepetition); 469 | } 470 | 471 | // Send curl request 472 | $this->ClientRequest->request( 473 | 'POST', 474 | "/$this->version/databases/$this->apiDatabase/layouts/$layout/records/$recordId/containers/$containerFieldName".$containerFieldRepetitionFormat, 475 | [ 476 | 'headers' => array_merge( 477 | $this->getDefaultHeaders(), 478 | ['Content-Type' => 'multipart/form-data'] 479 | ), 480 | 'file' => [ 481 | 'name' => $filename, 482 | 'path' => $filepath 483 | ] 484 | ] 485 | ); 486 | 487 | return true; 488 | } 489 | 490 | // -- End container Part -- 491 | 492 | // -- Start globals Part -- 493 | 494 | /** 495 | * Define one or multiple global fields 496 | * 497 | * @param $layout 498 | * @param array $globalFields 499 | * 500 | * @return mixed 501 | * @throws Exception 502 | */ 503 | public function setGlobalFields($layout, array $globalFields) 504 | { 505 | // Send curl request 506 | $response = $this->ClientRequest->request( 507 | 'PATCH', 508 | "/$this->version/databases/$this->apiDatabase/globals", 509 | [ 510 | 'headers' => $this->getDefaultHeaders(), 511 | 'json' => [ 512 | 'globalFields' => json_encode($globalFields), 513 | ], 514 | ] 515 | ); 516 | 517 | return $response->getBody()['response']; 518 | } 519 | 520 | // -- End globals Part -- 521 | 522 | // -- Start metadata Part -- 523 | 524 | /** 525 | * @return mixed 526 | * @throws Exception 527 | */ 528 | public function getProductInfo() 529 | { 530 | // Send curl request 531 | $response = $this->ClientRequest->request( 532 | 'GET', 533 | "/$this->version/productInfo", 534 | [ 535 | 'headers' => $this->getDefaultHeaders(), 536 | 'json' => [] 537 | ] 538 | ); 539 | 540 | return $response->getBody()['response']; 541 | } 542 | 543 | /** 544 | * @return mixed 545 | * @throws Exception 546 | */ 547 | public function getDatabaseNames() 548 | { 549 | // Send curl request 550 | $response = $this->ClientRequest->request( 551 | 'GET', 552 | "/$this->version/databases", 553 | [ 554 | 'headers' => $this->getHeaderAuth(), 555 | 'json' => [] 556 | ] 557 | ); 558 | 559 | return $response->getBody()['response']; 560 | } 561 | 562 | /** 563 | * @return mixed 564 | * @throws Exception 565 | */ 566 | public function getLayoutNames() 567 | { 568 | // Send curl request 569 | $response = $this->ClientRequest->request( 570 | 'GET', 571 | "/$this->version/databases/$this->apiDatabase/layouts", 572 | [ 573 | 'headers' => $this->getDefaultHeaders(), 574 | 'json' => [] 575 | ] 576 | ); 577 | 578 | return $response->getBody()['response']; 579 | } 580 | 581 | /** 582 | * @return mixed 583 | * @throws Exception 584 | */ 585 | public function getScriptNames() 586 | { 587 | // Send curl request 588 | $response = $this->ClientRequest->request( 589 | 'GET', 590 | "/$this->version/databases/$this->apiDatabase/scripts", 591 | [ 592 | 'headers' => $this->getDefaultHeaders(), 593 | 'json' => [] 594 | ] 595 | ); 596 | 597 | return $response->getBody()['response']; 598 | } 599 | 600 | /** 601 | * @param $layout 602 | * @param null $recordId 603 | * 604 | * @throws Exception 605 | * @return mixed 606 | */ 607 | public function getLayoutMetadata($layout, $recordId = null) 608 | { 609 | // Prepare options 610 | $jsonOptions = []; 611 | 612 | $metadataFormat = '/metadata'; 613 | 614 | if (!empty($recordId)) { 615 | $jsonOptions['recordId'] = $recordId; 616 | $metadataFormat = ''; 617 | } 618 | 619 | // Send curl request 620 | $response = $this->ClientRequest->request( 621 | 'GET', 622 | "/$this->version/databases/$this->apiDatabase/layouts/$layout".$metadataFormat, 623 | [ 624 | 'headers' => $this->getDefaultHeaders(), 625 | 'json' => array_merge( 626 | $jsonOptions 627 | ), 628 | ] 629 | ); 630 | 631 | return $response->getBody()['response']; 632 | } 633 | 634 | // -- End metadata Part -- 635 | 636 | 637 | // -- Class accessors -- 638 | 639 | /** 640 | * Get API token returned after a successful login 641 | * 642 | * @return null|string 643 | */ 644 | public function getApiToken() 645 | { 646 | return $this->apiToken; 647 | } 648 | 649 | /** 650 | * @return null 651 | */ 652 | public function getVersion() 653 | { 654 | return $this->version; 655 | } 656 | 657 | /** 658 | * @param null $version 659 | */ 660 | public function setVersion($version) 661 | { 662 | $this->version = $version; 663 | } 664 | 665 | /** 666 | * @return null 667 | */ 668 | public function getApiUsername() 669 | { 670 | return $this->apiUsername; 671 | } 672 | 673 | /** 674 | * @param null $apiUsername 675 | */ 676 | public function setApiUsername($apiUsername) 677 | { 678 | $this->apiUsername = $apiUsername; 679 | } 680 | 681 | /** 682 | * @return null 683 | */ 684 | public function getApiPassword() 685 | { 686 | return $this->apiPassword; 687 | } 688 | 689 | /** 690 | * @param null $apiPassword 691 | */ 692 | public function setApiPassword($apiPassword) 693 | { 694 | $this->apiPassword = $apiPassword; 695 | } 696 | 697 | /** 698 | * @return null 699 | */ 700 | public function getOAuthRequestId() 701 | { 702 | return $this->oAuthRequestId; 703 | } 704 | 705 | /** 706 | * @param null $oAuthRequestId 707 | */ 708 | public function setOAuthRequestId($oAuthRequestId) 709 | { 710 | $this->oAuthRequestId = $oAuthRequestId; 711 | } 712 | 713 | /** 714 | * @return null 715 | */ 716 | public function getOAuthIdentifier() 717 | { 718 | return $this->oAuthIdentifier; 719 | } 720 | 721 | /** 722 | * @param null $oAuthIdentifier 723 | */ 724 | public function setOAuthIdentifier($oAuthIdentifier) 725 | { 726 | $this->oAuthIdentifier = $oAuthIdentifier; 727 | } 728 | 729 | /** 730 | * Set API token in request headers 731 | * 732 | * @return array 733 | */ 734 | private function getDefaultHeaders() 735 | { 736 | return ['Authorization' => "Bearer $this->apiToken"]; 737 | } 738 | 739 | /** 740 | * Get header authorization for basic Auth 741 | * 742 | * @return array 743 | */ 744 | private function getHeaderBasicAuth() 745 | { 746 | return ['Authorization' => 'Basic '.base64_encode("$this->apiUsername:$this->apiPassword")]; 747 | } 748 | 749 | /** 750 | * Get header authorization for OAuth 751 | * 752 | * @return array 753 | */ 754 | private function getHeaderOAuth() 755 | { 756 | return [ 757 | 'X-FM-Data-Login-Type' => 'oauth', 758 | 'X-FM-Data-OAuth-Request-Id' => $this->oAuthRequestId, 759 | 'X-FM-Data-OAuth-Identifier' => $this->oAuthIdentifier, 760 | ]; 761 | } 762 | 763 | /** 764 | * Get Header switch to parameters 765 | * 766 | * @return array 767 | */ 768 | private function getHeaderAuth() 769 | { 770 | $headers = []; 771 | if (!empty($this->apiUsername)) { 772 | $headers = $this->getHeaderBasicAuth(); 773 | } 774 | 775 | if (!empty($this->oAuthRequestId)) { 776 | $headers = $this->getHeaderOAuth(); 777 | } 778 | 779 | return $headers; 780 | } 781 | 782 | // -- Options worker functions -- 783 | 784 | /** 785 | * Prepare options fields for query 786 | * 787 | * @param array $query 788 | * @return array 789 | */ 790 | private function prepareQueryOptions(array $query) 791 | { 792 | $preparedQuery = []; 793 | foreach ($query as $queryItem) { 794 | if (!isset($queryItem['fields'])) { 795 | break; 796 | } 797 | 798 | $item = []; 799 | foreach ($queryItem['fields'] as $field) { 800 | $item[$field['fieldname']] = $field['fieldvalue']; 801 | } 802 | 803 | if (isset($queryItem['options']['omit']) && $queryItem['options']['omit'] == true) { 804 | $preparedQuery[] = array_merge($item, ['omit' => "true"]); 805 | } else { 806 | $preparedQuery[] = $item; 807 | } 808 | } 809 | 810 | return $preparedQuery; 811 | } 812 | 813 | /** 814 | * Prepare options for script 815 | * 816 | * @param array $scripts 817 | * 818 | * @return array 819 | */ 820 | private function prepareScriptOptions(array $scripts) 821 | { 822 | $preparedScript = []; 823 | foreach ($scripts as $script) { 824 | if (!in_array($script['type'], [self::SCRIPT_POSTREQUEST, self::SCRIPT_PREREQUEST, self::SCRIPT_PRESORT])) { 825 | continue; 826 | } 827 | 828 | $scriptSuffix = !($script['type'] === self::SCRIPT_POSTREQUEST) ? '.'.$script['type'] : ''; 829 | 830 | $preparedScript['script'.$scriptSuffix] = $script['name']; 831 | $preparedScript['script'.$scriptSuffix.'.param'] = $script['param']; 832 | } 833 | 834 | return $preparedScript; 835 | } 836 | 837 | /** 838 | * Prepare options for portals 839 | * 840 | * @param array $portals 841 | * 842 | * @return array 843 | */ 844 | private function preparePortalsOptions(array $portals) 845 | { 846 | if (empty($portals)) { 847 | return []; 848 | } 849 | 850 | $portalList = []; 851 | 852 | foreach ($portals as $portal) { 853 | $portalList[] = $portal['name']; 854 | 855 | if (isset($portal['offset'])) { 856 | $options['offset.'.$portal['name']] = intval($portal['offset']); 857 | } 858 | 859 | if (isset($portal['limit'])) { 860 | $options['limit.'.$portal['name']] = intval($portal['limit']); 861 | } 862 | } 863 | 864 | $options['portal'] = json_encode($portalList); 865 | 866 | return $options; 867 | } 868 | 869 | /** 870 | * Json encode array with array_map options, for fieldData param 871 | * 872 | * @param array $data 873 | * @return array 874 | */ 875 | private function encodeFieldData(array $data) 876 | { 877 | return [ 878 | 'fieldData' => json_encode(array_map('\strval', $data)), 879 | ]; 880 | } 881 | 882 | /** 883 | * Normal json encode array 884 | * 885 | * @param array $portal 886 | * @return string 887 | */ 888 | private function encodePortalData(array $portal) 889 | { 890 | return json_encode($portal); 891 | } 892 | 893 | /** 894 | * Prepare recurrent options for requests 895 | * 896 | * @param array $jsonOptions 897 | * @param null $offset 898 | * @param null $limit 899 | * @param null $sort 900 | * @param null $responseLayout 901 | * @param bool $withUnderscore 902 | */ 903 | private function prepareJsonOption(array &$jsonOptions = [], $offset = null, $limit = null, $sort = null, $responseLayout = null, $withUnderscore = false) 904 | { 905 | $additionalCharacter = ($withUnderscore ? '_' : ''); 906 | 907 | if (!empty($offset)) { 908 | $jsonOptions[$additionalCharacter.'offset'] = intval($offset); 909 | } 910 | 911 | if (!empty($limit)) { 912 | $jsonOptions[$additionalCharacter.'limit'] = intval($limit); 913 | } 914 | 915 | if (!empty($sort)) { 916 | $jsonOptions[$additionalCharacter.'sort'] = (is_array($sort) ? json_encode($sort) : $sort); 917 | } 918 | 919 | if (!empty($responseLayout)) { 920 | $jsonOptions['layout.response'] = $responseLayout; 921 | } 922 | } 923 | } 924 | -------------------------------------------------------------------------------- /src/DataApiInterface.php: -------------------------------------------------------------------------------- 1 | setHeaders($headers); 40 | $this->body = $body; 41 | $this->responseType = is_array($body) ? self::RESPONSE_TYPE_JSON : self::RESPONSE_TYPE_TEXT; 42 | } 43 | 44 | /** 45 | * @param string $headers 46 | * @param string $body 47 | * 48 | * @return self 49 | * @throws Exception 50 | */ 51 | public static function parse($headers, $body) 52 | { 53 | return new self(self::parseHeaders($headers), self::parseBody($body)); 54 | } 55 | 56 | /** 57 | * @param array $headers 58 | * 59 | * @return Response 60 | * @throws Exception 61 | */ 62 | public function setHeaders($headers) 63 | { 64 | if (!is_array($headers)) { 65 | throw new Exception(); 66 | } 67 | 68 | $this->headers = $headers; 69 | 70 | return $this; 71 | } 72 | 73 | /** 74 | * @param $header 75 | * 76 | * @return mixed 77 | * @throws Exception 78 | */ 79 | public function getHeader($header) 80 | { 81 | if (isset($this->headers[$header])) { 82 | return $this->headers[$header]; 83 | } 84 | 85 | throw new Exception("Header not found"); 86 | } 87 | 88 | /** 89 | * @return int 90 | * @throws Exception 91 | */ 92 | public function getHttpCode() 93 | { 94 | $httpHeader = $this->getHeader('Status'); 95 | $httpHeader = explode(" ", $httpHeader); 96 | 97 | return (int)$httpHeader[1]; 98 | } 99 | 100 | /** 101 | * @param bool $raw 102 | * 103 | * @return string 104 | */ 105 | public function getBody($raw = false) 106 | { 107 | if (!$raw) { 108 | return $this->body; 109 | } 110 | 111 | return ($this->responseType === self::RESPONSE_TYPE_JSON) ? json_encode($this->body) : $this->body; 112 | } 113 | 114 | /** 115 | * @param $headers 116 | * 117 | * @return array 118 | */ 119 | private static function parseHeaders($headers) 120 | { 121 | // We convert the raw header string into an array 122 | $headers = explode("\n", $headers); 123 | $headers = array_map(function ($header) { 124 | $exploded = explode(":", $header, 2); 125 | 126 | return array_map(function ($value) { 127 | return trim($value); 128 | }, $exploded); 129 | }, $headers); 130 | 131 | // We remove empty lines in array 132 | $headers = array_filter($headers, function ($value) { 133 | return (is_array($value) ? $value[0] : $value) !== ''; 134 | }); 135 | 136 | // Lastly, we clean the array format to be a key => value array 137 | // The response code is special as there is no key. We handle it differently 138 | $statusHeader = []; 139 | foreach ($headers as $index => $header) { 140 | if (isset($header[1])) { 141 | break; 142 | } 143 | 144 | $statusHeader = [ 145 | 'Status' => $header[0], 146 | ]; 147 | unset($headers[$index]); 148 | } 149 | $processedHeaders = $statusHeader; 150 | 151 | foreach ($headers as $header) { 152 | if (!isset($header[1])) { 153 | continue; 154 | } 155 | 156 | $processedHeaders[$header[0]] = $header[1]; 157 | } 158 | 159 | return $processedHeaders; 160 | } 161 | 162 | /** 163 | * @param $body 164 | * 165 | * @return mixed 166 | */ 167 | private static function parseBody($body) 168 | { 169 | return self::isJson($body) ? json_decode($body, true) : $body; 170 | } 171 | 172 | 173 | private static function isJson($string) 174 | { 175 | return json_decode($string, true) !== null; 176 | } 177 | } 178 | -------------------------------------------------------------------------------- /tests/DataApiSimpleTest.php: -------------------------------------------------------------------------------- 1 | dataApi = new DataApi($url, $database, $sslVerify); 27 | } 28 | 29 | /** 30 | * @param $username 31 | * @param $password 32 | * 33 | * @return null|string 34 | */ 35 | public function loginTest($username, $password) 36 | { 37 | try { 38 | $this->dataApi->setApiPassword($password); 39 | $this->dataApi->setApiUsername($username); 40 | $this->dataApi->login(); 41 | } catch (\Exception $e) { 42 | return $e->getMessage(); 43 | } 44 | 45 | return $this->dataApi->getApiToken(); 46 | } 47 | 48 | /** 49 | * @param $oAuthRequestId 50 | * @param $oAuthIdentifier 51 | * 52 | * @return null|string 53 | */ 54 | public function loginOauthTest($oAuthRequestId, $oAuthIdentifier) 55 | { 56 | try { 57 | $this->dataApi->setOAuthIdentifier($oAuthRequestId); 58 | $this->dataApi->setOAuthRequestId($oAuthIdentifier); 59 | $this->dataApi->login(); 60 | } catch (\Exception $e) { 61 | return $e->getMessage(); 62 | } 63 | 64 | return $this->dataApi->getApiToken(); 65 | } 66 | 67 | /** 68 | * @param $layout 69 | * @param $data 70 | * 71 | * @return string 72 | */ 73 | public function createRecordTest($layout, array $data) 74 | { 75 | $record_id = null; 76 | 77 | try { 78 | $record_id = $this->dataApi->createRecord($layout, $data); 79 | } catch (\Exception $e) { 80 | return $e->getMessage(); 81 | } 82 | 83 | return $record_id; 84 | } 85 | 86 | /** 87 | * @param $layout 88 | * @param $recordId 89 | * @param array $data 90 | * @param null $lastModificationId 91 | * 92 | * @return mixed|string 93 | */ 94 | public function editRecordTest($layout, $recordId, array $data, $lastModificationId = null) 95 | { 96 | try { 97 | $record_id = $this->dataApi->editRecord($layout, $recordId, $data, $lastModificationId); 98 | } catch (\Exception $e) { 99 | return $e->getMessage(); 100 | } 101 | 102 | return $record_id; 103 | } 104 | 105 | /** 106 | * @param $layout 107 | * @param $recordId 108 | * @param null $offset 109 | * @param null $range 110 | * @param null $portal 111 | * 112 | * @return mixed|string 113 | */ 114 | public function getRecordTest($layout, $recordId, $offset = null, $range = null, $portal = null) 115 | { 116 | try { 117 | $record_id = $this->dataApi->getRecord($layout, $recordId, $offset, $range, $portal); 118 | } catch (\Exception $e) { 119 | return $e->getMessage(); 120 | } 121 | 122 | return $record_id; 123 | } 124 | 125 | /** 126 | * @param $layout 127 | * @param null $sort 128 | * @param null $offset 129 | * @param null $range 130 | * @param null $portal 131 | * 132 | * @return mixed|string 133 | */ 134 | public function getRecordsTest($layout, $sort = null, $offset = null, $range = null, $portal = null) 135 | { 136 | try { 137 | $result = $this->dataApi->getRecords($layout, $sort, $offset, $range, $portal); 138 | } catch (\Exception $e) { 139 | return $e->getMessage(); 140 | } 141 | 142 | return $result; 143 | } 144 | 145 | /** 146 | * @param $layout 147 | * @param $query 148 | * 149 | * @param null $sort 150 | * @param null $offset 151 | * @param null $range 152 | * @param null $portal 153 | * 154 | * @return string 155 | */ 156 | public function findRecordsTest($layout, $query, $sort = null, $offset = null, $range = null, $portal = null) 157 | { 158 | try { 159 | $result = $this->dataApi->findRecords($layout, $query, $sort, $offset, $range, $portal); 160 | } catch (\Exception $e) { 161 | return $e->getMessage(); 162 | } 163 | 164 | return $result; 165 | } 166 | 167 | /** 168 | * @param $layout 169 | * @param array $globalFields 170 | * 171 | * @return mixed|string 172 | */ 173 | public function setGlobalFieldsTest($layout, array $globalFields) 174 | { 175 | try { 176 | $result = $this->dataApi->setGlobalFields($layout, $globalFields); 177 | } catch (\Exception $e) { 178 | return $e->getMessage(); 179 | } 180 | 181 | return $result; 182 | } 183 | 184 | /** 185 | * @param $layout 186 | * @param $record_id 187 | * 188 | * @return string 189 | */ 190 | public function deleteRecordTest($layout, $record_id) 191 | { 192 | try { 193 | $this->dataApi->deleteRecord($layout, $record_id); 194 | } catch (\Exception $e) { 195 | return $e->getMessage(); 196 | } 197 | 198 | return $record_id; 199 | } 200 | 201 | /** 202 | * @return string 203 | */ 204 | public function logoutTest() 205 | { 206 | try { 207 | $this->dataApi->logout(); 208 | } catch (\Exception $e) { 209 | return $e->getMessage(); 210 | } 211 | 212 | return true; 213 | } 214 | } 215 | --------------------------------------------------------------------------------