├── CHANGES.md ├── LICENSE.md ├── README.md ├── amd ├── build │ └── control.min.js └── src │ └── control.js ├── block_todo.php ├── classes ├── external │ ├── add_item.php │ ├── api.php │ ├── delete_item.php │ ├── item_exporter.php │ ├── list_exporter.php │ └── toggle_item.php ├── item.php └── privacy │ └── provider.php ├── db ├── access.php ├── install.xml └── services.php ├── lang └── en │ └── block_todo.php ├── templates ├── content.mustache └── item.mustache ├── tests └── external_test.php └── version.php /CHANGES.md: -------------------------------------------------------------------------------- 1 | # CHANGES # 2 | 3 | ## 1.1.0 ## 4 | 5 | * Privacy API implementation. 6 | * Minor usability improvement - display a hint if the Add button is pressed without 7 | todo item text provided. 8 | * The plugin is considered to be stable now. 9 | 10 | ## 1.0.0 ## 11 | 12 | * Initial implementation of the plugin, first public release. 13 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | ========================== 3 | 4 | Version 3, 29 June 2007 5 | 6 | Copyright © 2007 Free Software Foundation, Inc. <> 7 | 8 | Everyone is permitted to copy and distribute verbatim copies of this license 9 | document, but changing it is not allowed. 10 | 11 | ## Preamble 12 | 13 | The GNU General Public License is a free, copyleft license for software and other 14 | kinds of works. 15 | 16 | The licenses for most software and other practical works are designed to take away 17 | your freedom to share and change the works. By contrast, the GNU General Public 18 | License is intended to guarantee your freedom to share and change all versions of a 19 | program--to make sure it remains free software for all its users. We, the Free 20 | Software Foundation, use the GNU General Public License for most of our software; it 21 | applies also to any other work released this way by its authors. You can apply it to 22 | your programs, too. 23 | 24 | When we speak of free software, we are referring to freedom, not price. Our General 25 | Public Licenses are designed to make sure that you have the freedom to distribute 26 | copies of free software (and charge for them if you wish), that you receive source 27 | code or can get it if you want it, that you can change the software or use pieces of 28 | it in new free programs, and that you know you can do these things. 29 | 30 | To protect your rights, we need to prevent others from denying you these rights or 31 | asking you to surrender the rights. Therefore, you have certain responsibilities if 32 | you distribute copies of the software, or if you modify it: responsibilities to 33 | respect the freedom of others. 34 | 35 | For example, if you distribute copies of such a program, whether gratis or for a fee, 36 | you must pass on to the recipients the same freedoms that you received. You must make 37 | sure that they, too, receive or can get the source code. And you must show them these 38 | terms so they know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: (1) assert 41 | copyright on the software, and (2) offer you this License giving you legal permission 42 | to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains that there is 45 | no warranty for this free software. For both users' and authors' sake, the GPL 46 | requires that modified versions be marked as changed, so that their problems will not 47 | be attributed erroneously to authors of previous versions. 48 | 49 | Some devices are designed to deny users access to install or run modified versions of 50 | the software inside them, although the manufacturer can do so. This is fundamentally 51 | incompatible with the aim of protecting users' freedom to change the software. The 52 | systematic pattern of such abuse occurs in the area of products for individuals to 53 | use, which is precisely where it is most unacceptable. Therefore, we have designed 54 | this version of the GPL to prohibit the practice for those products. If such problems 55 | arise substantially in other domains, we stand ready to extend this provision to 56 | those domains in future versions of the GPL, as needed to protect the freedom of 57 | users. 58 | 59 | Finally, every program is threatened constantly by software patents. States should 60 | not allow patents to restrict development and use of software on general-purpose 61 | computers, but in those that do, we wish to avoid the special danger that patents 62 | applied to a free program could make it effectively proprietary. To prevent this, the 63 | GPL assures that patents cannot be used to render the program non-free. 64 | 65 | The precise terms and conditions for copying, distribution and modification follow. 66 | 67 | ## TERMS AND CONDITIONS 68 | 69 | ### 0. Definitions. 70 | 71 | “This License” refers to version 3 of the GNU General Public License. 72 | 73 | “Copyright” also means copyright-like laws that apply to other kinds of 74 | works, such as semiconductor masks. 75 | 76 | “The Program” refers to any copyrightable work licensed under this 77 | License. Each licensee is addressed as “you”. “Licensees” and 78 | “recipients” may be individuals or organizations. 79 | 80 | To “modify” a work means to copy from or adapt all or part of the work in 81 | a fashion requiring copyright permission, other than the making of an exact copy. The 82 | resulting work is called a “modified version” of the earlier work or a 83 | work “based on” the earlier work. 84 | 85 | A “covered work” means either the unmodified Program or a work based on 86 | the Program. 87 | 88 | To “propagate” a work means to do anything with it that, without 89 | permission, would make you directly or secondarily liable for infringement under 90 | applicable copyright law, except executing it on a computer or modifying a private 91 | copy. Propagation includes copying, distribution (with or without modification), 92 | making available to the public, and in some countries other activities as well. 93 | 94 | To “convey” a work means any kind of propagation that enables other 95 | parties to make or receive copies. Mere interaction with a user through a computer 96 | network, with no transfer of a copy, is not conveying. 97 | 98 | An interactive user interface displays “Appropriate Legal Notices” to the 99 | extent that it includes a convenient and prominently visible feature that (1) 100 | displays an appropriate copyright notice, and (2) tells the user that there is no 101 | warranty for the work (except to the extent that warranties are provided), that 102 | licensees may convey the work under this License, and how to view a copy of this 103 | License. If the interface presents a list of user commands or options, such as a 104 | menu, a prominent item in the list meets this criterion. 105 | 106 | ### 1. Source Code. 107 | 108 | The “source code” for a work means the preferred form of the work for 109 | making modifications to it. “Object code” means any non-source form of a 110 | work. 111 | 112 | A “Standard Interface” means an interface that either is an official 113 | standard defined by a recognized standards body, or, in the case of interfaces 114 | specified for a particular programming language, one that is widely used among 115 | developers working in that language. 116 | 117 | The “System Libraries” of an executable work include anything, other than 118 | the work as a whole, that (a) is included in the normal form of packaging a Major 119 | Component, but which is not part of that Major Component, and (b) serves only to 120 | enable use of the work with that Major Component, or to implement a Standard 121 | Interface for which an implementation is available to the public in source code form. 122 | A “Major Component”, in this context, means a major essential component 123 | (kernel, window system, and so on) of the specific operating system (if any) on which 124 | the executable work runs, or a compiler used to produce the work, or an object code 125 | interpreter used to run it. 126 | 127 | The “Corresponding Source” for a work in object code form means all the 128 | source code needed to generate, install, and (for an executable work) run the object 129 | code and to modify the work, including scripts to control those activities. However, 130 | it does not include the work's System Libraries, or general-purpose tools or 131 | generally available free programs which are used unmodified in performing those 132 | activities but which are not part of the work. For example, Corresponding Source 133 | includes interface definition files associated with source files for the work, and 134 | the source code for shared libraries and dynamically linked subprograms that the work 135 | is specifically designed to require, such as by intimate data communication or 136 | control flow between those subprograms and other parts of the work. 137 | 138 | The Corresponding Source need not include anything that users can regenerate 139 | automatically from other parts of the Corresponding Source. 140 | 141 | The Corresponding Source for a work in source code form is that same work. 142 | 143 | ### 2. Basic Permissions. 144 | 145 | All rights granted under this License are granted for the term of copyright on the 146 | Program, and are irrevocable provided the stated conditions are met. This License 147 | explicitly affirms your unlimited permission to run the unmodified Program. The 148 | output from running a covered work is covered by this License only if the output, 149 | given its content, constitutes a covered work. This License acknowledges your rights 150 | of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not convey, without 153 | conditions so long as your license otherwise remains in force. You may convey covered 154 | works to others for the sole purpose of having them make modifications exclusively 155 | for you, or provide you with facilities for running those works, provided that you 156 | comply with the terms of this License in conveying all material for which you do not 157 | control copyright. Those thus making or running the covered works for you must do so 158 | exclusively on your behalf, under your direction and control, on terms that prohibit 159 | them from making any copies of your copyrighted material outside their relationship 160 | with you. 161 | 162 | Conveying under any other circumstances is permitted solely under the conditions 163 | stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 164 | 165 | ### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 166 | 167 | No covered work shall be deemed part of an effective technological measure under any 168 | applicable law fulfilling obligations under article 11 of the WIPO copyright treaty 169 | adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention 170 | of such measures. 171 | 172 | When you convey a covered work, you waive any legal power to forbid circumvention of 173 | technological measures to the extent such circumvention is effected by exercising 174 | rights under this License with respect to the covered work, and you disclaim any 175 | intention to limit operation or modification of the work as a means of enforcing, 176 | against the work's users, your or third parties' legal rights to forbid circumvention 177 | of technological measures. 178 | 179 | ### 4. Conveying Verbatim Copies. 180 | 181 | You may convey verbatim copies of the Program's source code as you receive it, in any 182 | medium, provided that you conspicuously and appropriately publish on each copy an 183 | appropriate copyright notice; keep intact all notices stating that this License and 184 | any non-permissive terms added in accord with section 7 apply to the code; keep 185 | intact all notices of the absence of any warranty; and give all recipients a copy of 186 | this License along with the Program. 187 | 188 | You may charge any price or no price for each copy that you convey, and you may offer 189 | support or warranty protection for a fee. 190 | 191 | ### 5. Conveying Modified Source Versions. 192 | 193 | You may convey a work based on the Program, or the modifications to produce it from 194 | the Program, in the form of source code under the terms of section 4, provided that 195 | you also meet all of these conditions: 196 | 197 | * **a)** The work must carry prominent notices stating that you modified it, and giving a 198 | relevant date. 199 | * **b)** The work must carry prominent notices stating that it is released under this 200 | License and any conditions added under section 7. This requirement modifies the 201 | requirement in section 4 to “keep intact all notices”. 202 | * **c)** You must license the entire work, as a whole, under this License to anyone who 203 | comes into possession of a copy. This License will therefore apply, along with any 204 | applicable section 7 additional terms, to the whole of the work, and all its parts, 205 | regardless of how they are packaged. This License gives no permission to license the 206 | work in any other way, but it does not invalidate such permission if you have 207 | separately received it. 208 | * **d)** If the work has interactive user interfaces, each must display Appropriate Legal 209 | Notices; however, if the Program has interactive interfaces that do not display 210 | Appropriate Legal Notices, your work need not make them do so. 211 | 212 | A compilation of a covered work with other separate and independent works, which are 213 | not by their nature extensions of the covered work, and which are not combined with 214 | it such as to form a larger program, in or on a volume of a storage or distribution 215 | medium, is called an “aggregate” if the compilation and its resulting 216 | copyright are not used to limit the access or legal rights of the compilation's users 217 | beyond what the individual works permit. Inclusion of a covered work in an aggregate 218 | does not cause this License to apply to the other parts of the aggregate. 219 | 220 | ### 6. Conveying Non-Source Forms. 221 | 222 | You may convey a covered work in object code form under the terms of sections 4 and 223 | 5, provided that you also convey the machine-readable Corresponding Source under the 224 | terms of this License, in one of these ways: 225 | 226 | * **a)** Convey the object code in, or embodied in, a physical product (including a 227 | physical distribution medium), accompanied by the Corresponding Source fixed on a 228 | durable physical medium customarily used for software interchange. 229 | * **b)** Convey the object code in, or embodied in, a physical product (including a 230 | physical distribution medium), accompanied by a written offer, valid for at least 231 | three years and valid for as long as you offer spare parts or customer support for 232 | that product model, to give anyone who possesses the object code either (1) a copy of 233 | the Corresponding Source for all the software in the product that is covered by this 234 | License, on a durable physical medium customarily used for software interchange, for 235 | a price no more than your reasonable cost of physically performing this conveying of 236 | source, or (2) access to copy the Corresponding Source from a network server at no 237 | charge. 238 | * **c)** Convey individual copies of the object code with a copy of the written offer to 239 | provide the Corresponding Source. This alternative is allowed only occasionally and 240 | noncommercially, and only if you received the object code with such an offer, in 241 | accord with subsection 6b. 242 | * **d)** Convey the object code by offering access from a designated place (gratis or for 243 | a charge), and offer equivalent access to the Corresponding Source in the same way 244 | through the same place at no further charge. You need not require recipients to copy 245 | the Corresponding Source along with the object code. If the place to copy the object 246 | code is a network server, the Corresponding Source may be on a different server 247 | (operated by you or a third party) that supports equivalent copying facilities, 248 | provided you maintain clear directions next to the object code saying where to find 249 | the Corresponding Source. Regardless of what server hosts the Corresponding Source, 250 | you remain obligated to ensure that it is available for as long as needed to satisfy 251 | these requirements. 252 | * **e)** Convey the object code using peer-to-peer transmission, provided you inform 253 | other peers where the object code and Corresponding Source of the work are being 254 | offered to the general public at no charge under subsection 6d. 255 | 256 | A separable portion of the object code, whose source code is excluded from the 257 | Corresponding Source as a System Library, need not be included in conveying the 258 | object code work. 259 | 260 | A “User Product” is either (1) a “consumer product”, which 261 | means any tangible personal property which is normally used for personal, family, or 262 | household purposes, or (2) anything designed or sold for incorporation into a 263 | dwelling. In determining whether a product is a consumer product, doubtful cases 264 | shall be resolved in favor of coverage. For a particular product received by a 265 | particular user, “normally used” refers to a typical or common use of 266 | that class of product, regardless of the status of the particular user or of the way 267 | in which the particular user actually uses, or expects or is expected to use, the 268 | product. A product is a consumer product regardless of whether the product has 269 | substantial commercial, industrial or non-consumer uses, unless such uses represent 270 | the only significant mode of use of the product. 271 | 272 | “Installation Information” for a User Product means any methods, 273 | procedures, authorization keys, or other information required to install and execute 274 | modified versions of a covered work in that User Product from a modified version of 275 | its Corresponding Source. The information must suffice to ensure that the continued 276 | functioning of the modified object code is in no case prevented or interfered with 277 | solely because modification has been made. 278 | 279 | If you convey an object code work under this section in, or with, or specifically for 280 | use in, a User Product, and the conveying occurs as part of a transaction in which 281 | the right of possession and use of the User Product is transferred to the recipient 282 | in perpetuity or for a fixed term (regardless of how the transaction is 283 | characterized), the Corresponding Source conveyed under this section must be 284 | accompanied by the Installation Information. But this requirement does not apply if 285 | neither you nor any third party retains the ability to install modified object code 286 | on the User Product (for example, the work has been installed in ROM). 287 | 288 | The requirement to provide Installation Information does not include a requirement to 289 | continue to provide support service, warranty, or updates for a work that has been 290 | modified or installed by the recipient, or for the User Product in which it has been 291 | modified or installed. Access to a network may be denied when the modification itself 292 | materially and adversely affects the operation of the network or violates the rules 293 | and protocols for communication across the network. 294 | 295 | Corresponding Source conveyed, and Installation Information provided, in accord with 296 | this section must be in a format that is publicly documented (and with an 297 | implementation available to the public in source code form), and must require no 298 | special password or key for unpacking, reading or copying. 299 | 300 | ### 7. Additional Terms. 301 | 302 | “Additional permissions” are terms that supplement the terms of this 303 | License by making exceptions from one or more of its conditions. Additional 304 | permissions that are applicable to the entire Program shall be treated as though they 305 | were included in this License, to the extent that they are valid under applicable 306 | law. If additional permissions apply only to part of the Program, that part may be 307 | used separately under those permissions, but the entire Program remains governed by 308 | this License without regard to the additional permissions. 309 | 310 | When you convey a copy of a covered work, you may at your option remove any 311 | additional permissions from that copy, or from any part of it. (Additional 312 | permissions may be written to require their own removal in certain cases when you 313 | modify the work.) You may place additional permissions on material, added by you to a 314 | covered work, for which you have or can give appropriate copyright permission. 315 | 316 | Notwithstanding any other provision of this License, for material you add to a 317 | covered work, you may (if authorized by the copyright holders of that material) 318 | supplement the terms of this License with terms: 319 | 320 | * **a)** Disclaiming warranty or limiting liability differently from the terms of 321 | sections 15 and 16 of this License; or 322 | * **b)** Requiring preservation of specified reasonable legal notices or author 323 | attributions in that material or in the Appropriate Legal Notices displayed by works 324 | containing it; or 325 | * **c)** Prohibiting misrepresentation of the origin of that material, or requiring that 326 | modified versions of such material be marked in reasonable ways as different from the 327 | original version; or 328 | * **d)** Limiting the use for publicity purposes of names of licensors or authors of the 329 | material; or 330 | * **e)** Declining to grant rights under trademark law for use of some trade names, 331 | trademarks, or service marks; or 332 | * **f)** Requiring indemnification of licensors and authors of that material by anyone 333 | who conveys the material (or modified versions of it) with contractual assumptions of 334 | liability to the recipient, for any liability that these contractual assumptions 335 | directly impose on those licensors and authors. 336 | 337 | All other non-permissive additional terms are considered “further 338 | restrictions” within the meaning of section 10. If the Program as you received 339 | it, or any part of it, contains a notice stating that it is governed by this License 340 | along with a term that is a further restriction, you may remove that term. If a 341 | license document contains a further restriction but permits relicensing or conveying 342 | under this License, you may add to a covered work material governed by the terms of 343 | that license document, provided that the further restriction does not survive such 344 | relicensing or conveying. 345 | 346 | If you add terms to a covered work in accord with this section, you must place, in 347 | the relevant source files, a statement of the additional terms that apply to those 348 | files, or a notice indicating where to find the applicable terms. 349 | 350 | Additional terms, permissive or non-permissive, may be stated in the form of a 351 | separately written license, or stated as exceptions; the above requirements apply 352 | either way. 353 | 354 | ### 8. Termination. 355 | 356 | You may not propagate or modify a covered work except as expressly provided under 357 | this License. Any attempt otherwise to propagate or modify it is void, and will 358 | automatically terminate your rights under this License (including any patent licenses 359 | granted under the third paragraph of section 11). 360 | 361 | However, if you cease all violation of this License, then your license from a 362 | particular copyright holder is reinstated (a) provisionally, unless and until the 363 | copyright holder explicitly and finally terminates your license, and (b) permanently, 364 | if the copyright holder fails to notify you of the violation by some reasonable means 365 | prior to 60 days after the cessation. 366 | 367 | Moreover, your license from a particular copyright holder is reinstated permanently 368 | if the copyright holder notifies you of the violation by some reasonable means, this 369 | is the first time you have received notice of violation of this License (for any 370 | work) from that copyright holder, and you cure the violation prior to 30 days after 371 | your receipt of the notice. 372 | 373 | Termination of your rights under this section does not terminate the licenses of 374 | parties who have received copies or rights from you under this License. If your 375 | rights have been terminated and not permanently reinstated, you do not qualify to 376 | receive new licenses for the same material under section 10. 377 | 378 | ### 9. Acceptance Not Required for Having Copies. 379 | 380 | You are not required to accept this License in order to receive or run a copy of the 381 | Program. Ancillary propagation of a covered work occurring solely as a consequence of 382 | using peer-to-peer transmission to receive a copy likewise does not require 383 | acceptance. However, nothing other than this License grants you permission to 384 | propagate or modify any covered work. These actions infringe copyright if you do not 385 | accept this License. Therefore, by modifying or propagating a covered work, you 386 | indicate your acceptance of this License to do so. 387 | 388 | ### 10. Automatic Licensing of Downstream Recipients. 389 | 390 | Each time you convey a covered work, the recipient automatically receives a license 391 | from the original licensors, to run, modify and propagate that work, subject to this 392 | License. You are not responsible for enforcing compliance by third parties with this 393 | License. 394 | 395 | An “entity transaction” is a transaction transferring control of an 396 | organization, or substantially all assets of one, or subdividing an organization, or 397 | merging organizations. If propagation of a covered work results from an entity 398 | transaction, each party to that transaction who receives a copy of the work also 399 | receives whatever licenses to the work the party's predecessor in interest had or 400 | could give under the previous paragraph, plus a right to possession of the 401 | Corresponding Source of the work from the predecessor in interest, if the predecessor 402 | has it or can get it with reasonable efforts. 403 | 404 | You may not impose any further restrictions on the exercise of the rights granted or 405 | affirmed under this License. For example, you may not impose a license fee, royalty, 406 | or other charge for exercise of rights granted under this License, and you may not 407 | initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging 408 | that any patent claim is infringed by making, using, selling, offering for sale, or 409 | importing the Program or any portion of it. 410 | 411 | ### 11. Patents. 412 | 413 | A “contributor” is a copyright holder who authorizes use under this 414 | License of the Program or a work on which the Program is based. The work thus 415 | licensed is called the contributor's “contributor version”. 416 | 417 | A contributor's “essential patent claims” are all patent claims owned or 418 | controlled by the contributor, whether already acquired or hereafter acquired, that 419 | would be infringed by some manner, permitted by this License, of making, using, or 420 | selling its contributor version, but do not include claims that would be infringed 421 | only as a consequence of further modification of the contributor version. For 422 | purposes of this definition, “control” includes the right to grant patent 423 | sublicenses in a manner consistent with the requirements of this License. 424 | 425 | Each contributor grants you a non-exclusive, worldwide, royalty-free patent license 426 | under the contributor's essential patent claims, to make, use, sell, offer for sale, 427 | import and otherwise run, modify and propagate the contents of its contributor 428 | version. 429 | 430 | In the following three paragraphs, a “patent license” is any express 431 | agreement or commitment, however denominated, not to enforce a patent (such as an 432 | express permission to practice a patent or covenant not to sue for patent 433 | infringement). To “grant” such a patent license to a party means to make 434 | such an agreement or commitment not to enforce a patent against the party. 435 | 436 | If you convey a covered work, knowingly relying on a patent license, and the 437 | Corresponding Source of the work is not available for anyone to copy, free of charge 438 | and under the terms of this License, through a publicly available network server or 439 | other readily accessible means, then you must either (1) cause the Corresponding 440 | Source to be so available, or (2) arrange to deprive yourself of the benefit of the 441 | patent license for this particular work, or (3) arrange, in a manner consistent with 442 | the requirements of this License, to extend the patent license to downstream 443 | recipients. “Knowingly relying” means you have actual knowledge that, but 444 | for the patent license, your conveying the covered work in a country, or your 445 | recipient's use of the covered work in a country, would infringe one or more 446 | identifiable patents in that country that you have reason to believe are valid. 447 | 448 | If, pursuant to or in connection with a single transaction or arrangement, you 449 | convey, or propagate by procuring conveyance of, a covered work, and grant a patent 450 | license to some of the parties receiving the covered work authorizing them to use, 451 | propagate, modify or convey a specific copy of the covered work, then the patent 452 | license you grant is automatically extended to all recipients of the covered work and 453 | works based on it. 454 | 455 | A patent license is “discriminatory” if it does not include within the 456 | scope of its coverage, prohibits the exercise of, or is conditioned on the 457 | non-exercise of one or more of the rights that are specifically granted under this 458 | License. You may not convey a covered work if you are a party to an arrangement with 459 | a third party that is in the business of distributing software, under which you make 460 | payment to the third party based on the extent of your activity of conveying the 461 | work, and under which the third party grants, to any of the parties who would receive 462 | the covered work from you, a discriminatory patent license (a) in connection with 463 | copies of the covered work conveyed by you (or copies made from those copies), or (b) 464 | primarily for and in connection with specific products or compilations that contain 465 | the covered work, unless you entered into that arrangement, or that patent license 466 | was granted, prior to 28 March 2007. 467 | 468 | Nothing in this License shall be construed as excluding or limiting any implied 469 | license or other defenses to infringement that may otherwise be available to you 470 | under applicable patent law. 471 | 472 | ### 12. No Surrender of Others' Freedom. 473 | 474 | If conditions are imposed on you (whether by court order, agreement or otherwise) 475 | that contradict the conditions of this License, they do not excuse you from the 476 | conditions of this License. If you cannot convey a covered work so as to satisfy 477 | simultaneously your obligations under this License and any other pertinent 478 | obligations, then as a consequence you may not convey it at all. For example, if you 479 | agree to terms that obligate you to collect a royalty for further conveying from 480 | those to whom you convey the Program, the only way you could satisfy both those terms 481 | and this License would be to refrain entirely from conveying the Program. 482 | 483 | ### 13. Use with the GNU Affero General Public License. 484 | 485 | Notwithstanding any other provision of this License, you have permission to link or 486 | combine any covered work with a work licensed under version 3 of the GNU Affero 487 | General Public License into a single combined work, and to convey the resulting work. 488 | The terms of this License will continue to apply to the part which is the covered 489 | work, but the special requirements of the GNU Affero General Public License, section 490 | 13, concerning interaction through a network will apply to the combination as such. 491 | 492 | ### 14. Revised Versions of this License. 493 | 494 | The Free Software Foundation may publish revised and/or new versions of the GNU 495 | General Public License from time to time. Such new versions will be similar in spirit 496 | to the present version, but may differ in detail to address new problems or concerns. 497 | 498 | Each version is given a distinguishing version number. If the Program specifies that 499 | a certain numbered version of the GNU General Public License “or any later 500 | version” applies to it, you have the option of following the terms and 501 | conditions either of that numbered version or of any later version published by the 502 | Free Software Foundation. If the Program does not specify a version number of the GNU 503 | General Public License, you may choose any version ever published by the Free 504 | Software Foundation. 505 | 506 | If the Program specifies that a proxy can decide which future versions of the GNU 507 | General Public License can be used, that proxy's public statement of acceptance of a 508 | version permanently authorizes you to choose that version for the Program. 509 | 510 | Later license versions may give you additional or different permissions. However, no 511 | additional obligations are imposed on any author or copyright holder as a result of 512 | your choosing to follow a later version. 513 | 514 | ### 15. Disclaimer of Warranty. 515 | 516 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 517 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 518 | PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER 519 | EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 520 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE 521 | QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE 522 | DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 523 | 524 | ### 16. Limitation of Liability. 525 | 526 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY 527 | COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS 528 | PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, 529 | INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 530 | PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE 531 | OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE 532 | WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 533 | POSSIBILITY OF SUCH DAMAGES. 534 | 535 | ### 17. Interpretation of Sections 15 and 16. 536 | 537 | If the disclaimer of warranty and limitation of liability provided above cannot be 538 | given local legal effect according to their terms, reviewing courts shall apply local 539 | law that most closely approximates an absolute waiver of all civil liability in 540 | connection with the Program, unless a warranty or assumption of liability accompanies 541 | a copy of the Program in return for a fee. 542 | 543 | END OF TERMS AND CONDITIONS 544 | 545 | ## How to Apply These Terms to Your New Programs 546 | 547 | If you develop a new program, and you want it to be of the greatest possible use to 548 | the public, the best way to achieve this is to make it free software which everyone 549 | can redistribute and change under these terms. 550 | 551 | To do so, attach the following notices to the program. It is safest to attach them 552 | to the start of each source file to most effectively state the exclusion of warranty; 553 | and each file should have at least the “copyright” line and a pointer to 554 | where the full notice is found. 555 | 556 | 557 | Copyright (C) 558 | 559 | This program is free software: you can redistribute it and/or modify 560 | it under the terms of the GNU General Public License as published by 561 | the Free Software Foundation, either version 3 of the License, or 562 | (at your option) any later version. 563 | 564 | This program is distributed in the hope that it will be useful, 565 | but WITHOUT ANY WARRANTY; without even the implied warranty of 566 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 567 | GNU General Public License for more details. 568 | 569 | You should have received a copy of the GNU General Public License 570 | along with this program. If not, see . 571 | 572 | Also add information on how to contact you by electronic and paper mail. 573 | 574 | If the program does terminal interaction, make it output a short notice like this 575 | when it starts in an interactive mode: 576 | 577 | Copyright (C) 578 | This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'. 579 | This is free software, and you are welcome to redistribute it 580 | under certain conditions; type 'show c' for details. 581 | 582 | The hypothetical commands 'show w' and 'show c' should show the appropriate parts of 583 | the General Public License. Of course, your program's commands might be different; 584 | for a GUI interface, you would use an “about box”. 585 | 586 | You should also get your employer (if you work as a programmer) or school, if any, to 587 | sign a “copyright disclaimer” for the program, if necessary. For more 588 | information on this, and how to apply and follow the GNU GPL, see 589 | <>. 590 | 591 | The GNU General Public License does not permit incorporating your program into 592 | proprietary programs. If your program is a subroutine library, you may consider it 593 | more useful to permit linking proprietary applications with the library. If this is 594 | what you want to do, use the GNU Lesser General Public License instead of this 595 | License. But first, please read 596 | <>. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # My ToDo list # 2 | 3 | Simple plugin implementing a personal ToDo list on the user's Moodle dashboard. 4 | 5 | The main purpose of this plugin is to demonstrate usage of advanced coding techniques 6 | available in recent Moodle versions. Most notably: 7 | 8 | * Rendering HTML output via Mustache templates. 9 | * AJAX based workflow of the elementary CRUD operations. 10 | * Organising JS into AMD modules. 11 | * Organising external functions into traits. 12 | * Low-level access to the database via persistent models. 13 | * Using exporters for handling the data structures in rendering and AJAX. 14 | 15 | ## License ## 16 | 17 | 2018 David Mudrák 18 | 19 | This program is free software: you can redistribute it and/or modify it under 20 | the terms of the GNU General Public License as published by the Free Software 21 | Foundation, either version 3 of the License, or (at your option) any later 22 | version. 23 | 24 | This program is distributed in the hope that it will be useful, but WITHOUT ANY 25 | WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A 26 | PARTICULAR PURPOSE. See the GNU General Public License for more details. 27 | 28 | You should have received a copy of the GNU General Public License along with 29 | this program. If not, see . 30 | -------------------------------------------------------------------------------- /amd/build/control.min.js: -------------------------------------------------------------------------------- 1 | define(["jquery","core/log","core/ajax","core/templates","core/str"],function(a,b,c,d,e){"use strict";function f(c){b.debug("block_todo/control: initializing controls of the todo block instance "+c);var d=a('[data-region="block_todo-instance-'+c+'"]').first();if(!d.length)return void b.error("block_todo/control: wrapping region not found!");var e=new g(d);e.main()}function g(a){var b=this;b.region=a}return g.prototype.main=function(){var a=this;a.addTextForm=a.region.find('[data-control="addform"]').first(),a.addTextInput=a.addTextForm.find("input").first(),a.addTextButton=a.addTextForm.find("button").first(),a.itemsList=a.region.find("ul").first(),a.initAddFeatures(),a.initEditFeatures()},g.prototype.initAddFeatures=function(){var a=this;a.addTextForm.on("submit",function(b){b.preventDefault(),a.addNewTodo()}),a.addTextButton.on("click",function(){a.addTextForm.submit()})},g.prototype.initEditFeatures=function(){var b=this;b.itemsList.on("click","[data-item]",function(c){c.preventDefault(),c.stopPropagation();var d=a(c.currentTarget).attr("data-item");b.toggleItem(d)}),b.itemsList.on("click",'[data-control="delete"]',function(c){c.preventDefault(),c.stopPropagation();var d=a(c.currentTarget).closest("[data-item]").attr("data-item");b.deleteItem(d)})},g.prototype.addNewTodo=function(){var f=this,g=a.trim(f.addTextInput.val());return g?(f.addTextInput.prop("disabled",!0),c.call([{methodname:"block_todo_add_item",args:{todotext:g}}])[0].fail(function(c){return b.error("block_todo/control: unable to add the item"),b.debug(c),f.addTextButton.addClass("btn-danger"),f.addTextButton.html(''),a.Deferred().reject()}).then(function(a){return d.render("block_todo/item",a).fail(function(a){b.error("block_todo/control: unable to render the new item:"+a)})}).then(function(b){return f.itemsList.prepend(b),f.addTextInput.val(""),f.addTextInput.prop("disabled",!1),f.addTextInput.focus(),a.Deferred().resolve()})):e.get_string("placeholdermore","block_todo").then(function(b){return f.addTextInput.prop("placeholder",b),a.Deferred().resolve()})},g.prototype.toggleItem=function(e){var f=this;return e?c.call([{methodname:"block_todo_toggle_item",args:{id:e}}])[0].fail(function(c){return b.error("block_todo/control: unable to toggle the item"),b.debug(c),a.Deferred().reject()}).then(function(a){return d.render("block_todo/item",a).fail(function(a){b.error("block_todo/control: unable to render the new item:"+a)})}).then(function(b){return f.itemsList.find('[data-item="'+e+'"]').replaceWith(b),a.Deferred().resolve()}):a.Deferred().resolve()},g.prototype.deleteItem=function(d){var e=this;return d?c.call([{methodname:"block_todo_delete_item",args:{id:d}}])[0].fail(function(c){return b.error("block_todo/control: unable to delete the item"),b.debug(c),a.Deferred().reject()}).then(function(b){return e.itemsList.find('[data-item="'+b+'"]').remove(),a.Deferred().resolve()}):a.Deferred().resolve()},{init:f}}); -------------------------------------------------------------------------------- /amd/src/control.js: -------------------------------------------------------------------------------- 1 | // This file is part of Moodle - http://moodle.org/ 2 | // 3 | // Moodle is free software: you can redistribute it and/or modify 4 | // it under the terms of the GNU General Public License as published by 5 | // the Free Software Foundation, either version 3 of the License, or 6 | // (at your option) any later version. 7 | // 8 | // Moodle is distributed in the hope that it will be useful, 9 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | // GNU General Public License for more details. 12 | // 13 | // You should have received a copy of the GNU General Public License 14 | // along with Moodle. If not, see . 15 | 16 | /** 17 | * Provides the block_todo/control module 18 | * 19 | * @package block_todo 20 | * @category output 21 | * @copyright 2018 David Mudrák 22 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 23 | */ 24 | 25 | /** 26 | * @module block_todo/control 27 | */ 28 | define(['jquery', 'core/log', 'core/ajax', 'core/templates', 'core/str'], function($, Log, Ajax, Templates, Str) { 29 | 'use strict'; 30 | 31 | /** 32 | * Initializes the block controls. 33 | */ 34 | function init(instanceid) { 35 | Log.debug('block_todo/control: initializing controls of the todo block instance ' + instanceid); 36 | 37 | var region = $('[data-region="block_todo-instance-' + instanceid +'"]').first(); 38 | 39 | if (!region.length) { 40 | Log.error('block_todo/control: wrapping region not found!'); 41 | return; 42 | } 43 | 44 | var control = new TodoControl(region); 45 | control.main(); 46 | } 47 | 48 | /** 49 | * Controls a single ToDo block instance contents. 50 | * 51 | * @constructor 52 | * @param {jQuery} region 53 | */ 54 | function TodoControl(region) { 55 | var self = this; 56 | self.region = region; 57 | } 58 | 59 | /** 60 | * Run the controller. 61 | * 62 | */ 63 | TodoControl.prototype.main = function () { 64 | var self = this; 65 | 66 | self.addTextForm = self.region.find('[data-control="addform"]').first(); 67 | self.addTextInput = self.addTextForm.find('input').first(); 68 | self.addTextButton = self.addTextForm.find('button').first(); 69 | self.itemsList = self.region.find('ul').first(); 70 | 71 | self.initAddFeatures(); 72 | self.initEditFeatures(); 73 | }; 74 | 75 | /** 76 | * Initialize the controls for adding a new todo item. 77 | * 78 | * @method 79 | */ 80 | TodoControl.prototype.initAddFeatures = function () { 81 | var self = this; 82 | 83 | self.addTextForm.on('submit', function(e) { 84 | e.preventDefault(); 85 | self.addNewTodo(); 86 | }); 87 | 88 | self.addTextButton.on('click', function() { 89 | self.addTextForm.submit(); 90 | }); 91 | }; 92 | 93 | /** 94 | * Initialize the controls for modifying existing items. 95 | * 96 | * @method 97 | */ 98 | TodoControl.prototype.initEditFeatures = function () { 99 | var self = this; 100 | 101 | self.itemsList.on('click', '[data-item]', function(e) { 102 | e.preventDefault(); 103 | e.stopPropagation(); 104 | var id = $(e.currentTarget).attr('data-item'); 105 | self.toggleItem(id); 106 | }); 107 | 108 | self.itemsList.on('click', '[data-control="delete"]', function(e) { 109 | e.preventDefault(); 110 | e.stopPropagation(); 111 | var id = $(e.currentTarget).closest('[data-item]').attr('data-item'); 112 | self.deleteItem(id); 113 | }); 114 | }; 115 | 116 | /** 117 | * Add a new todo item. 118 | * 119 | * @method 120 | * @return {Deferred} 121 | */ 122 | TodoControl.prototype.addNewTodo = function () { 123 | var self = this; 124 | var text = $.trim(self.addTextInput.val()); 125 | 126 | if (!text) { 127 | return Str.get_string('placeholdermore', 'block_todo').then(function(text) { 128 | self.addTextInput.prop('placeholder', text); 129 | return $.Deferred().resolve(); 130 | }); 131 | } 132 | 133 | self.addTextInput.prop('disabled', true); 134 | 135 | return Ajax.call([{ 136 | methodname: 'block_todo_add_item', 137 | args: { 138 | todotext: text 139 | } 140 | 141 | }])[0].fail(function(reason) { 142 | Log.error('block_todo/control: unable to add the item'); 143 | Log.debug(reason); 144 | self.addTextButton.addClass('btn-danger'); 145 | self.addTextButton.html(''); 146 | return $.Deferred().reject(); 147 | 148 | }).then(function(response) { 149 | return Templates.render('block_todo/item', response).fail(function(reason) { 150 | Log.error('block_todo/control: unable to render the new item:' + reason); 151 | }); 152 | 153 | }).then(function(item) { 154 | self.itemsList.prepend(item); 155 | self.addTextInput.val(''); 156 | self.addTextInput.prop('disabled', false); 157 | self.addTextInput.focus(); 158 | return $.Deferred().resolve(); 159 | }); 160 | }; 161 | 162 | /** 163 | * Toggle the done status of the given item. 164 | * 165 | * @method 166 | * @return {Deferred} 167 | */ 168 | TodoControl.prototype.toggleItem = function (id) { 169 | var self = this; 170 | 171 | if (!id) { 172 | return $.Deferred().resolve(); 173 | } 174 | 175 | return Ajax.call([{ 176 | methodname: 'block_todo_toggle_item', 177 | args: { 178 | id: id 179 | } 180 | 181 | }])[0].fail(function(reason) { 182 | Log.error('block_todo/control: unable to toggle the item'); 183 | Log.debug(reason); 184 | return $.Deferred().reject(); 185 | 186 | }).then(function(response) { 187 | return Templates.render('block_todo/item', response).fail(function(reason) { 188 | Log.error('block_todo/control: unable to render the new item:' + reason); 189 | }); 190 | 191 | }).then(function(item) { 192 | self.itemsList.find('[data-item="' + id + '"]').replaceWith(item); 193 | return $.Deferred().resolve(); 194 | }); 195 | }; 196 | 197 | /** 198 | * Delete the given item. 199 | * 200 | * @method 201 | * @return {Deferred} 202 | */ 203 | TodoControl.prototype.deleteItem = function (id) { 204 | var self = this; 205 | 206 | if (!id) { 207 | return $.Deferred().resolve(); 208 | } 209 | 210 | return Ajax.call([{ 211 | methodname: 'block_todo_delete_item', 212 | args: { 213 | id: id 214 | } 215 | 216 | }])[0].fail(function(reason) { 217 | Log.error('block_todo/control: unable to delete the item'); 218 | Log.debug(reason); 219 | return $.Deferred().reject(); 220 | 221 | }).then(function(deletedid) { 222 | self.itemsList.find('[data-item="' + deletedid + '"]').remove(); 223 | return $.Deferred().resolve(); 224 | }); 225 | }; 226 | 227 | return { 228 | init: init 229 | }; 230 | }); 231 | -------------------------------------------------------------------------------- /block_todo.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | /** 18 | * Block todo is defined here. 19 | * 20 | * @package block_todo 21 | * @copyright 2018 David Mudrák 22 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 23 | */ 24 | 25 | defined('MOODLE_INTERNAL') || die(); 26 | 27 | /** 28 | * todo block. 29 | * 30 | * @package block_todo 31 | * @copyright 2018 David Mudrák 32 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 33 | */ 34 | class block_todo extends block_base { 35 | 36 | /** 37 | * Initializes class member variables. 38 | */ 39 | public function init() { 40 | // Needed by Moodle to differentiate between blocks. 41 | $this->title = get_string('pluginname', 'block_todo'); 42 | } 43 | 44 | /** 45 | * Returns the block contents. 46 | * 47 | * @return stdClass The block contents. 48 | */ 49 | public function get_content() { 50 | global $USER, $OUTPUT; 51 | 52 | if ($this->content !== null) { 53 | return $this->content; 54 | } 55 | 56 | if (empty($this->instance)) { 57 | $this->content = ''; 58 | return $this->content; 59 | } 60 | 61 | $this->content = new stdClass(); 62 | 63 | // Load the list of persistent todo item models from the database. 64 | $items = block_todo\item::get_my_todo_items(); 65 | 66 | // Prepare the exporter of the todo items list. 67 | $list = new block_todo\external\list_exporter([ 68 | 'instanceid' => $this->instance->id, 69 | ], [ 70 | 'items' => $items, 71 | 'context' => $this->context, 72 | ]); 73 | 74 | // Render the list using a template and exported data. 75 | $this->content->text = $OUTPUT->render_from_template('block_todo/content', $list->export($OUTPUT)); 76 | 77 | return $this->content; 78 | } 79 | 80 | /** 81 | * Gets Javascript required for the widget functionality. 82 | */ 83 | public function get_required_javascript() { 84 | 85 | parent::get_required_javascript(); 86 | $this->page->requires->js_call_amd('block_todo/control', 'init', [ 87 | 'instanceid' => $this->instance->id 88 | ]); 89 | } 90 | 91 | /** 92 | * Defines configuration data. 93 | * 94 | * The function is called immediatly after init(). 95 | */ 96 | public function specialization() { 97 | 98 | // Load user defined title and make sure it's never empty. 99 | if (empty($this->config->title)) { 100 | $this->title = get_string('pluginname', 'block_todo'); 101 | } else { 102 | $this->title = $this->config->title; 103 | } 104 | } 105 | 106 | /** 107 | * Sets the applicable formats for the block. 108 | * 109 | * @return string[] Array of pages and permissions. 110 | */ 111 | public function applicable_formats() { 112 | return array( 113 | 'my' => true, 114 | ); 115 | } 116 | } 117 | -------------------------------------------------------------------------------- /classes/external/add_item.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | /** 18 | * Provides {@link block_todo\external\add_item} trait. 19 | * 20 | * @package block_todo 21 | * @category external 22 | * @copyright 2018 David Mudrák 23 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 24 | */ 25 | 26 | namespace block_todo\external; 27 | 28 | defined('MOODLE_INTERNAL') || die(); 29 | 30 | use block_todo\item; 31 | use context_user; 32 | use external_function_parameters; 33 | use external_value; 34 | 35 | require_once($CFG->libdir.'/externallib.php'); 36 | 37 | /** 38 | * Trait implementing the external function block_todo_add_item. 39 | */ 40 | trait add_item { 41 | 42 | /** 43 | * Describes the structure of parameters for the function. 44 | * 45 | * @return external_function_parameters 46 | */ 47 | public static function add_item_parameters() { 48 | return new external_function_parameters([ 49 | 'todotext' => new external_value(PARAM_RAW, 'Item text describing what is to be done'), 50 | ]); 51 | } 52 | 53 | /** 54 | * Adds a new todo item. 55 | * 56 | * @param string $todotext Item text 57 | */ 58 | public static function add_item($todotext) { 59 | global $USER, $PAGE; 60 | 61 | $context = context_user::instance($USER->id); 62 | self::validate_context($context); 63 | require_capability('block/todo:myaddinstance', $context); 64 | 65 | $todotext = strip_tags($todotext); 66 | $params = self::validate_parameters(self::add_item_parameters(), compact('todotext')); 67 | 68 | $item = new item(null, (object) $params); 69 | $item->create(); 70 | 71 | $itemexporter = new item_exporter($item, ['context' => $context]); 72 | 73 | return $itemexporter->export($PAGE->get_renderer('core')); 74 | } 75 | 76 | /** 77 | * Describes the structure of the function return value. 78 | * 79 | * @return external_single_structure 80 | */ 81 | public static function add_item_returns() { 82 | return item_exporter::get_read_structure(); 83 | } 84 | } 85 | -------------------------------------------------------------------------------- /classes/external/api.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | /** 18 | * Provides {@link block_todo\external\api} class. 19 | * 20 | * @package block_todo 21 | * @category external 22 | * @copyright 2018 David Mudrák 23 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 24 | */ 25 | 26 | namespace block_todo\external; 27 | 28 | defined('MOODLE_INTERNAL') || die(); 29 | 30 | require_once($CFG->libdir.'/externallib.php'); 31 | 32 | use external_api; 33 | 34 | /** 35 | * Provides an external API of the block. 36 | * 37 | * Each external function is implemented in its own trait. This class 38 | * aggregates them all. 39 | * 40 | * @copyright 2018 David Mudrák 41 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 42 | */ 43 | class api extends external_api { 44 | 45 | use add_item; 46 | use toggle_item; 47 | use delete_item; 48 | } 49 | -------------------------------------------------------------------------------- /classes/external/delete_item.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | /** 18 | * Provides {@link block_todo\external\delete_item} trait. 19 | * 20 | * @package block_todo 21 | * @category external 22 | * @copyright 2018 David Mudrák 23 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 24 | */ 25 | 26 | namespace block_todo\external; 27 | 28 | defined('MOODLE_INTERNAL') || die(); 29 | 30 | use block_todo\item; 31 | use context_user; 32 | use external_function_parameters; 33 | use external_value; 34 | use invalid_parameter_exception; 35 | 36 | require_once($CFG->libdir.'/externallib.php'); 37 | 38 | /** 39 | * Trait implementing the external function block_todo_delete_item. 40 | */ 41 | trait delete_item { 42 | 43 | /** 44 | * Describes the structure of parameters for the function. 45 | * 46 | * @return external_function_parameters 47 | */ 48 | public static function delete_item_parameters() { 49 | return new external_function_parameters([ 50 | 'id' => new external_value(PARAM_INT, 'ID of the todo item'), 51 | ]); 52 | } 53 | 54 | /** 55 | * Toggle the done status of the item. 56 | * 57 | * @param int $id ID of the item 58 | * @return int ID of the removed todo item 59 | */ 60 | public static function delete_item($id) { 61 | global $USER, $PAGE; 62 | 63 | $context = context_user::instance($USER->id); 64 | self::validate_context($context); 65 | require_capability('block/todo:myaddinstance', $context); 66 | 67 | $params = self::validate_parameters(self::delete_item_parameters(), compact('id')); 68 | 69 | $item = item::get_record(['usermodified' => $USER->id, 'id' => $id]); 70 | 71 | if (!$item) { 72 | throw new invalid_parameter_exception('Unable to find your todo item with that ID'); 73 | } 74 | 75 | $item->delete(); 76 | 77 | return $id; 78 | } 79 | 80 | /** 81 | * Describes the structure of the function return value. 82 | * 83 | * @return external_description 84 | */ 85 | public static function delete_item_returns() { 86 | return new external_value(PARAM_INT, 'ID of the removed todo item'); 87 | } 88 | } 89 | -------------------------------------------------------------------------------- /classes/external/item_exporter.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | /** 18 | * Provides {@link block_todo\external\item_exporter} class. 19 | * 20 | * @package block_todo 21 | * @copyright 2018 David Mudrák 22 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 23 | */ 24 | 25 | namespace block_todo\external; 26 | 27 | defined('MOODLE_INTERNAL') || die(); 28 | 29 | use \block_todo\item; 30 | use \core\external\persistent_exporter; 31 | 32 | /** 33 | * Exporter of a single todo list item. 34 | */ 35 | class item_exporter extends persistent_exporter { 36 | 37 | /** 38 | * Returns the specific class the persistent should be an instance of. 39 | * 40 | * @return string 41 | */ 42 | protected static function define_class() { 43 | return item::class; 44 | } 45 | 46 | /** 47 | * Returns a list of objects that are related. 48 | * 49 | * We need the context to be used when formatting the todotext field. 50 | * 51 | * @return array 52 | */ 53 | protected static function define_related() { 54 | return [ 55 | 'context' => 'context', 56 | ]; 57 | } 58 | } 59 | -------------------------------------------------------------------------------- /classes/external/list_exporter.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | /** 18 | * Provides {@link block_todo\external\list_exporter} class. 19 | * 20 | * @package block_todo 21 | * @copyright 2018 David Mudrák 22 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 23 | */ 24 | 25 | namespace block_todo\external; 26 | 27 | defined('MOODLE_INTERNAL') || die(); 28 | 29 | use renderer_base; 30 | use core\external\exporter; 31 | 32 | /** 33 | * Exporter of the todo list items. 34 | */ 35 | class list_exporter extends exporter { 36 | 37 | /** 38 | * Return the list of standard exported properties. 39 | * 40 | * @return array 41 | */ 42 | protected static function define_properties() { 43 | return [ 44 | 'instanceid' => [ 45 | 'type' => PARAM_INT, 46 | ], 47 | ]; 48 | } 49 | 50 | /** 51 | * Return the list of additional properties. 52 | * 53 | * @return array 54 | */ 55 | protected static function define_other_properties() { 56 | return [ 57 | 'items' => [ 58 | 'type' => item_exporter::read_properties_definition(), 59 | 'multiple' => true, 60 | 'optional' => false, 61 | ], 62 | ]; 63 | } 64 | 65 | /** 66 | * Returns a list of objects that are related. 67 | * 68 | * We need the context to be used when formatting the todotext field. 69 | * 70 | * @return array 71 | */ 72 | protected static function define_related() { 73 | return [ 74 | 'context' => 'context', 75 | 'items' => 'block_todo\item[]', 76 | ]; 77 | } 78 | 79 | /** 80 | * Get the additional values to inject while exporting. 81 | * 82 | * @param renderer_base $output The renderer. 83 | * @return array Keys are the property names, values are their values. 84 | */ 85 | protected function get_other_values(renderer_base $output) { 86 | 87 | $items = []; 88 | 89 | foreach ($this->related['items'] as $item) { 90 | $itemexporter = new item_exporter($item, ['context' => $this->related['context']]); 91 | $items[] = $itemexporter->export($output); 92 | } 93 | 94 | return [ 95 | 'items' => $items, 96 | ]; 97 | } 98 | } 99 | -------------------------------------------------------------------------------- /classes/external/toggle_item.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | /** 18 | * Provides {@link block_todo\external\toggle_item} trait. 19 | * 20 | * @package block_todo 21 | * @category external 22 | * @copyright 2018 David Mudrák 23 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 24 | */ 25 | 26 | namespace block_todo\external; 27 | 28 | defined('MOODLE_INTERNAL') || die(); 29 | 30 | use block_todo\item; 31 | use context_user; 32 | use external_function_parameters; 33 | use external_value; 34 | use invalid_parameter_exception; 35 | 36 | require_once($CFG->libdir.'/externallib.php'); 37 | 38 | /** 39 | * Trait implementing the external function block_todo_toggle_item. 40 | */ 41 | trait toggle_item { 42 | 43 | /** 44 | * Describes the structure of parameters for the function. 45 | * 46 | * @return external_function_parameters 47 | */ 48 | public static function toggle_item_parameters() { 49 | return new external_function_parameters([ 50 | 'id' => new external_value(PARAM_INT, 'ID of the todo item'), 51 | ]); 52 | } 53 | 54 | /** 55 | * Toggle the done status of the item. 56 | * 57 | * @param int $id ID of the item 58 | */ 59 | public static function toggle_item($id) { 60 | global $USER, $PAGE; 61 | 62 | $context = context_user::instance($USER->id); 63 | self::validate_context($context); 64 | require_capability('block/todo:myaddinstance', $context); 65 | 66 | $params = self::validate_parameters(self::toggle_item_parameters(), compact('id')); 67 | 68 | $item = item::get_record(['usermodified' => $USER->id, 'id' => $id]); 69 | 70 | if (!$item) { 71 | throw new invalid_parameter_exception('Unable to find your todo item with that ID'); 72 | } 73 | 74 | $item->set('done', !$item->get('done')); 75 | $item->update(); 76 | 77 | $itemexporter = new item_exporter($item, ['context' => $context]); 78 | 79 | return $itemexporter->export($PAGE->get_renderer('core')); 80 | } 81 | 82 | /** 83 | * Describes the structure of the function return value. 84 | * 85 | * @return external_single_structure 86 | */ 87 | public static function toggle_item_returns() { 88 | return item_exporter::get_read_structure(); 89 | } 90 | } 91 | -------------------------------------------------------------------------------- /classes/item.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | /** 18 | * Provides the {@link block_todo\item} class. 19 | * 20 | * @package block_todo 21 | * @copyright 2018 David Mudrák 22 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 23 | */ 24 | 25 | namespace block_todo; 26 | 27 | defined('MOODLE_INTERNAL') || die(); 28 | 29 | use \core\persistent; 30 | 31 | /** 32 | * Persistent model representing a single todo item on the user's list. 33 | */ 34 | class item extends persistent { 35 | 36 | /** Table to store this persistent model instances. */ 37 | const TABLE = 'block_todo'; 38 | 39 | /** 40 | * Return todo items for the current user. 41 | * 42 | * @return array 43 | */ 44 | public static function get_my_todo_items() { 45 | global $USER; 46 | 47 | return static::get_records(['usermodified' => $USER->id], 'timecreated', 'DESC'); 48 | } 49 | 50 | /** 51 | * Return the definition of the properties of this model. 52 | * 53 | * @return array 54 | */ 55 | protected static function define_properties() { 56 | return [ 57 | 'todotext' => [ 58 | 'type' => PARAM_TEXT, 59 | ], 60 | 'done' => [ 61 | 'type' => PARAM_BOOL, 62 | 'default' => false, 63 | ] 64 | ]; 65 | } 66 | } 67 | -------------------------------------------------------------------------------- /classes/privacy/provider.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | /** 18 | * Defines {@link \block_todo\privacy\provider} class. 19 | * 20 | * @package block_todo 21 | * @category privacy 22 | * @copyright 2018 David Mudrák 23 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 24 | */ 25 | 26 | namespace block_todo\privacy; 27 | 28 | defined('MOODLE_INTERNAL') || die(); 29 | 30 | use core_privacy\local\metadata\collection; 31 | use core_privacy\local\request\approved_contextlist; 32 | use core_privacy\local\request\contextlist; 33 | use core_privacy\local\request\helper; 34 | use core_privacy\local\request\transform; 35 | use core_privacy\local\request\writer; 36 | 37 | /** 38 | * Privacy API implementation for the My ToDo list plugin. 39 | * 40 | * @copyright 2018 David Mudrák 41 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 42 | */ 43 | class provider implements 44 | \core_privacy\local\metadata\provider, 45 | \core_privacy\local\request\plugin\provider { 46 | 47 | use \core_privacy\local\legacy_polyfill; 48 | 49 | /** 50 | * Describe all the places where the My ToDo list plugin stores some personal data. 51 | * 52 | * @param collection $collection Collection of items to add metadata to. 53 | * @return collection Collection with our added items. 54 | */ 55 | public static function _get_metadata(collection $collection) { 56 | 57 | $collection->add_database_table('block_todo', [ 58 | 'timecreated' => 'privacy:metadata:db:blocktodo:timecreated', 59 | 'timemodified' => 'privacy:metadata:db:blocktodo:timemodified', 60 | 'todotext' => 'privacy:metadata:db:blocktodo:todotext', 61 | 'done' => 'privacy:metadata:db:blocktodo:done', 62 | ], 'privacy:metadata:db:blocktodo'); 63 | 64 | return $collection; 65 | } 66 | 67 | /** 68 | * Get the list of contexts that contain personal data for the specified user. 69 | * 70 | * @param int $userid ID of the user. 71 | * @return contextlist List of contexts containing the user's personal data. 72 | */ 73 | public static function _get_contexts_for_userid($userid) { 74 | 75 | $contextlist = new contextlist(); 76 | 77 | $sql = "SELECT DISTINCT c.id 78 | FROM {block_todo} b 79 | JOIN {context} c ON c.instanceid = b.usermodified AND c.contextlevel = :contextuser 80 | WHERE b.usermodified = :userid"; 81 | 82 | $params = [ 83 | 'contextuser' => CONTEXT_USER, 84 | 'userid' => $userid 85 | ]; 86 | 87 | $contextlist->add_from_sql($sql, $params); 88 | 89 | return $contextlist; 90 | } 91 | 92 | /** 93 | * Export personal data stored in the given contexts. 94 | * 95 | * @param approved_contextlist $contextlist List of contexts approved for export. 96 | */ 97 | public static function _export_user_data(approved_contextlist $contextlist) { 98 | global $DB; 99 | 100 | if (!count($contextlist)) { 101 | return; 102 | } 103 | 104 | $user = $contextlist->get_user(); 105 | 106 | $items = $DB->get_records('block_todo', ['usermodified' => $user->id], 'timecreated DESC', 107 | 'id, timecreated, timemodified, todotext, done'); 108 | 109 | foreach ($items as &$item) { 110 | unset($item->id); 111 | $item->timecreated = transform::datetime($item->timecreated); 112 | $item->timemodified = transform::datetime($item->timemodified); 113 | $item->done = transform::yesno($item->done); 114 | } 115 | 116 | foreach ($contextlist->get_contexts() as $context) { 117 | if ($context->contextlevel != CONTEXT_USER || $context->instanceid != $user->id) { 118 | continue; 119 | } 120 | writer::with_context($context)->export_data( 121 | [get_string('pluginname', 'block_todo')], 122 | (object)['todo' => array_values($items)] 123 | ); 124 | } 125 | } 126 | 127 | /** 128 | * Delete personal data for all users in the context. 129 | * 130 | * @param context $context Context to delete personal data from. 131 | */ 132 | public static function _delete_data_for_all_users_in_context(\context $context) { 133 | global $DB; 134 | 135 | if ($context->contextlevel == CONTEXT_USER) { 136 | $DB->delete_records('block_todo', ['usermodified' => $context->instanceid]); 137 | } 138 | } 139 | 140 | /** 141 | * Delete personal data for the user in a list of contexts. 142 | * 143 | * @param approved_contextlist $contextlist List of contexts to delete data from. 144 | */ 145 | public static function _delete_data_for_user(approved_contextlist $contextlist) { 146 | global $DB; 147 | 148 | if (!count($contextlist)) { 149 | return; 150 | } 151 | 152 | $user = $contextlist->get_user(); 153 | 154 | foreach ($contextlist->get_contexts() as $context) { 155 | if ($context->contextlevel != CONTEXT_USER || $context->instanceid != $user->id) { 156 | continue; 157 | } 158 | 159 | $DB->delete_records('block_todo', ['usermodified' => $user->id]); 160 | } 161 | } 162 | } 163 | -------------------------------------------------------------------------------- /db/access.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | /** 18 | * Plugin capabilities are defined here. 19 | * 20 | * @package block_todo 21 | * @category access 22 | * @copyright 2018 David Mudrák 23 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 24 | */ 25 | 26 | defined('MOODLE_INTERNAL') || die(); 27 | 28 | $capabilities = [ 29 | // Allows users to add a new ToDo block to their Dashboard. 30 | 'block/todo:myaddinstance' => [ 31 | 'captype' => 'write', 32 | 'contextlevel' => CONTEXT_USER, 33 | 'archetypes' => [ 34 | 'user' => CAP_ALLOW, 35 | ], 36 | 'clonepermissionsfrom' => 'moodle/my:manageblocks', 37 | ], 38 | ]; 39 | -------------------------------------------------------------------------------- /db/install.xml: -------------------------------------------------------------------------------- 1 | 2 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 |
21 | 22 | -------------------------------------------------------------------------------- /db/services.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | /** 18 | * Plugin external functions and services are defined here. 19 | * 20 | * @package block_todo 21 | * @category external 22 | * @copyright 2018 David Mudrák 23 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 24 | */ 25 | 26 | defined('MOODLE_INTERNAL') || die(); 27 | 28 | $functions = [ 29 | 'block_todo_add_item' => [ 30 | 'classname' => 'block_todo\external\api', 31 | 'methodname' => 'add_item', 32 | 'classpath' => '', 33 | 'description' => 'Adds a new item to the user\'s todo list', 34 | 'type' => 'write', 35 | 'capabilities' => 'block/todo:myaddinstance', 36 | 'loginrequired' => true, 37 | 'ajax' => true, 38 | ], 39 | 40 | 'block_todo_toggle_item' => [ 41 | 'classname' => 'block_todo\external\api', 42 | 'methodname' => 'toggle_item', 43 | 'classpath' => '', 44 | 'description' => 'Toggles the done status of the given item', 45 | 'type' => 'write', 46 | 'capabilities' => 'block/todo:myaddinstance', 47 | 'loginrequired' => true, 48 | 'ajax' => true, 49 | ], 50 | 51 | 'block_todo_delete_item' => [ 52 | 'classname' => 'block_todo\external\api', 53 | 'methodname' => 'delete_item', 54 | 'classpath' => '', 55 | 'description' => 'Removes the given item from the todo list', 56 | 'type' => 'write', 57 | 'capabilities' => 'block/todo:myaddinstance', 58 | 'loginrequired' => true, 59 | 'ajax' => true, 60 | ], 61 | ]; 62 | -------------------------------------------------------------------------------- /lang/en/block_todo.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | /** 18 | * Plugin strings are defined here. 19 | * 20 | * @package block_todo 21 | * @category string 22 | * @copyright 2018 David Mudrák 23 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 24 | */ 25 | 26 | defined('MOODLE_INTERNAL') || die(); 27 | 28 | $string['placeholder'] = 'What do you need to do?'; 29 | $string['placeholdermore'] = 'Type something here and press the Add button'; 30 | $string['pluginname'] = 'My ToDo list'; 31 | $string['privacy:metadata:db:blocktodo'] = 'Storage of users todo items.'; 32 | $string['privacy:metadata:db:blocktodo:done'] = 'Has the item been marked as done.'; 33 | $string['privacy:metadata:db:blocktodo:timecreated'] = 'When the item was created.'; 34 | $string['privacy:metadata:db:blocktodo:timemodified'] = 'When the item was last modified.'; 35 | $string['privacy:metadata:db:blocktodo:todotext'] = 'Todo item text.'; 36 | $string['todo:myaddinstance'] = 'Add a new ToDo block to Dashboard'; 37 | -------------------------------------------------------------------------------- /templates/content.mustache: -------------------------------------------------------------------------------- 1 | {{! 2 | This file is part of Moodle - http://moodle.org/ 3 | 4 | Moodle is free software: you can redistribute it and/or modify 5 | it under the terms of the GNU General Public License as published by 6 | the Free Software Foundation, either version 3 of the License, or 7 | (at your option) any later version. 8 | 9 | Moodle is distributed in the hope that it will be useful, 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | GNU General Public License for more details. 13 | 14 | You should have received a copy of the GNU General Public License 15 | along with Moodle. If not, see . 16 | }} 17 | {{! 18 | @template block_todo/content 19 | 20 | My ToDo list block content template. 21 | 22 | Renders a list of todo items. 23 | 24 | Classes required for JS: 25 | * none 26 | 27 | Data attributes required for JS: 28 | * data-region="block_todo-instance-" - specifies the region wrapping all the contents 29 | * data-item="" - specifies the wraper of a single todo item 30 | * data-control="addform" - specifies the form for adding a new todo item 31 | * data-control="delete" - specifies the button for deleting an item 32 | 33 | Context variables required for this template: 34 | * instanceid - block instance id 35 | * items 36 | ** items.id 37 | ** items.todotext 38 | ** items.done 39 | 40 | Example context (json): 41 | { 42 | "items": [ 43 | { "id": "2", "todotext": "Meditate", "done": "0" } 44 | { "id": "1", "todotext": "Hack", "done": "1" } 45 | ] 46 | } 47 | 48 | }} 49 | 50 |
51 |
52 |
53 | 54 | 55 | 58 | 59 |
60 |
61 | 62 |
63 | 64 |
    65 | {{#items}} 66 | {{>block_todo/item}} 67 | {{/items}} 68 |
69 |
70 | -------------------------------------------------------------------------------- /templates/item.mustache: -------------------------------------------------------------------------------- 1 | {{! 2 | This file is part of Moodle - http://moodle.org/ 3 | 4 | Moodle is free software: you can redistribute it and/or modify 5 | it under the terms of the GNU General Public License as published by 6 | the Free Software Foundation, either version 3 of the License, or 7 | (at your option) any later version. 8 | 9 | Moodle is distributed in the hope that it will be useful, 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | GNU General Public License for more details. 13 | 14 | You should have received a copy of the GNU General Public License 15 | along with Moodle. If not, see . 16 | }} 17 | {{! 18 | @template block_todo/item 19 | 20 | ToDo item template. 21 | 22 | Renders a single todo item. See template block_todo/content for details. 23 | }} 24 | 25 |
  • 26 | {{#done}} {{/done}} 27 | {{^done}} {{/done}} 28 | {{todotext}} 29 | 32 |
    • 33 | -------------------------------------------------------------------------------- /tests/external_test.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | /** 18 | * Provides {@link block_todo_external_testcase} class. 19 | * 20 | * @package block_todo 21 | * @category test 22 | * @copyright 2018 David Mudrák 23 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 24 | */ 25 | 26 | defined('MOODLE_INTERNAL') || die(); 27 | 28 | global $CFG; 29 | 30 | /** 31 | * Tests for the external API of the plugin. 32 | * 33 | * @copyright 2018 David Mudrak 34 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 35 | */ 36 | class block_todo_external_testcase extends advanced_testcase { 37 | 38 | /** @var stdClass */ 39 | protected $user; 40 | 41 | /** @var array */ 42 | protected $anotheruser; 43 | 44 | /** 45 | * Set up for every test 46 | */ 47 | public function setUp() { 48 | global $DB; 49 | $this->resetAfterTest(); 50 | 51 | $this->user = self::getDataGenerator()->create_user(); 52 | self::setUser($this->user); 53 | 54 | $this->anotheruser = self::getDataGenerator()->create_user(); 55 | } 56 | 57 | /** 58 | * Test that users who can't add the block to their dashboard, can't add new todo items. 59 | * 60 | * @expectedException required_capability_exception 61 | */ 62 | public function test_add_item_no_permission() { 63 | 64 | $context = context_user::instance($this->user->id); 65 | 66 | $userroles = get_archetype_roles('user'); 67 | $authrole = array_pop($userroles); 68 | unassign_capability('block/todo:myaddinstance', $authrole->id); 69 | 70 | block_todo\external\api::add_item('This should throw required_capability_exception'); 71 | } 72 | 73 | /** 74 | * Test adding a new todo item. 75 | */ 76 | public function test_add_item() { 77 | 78 | $items = block_todo\item::get_my_todo_items(); 79 | $this->assertEmpty($items); 80 | 81 | $todotext = '

    Meditate!

    '; 82 | $raw = block_todo\external\api::add_item($todotext); 83 | $result = external_api::clean_returnvalue(block_todo\external\api::add_item_returns(), $raw); 84 | 85 | $this->assertEquals($result['todotext'], strip_tags($todotext)); 86 | $this->assertSame($result['done'], false); 87 | $this->assertEquals($result['usermodified'], $this->user->id); 88 | 89 | $items = block_todo\item::get_my_todo_items(); 90 | $this->assertEquals(1, count($items)); 91 | } 92 | 93 | /** 94 | * Test that the done status of an item can be toggled. 95 | */ 96 | public function test_toggle_item() { 97 | 98 | $todotext = 'Write a unit test'; 99 | $raw = block_todo\external\api::add_item($todotext); 100 | $result = external_api::clean_returnvalue(block_todo\external\api::add_item_returns(), $raw); 101 | $this->assertSame($result['done'], false); 102 | 103 | $raw = block_todo\external\api::toggle_item($result['id']); 104 | $result = external_api::clean_returnvalue(block_todo\external\api::toggle_item_returns(), $raw); 105 | $this->assertSame($result['done'], true); 106 | 107 | $raw = block_todo\external\api::toggle_item($result['id']); 108 | $result = external_api::clean_returnvalue(block_todo\external\api::toggle_item_returns(), $raw); 109 | $this->assertSame($result['done'], false); 110 | } 111 | 112 | /** 113 | * Test that the done status can't be toggled by another user. 114 | * 115 | * @expectedException invalid_parameter_exception 116 | */ 117 | public function test_toggle_item_by_another_user() { 118 | 119 | $todotext = 'This is my todo!'; 120 | $raw = block_todo\external\api::add_item($todotext); 121 | $result = external_api::clean_returnvalue(block_todo\external\api::add_item_returns(), $raw); 122 | 123 | self::setUser($this->anotheruser); 124 | block_todo\external\api::toggle_item($result['id']); 125 | } 126 | 127 | /** 128 | * Test that the done status of an item can be deleted. 129 | */ 130 | public function test_delete_item() { 131 | 132 | $todotext = 'Write a unit test'; 133 | $raw = block_todo\external\api::add_item($todotext); 134 | $result = external_api::clean_returnvalue(block_todo\external\api::add_item_returns(), $raw); 135 | $itemid = $result['id']; 136 | $this->assertTrue(block_todo\item::record_exists($itemid)); 137 | 138 | $raw = block_todo\external\api::delete_item($itemid); 139 | $result = external_api::clean_returnvalue(block_todo\external\api::delete_item_returns(), $raw); 140 | $this->assertSame($result, $itemid); 141 | $this->assertFalse(block_todo\item::record_exists($itemid)); 142 | } 143 | 144 | /** 145 | * Test that the item can't be deleted by another user. 146 | * 147 | * @expectedException invalid_parameter_exception 148 | */ 149 | public function test_delete_item_by_another_user() { 150 | 151 | $todotext = 'This is not yours!'; 152 | $raw = block_todo\external\api::add_item($todotext); 153 | $result = external_api::clean_returnvalue(block_todo\external\api::add_item_returns(), $raw); 154 | 155 | self::setUser($this->anotheruser); 156 | block_todo\external\api::delete_item($result['id']); 157 | } 158 | } 159 | -------------------------------------------------------------------------------- /version.php: -------------------------------------------------------------------------------- 1 | . 16 | 17 | /** 18 | * Plugin version and other meta-data are defined here. 19 | * 20 | * @package block_todo 21 | * @copyright 2018 David Mudrák 22 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 23 | */ 24 | 25 | defined('MOODLE_INTERNAL') || die(); 26 | 27 | $plugin->component = 'block_todo'; 28 | $plugin->release = '1.1.0'; 29 | $plugin->version = 2018071500; 30 | $plugin->requires = 2017051500; 31 | $plugin->maturity = MATURITY_STABLE; 32 | --------------------------------------------------------------------------------