├── CHANGELOG.md ├── LICENSE ├── README.md ├── composer.json └── src ├── Baserow.php ├── Request.php └── Response.php /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # stevecomrie/baserow-php Change Log 2 | 3 | ## 0.0.7 - 2023.04.27 4 | 5 | ### Fixed 6 | 7 | * Fixed a bug that was preventing delete operations from working after the `0.0.3` update ([#3](https://github.com/stevecomrie/baserow-php/issues/3)). Thanks to [@bernetflorent](https://github.com/bernetflorent) for identifying the issue and the fix. 8 | 9 | 10 | ## 0.0.6 - 2023.03.24 11 | 12 | ### Fixed 13 | 14 | * The function added in `0.0.3` to force integer values to be encoded without surrounding quotes when being converted to JSON forgot to take into consideration the individual values in side a field value that is an array (i.e. a multi-select field or a relationship field). 15 | 16 | 17 | ## 0.0.3 - 2023.03.21 18 | 19 | ### Added 20 | 21 | * Implemented a function that looks for integer values inside payloads being sent to Baserow and attempts to ensure that `json_encode()` properly outputs integer values without being wrapped by quotes. Fixes [an issue introduced by Baserow 1.15](https://gitlab.com/bramw/baserow/-/issues/1653) that interprets quote-wrapped integers as string and prevents updates to single/multi select field value by ID. 22 | 23 | 24 | ## 0.0.2 - 2021.10.31 25 | 26 | ### Added 27 | 28 | * Can now pass an array as a value for query fields, which creates duplictates of the same param name in the query string - which Baserow accepts. Usually only useful with the "OR" condition. 29 | -------------------------------------------------------------------------------- /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 | 2 | # Baserow PHP client 3 | A PHP client for the Baserow.io API with human readable table and field names. 4 | 5 | Comments, requests or bug reports are appreciated. 6 | 7 | ## Getting started 8 | 9 | This library only manages CRUD operations using the Baserow API. 10 | 11 | It can be used with both the SaaS hosted and self hosted versions. 12 | 13 | For more information about the Baserow API, please see: 14 | 15 | - https://baserow.io/api/docs 16 | - https://api.baserow.io/api/redoc/ 17 | 18 | --- 19 | 20 | ### Installation 21 | 22 | If you're using Composer, you can run the following command: 23 | ``` 24 | composer require "stevecomrie/baserow-php:main-dev" 25 | ``` 26 | You can also download the src files directly and extract them to your web directory. 27 | 28 | 29 | ### Add the client to your project 30 | If you're using Composer, run the autoloader 31 | ```php 32 | require 'vendor/autoload.php'; 33 | ``` 34 | Or include the Baserow.php file 35 | 36 | ```php 37 | include('../src/Baserow.php'); 38 | include('../src/Request.php'); 39 | include('../src/Response.php'); 40 | ``` 41 | ### Initialize the class 42 | Only the `api_key` parameter is required, the rest are added as a reference. 43 | 44 | You can create your API key through your Baserow.io dashboard. 45 | 46 | ```php 47 | use \Scomrie\Baserow\Baserow; 48 | 49 | $baserow = new Baserow([ 50 | 'api_key' => 'API_KEY', // REQUIRED!! 51 | 52 | // if you are self hosting your own instance of Baserow, use this parameter to 53 | // point to the proper location on your server. defaults to the SaaS hosted endpoint. 54 | 'api_url' => 'https://api.baserow.io/api/database/rows/table' 55 | 56 | // if set to true, will dump any errors with print_r() and exit on failure 57 | 'debug' => false, 58 | 59 | // map of all tables & fields from auto-generated ###'s to human readable names 60 | 'table_map' => [] 61 | ]); 62 | ``` 63 | 64 | ### Creating a human readable table map 65 | 66 | Baserow uses incrementing integers for names when creating new tables and fields. 67 | 68 | For example, tables are given IDs like: 69 | - 10001 70 | - 10002 71 | - 10003, etc 72 | 73 | And fields within a table are given names like: 74 | - field_1001 75 | - field_1002 76 | - field_1003, etc 77 | 78 | This is obviously not ideal for long-term code readability and maintenance, but totally understandable given the current stage of Baserow development. 79 | 80 | To make developer life a littler easier, you can configure a `table_map` parameter when creating a new instance of the Baserow client that lets you map these auto-generated IDs to human readable names. 81 | 82 | #### Sample table map 83 | 84 | This is what a sample table map configuration might look like. 85 | 86 | ``` 87 | $table_map = [ 88 | 'Customers' => [ 10001, [ 89 | 'firstName' => 'field_1001', 90 | 'lastName' => 'field_1002', 91 | 'active' => 'field_1003', 92 | 'projects' => 'field_1004', 93 | ]], 94 | 95 | 'Projects' => [ 10002, [ 96 | 'name' => 'field_1005', 97 | 'dueDate' => 'field_1006', 98 | 'customer' => 'field_1007', 99 | ]], 100 | ]; 101 | ``` 102 | 103 | You can find the table and field IDs generated by Baserow using the [API documentation for your database](https://baserow.io/api/docs/). 104 | 105 | When you initialize the Baserow client with a `table_map` you are able to use your new human readable names anywhere that you would have previously used a table #### or field_####. 106 | 107 | The `table_map` parameter is optional, but the rest of the examples in this document will assume that you're using it. 108 | 109 | #### Table map recommendations 110 | 111 | You probably don't want to use spaces in your human readable field names. 112 | 113 | Your table map configuration will need to be manually updated if you add or remove fields. 114 | 115 | In addition to maintaining your sanity when writing code, the table map configuration also make it possible to create a staging / production environment using two separate databases, each with their own table map. 116 | 117 | 118 | ## Communicating with the API 119 | 120 | ### Retrieving a "page" of records from a table 121 | Get entries from the table "Contacts". 122 | ```php 123 | $response = $baserow->list( 'Contacts' ); 124 | 125 | print_r($response); 126 | ``` 127 | 128 | 129 | ### Using $params to filter & sort records 130 | 131 | You don't have to use all the params, they are added as a reference. 132 | 133 | ```php 134 | $params = array( 135 | "page" => 1, 136 | "size" => 100, 137 | "order_by" => "lastName", 138 | "filter__firstName__equal" => "Steve", 139 | "include" => "firstName,lastName", 140 | ); 141 | 142 | $response = $baserow->list( 'Contacts', $params ); 143 | print_r($response); 144 | ``` 145 | The full list of available parameters for use with the `list()` or `all()` functions can be found within the [API documentation](https://baserow.io/api/docs/) that is automatically generated by Baserow for your database. 146 | 147 | 148 | ### Retrieving ALL records within a table 149 | If you need to return more than a single page of results, you can use the `all()` function to automatically retrieve the entire paginated result set. 150 | ```php 151 | $response = $baserow->all( 'Contacts', $params ); 152 | print_r($response); 153 | ``` 154 | 155 | 156 | ### Creating a new record 157 | We will create new entry in the table Contacts 158 | ```php 159 | $newContact = [ 160 | 'firstName' => "Steve", 161 | 'lastName' => "Comrie", 162 | 'active' => true, 163 | 'projects' => [ 2 ], 164 | ]; 165 | 166 | if( $contact = $baserow->create( "Contacts", $newContact ) ) { 167 | echo "Created new contact: " . $contact->id . "\n"; 168 | } else { 169 | print_r( $baserow->error() ); 170 | } 171 | ``` 172 | 173 | ### Updating an existing record 174 | Use the row ID to update the entry 175 | ```php 176 | $contactID = 1; 177 | $updatedFields = [ 178 | 'firstName' => "Steven", 179 | 'active' => false, 180 | ]; 181 | 182 | if( $baserow->update( "Contacts", $updatedFields, $contactID ) ) { 183 | echo "Contact updated!\n"; 184 | } 185 | ``` 186 | 187 | ### Deleting a record 188 | Use the row ID to delete the entry 189 | ```php 190 | $deleteContactID = 4; 191 | if( $baserow->delete("Contacts", $deleteContactID ) ) { 192 | echo "Contact deleted!\n"; 193 | } 194 | ``` 195 | ### Accessing API error messages 196 | Any time an API operation fails, you can access the reason for the failure using the `error()` function. 197 | ```php 198 | $error = $baserow->error(); 199 | print_r( $error ); 200 | ``` 201 | 202 | 203 | ## Credits 204 | 205 | Copyright (c) 2021 - Programmed by Steve Comrie. 206 | 207 | Thanks to Bram Wiepjes for developing Baserow.io and to Sleiman Tanios whose Airtable API Client this library borrows from substantially. 208 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "stevecomrie/baserow-php", 3 | "description": "A PHP Client for the Baserow.io API", 4 | "version": "0.0.7", 5 | "keywords": ["baserow", "php", "api"], 6 | "license": "MIT", 7 | "authors": [ 8 | { 9 | "name": "Steve Comrie", 10 | "email": "stevecomrie@gmail.com" 11 | } 12 | ], 13 | "type": "library", 14 | "require": { 15 | "php": ">=7.1" 16 | }, 17 | "require-dev": { 18 | 19 | }, 20 | "autoload": { 21 | "psr-4": { 22 | "Scomrie\\Baserow\\": "src/" 23 | } 24 | } 25 | } -------------------------------------------------------------------------------- /src/Baserow.php: -------------------------------------------------------------------------------- 1 | '', 29 | 'api_url' => 'https://api.baserow.io/api/database/rows/table', 30 | 'table_map' => [], 31 | 'debug' => false, 32 | ], $config ); 33 | 34 | $this->setKey($config['api_key']); 35 | $this->setApiUrl($config['api_url']); 36 | $this->setTableMap($config['table_map']); 37 | $this->setDebug($config['debug']); 38 | 39 | } else { 40 | echo 'Error: __construct() - Configuration data is missing'; 41 | } 42 | } 43 | 44 | public function setKey($key) 45 | { 46 | if( empty($key) ) { 47 | echo 'Error: setKey() - API key is missing'; 48 | } 49 | 50 | $this->_key = $key; 51 | } 52 | 53 | public function getKey() 54 | { 55 | return $this->_key; 56 | } 57 | 58 | public function setDebug($debug) 59 | { 60 | $this->_debug = $debug; 61 | } 62 | 63 | public function setApiUrl($url) 64 | { 65 | $this->_apiurl = rtrim($url, '/'); 66 | } 67 | 68 | public function getApiUrl($request) 69 | { 70 | $request = str_replace( ' ', '%20', $request ); 71 | 72 | // crude proof of concept hack to allow duplicate query param keys with multiple values 73 | // ideal solution: https://stackoverflow.com/questions/17161114/php-http-build-query-with-two-array-keys-that-are-same 74 | $request = preg_replace( '/\%5B\d+\%5D\=/', '=', $request ); 75 | 76 | return $this->_apiurl.'/'.$request; 77 | } 78 | 79 | public function setTableMap($map) 80 | { 81 | if( empty($map) ) { 82 | return; 83 | } 84 | 85 | foreach ($map as $tblName => $tblDetails) { 86 | $this->tableNamesToIds[$tblName] = $tblDetails[0]; 87 | 88 | foreach( $tblDetails[1] as $fieldName => $fieldId ) { 89 | $this->tableFieldsByName[$tblDetails[0]][$fieldName] = $fieldId; 90 | $this->tableFieldsById[$tblDetails[0]][$fieldId] = $fieldName; 91 | } 92 | 93 | // sort by length of field name to prevent mapping errors when performing 94 | // bulk search & replace on fields that start with similar strings 95 | uksort( 96 | $this->tableFieldsByName[$tblDetails[0]], 97 | function($a, $b) { return strlen($b) - strlen($a); } 98 | ); 99 | } 100 | } 101 | 102 | 103 | public function error() 104 | { 105 | return array_pop($this->_errors); 106 | } 107 | 108 | 109 | function get($table,$rowID) 110 | { 111 | $table = $this->_tableID($table); 112 | $request = new Request( $this, "$table/$rowID", [], false ); 113 | 114 | $response = $request->getResponse(); 115 | 116 | return $response->error 117 | ? $this->_handleError($response) 118 | : $this->_mapRecordToNames($response->parsedContent(),$table); 119 | } 120 | 121 | 122 | function list($table,$params=[]) 123 | { 124 | $table = $this->_tableID($table); 125 | $params = $this->_mapParams($params, $table); 126 | 127 | $page = empty( $params['page'] ) ? 1 : $params['page']; 128 | $size = empty( $params['size'] ) ? 100 : $params['size']; 129 | 130 | $request = new Request( $this, $table, $params, false ); 131 | $response = $request->getResponse(); 132 | 133 | $records = []; 134 | if( !empty($response->results) ) { 135 | foreach( $response->results AS $row ) { 136 | $records[] = $this->_mapRecordToNames( $row, $table ); 137 | } 138 | } 139 | 140 | return [ 141 | 'records' => $records, 142 | 'page' => $page, 143 | 'totalPages' => ceil( $response->count / $size ), 144 | 'count' => $response->count, 145 | 'next' => !empty( $response->next ), 146 | 'previous' => !empty( $response->previous ), 147 | ]; 148 | } 149 | 150 | 151 | function all($table,$params=[]) 152 | { 153 | $table = $this->_tableID($table); 154 | $params = $this->_mapParams($params, $table); 155 | 156 | $params['size'] = 200; // override the default to get more results per request 157 | $params['page'] = 0; 158 | 159 | $request = new Request( $this, $table, $params, false ); 160 | 161 | $records = []; 162 | do { 163 | $request->page = ++$params['page']; 164 | $response = $request->getResponse(); 165 | 166 | if( !empty($response->results) ) { 167 | foreach( $response->results AS $row ) { 168 | $records[] = $this->_mapRecordToNames( $row, $table ); 169 | } 170 | } 171 | 172 | } while ( !empty( $response->next ) ); 173 | 174 | return [ 175 | 'records' => $records, 176 | 'count' => $response->count, 177 | ]; 178 | } 179 | 180 | 181 | function create($table,$fields=[]) 182 | { 183 | if( empty( $fields ) ) { 184 | return $this->_handleError([ 185 | 'error' => "ERROR_MISSING_SAVE_DATA", 186 | 'detail' => "No column data provided for create action" 187 | ]); 188 | } 189 | 190 | $table = $this->_tableID($table); 191 | $fields = $this->_mapNamesToFields($fields,$table); 192 | 193 | $request = new Request( $this, $table, $fields, true ); 194 | 195 | $response = $request->getResponse(); 196 | 197 | return $response->error 198 | ? $this->_handleError($response) 199 | : $this->_mapRecordToNames($response->parsedContent(),$table); 200 | } 201 | 202 | 203 | function update($table, $fields=[], $rowID=null) 204 | { 205 | if( empty($fields) ) { 206 | return $this->_handleError([ 207 | 'error' => "ERROR_MISSING_UPDATE_DATA", 208 | 'detail' => "No column data provided for update action" 209 | ]); 210 | } 211 | 212 | $table = $this->_tableID($table); 213 | $fields = $this->_mapNamesToFields($fields, $table); 214 | 215 | if( $rowID && !empty( $fields['id'] ) ) { 216 | $rowID = $fields['id']; 217 | unset($fields['id']); 218 | } 219 | 220 | if( empty( $rowID ) ) { 221 | return $this->_handleError([ 222 | 'error' => "ERROR_MISSING_ROW_ID", 223 | 'detail' => "No row ID provided for update action" 224 | ]); 225 | } 226 | 227 | $request = new Request( $this, "$table/$rowID", $fields, 'patch' ); 228 | 229 | $response = $request->getResponse(); 230 | 231 | return $response->error 232 | ? $this->_handleError($response) 233 | : $this->_mapRecordToNames($response->parsedContent(),$table); 234 | } 235 | 236 | 237 | function delete($table,$rowID=null) 238 | { 239 | if( empty( $rowID ) ) { 240 | return $this->_handleError([ 241 | 'error' => "ERROR_MISSING_ROW_ID", 242 | 'detail' => "No row ID provided for delete action" 243 | ]); 244 | } 245 | 246 | $table = $this->_tableID($table); 247 | $request = new Request( $this, "$table/$rowID", [], 'delete' ); 248 | $response = $request->getResponse(); 249 | 250 | return $response->error 251 | ? $this->_handleError($response) 252 | : $rowID; 253 | 254 | // check for an error 255 | if( $response->error ) { 256 | $this->_errors[] = [ 'error' => $response->error, 'detail' => $response->detail ]; 257 | return false; 258 | } 259 | 260 | // success 261 | return $rowId; 262 | } 263 | 264 | 265 | private function _mapRecordToNames($record, $tableID) 266 | { 267 | if( empty( $this->tableFieldsById[$tableID] ) ) { 268 | return $record; // don't do anything if we don't have a map for this table 269 | } 270 | 271 | $record = (array) $record; 272 | $x = []; 273 | if( !empty($record['id']) ) { 274 | $x['id'] = $record['id']; 275 | } 276 | foreach ( $this->tableFieldsById[$tableID] as $key => $name) { 277 | if( array_key_exists( $key, $record ) ) { 278 | $x[$name] = $record[$key]; 279 | } 280 | } 281 | 282 | return (object) $x; 283 | } 284 | 285 | 286 | private function _mapParams($params, $tableID) 287 | { 288 | if( empty($this->tableFieldsByName[$tableID]) ) { 289 | return $params; // don't do anything if we don't have a map for this table 290 | } 291 | 292 | $mappedParams = []; 293 | foreach( $params AS $key => $value ) { 294 | 295 | if( substr($key, 0, 8) == 'filter__' ) { 296 | $filter = explode("__", $key); 297 | $filter[1] = str_replace( 298 | array_keys($this->tableFieldsByName[$tableID]), 299 | array_values($this->tableFieldsByName[$tableID]), 300 | $filter[1] 301 | ); 302 | $key = implode("__", $filter); 303 | } 304 | 305 | if( in_array( $key, ['order_by', 'include', 'exclude'] ) ) { 306 | $value = str_replace( 307 | array_keys($this->tableFieldsByName[$tableID]), 308 | array_values($this->tableFieldsByName[$tableID]), 309 | $value 310 | ); 311 | } 312 | 313 | $mappedParams[ $key ] = $value; 314 | } 315 | return $mappedParams; 316 | } 317 | 318 | 319 | private function _mapNamesToFields($fields, $tableID) 320 | { 321 | if( empty($this->tableFieldsByName[$tableID]) ) { 322 | return $fields; // don't do anything if we don't have a map for this table 323 | } 324 | 325 | $mappedFields = []; 326 | foreach( $fields AS $key => $value ) { 327 | $newKey = str_replace( 328 | array_keys($this->tableFieldsByName[$tableID]), 329 | array_values($this->tableFieldsByName[$tableID]), 330 | $key 331 | ); 332 | $mappedFields[ $newKey ] = $value; 333 | } 334 | return $mappedFields; 335 | } 336 | 337 | 338 | private function _tableID($tableName) 339 | { 340 | return empty( $this->tableNamesToIds[$tableName] ) 341 | ? $tableName 342 | : $this->tableNamesToIds[$tableName]; 343 | } 344 | 345 | 346 | private function _handleError( $error ) 347 | { 348 | $this->_errors[] = is_array($error) 349 | ? $error 350 | : [ 'error' => $error->error, 'detail' => $error->detail ]; 351 | 352 | if( $this->_debug ) { 353 | print_r( $this->error() ); 354 | exit; 355 | } 356 | 357 | return false; 358 | } 359 | } -------------------------------------------------------------------------------- /src/Request.php: -------------------------------------------------------------------------------- 1 | baserow = $baserow; 43 | $this->content_type = $content_type; 44 | $this->data = $data; 45 | $this->is_post = $is_post; 46 | 47 | } 48 | 49 | private function init() 50 | { 51 | $headers = array( 52 | 'Content-Type: application/json', 53 | sprintf('Authorization: Token %s', $this->baserow->getKey()) 54 | ); 55 | 56 | $request = $this->content_type; 57 | 58 | $request_parts = explode( '/', $request ); 59 | 60 | $request_parts = array_map( 'rawurlencode', $request_parts ); 61 | 62 | $request = join( '/', $request_parts ) . '/'; 63 | 64 | $url_encoded = false; 65 | 66 | if( ! $this->is_post || strtolower( $this->is_post ) === 'delete' ) 67 | { 68 | if (!empty($this->data)){ 69 | $data = http_build_query($this->data); 70 | $request .= "?" . $data; 71 | } 72 | 73 | $url_encoded = true; 74 | } 75 | 76 | $curl = curl_init($this->baserow->getApiUrl($request)); 77 | 78 | curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); 79 | 80 | curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); 81 | 82 | if( $this->is_post ) 83 | { 84 | $postData = []; 85 | $postType = strtoupper( $this->is_post ); 86 | 87 | curl_setopt($curl,CURLOPT_POST, true); 88 | 89 | if( in_array( $postType, ['PATCH', 'DELETE'] ) ) { 90 | curl_setopt($curl, CURLOPT_CUSTOMREQUEST, $postType ); 91 | } 92 | 93 | // POST & PATCH send a payload that needs to be modified 94 | if( $postType != 'DELETE' ) 95 | { 96 | // make sure any straight integer values in the data array 97 | // are reformatted using (int) which prevents json_encode() from 98 | // wrapping them in quotes, since baserow interprets integers 99 | // wrapped in quotes as strings, which breaks updating select 100 | // fields by option id. this is a preferable method to using 101 | // JSON_NUMERIC_CHECK as there are some legacy issues with the 102 | // way that flag tests and validates numbers 103 | $postData = $this->data; 104 | foreach( $postData AS $key => $value ) { 105 | if( is_numeric($value) && preg_match("/^\d+$/", $value ) ) { 106 | $postData[$key] = (int) $value; 107 | } 108 | 109 | if( is_array($value) && !empty($value) ) { 110 | $cleanValues = []; 111 | foreach( $value AS $arrayVal ) { 112 | $cleanValues[] = 113 | ( is_numeric($arrayVal) && preg_match("/^\d+$/", $arrayVal ) ) 114 | ? (int) $arrayVal 115 | : $arrayVal; 116 | } 117 | 118 | $postData[$key] = empty($cleanValues) ? $value : $cleanValues; 119 | } 120 | } 121 | } 122 | 123 | curl_setopt($curl,CURLOPT_POSTFIELDS, json_encode($postData)); 124 | } 125 | 126 | $this->curl = $curl; 127 | } 128 | 129 | /** 130 | * @return Response Get response from API 131 | */ 132 | public function getResponse() 133 | { 134 | $this->init(); 135 | 136 | $response_string = curl_exec( $this->curl ); 137 | 138 | $this->response = new Response( $this->baserow, $this, $response_string ); 139 | 140 | return $this->response; 141 | } 142 | 143 | public function __set( $key, $value ) 144 | { 145 | if( ! is_array( $this->data ) ) 146 | { 147 | $this->data = []; 148 | } 149 | 150 | $this->data[ $key ] = $value; 151 | } 152 | } -------------------------------------------------------------------------------- /src/Response.php: -------------------------------------------------------------------------------- 1 | baserow = $baserow; 38 | 39 | $this->request = $request; 40 | 41 | $this->content = $content; 42 | 43 | try 44 | { 45 | $this->parsedContent = json_decode( $content ); 46 | } 47 | catch ( \Exception $e ) 48 | { 49 | $this->parsedContent = false; 50 | } 51 | } 52 | 53 | public function __get( $key ) 54 | { 55 | if( ! $this->parsedContent || ! isset( $this->parsedContent->$key ) ) 56 | { 57 | return null; 58 | } 59 | 60 | return $this->parsedContent->$key; 61 | } 62 | 63 | public function __toString() 64 | { 65 | return $this->content; 66 | } 67 | 68 | public function __isset( $key ) 69 | { 70 | return $this->parsedContent && isset( $this->parsedContent->$key ); 71 | } 72 | 73 | public function parsedContent() { 74 | return $this->parsedContent; 75 | } 76 | } --------------------------------------------------------------------------------