diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000000000000000000000000000000000000..b8d20acb6c365ad8036a7b36d47dabd876d08efa --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,3 @@ +include: + - project: 'quiqqer/stabilization/semantic-release' + file: '/ci-templates/.gitlab-ci.yml' diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000000000000000000000000000000000..e72bfddabc15be5718a7cc061ac10e47741d8219 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + 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. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + 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 <https://www.gnu.org/licenses/>. + +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: + + <program> Copyright (C) <year> <name of author> + 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 +<https://www.gnu.org/licenses/>. + + 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 +<https://www.gnu.org/licenses/why-not-lgpl.html>. \ No newline at end of file diff --git a/bin/css/order.css b/bin/css/order.css index 6a18aeb2fc41572a2a06ec6bb83ad59bb94be04b..b4e912fc188eebd52b61d24c5ec38823e80178c3 100644 --- a/bin/css/order.css +++ b/bin/css/order.css @@ -343,11 +343,7 @@ input.quiqqer-coupons-couponcodeinput-input:active { display: block; width: 100%; } - - .quiqqer-order-ordering-buttons-backToShop { - display: none; - } - + .quiqqer-order-ordering-buttons-next, .quiqqer-order-ordering-buttons a { width: 100%; diff --git a/composer.json b/composer.json index 497175b90a435c7be8a91cba8665f6c928d1de02..5681fb5a0020eab8c9100bbe7d7982863f30c343 100644 --- a/composer.json +++ b/composer.json @@ -18,7 +18,7 @@ "require": { "php": ">=5.3", "quiqqer\/quiqqer": "1.*|dev-master|dev-dev", - "quiqqer\/erp": "1.*|dev-master|dev-dev", + "quiqqer\/erp": "^1|^2|^3|dev-master|dev-dev", "quiqqer\/products": "^1.3.1|dev-master|dev-dev", "quiqqer\/order": "^1.6|dev-master|dev-dev", "quiqqer\/product-bricks": "1.*|dev-master|dev-dev", diff --git a/index.php b/index.php index 9d0011f0e34a7cec4c7211e62584f92ef0651ed0..a49e56fec0764332379ba4b0900bd272e4185675 100644 --- a/index.php +++ b/index.php @@ -12,6 +12,7 @@ */ $templateSettings = QUI\TemplateCologne\Utils::getConfig([ 'Project' => $Project, + 'Template' => $Template, 'Site' => $Site ]); @@ -19,9 +20,9 @@ * Menu */ $menuParams = [ - 'showStart' => false, + 'showStart' => false, 'data-show-button-on-desktop' => 1, - 'Project' => $Site->getProject() + 'Project' => $Site->getProject() ]; if (isset($templateSettings['homeLink']) && $templateSettings['homeLink']) { @@ -32,10 +33,13 @@ $menuParams['startText'] = $templateSettings['homeLinkText']; } -if ($Project->getConfig('templateCologne.settings.enableIndependentMenu') && $Project->getConfig('templateCologne.settings.menuId')) { - $menuParams['menuId'] = $Project->getConfig('templateCologne.settings.menuId'); +$enableIndependentMenu = $Project->getConfig('templateCologne.settings.enableIndependentMenu'); +$independentMenuId = $Project->getConfig('templateCologne.settings.menuId'); + +if ($enableIndependentMenu && $independentMenuId) { + $menuParams['menuId'] = $enableIndependentMenu; $menuParams['showFirstLevelIcons'] = $Project->getConfig('templateCologne.settings.showFirstLevelIcons'); - $menuParams['showStart'] = false; + $menuParams['showStart'] = false; } // Site own / independent menu @@ -55,20 +59,22 @@ } $createBasketButton = true; +$simpleSiteTypes = [ + 'quiqqer/order:types/orderingProcess', + 'quiqqer/order:types/shoppingCart', + 'quiqqer/order-simple-checkout:types/simpleCheckout', +]; -if ($Site->getAttribute('type') == 'quiqqer/order:types/orderingProcess' || - $Site->getAttribute('type') == 'quiqqer/order:types/shoppingCart' || - $Site->getAttribute('type') == 'quiqqer/order-simple-checkout:types/simpleCheckout') { +if (in_array($Site->getAttribute('type'), $simpleSiteTypes)) { $createBasketButton = false; - $Template->setAttribute('content-header', false); } $InitialBasketPrice = new QUI\ERP\Money\Price(0, $Currency); -$Logo = $Project->getMedia()->getLogoImage(); +$Logo = $Project->getMedia()->getLogoImage(); $logoHeight = $templateSettings['logoHeight']; -$logoWidth = false; +$logoWidth = false; try { if ($Logo) { @@ -78,9 +84,9 @@ QUI\System\Log::addNotice($Exception->getMessage()); } -$templateSettings['Logo'] = $Logo; -$templateSettings['logoHeight'] = $logoHeight; -$templateSettings['logoWidth'] = $logoWidth; +$templateSettings['Logo'] = $Logo; +$templateSettings['logoHeight'] = $logoHeight; +$templateSettings['logoWidth'] = $logoWidth; $templateSettings['initialBasketPrice'] = $InitialBasketPrice->getDisplayPrice(); $templateSettings['createBasketButton'] = $createBasketButton; @@ -103,27 +109,24 @@ * Flags */ $Flags = new QUI\Bricks\Controls\LanguageSwitches\Flags([ - 'Site' => $Site, + 'Site' => $Site, 'showFlags' => true, - 'showText' => true, - 'all' => true + 'showText' => true, + 'all' => true ]); - /** * Langguage and currency swtich */ //$LangCurrencySwitch = new \QUI\TemplateCologne\Controls\LangCurrencySwitch(); $LangCurrencySwitch = null; - - /** * Sign up / registration page */ $registerSiteUrl = false; -$types = [ +$registerSiteTypes = [ 'quiqqer/frontend-users:types/registrationSignUp', 'quiqqer/frontend-users:types/registration', ]; @@ -132,7 +135,7 @@ 'where' => [ 'type' => [ 'type' => 'IN', - 'value' => $types + 'value' => $registerSiteTypes ] ], 'limit' => 1 @@ -144,18 +147,18 @@ } // array to assign -$templateSettings['BricksManager'] = QUI\Bricks\Manager::init(); -$templateSettings['Project'] = $Project; -$templateSettings['Menu'] = $Menu; -$templateSettings['Avatar'] = $Avatar; -$templateSettings['productPage'] = $productPage; -$templateSettings['Flags'] = $Flags; +$templateSettings['BricksManager'] = QUI\Bricks\Manager::init(); +$templateSettings['Project'] = $Project; +$templateSettings['Menu'] = $Menu; +$templateSettings['Avatar'] = $Avatar; +$templateSettings['productPage'] = $productPage; +$templateSettings['Flags'] = $Flags; $templateSettings['LangCurrencySwitch'] = $LangCurrencySwitch; -$templateSettings['countLanguages'] = \count($Project->getLanguages()); -$templateSettings['Search'] = new QUI\ERP\Products\Search\Controls\Suggest([ +$templateSettings['countLanguages'] = \count($Project->getLanguages()); +$templateSettings['Search'] = new QUI\ERP\Products\Search\Controls\Suggest([ 'globalsearch' => true ]); -$templateSettings['registerSiteUrl'] = $registerSiteUrl; +$templateSettings['registerSiteUrl'] = $registerSiteUrl; $Template->setAttributes($templateSettings); diff --git a/src/QUI/TemplateCologne/Controls/CurrencySwitch.php b/src/QUI/TemplateCologne/Controls/CurrencySwitch.php index e447122ee59c825aec8b622458055fdc37bff395..c1c124227cefb29e8912ea7618ff2e31fe323afc 100644 --- a/src/QUI/TemplateCologne/Controls/CurrencySwitch.php +++ b/src/QUI/TemplateCologne/Controls/CurrencySwitch.php @@ -21,11 +21,11 @@ class CurrencySwitch extends QUI\Control public function __construct($attributes = []) { $this->setAttributes([ - 'class' => 'quiqqer-currency-switch', + 'class' => 'quiqqer-currency-switch', 'userRelatedCurrency' => 1, // 1 / 0 -> is user allowed to change currency? ]); - $this->addCSSFile(dirname(__FILE__).'/CurrencySwitch.css'); + $this->addCSSFile(dirname(__FILE__) . '/CurrencySwitch.css'); parent::__construct($attributes); } @@ -51,7 +51,7 @@ public function getBody() if ($this->isCurrencySwitchAllowed()) { try { $Package = QUI::getPackage('quiqqer/erp'); - $Config = $Package->getConfig(); + $Config = $Package->getConfig(); if ($Config->getValue('general', 'userRelatedCurrency')) { $this->setJavaScriptControl('package/quiqqer/currency/bin/controls/Switch'); @@ -68,11 +68,11 @@ public function getBody() } $Engine->assign([ - 'this' => $this, + 'this' => $this, 'DefaultCurrency' => $Currency, ]); - return $Engine->fetch(dirname(__FILE__).'/CurrencySwitch.html'); + return $Engine->fetch(dirname(__FILE__) . '/CurrencySwitch.html'); } /** diff --git a/src/QUI/TemplateCologne/Controls/Menu/Categories.php b/src/QUI/TemplateCologne/Controls/Menu/Categories.php index 92bb4a1cf235d6ba9d88453bca5520dca2146a72..53885961b9d14550db30b57d4589fd377071be79 100644 --- a/src/QUI/TemplateCologne/Controls/Menu/Categories.php +++ b/src/QUI/TemplateCologne/Controls/Menu/Categories.php @@ -27,16 +27,16 @@ class Categories extends QUI\Control public function __construct($attributes = []) { $this->setAttributes([ - 'class' => 'quiqqer-categories-menu', - 'startId' => 1, // site id or site link where menu starts by. 1 is start page (first project page) - 'template' => \dirname(__FILE__).'/Categories.html', // nav wrapper - 'menuFile' => \dirname(__FILE__).'/Categories.Menu.html', // contains children (sites), - 'jsControl' => 'package/quiqqer/template-cologne/bin/javascript/controls/Menu/Categories', - 'showDescFor' => 'all', // Show category description: all / firstLevel / none + 'class' => 'quiqqer-categories-menu', + 'startId' => 1, // site id or site link where menu starts by. 1 is start page (first project page) + 'template' => \dirname(__FILE__) . '/Categories.html', // nav wrapper + 'menuFile' => \dirname(__FILE__) . '/Categories.Menu.html', // contains children (sites), + 'jsControl' => 'package/quiqqer/template-cologne/bin/javascript/controls/Menu/Categories', + 'showDescFor' => 'all', // Show category description: all / firstLevel / none 'showBasketButton' => false ]); - $this->addCSSFile(\dirname(__FILE__).'/Categories.css'); + $this->addCSSFile(\dirname(__FILE__) . '/Categories.css'); parent::__construct($attributes); } @@ -47,7 +47,7 @@ public function __construct($attributes = []) */ public function getBody() { - $Engine = QUI::getTemplateManager()->getEngine(); + $Engine = QUI::getTemplateManager()->getEngine(); $Project = $this->getProject(); @@ -66,10 +66,10 @@ public function getBody() return ''; } - $cache = EventHandler::menuCacheName().'/megaMenu/'; + $cache = EventHandler::menuCacheName() . '/megaMenu/'; $cache .= \md5( - $this->getSite()->getCachePath(). + $this->getSite()->getCachePath() . \serialize($this->getAttributes()) ); @@ -85,12 +85,12 @@ public function getBody() } $Engine->assign([ - 'menuFile' => $this->getAttribute('menuFile'), - 'this' => $this, - 'showDescFor' => $this->getAttribute('showDescFor'), + 'menuFile' => $this->getAttribute('menuFile'), + 'this' => $this, + 'showDescFor' => $this->getAttribute('showDescFor'), 'showBasketButton' => $showBasketButton, - 'Site' => $Site, - 'Project' => $Project + 'Site' => $Site, + 'Project' => $Project ]); $result = $Engine->fetch($this->getAttribute('template')); diff --git a/src/QUI/TemplateCologne/Controls/Payments.php b/src/QUI/TemplateCologne/Controls/Payments.php index d9178e1078048696a0aeda0c69574533acf53eb2..96d6e7834dfedf088a4756a79d10caf303fbad88 100644 --- a/src/QUI/TemplateCologne/Controls/Payments.php +++ b/src/QUI/TemplateCologne/Controls/Payments.php @@ -26,13 +26,13 @@ class Payments extends QUI\Control public function __construct($attributes = []) { $this->setAttributes([ - 'class' => 'quiqqer-payments-control', - 'showInactive' => false, - 'template' => 'list', + 'class' => 'quiqqer-payments-control', + 'showInactive' => false, + 'template' => 'list', // Custom children template (path to html file); overwrites "template". 'customTemplate' => false, // Custom children template css (path to css file); overwrites "template". - 'customCss' => false, + 'customCss' => false, ]); parent::__construct($attributes); @@ -51,7 +51,7 @@ public function getBody() return ''; } - $Engine = QUI::getTemplateManager()->getEngine(); + $Engine = QUI::getTemplateManager()->getEngine(); $Payments = \QUI\ERP\Accounting\Payments\Payments::getInstance(); $payments = $Payments->getpayments(); @@ -62,17 +62,16 @@ public function getBody() } $Engine->assign([ - 'payments' => $payments, + 'payments' => $payments, 'showInactive' => $this->getAttribute('showInactive') ]); // load custom template (if set) - if ($this->getAttribute('customTemplate') - && \file_exists($this->getAttribute('customTemplate')) - ) { - if ($this->getAttribute('customCss') - && \file_exists($this->getAttribute('customCss')) - ) { + $customTemplate = $this->getAttribute('customTemplate'); + $customCss = $this->getAttribute('customCss'); + + if ($customTemplate && \file_exists($customTemplate)) { + if ($customCss && \file_exists($customCss)) { $this->addCSSFile($this->getAttribute('customCss')); } @@ -83,12 +82,12 @@ public function getBody() switch ($this->getAttribute('template')) { case 'list': $template = dirname(__FILE__) . '/Payments.List.html'; - $css = dirname(__FILE__) . '/Payments.List.css'; + $css = dirname(__FILE__) . '/Payments.List.css'; break; case 'grid': default: $template = dirname(__FILE__) . '/Payments.Grid.html'; - $css = dirname(__FILE__) . '/Payments.Grid.css'; + $css = dirname(__FILE__) . '/Payments.Grid.css'; } $this->addCSSFile($css); diff --git a/src/QUI/TemplateCologne/Controls/ProductGallery.php b/src/QUI/TemplateCologne/Controls/ProductGallery.php index e8a5500701e2048b6724b682b42e0526ef7b6cb3..8a7386096c59739e2955f2e375f3fe333639fe81 100644 --- a/src/QUI/TemplateCologne/Controls/ProductGallery.php +++ b/src/QUI/TemplateCologne/Controls/ProductGallery.php @@ -8,6 +8,7 @@ use QUI; use QUI\ERP\Products\Handler\Fields; + use function is_a; use function usort; @@ -43,7 +44,7 @@ public function getBody() return ''; } - $Engine = QUI::getTemplateManager()->getEngine(); + $Engine = QUI::getTemplateManager()->getEngine(); $Product = $this->getAttribute('Product'); $Gallery = new QUI\Gallery\Controls\Slider(); @@ -52,7 +53,7 @@ public function getBody() } $typeVariantParent = is_a($Product->getType(), QUI\ERP\Products\Product\Types\VariantParent::class, true); - $typeVariantChild = is_a($Product->getType(), QUI\ERP\Products\Product\Types\VariantChild::class, true); + $typeVariantChild = is_a($Product->getType(), QUI\ERP\Products\Product\Types\VariantChild::class, true); // gallery $PlaceholderImage = $this->getProject()->getMedia()->getPlaceholderImage(); @@ -100,7 +101,7 @@ public function getBody() 'Gallery' => $Gallery, ]); - return $Engine->fetch(dirname(__FILE__).'/ProductGallery.html'); + return $Engine->fetch(dirname(__FILE__) . '/ProductGallery.html'); } /** @@ -109,6 +110,7 @@ public function getBody() * By @peat * * @param QUI\ERP\Products\Product\Product $Product + * * @return QUI\Projects\Media\Image[] */ protected function getVariantImages(QUI\ERP\Products\Product\Product $Product): array @@ -116,8 +118,8 @@ protected function getVariantImages(QUI\ERP\Products\Product\Product $Product): $images = $Product->getImages(); try { - $MainImage = $Product->getImage(); - $mainImageId = $MainImage->getId(); + $MainImage = $Product->getImage(); + $mainImageId = $MainImage->getId(); $hasMainImage = false; foreach ($images as $Image) { diff --git a/src/QUI/TemplateCologne/Controls/SimpleUserInfo.php b/src/QUI/TemplateCologne/Controls/SimpleUserInfo.php index 7626e141e6d99310ca0d4d12c2c93a59944e79e7..f33ce894d3b7de0fd042087039c1c020c4d5cb34 100644 --- a/src/QUI/TemplateCologne/Controls/SimpleUserInfo.php +++ b/src/QUI/TemplateCologne/Controls/SimpleUserInfo.php @@ -24,7 +24,7 @@ public function __construct($attributes = []) 'User' => null ]); - $this->addCSSFile(dirname(__FILE__).'/SimpleUserInfo.css'); + $this->addCSSFile(dirname(__FILE__) . '/SimpleUserInfo.css'); parent::__construct($attributes); } @@ -32,14 +32,13 @@ public function __construct($attributes = []) /** * (non-PHPdoc) * - * @see \QUI\Control::create() - * * @throws QUI\Exception + * @see \QUI\Control::create() */ public function getBody() { $Engine = QUI::getTemplateManager()->getEngine(); - $User = $this->getUser(); + $User = $this->getUser(); $avatarUrl = URL_OPT_DIR . 'quiqqer/template-cologne/bin/images/avatar-placeholder.svg'; @@ -48,9 +47,9 @@ public function getBody() } $Engine->assign([ - 'name' => $User->getName(), + 'name' => $User->getName(), 'registrationDay' => $User->getAttribute('regdate'), - 'avatarUrl' => $avatarUrl, + 'avatarUrl' => $avatarUrl, 'ordersNumber' => $this->getOrdersNumber($User) ]); @@ -100,6 +99,7 @@ public function getSite() * Get number of orders * * @param $User QUI\Interfaces\Users\User + * * @return int */ public function getOrdersNumber($User) diff --git a/src/QUI/TemplateCologne/EventHandler.php b/src/QUI/TemplateCologne/EventHandler.php index 73ccff1d8b2cc994b00bbefdb41dd4e23129b4fa..17c1f0102a1b76af1df5fa343f26293450d101d9 100644 --- a/src/QUI/TemplateCologne/EventHandler.php +++ b/src/QUI/TemplateCologne/EventHandler.php @@ -1,4 +1,5 @@ <?php + /** * This file contains \QUI\TemplateCologne\EventHandler */ @@ -48,8 +49,10 @@ public static function onSiteSave() * * @throws QUI\Exception */ - public static function onQuiqqerProductsProductButtonsEnd(\Quiqqer\Engine\Collector $Collector, \QUI\ERP\Products\Product\ViewFrontend $Product) - { + public static function onQuiqqerProductsProductButtonsEnd( + \Quiqqer\Engine\Collector $Collector, + \QUI\ERP\Products\Product\ViewFrontend $Product + ) { // setting $Project = QUI::getRewrite()->getProject(); @@ -57,7 +60,7 @@ public static function onQuiqqerProductsProductButtonsEnd(\Quiqqer\Engine\Collec return; } - $text = QUI::getLocale()->get('quiqqer/template-cologne', 'control.product.buy.know.button'); + $text = QUI::getLocale()->get('quiqqer/template-cologne', 'control.product.buy.know.button'); $disabled = 0; if (!$Product->getMaximumQuantity()) { @@ -65,11 +68,11 @@ public static function onQuiqqerProductsProductButtonsEnd(\Quiqqer\Engine\Collec } $Collector->append( - '<div class="product-data-actionButtons-buyNow" data-qui-options-disabled="'.$disabled.'"> + '<div class="product-data-actionButtons-buyNow" data-qui-options-disabled="' . $disabled . '"> <div class="product-data-actionButtons-buyNow-placeholder"></div> <button disabled data-qui="package/quiqqer/template-cologne/bin/javascript/controls/BuyNowButton" - data-qui-options-disabled="'.$disabled.'"> - <span class="add-to-basket-text">'.$text.'</span> + data-qui-options-disabled="' . $disabled . '"> + <span class="add-to-basket-text">' . $text . '</span> </button> </div>' ); diff --git a/src/QUI/TemplateCologne/Utils.php b/src/QUI/TemplateCologne/Utils.php index ebd541fb689ced29832bc6807d245befc2d4ccda..81475da826351dffeea5bbc754767cf453ff48b5 100644 --- a/src/QUI/TemplateCologne/Utils.php +++ b/src/QUI/TemplateCologne/Utils.php @@ -19,6 +19,7 @@ class Utils * Get user avatar. If no avatar available return false. * * @param $User QUI\Interfaces\Users\User + * * @return QUI\Projects\Media\Image|false * @throws QUI\Exception * @@ -60,6 +61,7 @@ public static function getAvatar($User) * Returns config. If a cache exists, it will be returned. * * @param $params + * * @return array|bool|object|string * @throws QUI\Exception */ @@ -71,11 +73,14 @@ public static function getConfig($params) /* @var $Project QUI\Projects\Project */ $Project = $params['Project']; - $cacheName = md5($params['Site']->getId().$Project->getName().$Project->getLang()); + /* @var $Project QUI\Template */ + $Template = $params['Template']; + + $cacheName = md5($Site->getId() . $Project->getName() . $Project->getLang()); try { return QUI\Cache\Manager::get( - 'quiqqer/templateCologne/'.$cacheName + 'quiqqer/templateCologne/' . $cacheName ); } catch (QUI\Exception $Exception) { } @@ -87,7 +92,6 @@ public static function getConfig($params) /** * Logo height */ - $logoHeight = 60; if (intval($Project->getConfig('templateCologne.settings.logoHeight'))) { @@ -101,62 +105,65 @@ public static function getConfig($params) * * own site type */ - $header = 'hide'; - $pageTitle = 'breadcrumb'; // where to show page title: in header, in breadcrumb or both? - $pageShortDesc = false; + $header = 'hide'; + $pageTitle = 'breadcrumb'; // where to show page title: in header, in breadcrumb or both? + $pageShortDesc = false; $showBreadcrumb = false; - $showTopBar = true; - $showNav = true; - $showFooter = true; - $minimalDesign = false; - $siteType = 'no-sidebar'; + $showTopBar = true; + $showNav = true; + $showFooter = true; + $minimalDesign = false; + $siteType = 'no-sidebar'; switch ($Site->getAttribute('layout')) { case 'layout/startPage': - $header = $Project->getConfig('templateCologne.settings.headerStartPage'); - $pageTitle = $Project->getConfig('templateCologne.settings.pageTitleStartPage'); - $pageShortDesc = $Project->getConfig('templateCologne.settings.shortDescStartPage'); + $header = $Project->getConfig('templateCologne.settings.headerStartPage'); + $pageTitle = $Project->getConfig('templateCologne.settings.pageTitleStartPage'); + $pageShortDesc = $Project->getConfig('templateCologne.settings.shortDescStartPage'); $showBreadcrumb = $Project->getConfig('templateCologne.settings.showBreadcrumbStartPage'); - $siteType = 'layout-start-page'; + $siteType = 'layout-start-page'; break; case 'layout/noSidebar': - $header = $Project->getConfig('templateCologne.settings.headerNoSidebar'); - $pageTitle = $Project->getConfig('templateCologne.settings.pageTitleNoSidebar'); - $pageShortDesc = $Project->getConfig('templateCologne.settings.shortDescNoSidebar'); + $header = $Project->getConfig('templateCologne.settings.headerNoSidebar'); + $pageTitle = $Project->getConfig('templateCologne.settings.pageTitleNoSidebar'); + $pageShortDesc = $Project->getConfig('templateCologne.settings.shortDescNoSidebar'); $showBreadcrumb = $Project->getConfig('templateCologne.settings.showBreadcrumbNoSidebar'); - $siteType = 'layout-no-sidebar'; + $siteType = 'layout-no-sidebar'; break; case 'layout/noSidebarThin': - $header = $Project->getConfig('templateCologne.settings.headerNoSidebarThin'); - $pageTitle = $Project->getConfig('templateCologne.settings.pageTitleNoSidebarThin'); - $pageShortDesc = $Project->getConfig('templateCologne.settings.shortDescNoSidebarThin'); + $header = $Project->getConfig('templateCologne.settings.headerNoSidebarThin'); + $pageTitle = $Project->getConfig('templateCologne.settings.pageTitleNoSidebarThin'); + $pageShortDesc = $Project->getConfig('templateCologne.settings.shortDescNoSidebarThin'); $showBreadcrumb = $Project->getConfig('templateCologne.settings.showBreadcrumbNoSidebarThin'); - $siteType = 'layout-no-sidebar'; + $siteType = 'layout-no-sidebar'; break; case 'layout/rightSidebar': - $header = $Project->getConfig('templateCologne.settings.headerRightSidebar'); - $pageTitle = $Project->getConfig('templateCologne.settings.pageTitleRightSidebar'); - $pageShortDesc = $Project->getConfig('templateCologne.settings.shortDescLeftSidebar'); + $header = $Project->getConfig('templateCologne.settings.headerRightSidebar'); + $pageTitle = $Project->getConfig('templateCologne.settings.pageTitleRightSidebar'); + $pageShortDesc = $Project->getConfig('templateCologne.settings.shortDescLeftSidebar'); $showBreadcrumb = $Project->getConfig('templateCologne.settings.showBreadcrumbRightSidebar'); - $siteType = 'layout-right-sidebar'; + $siteType = 'layout-right-sidebar'; break; case 'layout/leftSidebar': - $header = $Project->getConfig('templateCologne.settings.headerLeftSidebar'); - $pageTitle = $Project->getConfig('templateCologne.settings.pageTitleLeftSidebar'); - $pageShortDesc = $Project->getConfig('templateCologne.settings.shortDescRightSidebar'); + $header = $Project->getConfig('templateCologne.settings.headerLeftSidebar'); + $pageTitle = $Project->getConfig('templateCologne.settings.pageTitleLeftSidebar'); + $pageShortDesc = $Project->getConfig('templateCologne.settings.shortDescRightSidebar'); $showBreadcrumb = $Project->getConfig('templateCologne.settings.showBreadcrumbLeftSidebar'); - $siteType = 'layout-left-sidebar'; + $siteType = 'layout-left-sidebar'; break; } - if ($Site->getAttribute('type') === 'quiqqer/order:types/orderingProcess' || - $Site->getAttribute('type') === 'quiqqer/order:types/shoppingCart' || - $Site->getAttribute('type') === 'quiqqer/order-simple-checkout:types/simpleCheckout' - ) { + $orderSiteTypes = [ + 'quiqqer/order:types/orderingProcess', + 'quiqqer/order:types/shoppingCart', + 'quiqqer/order-simple-checkout:types/simpleCheckout' + ]; + + if (in_array($Site->getAttribute('type'), $orderSiteTypes)) { switch ($Project->getConfig('templateCologne.settings.checkoutAppearance')) { case 'compact': $showBreadcrumb = false; @@ -168,15 +175,25 @@ public static function getConfig($params) case 'minimal': default: - $showTopBar = false; - $showNav = false; - $showFooter = false; + $showTopBar = false; + $showNav = false; + $showFooter = false; $showBreadcrumb = false; - $minimalDesign = true; + $minimalDesign = true; break; } } + // Show header & footer only if requested (support for quiqqer/app) + if (!$Template->getAttribute('template-header')) { + $showTopBar = false; + $showNav = false; + } + + if (!$Template->getAttribute('template-footer')) { + $showFooter = false; + } + /* site own show header */ switch ($Site->getAttribute('templateCologne.header')) { case 'afterNav': @@ -234,8 +251,8 @@ public static function getConfig($params) if ($showCategoryMenu) { $CategoriesMenu = new QUI\TemplateCologne\Controls\Menu\Categories([ - 'showDescFor' => $Project->getConfig('templateCologne.settings.showCategoryShortFor'), - 'startId' => $Project->getConfig('templateCologne.settings.categoryStartId'), + 'showDescFor' => $Project->getConfig('templateCologne.settings.showCategoryShortFor'), + 'startId' => $Project->getConfig('templateCologne.settings.categoryStartId'), 'showBasketButton' => $Project->getConfig('templateCologne.settings.showBasketButton') ]); @@ -245,7 +262,7 @@ public static function getConfig($params) /*** * Mega menu settings */ - $homeLink = false; + $homeLink = false; $homeLinkText = ''; if ($Project->getConfig('templateCologne.settings.homeLink')) { @@ -263,25 +280,26 @@ public static function getConfig($params) /** * Menu appearance and smooth scroll */ - $showNavAfterScroll = 0; - $showMenuSmooth = false; // smooth animation - $setMenuPosBackOnInit = false; // if true menu will be no longer fixed when user scrolls to menu initial position - if ($Project->getConfig('templateCologne.settings.showNavAfterScroll') && intval($Project->getConfig('templateCologne.settings.showNavAfterScroll')) > 0) { - $showNavAfterScroll = intval($Project->getConfig('templateCologne.settings.showNavAfterScroll')); - $showMenuSmooth = true; + $showNavAfterScrollSetting = intval($Project->getConfig('templateCologne.settings.showNavAfterScroll')); + $showNavAfterScroll = 0; + $showMenuSmooth = false; // smooth animation + // if true menu will be no longer fixed when user scrolls to menu initial position + $setMenuPosBackOnInit = false; + + if ($showNavAfterScrollSetting && $showNavAfterScrollSetting > 0) { + $showNavAfterScroll = $showNavAfterScrollSetting; + $showMenuSmooth = true; } if ($Project->getConfig('templateCologne.settings.setMenuPosBackOnInit')) { $setMenuPosBackOnInit = true; } - /* page custom class */ - $pageCustomClass = false; + $pageCustomClass = $Site->getAttribute('templateCologne.pageCustomClass'); - if ($Site->getAttribute('templateCologne.pageCustomClass') && $Site->getAttribute('templateCologne.pageCustomClass') !== '') { - $pageCustomClass = 'templateCologne__'.$Site->getAttribute('templateCologne.pageCustomClass'); - $pageCustomClass .= ' '.$Site->getAttribute('templateCologne.pageCustomClass'); + if ($pageCustomClass && $pageCustomClass !== '') { + $pageCustomClass .= 'templateCologne__' . $pageCustomClass; } /** @@ -314,35 +332,35 @@ public static function getConfig($params) // predefined footer $config += self::getPredefinedFooter($Project); - $config['header'] = $header; - $config['logoHeight'] = $logoHeight; - $config['pageTitle'] = $pageTitle; - $config['settings.pageShortDesc'] = $pageShortDesc; - $config['showBreadcrumb'] = $showBreadcrumb; - $config['minimalDesign'] = $minimalDesign; - $config['showTopBar'] = $showTopBar; - $config['showNav'] = $showNav; - $config['showFooter'] = $showFooter; - $config['settingsCSS'] = '<style data-no-cache="1">'.$settingsCSS.'</style>'; - $config['typeClass'] = 'type-'.str_replace(['/', ':'], '-', $Site->getAttribute('type')); - $config['minimalDesignClass'] = $minimalDesign ? 'type-minimal-design' : ''; - $config['siteType'] = $siteType; - $config['pageCustomClass'] = $pageCustomClass; - $config['basketStyle'] = $basketStyle; - $config['basketOpen'] = $basketOpen; - $config['showCategoryMenu'] = $showCategoryMenu; - $config['homeLink'] = $homeLink; - $config['homeLinkText'] = $homeLinkText; - $config['useSlideOutMenu'] = true; // for now is always true because quiqqer use currently only SlideOut nav - $config['showNavAfterScroll'] = $showNavAfterScroll; - $config['showMenuSmooth'] = $showMenuSmooth; - $config['setMenuPosBackOnInit'] = $setMenuPosBackOnInit; + $config['header'] = $header; + $config['logoHeight'] = $logoHeight; + $config['pageTitle'] = $pageTitle; + $config['settings.pageShortDesc'] = $pageShortDesc; + $config['showBreadcrumb'] = $showBreadcrumb; + $config['minimalDesign'] = $minimalDesign; + $config['showTopBar'] = $showTopBar; + $config['showNav'] = $showNav; + $config['showFooter'] = $showFooter; + $config['settingsCSS'] = '<style data-no-cache="1">' . $settingsCSS . '</style>'; + $config['typeClass'] = 'type-' . str_replace(['/', ':'], '-', $Site->getAttribute('type')); + $config['minimalDesignClass'] = $minimalDesign ? 'type-minimal-design' : ''; + $config['siteType'] = $siteType; + $config['pageCustomClass'] = $pageCustomClass; + $config['basketStyle'] = $basketStyle; + $config['basketOpen'] = $basketOpen; + $config['showCategoryMenu'] = $showCategoryMenu; + $config['homeLink'] = $homeLink; + $config['homeLinkText'] = $homeLinkText; + $config['useSlideOutMenu'] = true; // for now is always true because quiqqer use currently only SlideOut nav + $config['showNavAfterScroll'] = $showNavAfterScroll; + $config['showMenuSmooth'] = $showMenuSmooth; + $config['setMenuPosBackOnInit'] = $setMenuPosBackOnInit; $config['showTopbarLanguageSwitch'] = $showTopbarLanguageSwitch; $config['showTopbarCurrencySwitch'] = $showTopbarCurrencySwitch; // set cache QUI\Cache\Manager::set( - 'quiqqer/templateCologne/'.$cacheName, + 'quiqqer/templateCologne/' . $cacheName, $config ); @@ -353,6 +371,7 @@ public static function getConfig($params) * Returns data for predefined footer if enabled. * * @param \QUI\Projects\Project $Project + * * @return array - data for predefined footer */ private static function getPredefinedFooter($Project) @@ -397,7 +416,7 @@ private static function getPredefinedFooter($Project) } $siteIds = $Project->getConfig('templateCologne.settings.predefinedFooter.urlList.sites'); - $sites = []; + $sites = []; if ($siteIds) { $sites = QUI\Projects\Site\Utils::getSitesByInputList($Project, $siteIds, [ @@ -414,15 +433,15 @@ private static function getPredefinedFooter($Project) foreach ($sites as $Site) { $sitesData[] = [ 'title' => $Site->getAttribute('title'), - 'url' => $Site->getUrlRewritten() + 'url' => $Site->getUrlRewritten() ]; } - $urlList['title'] = $title; - $urlList['sites'] = $sitesData; - $urlList['productSearch'] = false; - $urlList['legalNotes'] = false; - $urlList['privacyPolicy'] = false; + $urlList['title'] = $title; + $urlList['sites'] = $sitesData; + $urlList['productSearch'] = false; + $urlList['legalNotes'] = false; + $urlList['privacyPolicy'] = false; $urlList['generalTermsAndConditions'] = false; if ($Project->getConfig('templateCologne.settings.predefinedFooter.urlList.showStandardSites')) { @@ -430,7 +449,7 @@ private static function getPredefinedFooter($Project) $productSearch = $Project->getSites([ 'where' => [ 'type' => [ - 'type' => 'IN', + 'type' => 'IN', 'value' => 'quiqqer/products:types/search' ] ], @@ -440,7 +459,7 @@ private static function getPredefinedFooter($Project) if (count($productSearch)) { $urlList['productSearch'] = [ 'title' => $productSearch[0]->getAttribute('title'), - 'url' => $productSearch[0]->getUrlRewritten() + 'url' => $productSearch[0]->getUrlRewritten() ]; } @@ -448,7 +467,7 @@ private static function getPredefinedFooter($Project) $legalNotes = $Project->getSites([ 'where' => [ 'type' => [ - 'type' => 'IN', + 'type' => 'IN', 'value' => 'quiqqer/sitetypes:types/legalnotes' ] ], @@ -458,7 +477,7 @@ private static function getPredefinedFooter($Project) if (count($legalNotes)) { $urlList['legalNotes'] = [ 'title' => $legalNotes[0]->getAttribute('title'), - 'url' => $legalNotes[0]->getUrlRewritten() + 'url' => $legalNotes[0]->getUrlRewritten() ]; } @@ -466,7 +485,7 @@ private static function getPredefinedFooter($Project) $privacyPolicy = $Project->getSites([ 'where' => [ 'type' => [ - 'type' => 'IN', + 'type' => 'IN', 'value' => 'quiqqer/sitetypes:types/privacypolicy' ] ], @@ -476,7 +495,7 @@ private static function getPredefinedFooter($Project) if (count($privacyPolicy)) { $urlList['privacyPolicy'] = [ 'title' => $privacyPolicy[0]->getAttribute('title'), - 'url' => $privacyPolicy[0]->getUrlRewritten() + 'url' => $privacyPolicy[0]->getUrlRewritten() ]; } @@ -484,7 +503,7 @@ private static function getPredefinedFooter($Project) $generalTermsAndConditions = $Project->getSites([ 'where' => [ 'type' => [ - 'type' => 'IN', + 'type' => 'IN', 'value' => 'quiqqer/sitetypes:types/generalTermsAndConditions' ] ], @@ -494,7 +513,7 @@ private static function getPredefinedFooter($Project) if (count($generalTermsAndConditions)) { $urlList['generalTermsAndConditions'] = [ 'title' => $generalTermsAndConditions[0]->getAttribute('title'), - 'url' => $generalTermsAndConditions[0]->getUrlRewritten() + 'url' => $generalTermsAndConditions[0]->getUrlRewritten() ]; } } @@ -531,8 +550,9 @@ private static function getPredefinedFooter($Project) /** Predefined footer: Payments Control */ $paymentsData = []; - if ($Project->getConfig('templateCologne.settings.predefinedFooter.payments') && - \class_exists('\QUI\ERP\Accounting\Payments\Payments') + if ( + $Project->getConfig('templateCologne.settings.predefinedFooter.payments') + && \class_exists('\QUI\ERP\Accounting\Payments\Payments') ) { $PaymentsControl = new \QUI\TemplateCologne\Controls\Payments([ 'template' => $Project->getConfig('templateCologne.settings.predefinedFooter.payments.layout') @@ -557,10 +577,10 @@ private static function getPredefinedFooter($Project) } return [ - 'shortText' => $shortText, - 'urlList' => $urlList, + 'shortText' => $shortText, + 'urlList' => $urlList, 'featuredProducts' => $featuredProducts, - 'paymentsData' => $paymentsData + 'paymentsData' => $paymentsData ]; } @@ -570,6 +590,7 @@ private static function getPredefinedFooter($Project) * requires quiqqer/shipping to be installed * * @param int $productId + * * @return false|QUI\ERP\Products\Field\View */ public static function getShippingTimeFrontendView(int $productId) @@ -607,12 +628,13 @@ public static function getShippingTimeFrontendView(int $productId) * requires quiqqer/stock-management to be installed * * @param int $productId + * * @return false|QUI\ERP\Products\Field\View */ public static function getStockFrontendView(int $productId) { try { - $Project = QUI::getRewrite()->getProject(); + $Project = QUI::getRewrite()->getProject(); $showStock = $Project->getConfig('templateCologne.settings.showStock'); if (empty($showStock)) { @@ -629,7 +651,7 @@ public static function getStockFrontendView(int $productId) } try { - $Product = QUI\ERP\Products\Handler\Products::getProduct($productId); + $Product = QUI\ERP\Products\Handler\Products::getProduct($productId); $StockField = $Product->getField(StockManager::PRODUCT_FIELD_STOCK); } catch (\Exception $Exception) { QUI\System\Log::writeException($Exception); @@ -651,6 +673,7 @@ public static function getStockFrontendView(int $productId) * Add a suffix to brick css class(es) * * @param array $classes + * * @return string */ public static function convertBrickCSSClass(array $classes) @@ -662,7 +685,7 @@ public static function convertBrickCSSClass(array $classes) $text = ''; foreach ($classes as $classString) { - $text .= ' brick-container__'.$classString; + $text .= ' brick-container__' . $classString; } return $text; diff --git a/template/footer/footer.html b/template/footer/footer.html index 2c9bfca08058ff9c3d25a6b2a753cf5d7b6d4310..88f610a0e2ab27e84b278d5b0175f9ac460788c2 100644 --- a/template/footer/footer.html +++ b/template/footer/footer.html @@ -15,10 +15,10 @@ urlList=$urlList featuredProducts=$featuredProducts } - {/if} - {* footer copyright *} - {fetch template="template/footer/copyright.html"} + {* footer copyright *} + {fetch template="template/footer/copyright.html"} + {/if} </footer> </section>