diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..15b0b06 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,24 @@ +# Auto detect text files and perform LF normalization +* text=auto +*.php text eol=lf +*.neon text eol=lf + +# Custom for Visual Studio +*.cs diff=csharp +*.sln merge=union +*.csproj merge=union +*.vbproj merge=union +*.fsproj merge=union +*.dbproj merge=union + +# Standard to msysgit +*.doc diff=astextplain +*.DOC diff=astextplain +*.docx diff=astextplain +*.DOCX diff=astextplain +*.dot diff=astextplain +*.DOT diff=astextplain +*.pdf diff=astextplain +*.PDF diff=astextplain +*.rtf diff=astextplain +*.RTF diff=astextplain diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..6fff16c --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,6 @@ +version: 2 +updates: + - package-ecosystem: github-actions + directory: "/" + schedule: + interval: monthly diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..0bedab0 --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,42 @@ +name: CI + +on: + push: + pull_request: + workflow_dispatch: + +jobs: + build: + name: PHPStan analysis + runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + php: + - "8.1" + - "8.2" + - "8.3" + + steps: + - uses: actions/checkout@v4 + + - name: Setup PHP + uses: pmmp/setup-php-action@3.1.0 + with: + php-version: ${{ matrix.php }} + install-path: "./bin" + pm-version-major: 5 + + - name: Restore Composer package cache + id: composer-cache + uses: actions/cache@v4 + with: + path: "~/.cache/composer" + key: "php-${{ matrix.php }}-composer-${{ hashFiles('**/composer.json') }}" + restore-keys: "php-${{ matrix.php }}-composer-" + + - name: Install PHPStan Composer dependencies + run: composer install --prefer-dist --no-interaction + + - name: Run PHPStan + run: vendor/bin/phpstan analyze diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..42ceee4 --- /dev/null +++ b/.gitignore @@ -0,0 +1,220 @@ +.idea/ + +################# +## Eclipse +################# + +*.pydevproject +.project +.metadata +bin/ +tmp/ +*.tmp +*.bak +*.swp +*~.nib +local.properties +.classpath +.settings/ +.loadpath + +# External tool builders +.externalToolBuilders/ + +# Locally stored "Eclipse launch configurations" +*.launch + +# CDT-specific +.cproject + +# PDT-specific +.buildpath + + +################# +## Visual Studio +################# + +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. + +# User-specific files +*.suo +*.user +*.sln.docstates + +# Build results + +[Dd]ebug/ +[Rr]elease/ +x64/ +build/ +[Bb]in/ +[Oo]bj/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +*_i.c +*_p.c +*.ilk +*.meta +*.obj +*.pch +*.pdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*.log +*.vspscc +*.vssscc +.builds +*.pidb +*.log +*.scc + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opensdf +*.sdf +*.cachefile + +# Visual Studio profiler +*.psess +*.vsp +*.vspx + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# NCrunch +*.ncrunch* +.*crunch*.local.xml + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.Publish.xml +*.pubxml + +# NuGet Packages Directory +## TODO: If you have NuGet Package Restore enabled, uncomment the next line +#packages/ + +# Windows Azure Build Output +csx +*.build.csdef + +# Windows Store app package directory +AppPackages/ + +# Others +sql/ +*.Cache +ClientBin/ +[Ss]tyle[Cc]op.* +~$* +*~ +*.dbmdl +*.[Pp]ublish.xml +*.pfx +*.publishsettings + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file to a newer +# Visual Studio version. Backup files are not needed, because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm + +# SQL Server files +App_Data/*.mdf +App_Data/*.ldf + +############# +## Windows detritus +############# + +# Windows image file caches +Thumbs.db +ehthumbs.db + +# Folder config file +Desktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Mac crap +.DS_Store + + +############# +## Python +############# + +*.py[co] + +# Packages +*.egg +*.egg-info +dist/ +build/ +eggs/ +parts/ +var/ +sdist/ +develop-eggs/ +.installed.cfg + +# Installer logs +pip-log.txt + +# Unit test / coverage reports +.coverage +.tox + +#Translations +*.mo + +#Mr Developer +.mr.developer.cfg + +vendor/ +composer.lock diff --git a/.poggit.yml b/.poggit.yml new file mode 100644 index 0000000..72d1962 --- /dev/null +++ b/.poggit.yml @@ -0,0 +1,13 @@ +--- # Poggit-CI Manifest. Open the CI at https://poggit.pmmp.io/ci/Frago9876543210/forms +branches: + - master +projects: + forms: + path: "" + lint: + phpstan: false + libforms: + path: "" + type: library + model: virion +... diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..4182998 --- /dev/null +++ b/README.md @@ -0,0 +1,167 @@ +# forms + +![build](https://img.shields.io/github/actions/workflow/status/Frago9876543210/forms/main.yml) +![php](https://img.shields.io/badge/php-8.1-informational) +![api](https://img.shields.io/badge/pocketmine-5.0-informational) + +Modern version of pocketmine forms API, ported to PHP 8.1+ with high quality code and phpstan integration + +## Code samples + ++ [ModalForm](#modalform) + - [Using ModalForm to represent "yes" / "no" button clicks as `bool` in closure](#using-modalform-to-represent-yes--no-button-clicks-as-bool-in-closure) + - [Short version of ModalForm to confirm any action](#short-version-of-modalform-to-confirm-any-action) ++ [MenuForm](#menuform) + - [Using MenuForm to display buttons with icons from URL and path](#using-menuform-to-display-buttons-with-icons-from-url-and-path) + - [Creating MenuForm from array of strings (i.e. from `string[]`) with modern syntax of matching button clicks](#creating-menuform-from-array-of-strings-ie-from-string-with-modern-syntax-of-matching-button-clicks) + - [Appending MenuForm with new options to handle different permissions](#appending-menuform-with-new-options-to-handle-different-permissions) ++ [CustomForm](#customform) + - [Using CustomForm with strict-typed API](#using-customform-with-strict-typed-api) + - [Using CustomForm with less strict-typed API](#using-customform-with-less-strict-typed-api) + +### ModalForm + +#### Using ModalForm to represent "yes" / "no" button clicks as `bool` in closure + +```php +$player->sendForm(new ModalForm("A small question", "Is our server cool?", + //result of pressing the "yes" / "no" button is written to a variable $choice + function(Player $player, bool $choice) : void{ + $player->sendMessage($choice ? "Thank you" : "We will try to become better"); + } +)); +``` + +![modal1](https://i.imgur.com/4Hf8RgD.png) + +#### Short version of ModalForm to confirm any action + +```php +$player->sendForm(ModalForm::confirm("Teleport request", "Do you want to accept it?", + //called only when the player selects the "yes" button + function(Player $player) : void{ + $player->sendMessage("*teleporting*"); + } +)); +``` + +![modal2](https://i.imgur.com/jevWyHy.png) + +### MenuForm + +#### Using MenuForm to display buttons with icons from URL and path + +> [!NOTE] +> If you are having trouble loading images, try installing https://github.com/Muqsit/FormImagesFix + +```php +$player->sendForm(new MenuForm("Select server", "Choose server", [ + //buttons without icon + new Button("SkyWars #1"), + new Button("SkyWars #2"), + //URL and path are supported for image + new Button("SkyWars #3", Image::url("https://static.wikia.nocookie.net/minecraft_gamepedia/images/f/f0/Melon_JE2_BE2.png")), + new Button("SkyWars #4", Image::path("textures/items/apple.png")), +], function(Player $player, Button $selected) : void{ + $player->sendMessage("You selected: " . $selected->text); + $player->sendMessage("Index of button: " . $selected->getValue()); +})); +``` + +![menu1](https://i.imgur.com/304JS1n.png) + +#### Creating MenuForm from array of strings (i.e. from `string[]`) with modern syntax of matching button clicks + +```php +//MenuForm::withOptions is useful when you have a string[] +//syntax TIP: fn() added since PHP 7.4, match since PHP 8.0 +$player->sendForm(MenuForm::withOptions("Select option", "List of options:", [ + "opt1", "opt2", "opt3", + "default branch #1", + "default branch #2", +], fn(Player $player, Button $selected) => match($selected->getValue()){ + 0 => $player->sendMessage("message #1"), //opt1 + 1 => $player->sendMessage("message #2"), //opt2 + 2 => $player->sendMessage("message #3"), //opt3 + default => $player->sendMessage("You selected: " . $selected->text), +})); +``` + +![menu2](https://i.imgur.com/JXRfoJW.png) + +#### Appending MenuForm with new options to handle different permissions + +```php +//appending form data if Player has enough permissions +$form = MenuForm::withOptions("Player info", "Username: " . $player->getName(), [ + "view statistics", //accessible for all +], fn(Player $player, Button $selected) => match($selected->getValue()){ + 0 => $player->sendMessage("*statistics*"), + 1 => $player->kick("kick message"), + 2 => $player->sendMessage("*logs*"), + default => throw new \AssertionError("unreachable code"), //shut phpstan +}); + +$isOp = $player->hasPermission(DefaultPermissions::ROOT_OPERATOR); //since PM 4.0 +if($isOp){ //accessible for ops + $form->appendOptions("kick player", "view logs"); +} +$player->sendForm($form); +``` + +![menu3](https://i.imgur.com/5XTOe9d.png) + +### CustomForm + +#### Using CustomForm with strict-typed API + +```php +$player->sendForm(new CustomForm("Enter data", [ + new Dropdown("Select product", ["beer", "cheese", "cola"]), + new Input("Enter your name", "Bob"), + new Label("I am label!"), //Note: get() does not work with label + new Slider("Select count", 0.0, 100.0, 1.0, 50.0), + new StepSlider("Select product", ["beer", "cheese", "cola"]), + new Toggle("Creative", $player->isCreative()), +], function(Player $player, CustomFormResponse $response) : void{ + $dropdown = $response->getDropdown(); + $player->sendMessage("You selected: " . $dropdown->getSelectedOption()); + + $input = $response->getInput(); + $player->sendMessage("Your name is " . $input->getValue()); + + $slider = $response->getSlider(); + $player->sendMessage("Count: " . $slider->getValue()); + + $stepSlider = $response->getStepSlider(); + $player->sendMessage("You selected: " . $stepSlider->getSelectedOption()); + + $toggle = $response->getToggle(); + $player->setGamemode($toggle->getValue() ? GameMode::CREATIVE : GameMode::SURVIVAL); +})); +``` + +#### Using CustomForm with less strict-typed API + +```php +$player->sendForm(new CustomForm("Enter data", [ + new Dropdown("Select product", ["beer", "cheese", "cola"]), + new Input("Enter your name", "Bob"), + new Label("I am label!"), //Note: get() does not work with label + new Slider("Select count", 0.0, 100.0, 1.0, 50.0), + new StepSlider("Select product", ["beer", "cheese", "cola"]), + new Toggle("Creative", $player->isCreative()), +], function(Player $player, CustomFormResponse $response) : void{ + /** @var bool $enableCreative */ //type-hint for phpstan + [$product1, $username, $count, $product2, $enableCreative] = $response->getValues(); + + $player->sendMessage("You selected: $product1"); + $player->sendMessage("Your name is $username"); + $player->sendMessage("Count: $count"); + $player->sendMessage("You selected: $product2"); + $player->setGamemode($enableCreative ? GameMode::CREATIVE : GameMode::SURVIVAL); +})); +``` + +![custom1](https://i.imgur.com/BEIZdvO.png) +![custom2](https://i.imgur.com/AtRvSjp.png) diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..6ab1062 --- /dev/null +++ b/composer.json @@ -0,0 +1,25 @@ +{ + "name": "frago9876543210/forms", + "require-dev": { + "phpstan/phpstan": "^1.10", + "pocketmine/pocketmine-mp": "^5.14", + "phpstan/phpstan-strict-rules": "^1.0", + "phpstan/extension-installer": "^1.0" + }, + "autoload": { + "psr-4": { + "": "src/" + } + }, + "config": { + "allow-plugins": { + "phpstan/extension-installer": true + } + }, + "extra":{ + "virion": { + "spec": "3.0", + "namespace-root": "forms" + } + } +} diff --git a/phpstan.neon.dist b/phpstan.neon.dist new file mode 100644 index 0000000..c308dcf --- /dev/null +++ b/phpstan.neon.dist @@ -0,0 +1,4 @@ +parameters: + level: 8 + paths: + - src diff --git a/plugin.yml b/plugin.yml new file mode 100644 index 0000000..e91f63f --- /dev/null +++ b/plugin.yml @@ -0,0 +1,4 @@ +name: forms +main: forms\bootstrap\Main +version: 1.0.0 +api: 5.14.0 diff --git a/src/forms/BaseForm.php b/src/forms/BaseForm.php new file mode 100644 index 0000000..2994fee --- /dev/null +++ b/src/forms/BaseForm.php @@ -0,0 +1,26 @@ + */ + abstract protected function serializeFormData() : array; + + /** @phpstan-return array */ + final public function jsonSerialize() : array{ + $ret = $this->serializeFormData(); + $ret["type"] = $this->getType(); + $ret["title"] = $this->title; + + return $ret; + } +} diff --git a/src/forms/CustomForm.php b/src/forms/CustomForm.php new file mode 100644 index 0000000..c809487 --- /dev/null +++ b/src/forms/CustomForm.php @@ -0,0 +1,77 @@ +> $elements + * @phpstan-param \Closure(Player, CustomFormResponse) : mixed $onSubmit + * @phpstan-param (\Closure(Player) : mixed)|null $onClose + */ + public function __construct( + string $title, + private array $elements, + private /*readonly*/ \Closure $onSubmit, + private /*readonly*/ ?\Closure $onClose = null, + ){ + Utils::validateCallableSignature(function(Player $player, CustomFormResponse $response){ }, $onSubmit); + if($onClose !== null){ + Utils::validateCallableSignature(function(Player $player){ }, $onClose); + } + parent::__construct($title); + } + + /** @phpstan-param element\BaseElementWithValue ...$elements */ + public function appendElements(BaseElementWithValue ...$elements) : void{ + foreach($elements as $element){ + $this->elements[] = $element; + } + } + + protected function getType() : string{ return "custom_form"; } + + protected function serializeFormData() : array{ + return [ + "content" => $this->elements, + ]; + } + + /** @phpstan-param array $data */ + private function validateElements(Player $player, array $data) : void{ + if(($actual = count($data)) !== ($expected = count($this->elements))){ + throw new FormValidationException("Expected $expected result data, got $actual"); + } + + foreach($data as $index => $value){ + /** @var BaseElementWithValue $element */ + $element = $this->elements[$index] ?? throw new FormValidationException("Element at offset $index does not exist"); + try{ + $element->setValue($value); + }catch(FormValidationException $e){ + throw new FormValidationException("Validation failed for element " . $element::class . ": " . $e->getMessage(), 0, $e); + } + } + + $this->onSubmit->__invoke($player, new CustomFormResponse($this->elements)); + } + + final public function handleResponse(Player $player, mixed $data) : void{ + match(true){ + is_null($data) => $this->onClose?->__invoke($player), + is_array($data) => $this->validateElements($player, $data), + default => throw new FormValidationException("Expected array or null, got " . gettype($data)), + }; + } +} diff --git a/src/forms/CustomFormResponse.php b/src/forms/CustomFormResponse.php new file mode 100644 index 0000000..c6968d5 --- /dev/null +++ b/src/forms/CustomFormResponse.php @@ -0,0 +1,65 @@ +> $elements */ + public function __construct(private array $elements){ } + + /** + * @template T&element\BaseElementWithValue + * @phpstan-param class-string> $expected + * @phpstan-return T&element\BaseElementWithValue + * @throws \UnexpectedValueException + */ + public function get(string $expected) : BaseElementWithValue{ + $element = array_shift($this->elements); + return match(true){ + is_null($element) => throw new \UnexpectedValueException("There are no elements in the container"), + $element instanceof Label => $this->get($expected), //skip labels + !($element instanceof $expected) => throw new \UnexpectedValueException("Unexpected type of element"), + default => $element, + }; + } + + public function getDropdown() : Dropdown{ return $this->get(Dropdown::class); } + + public function getInput() : Input{ return $this->get(Input::class); } + + public function getSlider() : Slider{ return $this->get(Slider::class); } + + public function getStepSlider() : StepSlider{ return $this->get(StepSlider::class); } + + public function getToggle() : Toggle{ return $this->get(Toggle::class); } + + /** @phpstan-return list */ + public function getValues() : array{ + $values = []; + + foreach($this->elements as $element){ + if($element instanceof Label){ + continue; + } + + $values[] = match(true){ + $element instanceof Dropdown => $element->getSelectedOption(), + default => $element->getValue(), + }; + } + + return $values; + } +} diff --git a/src/forms/MenuForm.php b/src/forms/MenuForm.php new file mode 100644 index 0000000..8bf22ef --- /dev/null +++ b/src/forms/MenuForm.php @@ -0,0 +1,86 @@ + $buttons + * @phpstan-param (\Closure(Player, Button) : mixed)|null $onSubmit + * @phpstan-param (\Closure(Player) : mixed)|null $onClose + */ + public function __construct( + string $title, + public /*readonly*/ string $content = "", + private array $buttons = [], + private /*readonly*/ ?\Closure $onSubmit = null, + private /*readonly*/ ?\Closure $onClose = null, + ){ + if($onSubmit !== null){ + Utils::validateCallableSignature(function(Player $player, Button $selected){ }, $onSubmit); + } + if($onClose !== null){ + Utils::validateCallableSignature(function(Player $player){ }, $onClose); + } + parent::__construct($title); + } + + /** @phpstan-param list $options */ + public static function withOptions( + string $title, + string $content = "", + array $options = [], + ?\Closure $onSubmit = null, + ?\Closure $onClose = null, + ) : self{ + /** @var Button[] $buttons */ + $buttons = []; + foreach($options as $option){ + $buttons[] = new Button($option); + } + return new self($title, $content, $buttons, $onSubmit, $onClose); + } + + public function appendOptions(string ...$options) : void{ + foreach($options as $option){ + $this->buttons[] = new Button($option); + } + } + + public function appendButtons(Button ...$buttons) : void{ + foreach($buttons as $button){ + $this->buttons[] = $button; + } + } + + protected function getType() : string{ return "form"; } + + protected function serializeFormData() : array{ + return [ + "buttons" => $this->buttons, + "content" => $this->content, + ]; + } + + private function getButton(int $index) : Button{ + return $this->buttons[$index] ?? throw new FormValidationException("Button with index $index does not exist"); + } + + final public function handleResponse(Player $player, mixed $data) : void{ + match(true){ + is_null($data) => $this->onClose?->__invoke($player), + is_int($data) => $this->onSubmit?->__invoke($player, $this->getButton($data)->setValue($data)), + default => throw new FormValidationException("Expected int or null, got " . gettype($data)), + }; + } +} diff --git a/src/forms/ModalForm.php b/src/forms/ModalForm.php new file mode 100644 index 0000000..bd29b16 --- /dev/null +++ b/src/forms/ModalForm.php @@ -0,0 +1,54 @@ + $this->content, + "button1" => $this->button1, + "button2" => $this->button2, + ]; + } + + final public function handleResponse(Player $player, mixed $data) : void{ + if(!is_bool($data)){ + throw new FormValidationException("Expected bool, got " . gettype($data)); + } + + ($this->onSubmit)($player, $data); + } +} diff --git a/src/forms/bootstrap/Main.php b/src/forms/bootstrap/Main.php new file mode 100644 index 0000000..0e21592 --- /dev/null +++ b/src/forms/bootstrap/Main.php @@ -0,0 +1,11 @@ + */ + abstract protected function serializeElementData() : array; + + /** @phpstan-return array */ + final public function jsonSerialize() : array{ + $ret = $this->serializeElementData(); + $ret["type"] = $this->getType(); + $ret["text"] = $this->text; + + return $ret; + } +} diff --git a/src/forms/element/BaseElementWithValue.php b/src/forms/element/BaseElementWithValue.php new file mode 100644 index 0000000..4397526 --- /dev/null +++ b/src/forms/element/BaseElementWithValue.php @@ -0,0 +1,25 @@ +value ?? throw new \RuntimeException("Trying to access an uninitialized value"); + } + + /** @phpstan-param TValue $value */ + public function setValue(mixed $value) : void{ + $this->validateValue($value); + $this->value = $value; + } +} diff --git a/src/forms/element/BaseSelector.php b/src/forms/element/BaseSelector.php new file mode 100644 index 0000000..678f006 --- /dev/null +++ b/src/forms/element/BaseSelector.php @@ -0,0 +1,38 @@ + + */ +abstract class BaseSelector extends BaseElementWithValue{ + + /** @phpstan-param list $options */ + public function __construct( + string $text, + public /*readonly*/ array $options, + public /*readonly*/ int $default = 0, + ){ + parent::__construct($text); + } + + public function getSelectedOption() : string{ + return $this->options[$this->getValue()]; + } + + protected function validateValue(mixed $value) : void{ + if(!is_int($value)){ + throw new FormValidationException("Expected int, got " . gettype($value)); + } + if(!isset($this->options[$value])){ + throw new FormValidationException("Option $value does not exist"); + } + } +} diff --git a/src/forms/element/Dropdown.php b/src/forms/element/Dropdown.php new file mode 100644 index 0000000..0f9e080 --- /dev/null +++ b/src/forms/element/Dropdown.php @@ -0,0 +1,18 @@ + */ +class Dropdown extends BaseSelector{ + + protected function getType() : string{ return "dropdown"; } + + protected function serializeElementData() : array{ + return [ + "options" => $this->options, + "default" => $this->default, + ]; + } +} diff --git a/src/forms/element/Input.php b/src/forms/element/Input.php new file mode 100644 index 0000000..fe389e3 --- /dev/null +++ b/src/forms/element/Input.php @@ -0,0 +1,36 @@ + */ +class Input extends BaseElementWithValue{ + + public function __construct( + string $text, + public /*readonly*/ string $placeholder, + public /*readonly*/ string $default = "", + ){ + parent::__construct($text); + } + + protected function getType() : string{ return "input"; } + + protected function validateValue(mixed $value) : void{ + if(!is_string($value)){ + throw new FormValidationException("Expected string, got " . gettype($value)); + } + } + + protected function serializeElementData() : array{ + return [ + "placeholder" => $this->placeholder, + "default" => $this->default, + ]; + } +} diff --git a/src/forms/element/Label.php b/src/forms/element/Label.php new file mode 100644 index 0000000..6b41e7d --- /dev/null +++ b/src/forms/element/Label.php @@ -0,0 +1,29 @@ + */ +class Label extends BaseElementWithValue{ + + public function __construct(string $text){ + parent::__construct($text); + } + + protected function getType() : string{ return "label"; } + + protected function validateValue(mixed $value) : void{ + if(!is_null($value)){ + throw new FormValidationException("Expected null, got " . gettype($value)); + } + } + + protected function serializeElementData() : array{ + return []; + } +} diff --git a/src/forms/element/Slider.php b/src/forms/element/Slider.php new file mode 100644 index 0000000..17d9f98 --- /dev/null +++ b/src/forms/element/Slider.php @@ -0,0 +1,60 @@ + */ +class Slider extends BaseElementWithValue{ + + public function __construct( + string $text, + public /*readonly*/ float $min, + public /*readonly*/ float $max, + public /*readonly*/ float $step = 1.0, + public /*readonly*/ ?float $default = null, + ){ + parent::__construct($text); + + if($this->min > $this->max){ + throw new \InvalidArgumentException("Slider min value should be less than max value"); + } + + if($default !== null){ + if($default > $this->max || $default < $this->min){ + throw new \InvalidArgumentException("Default must be in range $this->min ... $this->max"); + } + }else{ + $this->default = $this->min; + } + + if($step <= 0){ + throw new \InvalidArgumentException("Step must be greater than zero"); + } + } + + protected function getType() : string{ return "slider"; } + + protected function validateValue(mixed $value) : void{ + if(!is_float($value) && !is_int($value)){ + throw new FormValidationException("Expected float, got " . gettype($value)); + } + if($value < $this->min || $value > $this->max){ + throw new FormValidationException("Value $value is out of bounds (min $this->min, max $this->max)"); + } + } + + protected function serializeElementData() : array{ + return [ + "min" => $this->min, + "max" => $this->max, + "step" => $this->step, + "default" => $this->default, + ]; + } +} diff --git a/src/forms/element/StepSlider.php b/src/forms/element/StepSlider.php new file mode 100644 index 0000000..c67a406 --- /dev/null +++ b/src/forms/element/StepSlider.php @@ -0,0 +1,18 @@ + */ +class StepSlider extends BaseSelector{ + + protected function getType() : string{ return "step_slider"; } + + protected function serializeElementData() : array{ + return [ + "steps" => $this->options, + "default" => $this->default, + ]; + } +} diff --git a/src/forms/element/Toggle.php b/src/forms/element/Toggle.php new file mode 100644 index 0000000..cc79c15 --- /dev/null +++ b/src/forms/element/Toggle.php @@ -0,0 +1,38 @@ + */ +class Toggle extends BaseElementWithValue{ + + public function __construct( + string $text, + public /*readonly*/ bool $default = false, + ){ + parent::__construct($text); + } + + public function hasChanged() : bool{ + return $this->default !== $this->getValue(); + } + + protected function getType() : string{ return "toggle"; } + + protected function validateValue(mixed $value) : void{ + if(!is_bool($value)){ + throw new FormValidationException("Expected bool, got " . gettype($value)); + } + } + + protected function serializeElementData() : array{ + return [ + "default" => $this->default, + ]; + } +} diff --git a/src/forms/menu/Button.php b/src/forms/menu/Button.php new file mode 100644 index 0000000..4e7c00e --- /dev/null +++ b/src/forms/menu/Button.php @@ -0,0 +1,29 @@ +value ?? throw new \RuntimeException("Trying to access an uninitialized value"); + } + + public function setValue(int $value) : self{ + $this->value = $value; + return $this; + } + + /** @phpstan-return array */ + public function jsonSerialize() : array{ + $ret = ["text" => $this->text]; + if($this->image !== null){ + $ret["image"] = $this->image; + } + + return $ret; + } +} diff --git a/src/forms/menu/Image.php b/src/forms/menu/Image.php new file mode 100644 index 0000000..d0d7bb0 --- /dev/null +++ b/src/forms/menu/Image.php @@ -0,0 +1,22 @@ + */ + public function jsonSerialize() : array{ + return [ + "type" => $this->type, + "data" => $this->data, + ]; + } +} diff --git a/virion.yml b/virion.yml new file mode 100644 index 0000000..4015067 --- /dev/null +++ b/virion.yml @@ -0,0 +1,7 @@ +name: libforms +authors: + - Frago9876543210 +antigen: forms +version: 1.0.0 +api: + - 5.14.0