├── .gitignore ├── LICENCE ├── README.md ├── composer.json └── src └── Silverpop ├── EngagePod.php ├── Transact.php └── Util └── ArrayToXml.php /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled source # 2 | ################### 3 | *.com 4 | *.class 5 | *.dll 6 | *.exe 7 | *.o 8 | *.so 9 | 10 | # Packages # 11 | ############ 12 | # it's better to unpack these files and commit the raw source 13 | # git has its own built in compression methods 14 | *.7z 15 | *.dmg 16 | *.gz 17 | *.iso 18 | *.jar 19 | *.rar 20 | *.tar 21 | *.zip 22 | 23 | # Logs and databases # 24 | ###################### 25 | *.log 26 | *.sql 27 | *.sqlite 28 | 29 | # OS generated files # 30 | ###################### 31 | .DS_Store 32 | .DS_Store? 33 | ._* 34 | .Spotlight-V100 35 | .Trashes 36 | Icon? 37 | ehthumbs.db 38 | Thumbs.db 39 | .idea 40 | -------------------------------------------------------------------------------- /LICENCE: -------------------------------------------------------------------------------- 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 | # Silverpop PHP Client Library 2 | 3 | PHP client library for the Silverpop API. 4 | 5 | *Note*. This project is not actively maintained. I suggest if it is useful, you fork your own version of it. 6 | 7 | Pull requests that are non-breaking will be merged. 8 | 9 | ## Installation 10 | 11 | Installation via [composer](http://getcomposer.org) . Create a composer.json file in the root folder of you project and paste the code below. 12 | 13 | ```javascript 14 | { 15 | "require": { 16 | "simpleweb/silverpopphp": "master-dev" 17 | } 18 | } 19 | ``` 20 | 21 | With composer installed, just run `php composer.phar install` or simply 22 | `composer install` if you [did a global install](http://getcomposer.org/doc/00-intro.md#globally). 23 | 24 | ## Usage 25 | 26 | ```php 27 | 'XXX', 43 | 'password' => 'XXX', 44 | 'engage_server' => 4, 45 | )); 46 | 47 | // Fetch all contact lists 48 | $lists = $silverpop->GetLists(18); 49 | var_dump($lists); 50 | 51 | // Add a record to a contact 52 | $recipientID = $silverpop->addContact( 53 | $databaseID, 54 | true, 55 | array( 56 | 'name' => 'christos', 57 | 'email' => 'chris@simpleweb.co.uk', 58 | ) 59 | ); 60 | echo $recipientID; 61 | 62 | // Create a new mailing and send in 1 minute 63 | $mailingID = $silverpop->sendEmail( 64 | $templateID, 65 | $databaseID, 66 | 'API Mailing Test - ' . date("d/m/Y H:i:s", time()), 67 | time() + 60, 68 | ); 69 | echo $mailingID; 70 | ``` 71 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "simpleweb/silverpopphp", 3 | "type": "library", 4 | "description": "Silverpop API in php", 5 | "keywords": ["Silverpop","email", "API", "XML-API"], 6 | "homepage": "https://github.com/simpleweb/SilverpopPHP", 7 | "license": "GPL", 8 | "authors": [ 9 | { 10 | "name": "David Haywood Smith", 11 | "email": "davehs@gmail.com", 12 | "homepage": "https://github.com/DHS/" 13 | } 14 | ], 15 | "require": { 16 | "php": ">=5.3.0", 17 | "ext-curl" : "*" 18 | }, 19 | "autoload": { 20 | "psr-0": { 21 | "Silverpop": "src/" 22 | } 23 | }, 24 | "minimum-stability" : "dev" 25 | } 26 | -------------------------------------------------------------------------------- /src/Silverpop/EngagePod.php: -------------------------------------------------------------------------------- 1 | _baseUrl based on the engage server specified in config 28 | */ 29 | public function __construct($config) { 30 | 31 | // It would be a good thing to cache the jsessionid somewhere and reuse it across multiple requests 32 | // otherwise we are authenticating to the server once for every request 33 | $this->_baseUrl = 'http://api' . $config['engage_server'] . '.silverpop.com/XMLAPI'; 34 | $this->_login($config['username'], $config['password']); 35 | 36 | } 37 | 38 | /** 39 | * Terminate the session with Silverpop. 40 | * 41 | * @return bool 42 | */ 43 | public function logOut() { 44 | $data["Envelope"] = array( 45 | "Body" => array( 46 | "Logout" => "" 47 | ), 48 | ); 49 | $response = $this->_request($data); 50 | $result = $response["Envelope"]["Body"]["RESULT"]; 51 | return $this->_isSuccess($result); 52 | } 53 | 54 | /** 55 | * Fetches the contents of a list 56 | * 57 | * $listType can be one of: 58 | * 59 | * 0 - Databases 60 | * 1 - Queries 61 | * 2 - Both Databases and Queries 62 | * 5 - Test Lists 63 | * 6 - Seed Lists 64 | * 13 - Suppression Lists 65 | * 15 - Relational Tables 66 | * 18 - Contact Lists 67 | * 68 | */ 69 | public function getLists($listType = 2, $isPrivate = true, $folder = null) { 70 | $data["Envelope"] = array( 71 | "Body" => array( 72 | "GetLists" => array( 73 | "VISIBILITY" => ($isPrivate ? '0' : '1'), 74 | "FOLDER_ID" => $folder, 75 | "LIST_TYPE" => $listType, 76 | ), 77 | ), 78 | ); 79 | $response = $this->_request($data); 80 | $result = $response["Envelope"]["Body"]["RESULT"]; 81 | if ($this->_isSuccess($result)) { 82 | if (isset($result['LIST'])) 83 | return $result['LIST']; 84 | else { 85 | return array(); //? 86 | } 87 | } else { 88 | throw new \Exception("GetLists Error: ".$this->_getErrorFromResponse($response)); 89 | } 90 | } 91 | 92 | /** 93 | * Get mailing templates 94 | * 95 | */ 96 | public function getMailingTemplates($isPrivate = true) { 97 | $data["Envelope"] = array( 98 | "Body" => array( 99 | "GetMailingTemplates" => array( 100 | "VISIBILITY" => ($isPrivate ? '0' : '1'), 101 | ), 102 | ), 103 | ); 104 | $response = $this->_request($data); 105 | $result = $response["Envelope"]["Body"]["RESULT"]; 106 | if ($this->_isSuccess($result)) { 107 | if (isset($result['MAILING_TEMPLATE'])) 108 | return $result['MAILING_TEMPLATE']; 109 | else { 110 | return array(); //? 111 | } 112 | } else { 113 | throw new \Exception("GetLists Error: ".$this->_getErrorFromResponse($response)); 114 | } 115 | } 116 | 117 | /** 118 | * Calculate a query 119 | * 120 | */ 121 | public function calculateQuery($databaseID) { 122 | $data["Envelope"] = array( 123 | "Body" => array( 124 | "CalculateQuery" => array( 125 | "QUERY_ID" => $databaseID, 126 | ), 127 | ), 128 | ); 129 | $response = $this->_request($data); 130 | $result = $response["Envelope"]["Body"]["RESULT"]; 131 | if ($this->_isSuccess($result)) { 132 | return $result["JOB_ID"]; 133 | } else { 134 | throw new \Exception("Silverpop says: ".$response["Envelope"]["Body"]["Fault"]["FaultString"]); 135 | } 136 | } 137 | 138 | /** 139 | * Get scheduled mailings 140 | * 141 | */ 142 | public function getScheduledMailings() { 143 | $data['Envelope'] = array( 144 | 'Body' => array( 145 | 'GetSentMailingsForOrg' => array( 146 | 'SCHEDULED' => null, 147 | ), 148 | ), 149 | ); 150 | $response = $this->_request($data); 151 | $result = $response["Envelope"]["Body"]["RESULT"]; 152 | if ($this->_isSuccess($result)) { 153 | return $result; 154 | } else { 155 | throw new Exception("Silverpop says: ".$response["Envelope"]["Body"]["Fault"]["FaultString"]); 156 | } 157 | } 158 | 159 | /** 160 | * Get the meta information for a list 161 | * 162 | */ 163 | public function getListMetaData($databaseID) { 164 | $data["Envelope"] = array( 165 | "Body" => array( 166 | "GetListMetaData" => array( 167 | "LIST_ID" => $databaseID, 168 | ), 169 | ), 170 | ); 171 | $response = $this->_request($data); 172 | $result = $response["Envelope"]["Body"]["RESULT"]; 173 | if ($this->_isSuccess($result)) { 174 | return $result; 175 | } else { 176 | throw new \Exception("Silverpop says: ".$response["Envelope"]["Body"]["Fault"]["FaultString"]); 177 | } 178 | } 179 | 180 | /** 181 | * Remove a contact 182 | * @param string $databaseID 183 | * @param string $email 184 | * @param mixed $sync_fields boolean false if not used or associative array of sync fields. 185 | * 186 | * @return bool 187 | */ 188 | public function removeContact($databaseID, $email, $sync_fields=false) { 189 | $data["Envelope"] = array( 190 | "Body" => array( 191 | "RemoveRecipient" => array( 192 | "LIST_ID" => $databaseID, 193 | "EMAIL" => $email, 194 | ), 195 | ), 196 | ); 197 | /* 198 | * Sync fields are optional so users can target recipients that do not have the EMAIL unique key or no unique keys at all. 199 | */ 200 | if ( $sync_fields !== FALSE ) { 201 | foreach ( $sync_fields as $key => $value ) { 202 | $data['Envelope']['Body']['RemoveRecipient']['COLUMN'][] = array("NAME"=> $key , "VALUE"=> $sync_fields[$key] ); 203 | } 204 | 205 | } 206 | 207 | $response = $this->_request($data); 208 | $result = $response["Envelope"]["Body"]["RESULT"]; 209 | if ($this->_isSuccess($result)) { 210 | return true; 211 | } else { 212 | if ($response["Envelope"]["Body"]["Fault"]["FaultString"]=="Error removing recipient from list. Recipient is not a member of this list."){ 213 | return true; 214 | } else { 215 | throw new \Exception("Silverpop says: ".$response["Envelope"]["Body"]["Fault"]["FaultString"]); 216 | } 217 | } 218 | } 219 | 220 | /** 221 | * Add a contact to a list 222 | * https://kb.silverpop.com/kb/Engage/API/API_XML/XML_API_Developer_Guide/03_Contact_XML_Interfaces/02_Database_Management_Interfaces_-_Contact/01_Add_a_Contact 223 | */ 224 | public function addContact($databaseID, $updateIfFound, $columns, $contactListID = false, $sendAutoReply = false, $allowHTML = false, $createdFrom = 1, $visitorKey = '', $syncFields = []) { 225 | $data["Envelope"] = array( 226 | "Body" => array( 227 | "AddRecipient" => array( 228 | "LIST_ID" => $databaseID, 229 | "CREATED_FROM" => $createdFrom, 230 | "SEND_AUTOREPLY" => ($sendAutoReply ? 'true' : 'false'), 231 | "UPDATE_IF_FOUND" => ($updateIfFound ? 'true' : 'false'), 232 | "ALLOW_HTML" => ($allowHTML ? 'true' : 'false'), 233 | "VISITOR_KEY" => $visitorKey, 234 | "CONTACT_LISTS" => ($contactListID) ? array("CONTACT_LIST_ID" => $contactListID) : '', 235 | "COLUMN" => array(), 236 | ), 237 | ), 238 | ); 239 | foreach ($columns as $name => $value) { 240 | $data["Envelope"]["Body"]["AddRecipient"]["COLUMN"][] = array("NAME" => $name, "VALUE" => $value); 241 | } 242 | foreach ($syncFields as $name => $value) { 243 | $data["Envelope"]["Body"]["AddRecipient"]["SYNC_FIELDS"]["SYNC_FIELD"][] = array("NAME" => $name, "VALUE" => $value); 244 | } 245 | $response = $this->_request($data); 246 | $result = $response["Envelope"]["Body"]["RESULT"]; 247 | if ($this->_isSuccess($result)) { 248 | if (isset($result['RecipientId'])) 249 | return $result['RecipientId']; 250 | else { 251 | throw new \Exception('Recipient added but no recipient ID was returned from the server.'); 252 | } 253 | } else { 254 | throw new \Exception("AddRecipient Error: ".$this->_getErrorFromResponse($response)); 255 | } 256 | } 257 | 258 | public function addContactToContactList($contactId, $contactListId, $columns) { 259 | $data["Envelope"] = array( 260 | "Body" => array( 261 | "AddContactToContactList" => array( 262 | "CONTACT_ID" => $contactId, 263 | "CONTACT_LIST_ID" => $contactListId, 264 | ), 265 | ), 266 | ); 267 | foreach ($columns as $name => $value) { 268 | $data["Envelope"]["Body"]["AddContactToContactList"]["COLUMN"][] = array("NAME" => $name, "VALUE" => $value); 269 | } 270 | $response = $this->_request($data); 271 | $result = $response["Envelope"]["Body"]["RESULT"]; 272 | if ($this->_isSuccess($result)) { 273 | return true; 274 | } else { 275 | throw new \Exception("AddRecipient Error: ".$this->_getErrorFromResponse($response)); 276 | } 277 | } 278 | 279 | public function getContact($databaseID, $email = null, $recipientId = null, $encodedRecipientId = null , $returnContactLists = false, $columns = null) 280 | { 281 | 282 | if ( empty( $email ) && empty( $recipientId ) ) { 283 | throw new \Exception('One of Email address or Recipient ID must have a value.'); 284 | } 285 | 286 | $data["Envelope"] = array( 287 | "Body" => array( 288 | "SelectRecipientData" => array( 289 | "LIST_ID" => $databaseID, 290 | "EMAIL" => empty($recipientId) ? $email : null, 291 | "RECIPIENT_ID" => !empty($recipientId) ? $recipientId : null, 292 | "ENCODED_RECIPIENT_ID" => !empty($encodedRecipientId) ? $encodedRecipientId : null, 293 | "RETURN_CONTACT_LISTS" => (bool) $returnContactLists, 294 | ), 295 | ), 296 | ); 297 | 298 | if ( !empty($columns) && is_array($columns) ) { 299 | $column_data = array(); 300 | foreach ($columns as $key => $value ) { 301 | $column_data[] = array( 302 | "NAME" => $key, 303 | "VALUE" => $columns[$key], 304 | ); 305 | } 306 | $data["Envelope"]["Body"]["SelectRecipientData"]["COLUMN"] = $column_data; 307 | } 308 | 309 | $response = $this->_request($data); 310 | $result = $response["Envelope"]["Body"]["RESULT"]; 311 | if ($this->_isSuccess($result)) { 312 | if (isset($result['RecipientId'])) 313 | return $result; 314 | else { 315 | throw new \Exception('Recipient added but no recipient ID was returned from the server.'); 316 | } 317 | } else { 318 | throw new \Exception("AddRecipient Error: ".$this->_getErrorFromResponse($response)); 319 | } 320 | } 321 | 322 | /** 323 | * Double opt in a contact 324 | * 325 | * @param string $databaseID 326 | * @param string $email 327 | * 328 | * @throws \Exception 329 | * @throw Exception in case of error 330 | * @return int recipient ID 331 | */ 332 | public function doubleOptInContact($databaseID, $email) { 333 | $data["Envelope"] = array( 334 | "Body" => array( 335 | "DoubleOptInRecipient" => array( 336 | "LIST_ID" => $databaseID, 337 | "COLUMN" => array( 338 | array( 339 | 'NAME' => 'EMAIL', 340 | 'VALUE' => $email, 341 | ), 342 | ), 343 | ), 344 | ), 345 | ); 346 | 347 | $response = $this->_request($data); 348 | $result = $response["Envelope"]["Body"]["RESULT"]; 349 | if ($this->_isSuccess($result)) { 350 | if (isset($result['RecipientId'])) 351 | return $result['RecipientId']; 352 | else { 353 | throw new \Exception('Recipient added but no recipient ID was returned from the server.'); 354 | } 355 | } 356 | 357 | throw new \Exception("DoubleOptInRecipient Error: ".$this->_getErrorFromResponse($response)); 358 | } 359 | 360 | /** 361 | * Update a contact. 362 | * 363 | * @param int $databaseID 364 | * @param string $oldEmail 365 | * @param array $columns 366 | * 367 | * @throws \Exception 368 | * @return int recipient ID 369 | */ 370 | public function updateContact($databaseID, $oldEmail, $columns, $visitorKey = '', $syncFields = []) { 371 | $data["Envelope"] = array( 372 | "Body" => array( 373 | "UpdateRecipient" => array( 374 | "LIST_ID" => $databaseID, 375 | "OLD_EMAIL" => $oldEmail, 376 | "CREATED_FROM" => 1, // 1 = created manually 377 | "VISITOR_KEY" => $visitorKey, 378 | "COLUMN" => array(), 379 | ), 380 | ), 381 | ); 382 | foreach ($columns as $name => $value) { 383 | $data["Envelope"]["Body"]["UpdateRecipient"]["COLUMN"][] = array("NAME" => $name, "VALUE" => $value); 384 | } 385 | foreach ($syncFields as $name => $value) { 386 | $data["Envelope"]["Body"]["UpdateRecipient"]["SYNC_FIELDS"]["SYNC_FIELD"][] = array("NAME" => $name, "VALUE" => $value); 387 | } 388 | $response = $this->_request($data); 389 | $result = $response["Envelope"]["Body"]["RESULT"]; 390 | if ($this->_isSuccess($result)) { 391 | if (isset($result['RecipientId'])) 392 | return $result['RecipientId']; 393 | else { 394 | throw new \Exception('Recipient added but no recipient ID was returned from the server.'); 395 | } 396 | } 397 | 398 | throw new \Exception("UpdateRecipient Error: ".$this->_getErrorFromResponse($response)); 399 | } 400 | 401 | /** 402 | * Opt out a contact 403 | * 404 | * @param int $databaseID 405 | * @param string $email 406 | * @param array $columns 407 | * 408 | * @throws \Exception 409 | * @return boolean true on success 410 | */ 411 | public function optOutContact($databaseID, $email, $columns = array()) { 412 | $data["Envelope"] = array( 413 | "Body" => array( 414 | "OptOutRecipient" => array( 415 | "LIST_ID" => $databaseID, 416 | "EMAIL" => $email, 417 | "COLUMN" => array(), 418 | ), 419 | ), 420 | ); 421 | $columns['EMAIL'] = $email; 422 | foreach ($columns as $name => $value) { 423 | $data["Envelope"]["Body"]["OptOutRecipient"]["COLUMN"][] = array("NAME" => $name, "VALUE" => $value); 424 | } 425 | 426 | $response = $this->_request($data); 427 | $result = $response["Envelope"]["Body"]["RESULT"]; 428 | 429 | if ($this->_isSuccess($result)) { 430 | return true; 431 | } 432 | 433 | throw new \Exception("OptOutRecipient Error: ".$this->_getErrorFromResponse($response)); 434 | } 435 | 436 | /** 437 | * Create a new query 438 | * 439 | * Takes a list of criteria and creates a query from them 440 | * 441 | * @param string $queryName The name of the new query 442 | * @param int $parentListId List that this query is derived from 443 | * @param $parentFolderId 444 | * @param $condition 445 | * @param bool $isPrivate 446 | * 447 | * @throws \Exception 448 | * @internal param string $columnName Column that the expression will run against 449 | * @internal param string $operators Operator that will be used for the expression 450 | * @internal param string $values 451 | * @return int ListID of the query that was created 452 | */ 453 | public function createQuery($queryName, $parentListId, $parentFolderId, $condition, $isPrivate = true) { 454 | $data['Envelope'] = array( 455 | 'Body' => array( 456 | 'CreateQuery' => array( 457 | 'QUERY_NAME' => $queryName, 458 | 'PARENT_LIST_ID' => $parentListId, 459 | 'PARENT_FOLDER_ID' => $parentFolderId, 460 | 'VISIBILITY' => ($isPrivate ? '0' : '1'), 461 | 'CRITERIA' => array( 462 | 'TYPE' => 'editable', 463 | 'EXPRESSION' => $condition, 464 | ), 465 | ), 466 | ), 467 | ); 468 | 469 | $response = $this->_request($data); 470 | $result = $response["Envelope"]["Body"]["RESULT"]; 471 | 472 | if ($this->_isSuccess($result)) { 473 | if (isset($result['ListId'])) 474 | return $result['ListId']; 475 | else { 476 | throw new \Exception('Query created but no query ID was returned from the server.'); 477 | } 478 | } else { 479 | throw new \Exception("createQuery Error: ".$this->_getErrorFromResponse($response)); 480 | } 481 | } 482 | 483 | /** 484 | * Send email 485 | * 486 | * Sends an email to the specified list_id ($targetID) using the template 487 | * $templateID. You can optionally include substitutions that will act on 488 | * the template to fill in dynamic bits of data. 489 | * 490 | * ## Example 491 | * 492 | * $engage->sendEmail(123, 456, "Example Mailing with unique name", time() + 60, array( 493 | * 'SUBSTITUTIONS' => array( 494 | * array( 495 | * 'NAME' => 'FIELD_IN_TEMPLATE', 496 | * 'VALUE' => "Dynamic value to replace in template", 497 | * ), 498 | * ) 499 | * )); 500 | * 501 | * @param int $templateID ID of template upon which to base the mailing. 502 | * @param int $targetID ID of database, query, or contact list to send the template-based mailing. 503 | * @param string $mailingName Name to assign to the generated mailing. 504 | * @param int $scheduledTimestamp When the mailing should be scheduled to send. This must be later than the current timestamp. 505 | * @param array $optionalElements An array of $key => $value, where $key can be one of SUBJECT, FROM_NAME, FROM_ADDRESS, REPLY_TO, SUBSTITUTIONS 506 | * @param bool|int $saveToSharedFolder 507 | * @param array $suppressionLists 508 | * 509 | * @throws \Exception 510 | * @return int $mailingID 511 | */ 512 | public function sendEmail($templateID, $targetID, $mailingName, $scheduledTimestamp, $optionalElements = array(), $saveToSharedFolder = 0, $suppressionLists = array()) { 513 | $data["Envelope"] = array( 514 | "Body" => array( 515 | "ScheduleMailing" => array( 516 | "SEND_HTML" => true, 517 | "SEND_TEXT" => true, 518 | "TEMPLATE_ID" => $templateID, 519 | "LIST_ID" => $targetID, 520 | "MAILING_NAME" => $mailingName, 521 | "VISIBILITY" => ($saveToSharedFolder ? '1' : '0'), 522 | "SCHEDULED" => date("m/d/Y h:i:s A",$scheduledTimestamp), 523 | ), 524 | ), 525 | ); 526 | foreach ($optionalElements as $key => $value) { 527 | $data["Envelope"]["Body"]["ScheduleMailing"][$key] = $value; 528 | } 529 | 530 | if (is_array($suppressionLists) && count($suppressionLists) > 0) { 531 | $data["Envelope"]["Body"]["ScheduleMailing"]['SUPPRESSION_LISTS']['SUPPRESSION_LIST_ID'] = $suppressionLists; 532 | } 533 | 534 | $response = $this->_request($data); 535 | $result = $response["Envelope"]["Body"]["RESULT"]; 536 | if ($this->_isSuccess($result)) { 537 | if (isset($result['MAILING_ID'])) 538 | return $result['MAILING_ID']; 539 | else 540 | throw new \Exception('Email scheduled but no mailing ID was returned from the server.'); 541 | } else { 542 | throw new \Exception("SendEmail Error: ".$this->_getErrorFromResponse($response)); 543 | } 544 | } 545 | 546 | /** 547 | * Send a single transactional email 548 | * 549 | * Sends an email to the specified email address ($emailID) using the mailingId 550 | * of the autoresponder $mailingID. You can optionally include database keys 551 | * to match if multikey database is used (not for replacement). 552 | * 553 | * ## Example 554 | * 555 | * $engage->sendMailing("someone@somedomain.com", 149482, array("COLUMNS" => array( 556 | * 'COLUMN' => array( 557 | * array( 558 | * 'Name' => 'FIELD_IN_TEMPLATE', 559 | * 'Value' => "value to MATCH", 560 | * ), 561 | * ) 562 | * ))); 563 | * 564 | * @param string $emailID ID of users email, must be opted in. 565 | * @param int $mailingID ID of template upon which to base the mailing. 566 | * @param array $optionalKeys additional keys to match reciepent 567 | * 568 | * @throws \Exception 569 | * @return int $mailingID 570 | */ 571 | public function sendMailing($emailID, $mailingID, $optionalKeys = array()) { 572 | $data["Envelope"] = array( 573 | "Body" => array( 574 | "SendMailing" => array( 575 | "MailingId" => $mailingID, 576 | "RecipientEmail" => $emailID, 577 | ), 578 | ), 579 | ); 580 | foreach ($optionalKeys as $key => $value) { 581 | $data["Envelope"]["Body"]["SendMailing"][$key] = $value; 582 | } 583 | 584 | $response = $this->_request($data); 585 | $result = $response["Envelope"]["Body"]["RESULT"]; 586 | 587 | if ($this->_isSuccess($result)) { 588 | return true; 589 | } else { 590 | throw new \Exception("SendEmail Error: ".$this->_getErrorFromResponse($response)); 591 | } 592 | } 593 | 594 | 595 | /** 596 | * Import a table 597 | * 598 | * Requires a file to import and a mapping file to be in the 'upload' directory of the Engage FTP server 599 | * 600 | * Returns the data job id 601 | * 602 | */ 603 | public function importTable($fileName, $mapFileName) { 604 | 605 | $data["Envelope"] = array( 606 | "Body" => array( 607 | "ImportTable" => array( 608 | "MAP_FILE" => $mapFileName, 609 | "SOURCE_FILE" => $fileName, 610 | ), 611 | ), 612 | ); 613 | 614 | $response = $this->_request($data); 615 | $result = $response["Envelope"]["Body"]["RESULT"]; 616 | 617 | if ($this->_isSuccess($result)) { 618 | if (isset($result['JOB_ID'])) 619 | return $result['JOB_ID']; 620 | else { 621 | throw new \Exception('Import table query created but no job ID was returned from the server.'); 622 | } 623 | } else { 624 | throw new \Exception("importTable Error: ".$this->_getErrorFromResponse($response)); 625 | } 626 | 627 | } 628 | 629 | /** 630 | * Purge a table 631 | * 632 | * Clear the contents of a table, useful before importing new content 633 | * 634 | * Returns the data job id 635 | * 636 | */ 637 | public function purgeTable($tableName, $isPrivate = true) { 638 | 639 | $data["Envelope"] = array( 640 | "Body" => array( 641 | "PurgeTable" => array( 642 | "TABLE_NAME" => $tableName, 643 | "TABLE_VISIBILITY" => ($isPrivate ? '0' : '1'), 644 | ), 645 | ), 646 | ); 647 | 648 | $response = $this->_request($data); 649 | $result = $response["Envelope"]["Body"]["RESULT"]; 650 | 651 | if ($this->_isSuccess($result)) { 652 | if (isset($result['JOB_ID'])) 653 | return $result['JOB_ID']; 654 | else { 655 | throw new \Exception('Purge table query created but no job ID was returned from the server.'); 656 | } 657 | } else { 658 | throw new \Exception("purgeTable Error: ".$this->_getErrorFromResponse($response)); 659 | } 660 | 661 | } 662 | 663 | /** 664 | * This interface inserts or updates relational data 665 | * 666 | * For each Row that is passed in: 667 | * - If a row is found having the same key as the passed in row, update the record. 668 | * - If no matching row is found, insert a new row setting the column values to those passed in the request. 669 | * 670 | * Only one hundred rows may be passed in a single insertUpdateRelationalTable call! 671 | */ 672 | public function insertUpdateRelationalTable($tableId, $rows) { 673 | $processedRows = array(); 674 | $attribs = array(); 675 | foreach($rows as $row) { 676 | $columns = array(); 677 | foreach($row as $name => $value) 678 | { 679 | $columns['COLUMN'][] = $value; 680 | $attribs[5]['COLUMN'][] = array('name' => $name); 681 | } 682 | 683 | $processedRows['ROW'][] = $columns; 684 | } 685 | 686 | $data["Envelope"] = array( 687 | "Body" => array( 688 | "InsertUpdateRelationalTable" => array( 689 | "TABLE_ID" => $tableId, 690 | "ROWS" => $processedRows, 691 | ), 692 | ), 693 | ); 694 | 695 | $response = $this->_request($data, array(), $attribs); 696 | $result = $response["Envelope"]["Body"]["RESULT"]; 697 | 698 | if ($this->_isSuccess($result)) { 699 | return true; 700 | } else { 701 | throw new \Exception("insertUpdateRelationalTable Error: ".$this->_getErrorFromResponse($response)); 702 | } 703 | } 704 | 705 | /** 706 | * This interface deletes records from a relational table. 707 | */ 708 | public function deleteRelationalTableData($tableId, $rows) { 709 | $processedRows = array(); 710 | $attribs = array(); 711 | foreach($rows as $row) { 712 | $columns = array(); 713 | foreach($row as $name => $value) 714 | { 715 | $columns['KEY_COLUMN'][] = $value; 716 | $attribs[5]['KEY_COLUMN'][] = array('name' => $name); 717 | } 718 | 719 | $processedRows['ROW'][] = $columns; 720 | } 721 | 722 | $data["Envelope"] = array( 723 | "Body" => array( 724 | "DeleteRelationalTableData" => array( 725 | "TABLE_ID" => $tableId, 726 | "ROWS" => $processedRows, 727 | ), 728 | ), 729 | ); 730 | 731 | $response = $this->_request($data, array(), $attribs); 732 | $result = $response["Envelope"]["Body"]["RESULT"]; 733 | 734 | if ($this->_isSuccess($result)) { 735 | return true; 736 | } else { 737 | throw new \Exception("deleteRelationalTableData Error: ".$this->_getErrorFromResponse($response)); 738 | } 739 | } 740 | 741 | /** 742 | * Import a list/database 743 | * 744 | * Requires a file to import and a mapping file to be in the 'upload' directory of the Engage FTP server 745 | * 746 | * Returns the data job id 747 | * 748 | */ 749 | public function importList($fileName, $mapFileName) { 750 | 751 | $data["Envelope"] = array( 752 | "Body" => array( 753 | "ImportList" => array( 754 | "MAP_FILE" => $mapFileName, 755 | "SOURCE_FILE" => $fileName, 756 | ), 757 | ), 758 | ); 759 | 760 | $response = $this->_request($data); 761 | $result = $response["Envelope"]["Body"]["RESULT"]; 762 | 763 | if ($this->_isSuccess($result)) { 764 | if (isset($result['JOB_ID'])) 765 | return $result['JOB_ID']; 766 | else { 767 | throw new \Exception('Import list query created but no job ID was returned from the server.'); 768 | } 769 | } else { 770 | throw new \Exception("importList Error: ".$this->_getErrorFromResponse($response)); 771 | } 772 | 773 | } 774 | 775 | /** 776 | * Exports contact data from a database, query, or contact list. Engage exports the results to a CSV 777 | * file, then adds that file to the FTP account associated with the current session. 778 | * 779 | * @param string $listId Unique identifier for the database, query, or contact list Engage is exporting. 780 | * @param string $exportType Specifies which contacts to export. 781 | * @param string $exportFormat Specifies the format (file type) for the exported data. 782 | * @param array $exportColumns XML node used to request specific custom database columns to export for each contact. If EXPORT_COLUMNS is not specified, all database columns will be exported. 783 | * @param null|string $email If specified, this email address receives notification when the job is complete. 784 | * @param null|string $fileEncoding Defines the encoding of the exported file. 785 | * @param bool $addToStoredFiles Use the ADD_TO_STORED_FILES parameter to write the output to the Stored Files folder within Engage. 786 | * @param null|string $dateStart Specifies the beginning boundary of information to export (relative to the last modified date). If time is included, it must be in 24-hour format. 787 | * @param null|string $dateEnd Specifies the ending boundary of information to export (relative to the last modified date). If time is included, it must be in 24-hour format. 788 | * @param bool $useCreatedDate If included, the DATE_START and DATE_END range will be relative to the contact create date rather than last modified date. 789 | * @param bool $includeLeadSource Specifies whether to include the Lead Source column in the resulting file. 790 | * @param null|string $listDateFormat Used to specify the date format of the date fields in your exported file if date format differs from "mm/dd/yyyy" (month, day, and year can be in any order you choose). 791 | * @return mixed 792 | * @throws \Exception 793 | */ 794 | public function exportList($listId, $exportType, $exportFormat, $exportColumns = array(), $email = null, $fileEncoding = null, $addToStoredFiles = false, $dateStart = null, $dateEnd = null, $useCreatedDate = false, $includeLeadSource = false, $listDateFormat = null) 795 | { 796 | $data["Envelope"] = array( 797 | "Body" => array( 798 | "ExportList" => array( 799 | "LIST_ID" => $listId, 800 | "EXPORT_TYPE" => $exportType, 801 | "EXPORT_FORMAT" => $exportFormat 802 | ) 803 | ) 804 | ); 805 | 806 | if ($exportColumns) { 807 | foreach ($exportColumns as $column) { 808 | $data["Envelope"]["Body"]["ExportList"]["EXPORT_COLUMNS"]["COLUMN"][] = $column; 809 | } 810 | } 811 | 812 | if ($email) { 813 | $data["Envelope"]["Body"]["ExportList"]["EMAIL"] = $email; 814 | } 815 | 816 | if ($fileEncoding) { 817 | $data["Envelope"]["Body"]["ExportList"]["FILE_ENCODING"] = $fileEncoding; 818 | } 819 | 820 | if ($addToStoredFiles) { 821 | $data["Envelope"]["Body"]["ExportList"]["ADD_TO_STORED_FILES"] = ""; 822 | } 823 | 824 | if ($dateStart) { 825 | $data["Envelope"]["Body"]["ExportList"]["DATE_START"] = $dateStart; 826 | } 827 | 828 | if ($dateEnd) { 829 | $data["Envelope"]["Body"]["ExportList"]["DATE_END"] = $dateEnd; 830 | } 831 | 832 | if ($useCreatedDate) { 833 | $data["Envelope"]["Body"]["ExportList"]["USE_CREATED_DATE"] = ""; 834 | } 835 | 836 | if ($includeLeadSource) { 837 | $data["Envelope"]["Body"]["ExportList"]["INCLUDE_LEAD_SOURCE"] = ""; 838 | } 839 | 840 | if ($listDateFormat) { 841 | $data["Envelope"]["Body"]["ExportList"]["LIST_DATE_FORMAT"] = $listDateFormat; 842 | } 843 | 844 | $response = $this->_request($data); 845 | $result = $response["Envelope"]["Body"]["RESULT"]; 846 | 847 | if ($this->_isSuccess($result)) { 848 | if (isset($result['JOB_ID'])) 849 | return array("JOB_ID" => $result['JOB_ID'], "FILE_PATH" => $result['FILE_PATH']); 850 | else { 851 | throw new \Exception('Export list created but no job ID was returned from the server.'); 852 | } 853 | } else { 854 | throw new \Exception("exportList Error: ".$this->_getErrorFromResponse($response)); 855 | } 856 | } 857 | 858 | /** 859 | * Get a data job status 860 | * 861 | * Returns the status or throws an exception 862 | * 863 | */ 864 | public function getJobStatus($jobId) { 865 | 866 | $data["Envelope"] = array( 867 | "Body" => array( 868 | "GetJobStatus" => array( 869 | "JOB_ID" => $jobId 870 | ), 871 | ), 872 | ); 873 | 874 | $response = $this->_request($data); 875 | $result = $response["Envelope"]["Body"]["RESULT"]; 876 | 877 | if ($this->_isSuccess($result)) { 878 | if (isset($result['JOB_STATUS'])) 879 | return $result; 880 | else { 881 | throw new Exception('Job status query was successful but no status was found.'); 882 | } 883 | } else { 884 | throw new \Exception("getJobStatus Error: ".$this->_getErrorFromResponse($response)); 885 | } 886 | 887 | } 888 | 889 | /** 890 | * Private method: authenticate with Silverpop 891 | * 892 | */ 893 | private function _login($username, $password) { 894 | $data["Envelope"] = array( 895 | "Body" => array( 896 | "Login" => array( 897 | "USERNAME" => $username, 898 | "PASSWORD" => $password, 899 | ), 900 | ), 901 | ); 902 | $response = $this->_request($data); 903 | $result = $response["Envelope"]["Body"]["RESULT"]; 904 | if ($this->_isSuccess($result)) { 905 | $this->_jsessionid = $result['SESSIONID']; 906 | $this->_session_encoding = $result['SESSION_ENCODING']; 907 | $this->_username = $username; 908 | $this->_password = $password; 909 | } else { 910 | throw new \Exception("Login Error: ".$this->_getErrorFromResponse($response)); 911 | } 912 | } 913 | 914 | /** 915 | * Private method: generate the full request url 916 | * 917 | */ 918 | private function _getFullUrl() { 919 | return $this->_baseUrl . (isset($this->_session_encoding) ? $this->_session_encoding : ''); 920 | } 921 | 922 | /** 923 | * Private method: make the request 924 | * 925 | */ 926 | private function _request($data, $replace = array(), $attribs = array()) { 927 | 928 | if (is_array($data)) 929 | { 930 | $atx = new ArrayToXml($data, $replace, $attribs);; 931 | $xml = $atx->getXML(); 932 | } 933 | else 934 | { 935 | //assume raw xml otherwise, we need this because we have to build 936 | // our own sometimes because assoc arrays don't support same name keys 937 | $xml = $data; 938 | } 939 | 940 | $fields = array( 941 | "jsessionid" => isset($this->_jsessionid) ? $this->_jsessionid : '', 942 | "xml" => $xml, 943 | ); 944 | $response = $this->_httpPost($fields); 945 | if ($response) { 946 | $arr = \Silverpop\Util\xml2array($response); 947 | if (isset($arr["Envelope"]["Body"]["RESULT"]["SUCCESS"])) { 948 | return $arr; 949 | } else { 950 | throw new \Exception("HTTP Error: Invalid data from the server"); 951 | } 952 | } else { 953 | throw new \Exception("HTTP request failed"); 954 | } 955 | } 956 | 957 | /** 958 | * Private method: post the request to the url 959 | * 960 | */ 961 | private function _httpPost($fields) { 962 | $fields_string = http_build_query($fields); 963 | //open connection 964 | $ch = curl_init(); 965 | //set headers in array 966 | $headers = array( 967 | 'Expect:', 968 | 'Content-Type: application/x-www-form-urlencoded; charset=utf-8', 969 | ); 970 | //set the url, number of POST vars, POST data 971 | curl_setopt($ch,CURLOPT_HTTPHEADER, $headers); 972 | curl_setopt($ch,CURLOPT_URL,$this->_getFullUrl()); 973 | curl_setopt($ch,CURLOPT_POST,count($fields)); 974 | curl_setopt($ch,CURLOPT_POSTFIELDS,$fields_string); 975 | curl_setopt($ch,CURLOPT_RETURNTRANSFER,true); 976 | 977 | //execute post 978 | $result = curl_exec($ch); 979 | 980 | //close connection 981 | curl_close($ch); 982 | 983 | return $result; 984 | } 985 | 986 | /** 987 | * Private method: parse an error response from Silverpop 988 | * 989 | */ 990 | private function _getErrorFromResponse($response) { 991 | if (isset($response['Envelope']['Body']['Fault']['FaultString']) && !empty($response['Envelope']['Body']['Fault']['FaultString'])) { 992 | return $response['Envelope']['Body']['Fault']['FaultString']; 993 | } 994 | return 'Unknown Server Error'; 995 | } 996 | 997 | /** 998 | * Private method: determine whether a request was successful 999 | * 1000 | */ 1001 | private function _isSuccess($result) { 1002 | if (isset($result['SUCCESS']) && in_array(strtolower($result["SUCCESS"]), array('true', 'success'))) { 1003 | return true; 1004 | } 1005 | return false; 1006 | } 1007 | 1008 | } 1009 | -------------------------------------------------------------------------------- /src/Silverpop/Transact.php: -------------------------------------------------------------------------------- 1 | _baseUrl based on the engage server specified in config 24 | */ 25 | public function __construct($engage_server) { 26 | $this->_baseUrl = 'http://transact' . $engage_server . '.silverpop.com/XTMail'; 27 | } 28 | 29 | /** 30 | * Submit transaction email 31 | * 32 | * Sends an email to the specified recipient ($recipient) 33 | * 34 | * ## Example 35 | * 36 | * $engage->sendEmail(123, array( 37 | * 'EMAIL' => 'som@email.tld', 38 | 'BODY_TYPE' => 'HTML', 39 | 'PERSONALIZATION' => array( 40 | array( 41 | 'TAG_NAME' => 'SomeParam', 42 | 'VALUE' => 'SomeValue' 43 | ), 44 | array( 45 | 'TAG_NAME' => 'SomeParam', 46 | 'VALUE' => 'SomeValue' 47 | ) 48 | ) 49 | * )); 50 | * 51 | * @param int $campaingID ID of capaing upon which to base the mailing. 52 | * @param array $recipient An array of $key => $value, where $key can be one of EMAIL, BODY_TYPE, PERSONALIZATION 53 | * @param int $transactionID ID of transaction. 54 | * @param bool $showAllSendDetail 55 | * @param bool $sendAsBatch 56 | * 57 | * @throws \Exception 58 | * @return array RECIPIENT_DETAIL 59 | */ 60 | public function submit($campaingID, $recipient, $transactionID = null, $showAllSendDetail = true, $sendAsBatch = false) { 61 | $data["XTMAILING"] = array( 62 | "CAMPAIGN_ID" => $campaingID, 63 | "SHOW_ALL_SEND_DETAIL" => ($showAllSendDetail ? "true" : "false"), 64 | "SEND_AS_BATCH" => ($sendAsBatch ? "true" : "false"), 65 | "NO_RETRY_ON_FAILURE" => "true", 66 | "RECIPIENT" => $recipient 67 | ); 68 | 69 | if($transactionID !== null) { 70 | $data["XTMAILING"]["TRANSACTION_ID"] = $transactionID; 71 | } 72 | 73 | $response = $this->_request($data); 74 | 75 | $result = $response["XTMAILING_RESPONSE"]; 76 | 77 | if ($this->_isSuccess($result) && $result['EMAILS_SENT'] != 0) { 78 | return $result['RECIPIENT_DETAIL']; 79 | } 80 | 81 | throw new \Exception("Silverpop\\Transact::submit Error: ".$this->_getErrorFromResponse($result)); 82 | } 83 | 84 | /** 85 | * Private method: make the request 86 | * 87 | */ 88 | private function _request($data, $replace = array(), $attribs = array()) { 89 | 90 | if (is_array($data)) 91 | { 92 | $atx = new ArrayToXml($data, $replace, $attribs);; 93 | $xml = $atx->getXML(); 94 | } 95 | else 96 | { 97 | //assume raw xml otherwise, we need this because we have to build 98 | // our own sometimes because assoc arrays don't support same name keys 99 | $xml = $data; 100 | } 101 | 102 | $jsessionid = isset($this->_jsessionid) ? $this->_jsessionid : ''; 103 | 104 | $response = $this->_httpPost($jsessionid, $xml); 105 | if ($response) { 106 | $arr = \Silverpop\Util\xml2array($response); 107 | return $arr; 108 | if (isset($arr["XTMAILING_RESPONSE"])) { 109 | return $arr; 110 | } else { 111 | throw new \Exception("HTTP Error: Invalid data from the server"); 112 | } 113 | } else { 114 | throw new \Exception("HTTP request failed"); 115 | } 116 | } 117 | 118 | /** 119 | * Private method: post the request to the url 120 | * 121 | */ 122 | private function _httpPost($jsessionid, $xml) { 123 | //open connection 124 | $ch = curl_init(); 125 | 126 | //set the url, number of POST vars, POST data 127 | curl_setopt($ch,CURLOPT_URL,$this->_baseUrl); 128 | curl_setopt($ch,CURLOPT_POSTFIELDS,$xml); 129 | curl_setopt($ch,CURLOPT_RETURNTRANSFER,true); 130 | curl_setopt($ch,CURLOPT_HTTPHEADER, array( 131 | 'Content-Type: text/xml;charset=UTF-8', 132 | 'Content-Length: '.strlen($xml) 133 | )); 134 | 135 | //execute post 136 | $result = curl_exec($ch); 137 | 138 | //close connection 139 | curl_close($ch); 140 | 141 | return $result; 142 | } 143 | 144 | /** 145 | * Private method: parse an error response from Silverpop 146 | * 147 | */ 148 | private function _getErrorFromResponse($result) { 149 | if($result['ERROR_CODE'] != 0) { 150 | return $result['ERROR_STRING']; 151 | } 152 | 153 | if($result['NUMBER_ERRORS'] != 0) { 154 | return $result['RECIPIENT_DETAIL']['ERROR_STRING']; 155 | } 156 | 157 | return 'Unknown Server Error'; 158 | } 159 | 160 | /** 161 | * Private method: determine whether a request was successful 162 | * 163 | */ 164 | private function _isSuccess($result) { 165 | if($result['ERROR_CODE'] == 0 && $result['NUMBER_ERRORS'] == 0) { 166 | return true; 167 | } 168 | 169 | return false; 170 | } 171 | 172 | } 173 | -------------------------------------------------------------------------------- /src/Silverpop/Util/ArrayToXml.php: -------------------------------------------------------------------------------- 1 | _attribs = $attribs; 17 | $this->_replace = $replace; 18 | $this->_data = $this->_processArray( $data ); 19 | } 20 | 21 | function getXML() { 22 | return $this->_data; 23 | } 24 | 25 | function _processArray( &$array, $level = 0, $parent = '' ) { 26 | //ksort($array); 27 | $return = ''; 28 | foreach ( (array) $array as $name => $value ) { 29 | $tlevel = $level; 30 | $isarray = false; 31 | $attrs = ''; 32 | 33 | if ( is_array( $value ) && ( sizeof( $value ) > 0 ) && array_key_exists( 0, $value ) ) { 34 | $tlevel = $level - 1; 35 | $isarray = true; 36 | } 37 | elseif ( ! is_int( $name ) ) { 38 | if ( ! isset( $this->_rep[$name] ) ) 39 | $this->_rep[$name] = 0; 40 | $this->_rep[$name]++; 41 | } 42 | else { 43 | $name = $parent; 44 | if ( ! isset( $this->_rep[$name] ) ) 45 | $this->_rep[$name] = 0; 46 | $this->_rep[$name]++; 47 | } 48 | 49 | if ( ! isset( $this->_rep[$name] ) ) 50 | $this->_rep[$name] = 0; 51 | 52 | if ( isset( $this->_attribs[$tlevel][$name][$this->_rep[$name] - 1] ) && is_array( $this->_attribs[$tlevel][$name][$this->_rep[$name] - 1] ) ) { 53 | foreach ( (array) $this->_attribs[$tlevel][$name][$this->_rep[$name] - 1] as $aname => $avalue ) { 54 | $attrs .= " $aname=\"$avalue\""; 55 | } 56 | } 57 | if ( isset($this->_replace[$name]) && $this->_replace[$name] ) 58 | $name = $this->_replace[$name]; 59 | 60 | is_array( $value ) ? $output = $this->_processArray( $value, $tlevel + 1, $name ) : $output = htmlspecialchars( $value ); 61 | 62 | $isarray ? $return .= $output : $return .= "<$name$attrs>$output\n"; 63 | } 64 | return $return; 65 | } 66 | } 67 | 68 | /* Original source from http://www.bin-co.com/php/scripts/xml2array/ */ 69 | 70 | function xml2array($contents, $get_attributes=1, $priority = 'tag') { 71 | if(!$contents) return array(); 72 | 73 | if(!function_exists('xml_parser_create')) { 74 | //print "'xml_parser_create()' function not found!"; 75 | return array(); 76 | } 77 | 78 | //Get the XML parser of PHP - PHP must have this module for the parser to work 79 | $parser = xml_parser_create(''); 80 | xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, "UTF-8"); # http://minutillo.com/steve/weblog/2004/6/17/php-xml-and-character-encodings-a-tale-of-sadness-rage-and-data-loss 81 | xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0); 82 | xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, 1); 83 | xml_parse_into_struct($parser, trim($contents), $xml_values); 84 | xml_parser_free($parser); 85 | 86 | if(!$xml_values) return;//Hmm... 87 | 88 | //Initializations 89 | $xml_array = array(); 90 | $parents = array(); 91 | $opened_tags = array(); 92 | $arr = array(); 93 | 94 | $current = &$xml_array; //Refference 95 | 96 | //Go through the tags. 97 | $repeated_tag_index = array();//Multiple tags with same name will be turned into an array 98 | foreach($xml_values as $data) { 99 | unset($attributes,$value);//Remove existing values, or there will be trouble 100 | 101 | //This command will extract these variables into the foreach scope 102 | // tag(string), type(string), level(int), attributes(array). 103 | extract($data);//We could use the array by itself, but this cooler. 104 | 105 | $result = array(); 106 | $attributes_data = array(); 107 | 108 | if(isset($value)) { 109 | if($priority == 'tag') $result = $value; 110 | else $result['value'] = $value; //Put the value in a assoc array if we are in the 'Attribute' mode 111 | } 112 | 113 | //Set the attributes too. 114 | if(isset($attributes) and $get_attributes) { 115 | foreach($attributes as $attr => $val) { 116 | if($priority == 'tag') $attributes_data[$attr] = $val; 117 | else $result['attr'][$attr] = $val; //Set all the attributes in a array called 'attr' 118 | } 119 | } 120 | 121 | //See tag status and do the needed. 122 | if($type == "open") {//The starting of the tag '' 123 | $parent[$level-1] = &$current; 124 | if(!is_array($current) or (!in_array($tag, array_keys($current)))) { //Insert New tag 125 | $current[$tag] = $result; 126 | if($attributes_data) $current[$tag. '_attr'] = $attributes_data; 127 | $repeated_tag_index[$tag.'_'.$level] = 1; 128 | 129 | $current = &$current[$tag]; 130 | 131 | } else { //There was another element with the same tag name 132 | 133 | if(isset($current[$tag][0])) {//If there is a 0th element it is already an array 134 | $current[$tag][$repeated_tag_index[$tag.'_'.$level]] = $result; 135 | $repeated_tag_index[$tag.'_'.$level]++; 136 | } else {//This section will make the value an array if multiple tags with the same name appear together 137 | $current[$tag] = array($current[$tag],$result);//This will combine the existing item and the new item together to make an array 138 | $repeated_tag_index[$tag.'_'.$level] = 2; 139 | 140 | if(isset($current[$tag.'_attr'])) { //The attribute of the last(0th) tag must be moved as well 141 | $current[$tag]['0_attr'] = $current[$tag.'_attr']; 142 | unset($current[$tag.'_attr']); 143 | } 144 | 145 | } 146 | $last_item_index = $repeated_tag_index[$tag.'_'.$level]-1; 147 | $current = &$current[$tag][$last_item_index]; 148 | } 149 | 150 | } elseif($type == "complete") { //Tags that ends in 1 line '' 151 | //See if the key is already taken. 152 | if(!isset($current[$tag])) { //New Key 153 | $current[$tag] = $result; 154 | $repeated_tag_index[$tag.'_'.$level] = 1; 155 | if($priority == 'tag' and $attributes_data) $current[$tag. '_attr'] = $attributes_data; 156 | 157 | } else { //If taken, put all things inside a list(array) 158 | if(isset($current[$tag][0]) and is_array($current[$tag])) {//If it is already an array... 159 | 160 | // ...push the new element into that array. 161 | $current[$tag][$repeated_tag_index[$tag.'_'.$level]] = $result; 162 | 163 | if($priority == 'tag' and $get_attributes and $attributes_data) { 164 | $current[$tag][$repeated_tag_index[$tag.'_'.$level] . '_attr'] = $attributes_data; 165 | } 166 | $repeated_tag_index[$tag.'_'.$level]++; 167 | 168 | } else { //If it is not an array... 169 | $current[$tag] = array($current[$tag],$result); //...Make it an array using using the existing value and the new value 170 | $repeated_tag_index[$tag.'_'.$level] = 1; 171 | if($priority == 'tag' and $get_attributes) { 172 | if(isset($current[$tag.'_attr'])) { //The attribute of the last(0th) tag must be moved as well 173 | 174 | $current[$tag]['0_attr'] = $current[$tag.'_attr']; 175 | unset($current[$tag.'_attr']); 176 | } 177 | 178 | if($attributes_data) { 179 | $current[$tag][$repeated_tag_index[$tag.'_'.$level] . '_attr'] = $attributes_data; 180 | } 181 | } 182 | $repeated_tag_index[$tag.'_'.$level]++; //0 and 1 index is already taken 183 | } 184 | } 185 | 186 | } elseif($type == 'close') { //End of tag '' 187 | $current = &$parent[$level-1]; 188 | } 189 | } 190 | 191 | return($xml_array); 192 | } 193 | ?> 194 | --------------------------------------------------------------------------------