Compare commits
29 Commits
Author | SHA1 | Date | |
---|---|---|---|
6e831e2650 | |||
52de613b0f | |||
58b3b74d99 | |||
f5420ce2c0 | |||
e9118609b6 | |||
1290a567de | |||
df660676d0 | |||
3e199fc460 | |||
a58b6f1358 | |||
a439c0d2c9 | |||
ef0f2ff54d | |||
28dbf773f1 | |||
0730509096 | |||
e9333e8624 | |||
71958482c5 | |||
97f73a73e2 | |||
6a4df8373c | |||
10ec8df983 | |||
2d16baaef9 | |||
2e684cb862 | |||
f98a277986 | |||
5b83b096e5 | |||
b011d3930c | |||
ee76392d71 | |||
2a03797bfe | |||
18286ea99d | |||
697f6b81b9 | |||
8da3c1df38 | |||
07a994df83 |
LICENSEcomposer.jsoncomposer.lock
sources
attributes
classes
ActionState.phpClassMapper.phpDictionary.phpFile.phpJsonReWriter.mdJsonReWriter.phpObjectArray.phpTuple.phpVersionInfo.mdVersionInfo.php
enums
exceptions
extensions
interfaces
models
operators
traits
ActionState
ArrayBasicTrait.phpJsonReWriter
JsonReWriterDeleteTrait.phpJsonReWriterKeyTrait.phpJsonReWriterLoadSaveTrait.phpJsonReWriterReadTrait.phpJsonReWriterWriteTrait.php
ObjectArray
types
tests
235
LICENSE
Normal file
235
LICENSE
Normal file
@ -0,0 +1,235 @@
|
||||
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
Version 3, 19 November 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
|
||||
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU Affero General Public License is a free, copyleft license for software and other kinds of works, specifically designed to ensure cooperation with the community in the case of network server software.
|
||||
|
||||
The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, our General Public Licenses are 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.
|
||||
|
||||
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.
|
||||
|
||||
Developers that use our General Public Licenses protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License which gives you legal permission to copy, distribute and/or modify the software.
|
||||
|
||||
A secondary benefit of defending all users' freedom is that improvements made in alternate versions of the program, if they receive widespread use, become available for other developers to incorporate. Many developers of free software are heartened and encouraged by the resulting cooperation. However, in the case of software used on network servers, this result may fail to come about. The GNU General Public License permits making a modified version and letting the public access it on a server without ever releasing its source code to the public.
|
||||
|
||||
The GNU Affero General Public License is designed specifically to ensure that, in such cases, the modified source code becomes available to the community. It requires the operator of a network server to provide the source code of the modified version running there to the users of that server. Therefore, public use of a modified version, on a publicly accessible server, gives the public access to the source code of the modified version.
|
||||
|
||||
An older license, called the Affero General Public License and published by Affero, was designed to accomplish similar goals. This is a different license, not a version of the Affero GPL, but Affero has released a new version of the Affero GPL which permits relicensing under this license.
|
||||
|
||||
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 Affero 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. Remote Network Interaction; Use with the GNU General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, if you modify the Program, your modified version must prominently offer all users interacting with it remotely through a computer network (if your version supports such interaction) an opportunity to receive the Corresponding Source of your version by providing access to the Corresponding Source from a network server at no charge, through some standard or customary means of facilitating copying of software. This Corresponding Source shall include the Corresponding Source for any work covered by version 3 of the GNU General Public License that is incorporated pursuant to the following paragraph.
|
||||
|
||||
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 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 work with which it is combined will remain governed by version 3 of the GNU General Public License.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of the GNU Affero 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 Affero 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 Affero 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 Affero 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.
|
||||
|
||||
123
|
||||
Copyright (C) 2025 babaev-an
|
||||
|
||||
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If your software can interact with users remotely through a computer network, you should also make sure that it provides a way for users to get its source. For example, if your program is a web application, its interface could display a "Source" link that leads users to an archive of the code. There are many ways you could offer source, and different solutions will be better for different programs; see section 13 for the specific requirements.
|
||||
|
||||
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 AGPL, see <http://www.gnu.org/licenses/>.
|
@ -6,7 +6,7 @@
|
||||
"keywords": [
|
||||
"components"
|
||||
],
|
||||
"homepage": "https://gitverse.ru/babaev-an/php_components_pack",
|
||||
"homepage": "https://git.babaev-an.ru/babaev-an/php_components_pack",
|
||||
"license": "GPL-3.0-or-later",
|
||||
"type": "library",
|
||||
"authors": [
|
||||
@ -20,7 +20,7 @@
|
||||
"ext-mbstring": "*"
|
||||
},
|
||||
"require-dev": {
|
||||
"phpunit/phpunit": "^12.0.4"
|
||||
"phpunit/phpunit": "^12.2.1"
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
|
150
composer.lock
generated
150
composer.lock
generated
@ -4,21 +4,21 @@
|
||||
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
|
||||
"This file is @generated automatically"
|
||||
],
|
||||
"content-hash": "157bb444d3a207c9efb13c1562ce2a0a",
|
||||
"content-hash": "f5bf0ec4042cb12fb3a702cad65f099d",
|
||||
"packages": [],
|
||||
"packages-dev": [
|
||||
{
|
||||
"name": "myclabs/deep-copy",
|
||||
"version": "1.13.0",
|
||||
"version": "1.13.1",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/myclabs/DeepCopy.git",
|
||||
"reference": "024473a478be9df5fdaca2c793f2232fe788e414"
|
||||
"reference": "1720ddd719e16cf0db4eb1c6eca108031636d46c"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/myclabs/DeepCopy/zipball/024473a478be9df5fdaca2c793f2232fe788e414",
|
||||
"reference": "024473a478be9df5fdaca2c793f2232fe788e414",
|
||||
"url": "https://api.github.com/repos/myclabs/DeepCopy/zipball/1720ddd719e16cf0db4eb1c6eca108031636d46c",
|
||||
"reference": "1720ddd719e16cf0db4eb1c6eca108031636d46c",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
@ -57,7 +57,7 @@
|
||||
],
|
||||
"support": {
|
||||
"issues": "https://github.com/myclabs/DeepCopy/issues",
|
||||
"source": "https://github.com/myclabs/DeepCopy/tree/1.13.0"
|
||||
"source": "https://github.com/myclabs/DeepCopy/tree/1.13.1"
|
||||
},
|
||||
"funding": [
|
||||
{
|
||||
@ -65,20 +65,20 @@
|
||||
"type": "tidelift"
|
||||
}
|
||||
],
|
||||
"time": "2025-02-12T12:17:51+00:00"
|
||||
"time": "2025-04-29T12:36:36+00:00"
|
||||
},
|
||||
{
|
||||
"name": "nikic/php-parser",
|
||||
"version": "v5.4.0",
|
||||
"version": "v5.5.0",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/nikic/PHP-Parser.git",
|
||||
"reference": "447a020a1f875a434d62f2a401f53b82a396e494"
|
||||
"reference": "ae59794362fe85e051a58ad36b289443f57be7a9"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/nikic/PHP-Parser/zipball/447a020a1f875a434d62f2a401f53b82a396e494",
|
||||
"reference": "447a020a1f875a434d62f2a401f53b82a396e494",
|
||||
"url": "https://api.github.com/repos/nikic/PHP-Parser/zipball/ae59794362fe85e051a58ad36b289443f57be7a9",
|
||||
"reference": "ae59794362fe85e051a58ad36b289443f57be7a9",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
@ -121,9 +121,9 @@
|
||||
],
|
||||
"support": {
|
||||
"issues": "https://github.com/nikic/PHP-Parser/issues",
|
||||
"source": "https://github.com/nikic/PHP-Parser/tree/v5.4.0"
|
||||
"source": "https://github.com/nikic/PHP-Parser/tree/v5.5.0"
|
||||
},
|
||||
"time": "2024-12-30T11:07:19+00:00"
|
||||
"time": "2025-05-31T08:24:38+00:00"
|
||||
},
|
||||
{
|
||||
"name": "phar-io/manifest",
|
||||
@ -245,16 +245,16 @@
|
||||
},
|
||||
{
|
||||
"name": "phpunit/php-code-coverage",
|
||||
"version": "12.0.3",
|
||||
"version": "12.3.1",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/sebastianbergmann/php-code-coverage.git",
|
||||
"reference": "2e3038bff41d56114e5396151060f5ac9d2d6751"
|
||||
"reference": "ddec29dfc128eba9c204389960f2063f3b7fa170"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/2e3038bff41d56114e5396151060f5ac9d2d6751",
|
||||
"reference": "2e3038bff41d56114e5396151060f5ac9d2d6751",
|
||||
"url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/ddec29dfc128eba9c204389960f2063f3b7fa170",
|
||||
"reference": "ddec29dfc128eba9c204389960f2063f3b7fa170",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
@ -272,7 +272,7 @@
|
||||
"theseer/tokenizer": "^1.2.3"
|
||||
},
|
||||
"require-dev": {
|
||||
"phpunit/phpunit": "^12.0"
|
||||
"phpunit/phpunit": "^12.1"
|
||||
},
|
||||
"suggest": {
|
||||
"ext-pcov": "PHP extension that provides line coverage",
|
||||
@ -281,7 +281,7 @@
|
||||
"type": "library",
|
||||
"extra": {
|
||||
"branch-alias": {
|
||||
"dev-main": "12.0.x-dev"
|
||||
"dev-main": "12.3.x-dev"
|
||||
}
|
||||
},
|
||||
"autoload": {
|
||||
@ -310,15 +310,27 @@
|
||||
"support": {
|
||||
"issues": "https://github.com/sebastianbergmann/php-code-coverage/issues",
|
||||
"security": "https://github.com/sebastianbergmann/php-code-coverage/security/policy",
|
||||
"source": "https://github.com/sebastianbergmann/php-code-coverage/tree/12.0.3"
|
||||
"source": "https://github.com/sebastianbergmann/php-code-coverage/tree/12.3.1"
|
||||
},
|
||||
"funding": [
|
||||
{
|
||||
"url": "https://github.com/sebastianbergmann",
|
||||
"type": "github"
|
||||
},
|
||||
{
|
||||
"url": "https://liberapay.com/sebastianbergmann",
|
||||
"type": "liberapay"
|
||||
},
|
||||
{
|
||||
"url": "https://thanks.dev/u/gh/sebastianbergmann",
|
||||
"type": "thanks_dev"
|
||||
},
|
||||
{
|
||||
"url": "https://tidelift.com/funding/github/packagist/phpunit/php-code-coverage",
|
||||
"type": "tidelift"
|
||||
}
|
||||
],
|
||||
"time": "2025-02-18T14:04:13+00:00"
|
||||
"time": "2025-06-18T08:58:13+00:00"
|
||||
},
|
||||
{
|
||||
"name": "phpunit/php-file-iterator",
|
||||
@ -567,16 +579,16 @@
|
||||
},
|
||||
{
|
||||
"name": "phpunit/phpunit",
|
||||
"version": "12.0.4",
|
||||
"version": "12.2.5",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/sebastianbergmann/phpunit.git",
|
||||
"reference": "e469daf4e173c4b7f2d6154d364f468f3713f632"
|
||||
"reference": "b71849b29f7a8d7574e4401873cb8b539896613f"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/e469daf4e173c4b7f2d6154d364f468f3713f632",
|
||||
"reference": "e469daf4e173c4b7f2d6154d364f468f3713f632",
|
||||
"url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/b71849b29f7a8d7574e4401873cb8b539896613f",
|
||||
"reference": "b71849b29f7a8d7574e4401873cb8b539896613f",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
@ -586,23 +598,23 @@
|
||||
"ext-mbstring": "*",
|
||||
"ext-xml": "*",
|
||||
"ext-xmlwriter": "*",
|
||||
"myclabs/deep-copy": "^1.13.0",
|
||||
"myclabs/deep-copy": "^1.13.1",
|
||||
"phar-io/manifest": "^2.0.4",
|
||||
"phar-io/version": "^3.2.1",
|
||||
"php": ">=8.3",
|
||||
"phpunit/php-code-coverage": "^12.0.3",
|
||||
"phpunit/php-code-coverage": "^12.3.1",
|
||||
"phpunit/php-file-iterator": "^6.0.0",
|
||||
"phpunit/php-invoker": "^6.0.0",
|
||||
"phpunit/php-text-template": "^5.0.0",
|
||||
"phpunit/php-timer": "^8.0.0",
|
||||
"sebastian/cli-parser": "^4.0.0",
|
||||
"sebastian/comparator": "^7.0.0",
|
||||
"sebastian/comparator": "^7.1.0",
|
||||
"sebastian/diff": "^7.0.0",
|
||||
"sebastian/environment": "^8.0.0",
|
||||
"sebastian/environment": "^8.0.2",
|
||||
"sebastian/exporter": "^7.0.0",
|
||||
"sebastian/global-state": "^8.0.0",
|
||||
"sebastian/object-enumerator": "^7.0.0",
|
||||
"sebastian/type": "^6.0.0",
|
||||
"sebastian/type": "^6.0.2",
|
||||
"sebastian/version": "^6.0.0",
|
||||
"staabm/side-effects-detector": "^1.0.5"
|
||||
},
|
||||
@ -612,7 +624,7 @@
|
||||
"type": "library",
|
||||
"extra": {
|
||||
"branch-alias": {
|
||||
"dev-main": "12.0-dev"
|
||||
"dev-main": "12.2-dev"
|
||||
}
|
||||
},
|
||||
"autoload": {
|
||||
@ -644,7 +656,7 @@
|
||||
"support": {
|
||||
"issues": "https://github.com/sebastianbergmann/phpunit/issues",
|
||||
"security": "https://github.com/sebastianbergmann/phpunit/security/policy",
|
||||
"source": "https://github.com/sebastianbergmann/phpunit/tree/12.0.4"
|
||||
"source": "https://github.com/sebastianbergmann/phpunit/tree/12.2.5"
|
||||
},
|
||||
"funding": [
|
||||
{
|
||||
@ -655,12 +667,20 @@
|
||||
"url": "https://github.com/sebastianbergmann",
|
||||
"type": "github"
|
||||
},
|
||||
{
|
||||
"url": "https://liberapay.com/sebastianbergmann",
|
||||
"type": "liberapay"
|
||||
},
|
||||
{
|
||||
"url": "https://thanks.dev/u/gh/sebastianbergmann",
|
||||
"type": "thanks_dev"
|
||||
},
|
||||
{
|
||||
"url": "https://tidelift.com/funding/github/packagist/phpunit/phpunit",
|
||||
"type": "tidelift"
|
||||
}
|
||||
],
|
||||
"time": "2025-02-21T06:10:40+00:00"
|
||||
"time": "2025-06-27T04:37:55+00:00"
|
||||
},
|
||||
{
|
||||
"name": "sebastian/cli-parser",
|
||||
@ -721,16 +741,16 @@
|
||||
},
|
||||
{
|
||||
"name": "sebastian/comparator",
|
||||
"version": "7.0.0",
|
||||
"version": "7.1.0",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/sebastianbergmann/comparator.git",
|
||||
"reference": "18eb5a4f854dbd1d6512c459b605de2edb5a0b47"
|
||||
"reference": "03d905327dccc0851c9a08d6a979dfc683826b6f"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/sebastianbergmann/comparator/zipball/18eb5a4f854dbd1d6512c459b605de2edb5a0b47",
|
||||
"reference": "18eb5a4f854dbd1d6512c459b605de2edb5a0b47",
|
||||
"url": "https://api.github.com/repos/sebastianbergmann/comparator/zipball/03d905327dccc0851c9a08d6a979dfc683826b6f",
|
||||
"reference": "03d905327dccc0851c9a08d6a979dfc683826b6f",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
@ -741,7 +761,7 @@
|
||||
"sebastian/exporter": "^7.0"
|
||||
},
|
||||
"require-dev": {
|
||||
"phpunit/phpunit": "^12.0"
|
||||
"phpunit/phpunit": "^12.2"
|
||||
},
|
||||
"suggest": {
|
||||
"ext-bcmath": "For comparing BcMath\\Number objects"
|
||||
@ -749,7 +769,7 @@
|
||||
"type": "library",
|
||||
"extra": {
|
||||
"branch-alias": {
|
||||
"dev-main": "7.0-dev"
|
||||
"dev-main": "7.1-dev"
|
||||
}
|
||||
},
|
||||
"autoload": {
|
||||
@ -789,15 +809,27 @@
|
||||
"support": {
|
||||
"issues": "https://github.com/sebastianbergmann/comparator/issues",
|
||||
"security": "https://github.com/sebastianbergmann/comparator/security/policy",
|
||||
"source": "https://github.com/sebastianbergmann/comparator/tree/7.0.0"
|
||||
"source": "https://github.com/sebastianbergmann/comparator/tree/7.1.0"
|
||||
},
|
||||
"funding": [
|
||||
{
|
||||
"url": "https://github.com/sebastianbergmann",
|
||||
"type": "github"
|
||||
},
|
||||
{
|
||||
"url": "https://liberapay.com/sebastianbergmann",
|
||||
"type": "liberapay"
|
||||
},
|
||||
{
|
||||
"url": "https://thanks.dev/u/gh/sebastianbergmann",
|
||||
"type": "thanks_dev"
|
||||
},
|
||||
{
|
||||
"url": "https://tidelift.com/funding/github/packagist/sebastian/comparator",
|
||||
"type": "tidelift"
|
||||
}
|
||||
],
|
||||
"time": "2025-02-07T04:54:52+00:00"
|
||||
"time": "2025-06-17T07:41:58+00:00"
|
||||
},
|
||||
{
|
||||
"name": "sebastian/complexity",
|
||||
@ -926,16 +958,16 @@
|
||||
},
|
||||
{
|
||||
"name": "sebastian/environment",
|
||||
"version": "8.0.0",
|
||||
"version": "8.0.2",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/sebastianbergmann/environment.git",
|
||||
"reference": "8afe311eca49171bf95405cc0078be9a3821f9f2"
|
||||
"reference": "d364b9e5d0d3b18a2573351a1786fbf96b7e0792"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/sebastianbergmann/environment/zipball/8afe311eca49171bf95405cc0078be9a3821f9f2",
|
||||
"reference": "8afe311eca49171bf95405cc0078be9a3821f9f2",
|
||||
"url": "https://api.github.com/repos/sebastianbergmann/environment/zipball/d364b9e5d0d3b18a2573351a1786fbf96b7e0792",
|
||||
"reference": "d364b9e5d0d3b18a2573351a1786fbf96b7e0792",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
@ -978,15 +1010,27 @@
|
||||
"support": {
|
||||
"issues": "https://github.com/sebastianbergmann/environment/issues",
|
||||
"security": "https://github.com/sebastianbergmann/environment/security/policy",
|
||||
"source": "https://github.com/sebastianbergmann/environment/tree/8.0.0"
|
||||
"source": "https://github.com/sebastianbergmann/environment/tree/8.0.2"
|
||||
},
|
||||
"funding": [
|
||||
{
|
||||
"url": "https://github.com/sebastianbergmann",
|
||||
"type": "github"
|
||||
},
|
||||
{
|
||||
"url": "https://liberapay.com/sebastianbergmann",
|
||||
"type": "liberapay"
|
||||
},
|
||||
{
|
||||
"url": "https://thanks.dev/u/gh/sebastianbergmann",
|
||||
"type": "thanks_dev"
|
||||
},
|
||||
{
|
||||
"url": "https://tidelift.com/funding/github/packagist/sebastian/environment",
|
||||
"type": "tidelift"
|
||||
}
|
||||
],
|
||||
"time": "2025-02-07T04:56:08+00:00"
|
||||
"time": "2025-05-21T15:05:44+00:00"
|
||||
},
|
||||
{
|
||||
"name": "sebastian/exporter",
|
||||
@ -1366,16 +1410,16 @@
|
||||
},
|
||||
{
|
||||
"name": "sebastian/type",
|
||||
"version": "6.0.0",
|
||||
"version": "6.0.2",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/sebastianbergmann/type.git",
|
||||
"reference": "533fe082889a616f330bcba6f50965135f4f2fab"
|
||||
"reference": "1d7cd6e514384c36d7a390347f57c385d4be6069"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/sebastianbergmann/type/zipball/533fe082889a616f330bcba6f50965135f4f2fab",
|
||||
"reference": "533fe082889a616f330bcba6f50965135f4f2fab",
|
||||
"url": "https://api.github.com/repos/sebastianbergmann/type/zipball/1d7cd6e514384c36d7a390347f57c385d4be6069",
|
||||
"reference": "1d7cd6e514384c36d7a390347f57c385d4be6069",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
@ -1411,7 +1455,7 @@
|
||||
"support": {
|
||||
"issues": "https://github.com/sebastianbergmann/type/issues",
|
||||
"security": "https://github.com/sebastianbergmann/type/security/policy",
|
||||
"source": "https://github.com/sebastianbergmann/type/tree/6.0.0"
|
||||
"source": "https://github.com/sebastianbergmann/type/tree/6.0.2"
|
||||
},
|
||||
"funding": [
|
||||
{
|
||||
@ -1419,7 +1463,7 @@
|
||||
"type": "github"
|
||||
}
|
||||
],
|
||||
"time": "2025-02-07T05:00:19+00:00"
|
||||
"time": "2025-03-18T13:37:31+00:00"
|
||||
},
|
||||
{
|
||||
"name": "sebastian/version",
|
||||
|
29
sources/attributes/GetOnly.php
Normal file
29
sources/attributes/GetOnly.php
Normal file
@ -0,0 +1,29 @@
|
||||
<?php
|
||||
/**
|
||||
* Отключаю несущественные инспекции (из-за Attribute)
|
||||
*
|
||||
* @noinspection PhpMultipleClassDeclarationsInspection
|
||||
*/
|
||||
|
||||
namespace goodboyalex\php_components_pack\attributes;
|
||||
|
||||
use Attribute;
|
||||
|
||||
/**
|
||||
* Атрибут указания, что параметр является параметром только для чтения и не подлежит маппингу.
|
||||
*
|
||||
* @author Александр Бабаев
|
||||
* @package php_components_pack
|
||||
* @version 1.0
|
||||
* @since 1.0.25
|
||||
*/
|
||||
#[Attribute(flags: Attribute::TARGET_PROPERTY)]
|
||||
final readonly class GetOnly
|
||||
{
|
||||
/**
|
||||
* Конструктор
|
||||
*/
|
||||
public function __construct ()
|
||||
{
|
||||
}
|
||||
}
|
@ -7,10 +7,12 @@
|
||||
|
||||
namespace goodboyalex\php_components_pack\classes;
|
||||
|
||||
use Closure;
|
||||
use goodboyalex\php_components_pack\enums\MessageType;
|
||||
use goodboyalex\php_components_pack\interfaces\ISerializable;
|
||||
use goodboyalex\php_components_pack\models\ActionStateMessageModel;
|
||||
use goodboyalex\php_components_pack\traits\ActionState\ActionStateAddTrait;
|
||||
use goodboyalex\php_components_pack\traits\ActionState\ActionStateGetTrait;
|
||||
use goodboyalex\php_components_pack\traits\ActionState\ActionStateHasTrait;
|
||||
use goodboyalex\php_components_pack\traits\ActionState\ActionStateStaticTrait;
|
||||
|
||||
/**
|
||||
* Состояние действия.
|
||||
@ -28,9 +30,9 @@ final class ActionState implements ISerializable
|
||||
public mixed $Value;
|
||||
|
||||
/**
|
||||
* @var array $Messages Список информации
|
||||
* @var ObjectArray $Messages Список информации
|
||||
*/
|
||||
private array $Messages = [];
|
||||
private ObjectArray $Messages;
|
||||
|
||||
/**
|
||||
* Конструктор
|
||||
@ -39,218 +41,24 @@ final class ActionState implements ISerializable
|
||||
*/
|
||||
public function __construct (mixed $defValue = null)
|
||||
{
|
||||
// Присваиваю значение по умолчанию
|
||||
$this->Value = $defValue;
|
||||
|
||||
// Создаю список сообщений
|
||||
$this->Messages = new ObjectArray([]);
|
||||
}
|
||||
|
||||
/**
|
||||
* При выводе GetStringMessages выводит только ошибки.
|
||||
*
|
||||
* @return Closure Возвращает функцию, проверяющую сообщение на соответствие типу.
|
||||
*/
|
||||
public static function GET_STRING_ERROR_ONLY (): Closure
|
||||
{
|
||||
return fn (ActionStateMessageModel $message)
|
||||
=> $message->MessageType === MessageType::Error;
|
||||
}
|
||||
// Статичные методы и константы
|
||||
use ActionStateStaticTrait;
|
||||
|
||||
/**
|
||||
* При выводе GetStringMessages выводит ошибки и предупреждения.
|
||||
*
|
||||
* @return Closure Возвращает функцию, проверяющую сообщение на соответствие типу.
|
||||
*/
|
||||
public static function GET_STRING_ERROR_AND_WARNING (): Closure
|
||||
{
|
||||
return fn (ActionStateMessageModel $message)
|
||||
=> $message->MessageType === MessageType::Error
|
||||
|| $message->MessageType === MessageType::Warning;
|
||||
}
|
||||
// Методы добавления сообщений
|
||||
use ActionStateAddTrait;
|
||||
|
||||
/**
|
||||
* При выводе GetStringMessages выводит все сообщения.
|
||||
*
|
||||
* @return Closure Возвращает функцию, проверяющую сообщение на соответствие типу.
|
||||
*/
|
||||
public static function GET_STRING_ALL (): Closure
|
||||
{
|
||||
return fn (ActionStateMessageModel $message) => true;
|
||||
}
|
||||
// Методы проверки на наличие сообщений
|
||||
use ActionStateHasTrait;
|
||||
|
||||
/**
|
||||
* Добавляет данные из другого состояния.
|
||||
*
|
||||
* @param ActionState $state Другое состояние
|
||||
* @param bool $clearAllBefore Очищать сообщения перед добавлением (true) или просто добавить к текущим (false)
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function AddState (ActionState $state, bool $clearAllBefore = false): void
|
||||
{
|
||||
// Если нужно очистить список сообщений
|
||||
if ($clearAllBefore)
|
||||
// - то очищаю список сообщений
|
||||
$this->Clear(fn (ActionStateMessageModel $message) => true);
|
||||
|
||||
// Добавляю сообщения из другого состояния
|
||||
$this->AddRange($state->GetMessages(function (ActionStateMessageModel $message)
|
||||
{
|
||||
return true;
|
||||
}));
|
||||
|
||||
// Добавляю значение
|
||||
$this->Value = $state->Value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Очищает список сообщений, согласно условию.
|
||||
*
|
||||
* @param callable $predicate Условие выборки
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function Clear (callable $predicate): void
|
||||
{
|
||||
// Выбираю все сообщения, удовлетворяющие условию
|
||||
$list = $this->GetMessages($predicate);
|
||||
|
||||
// Удаляю их из списка
|
||||
$this->Messages = array_diff($this->Messages, $list);
|
||||
}
|
||||
|
||||
/**
|
||||
* Выбирает сообщения по условию predicate.
|
||||
*
|
||||
* @param callable $predicate Условие выборки
|
||||
*
|
||||
* @return array Список отобранных сообщений
|
||||
*/
|
||||
public function GetMessages (callable $predicate): array
|
||||
{
|
||||
// Получаю список элементов
|
||||
$list = [];
|
||||
|
||||
// Для каждого элемента
|
||||
foreach ($this->Messages as $actionStateMessage)
|
||||
// - если он подходит под условие
|
||||
if ($predicate($actionStateMessage))
|
||||
// - добавляю его в список
|
||||
$list[] = $actionStateMessage;
|
||||
|
||||
// Возвращаю список
|
||||
return $list;
|
||||
}
|
||||
|
||||
/**
|
||||
* Добавляет список
|
||||
*
|
||||
* @param array $messages Список сообщений
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function AddRange (array $messages): void
|
||||
{
|
||||
$this->Messages = array_merge($this->Messages, $messages);
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает список сообщений (параметр Message у каждого сообщения).
|
||||
*
|
||||
* @param callable $predicate Условие выборки
|
||||
* @param string $separator Разделитель
|
||||
*
|
||||
* @return string Список сообщений
|
||||
*/
|
||||
public function GetStringMessages (callable $predicate, string $separator = '\n'): string
|
||||
{
|
||||
// Делаю выборку
|
||||
$list = $this->GetMessages($predicate);
|
||||
|
||||
// Формирую список сообщений
|
||||
$result = [];
|
||||
|
||||
// Для каждого сообщения из выборки
|
||||
foreach ($list as $message) {
|
||||
// - если оно не нужного нам класса
|
||||
if (!$message instanceof ActionStateMessageModel)
|
||||
// -- то пропускаю
|
||||
continue;
|
||||
|
||||
// - добавляю сообщение
|
||||
$result[] = $message->Message;
|
||||
}
|
||||
|
||||
// Возвращаю список
|
||||
return implode($separator, $result);
|
||||
}
|
||||
|
||||
/**
|
||||
* Добавляет сообщение о критической ошибке.
|
||||
*
|
||||
* @param string $message Сообщение
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function AddCritical (string $message): void
|
||||
{
|
||||
$this->Add(new ActionStateMessageModel(MessageType::Error, true, $message));
|
||||
}
|
||||
|
||||
/**
|
||||
* Добавление сообщения.
|
||||
*
|
||||
* @param ActionStateMessageModel $message Сообщение
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function Add (ActionStateMessageModel $message): void
|
||||
{
|
||||
$this->Messages[] = $message;
|
||||
}
|
||||
|
||||
/**
|
||||
* Добавляет сообщение об ошибке.
|
||||
*
|
||||
* @param string $message Сообщение
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function AddError (string $message): void
|
||||
{
|
||||
$this->Add(new ActionStateMessageModel(MessageType::Error, false, $message));
|
||||
}
|
||||
|
||||
/**
|
||||
* Добавляет предупреждение.
|
||||
*
|
||||
* @param string $message Сообщение.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function AddWarning (string $message): void
|
||||
{
|
||||
$this->Add(new ActionStateMessageModel(MessageType::Warning, false, $message));
|
||||
}
|
||||
|
||||
/**
|
||||
* Добавляет информационное сообщение.
|
||||
*
|
||||
* @param string $message Сообщение.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function AddInfo (string $message): void
|
||||
{
|
||||
$this->Add(new ActionStateMessageModel(MessageType::Info, false, $message));
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверяет, есть ли информационные сообщения.
|
||||
*
|
||||
* @return bool Наличие сообщений
|
||||
*/
|
||||
public function HasInfos (): bool
|
||||
{
|
||||
return $this->Count(fn (ActionStateMessageModel $message) => $message->MessageType == MessageType::Info) > 0;
|
||||
}
|
||||
// Методы получения сообщений
|
||||
use ActionStateGetTrait;
|
||||
|
||||
/**
|
||||
* Количество сообщений, удовлетворяющих условию.
|
||||
@ -261,65 +69,7 @@ final class ActionState implements ISerializable
|
||||
*/
|
||||
public function Count (callable $predicate): int
|
||||
{
|
||||
// Получаю список сообщений
|
||||
$list = $this->GetMessages($predicate);
|
||||
|
||||
// Возвращаю результат
|
||||
return count($list);
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверяет, успешно ли завершилась операция.
|
||||
*
|
||||
* @param bool $onlyCritical Игнорировать все некритические ошибки и предупреждения (не рекомендуется!)
|
||||
*
|
||||
* @return bool Успешно ли завершилась операция.
|
||||
*/
|
||||
public function IsSuccess (bool $onlyCritical = false): bool
|
||||
{
|
||||
// Если нужно учитывать только критические ошибки
|
||||
if ($onlyCritical)
|
||||
// - то проверяю наличие критических ошибок
|
||||
return !$this->HasErrors($onlyCritical);
|
||||
|
||||
// Возвращаю результат
|
||||
return !$this->HasErrors() && !$this->HasWarnings();
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверяет, есть ли ошибки.
|
||||
*
|
||||
* @param bool $onlyCritical Учитывать только критические ошибки.
|
||||
*
|
||||
* @return bool Наличие ошибок.
|
||||
*/
|
||||
public function HasErrors (bool $onlyCritical = false): bool
|
||||
{
|
||||
return $this->Count(function (ActionStateMessageModel $message) use ($onlyCritical): bool
|
||||
{
|
||||
// - сравниваю тип сообщения
|
||||
if ($message->MessageType != MessageType::Error)
|
||||
// -- если не совпадает, то возвращаю false
|
||||
return false;
|
||||
|
||||
// - если нужно выводить только критические ошибки, а сообщение не критическое
|
||||
if ($onlyCritical && !$message->IsCritical)
|
||||
// -- то возвращаю false
|
||||
return false;
|
||||
|
||||
// Возвращаю true
|
||||
return true;
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверяет, есть ли предупреждения.
|
||||
*
|
||||
* @return bool Наличие предупреждений
|
||||
*/
|
||||
public function HasWarnings (): bool
|
||||
{
|
||||
return $this->Count(fn (ActionStateMessageModel $message) => $message->MessageType == MessageType::Warning) > 0;
|
||||
return $this->Messages->Count($predicate);
|
||||
}
|
||||
|
||||
/**
|
||||
@ -336,7 +86,7 @@ final class ActionState implements ISerializable
|
||||
$list[] = $message->Serialize();
|
||||
|
||||
// Возвращаю результат
|
||||
return serialize($list);
|
||||
return json_encode($list);
|
||||
}
|
||||
|
||||
/**
|
||||
@ -345,10 +95,10 @@ final class ActionState implements ISerializable
|
||||
public function UnSerialize (string $serialized): void
|
||||
{
|
||||
// Очищаю список сообщений
|
||||
$this->Clear(fn (ActionStateMessageModel $message) => true);
|
||||
$this->Clear(self::GET_STRING_ALL());
|
||||
|
||||
// Десериализую список сообщений
|
||||
$list = unserialize($serialized);
|
||||
$list = json_decode($serialized, true);
|
||||
|
||||
// Для каждого сообщения
|
||||
foreach ($list as $messageSerialized) {
|
||||
@ -360,4 +110,16 @@ final class ActionState implements ISerializable
|
||||
$this->Add($message);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Очищает список сообщений, согласно условию.
|
||||
*
|
||||
* @param callable $predicate Условие выборки
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function Clear (callable $predicate): void
|
||||
{
|
||||
$this->Messages->Delete($predicate);
|
||||
}
|
||||
}
|
@ -5,8 +5,10 @@ namespace goodboyalex\php_components_pack\classes;
|
||||
use DateTimeImmutable;
|
||||
use DateTimeInterface;
|
||||
use Exception;
|
||||
use goodboyalex\php_components_pack\attributes\GetOnly;
|
||||
use ReflectionClass;
|
||||
use ReflectionException;
|
||||
use ReflectionProperty;
|
||||
use stdClass;
|
||||
use UnitEnum;
|
||||
|
||||
@ -15,7 +17,7 @@ use UnitEnum;
|
||||
*
|
||||
* @author Александр Бабаев
|
||||
* @package php_components_pack
|
||||
* @version 1.0
|
||||
* @version 1.0.1
|
||||
* @since 1.0
|
||||
*/
|
||||
final class ClassMapper
|
||||
@ -59,6 +61,11 @@ final class ClassMapper
|
||||
// -- пропускаю
|
||||
continue;
|
||||
|
||||
// - если свойство маркируется как GetOnly
|
||||
if (self::HasGetOnlyAttributes($from, $name))
|
||||
// -- пропускаю
|
||||
continue;
|
||||
|
||||
// - если свойство не разрешено
|
||||
if (count($options['allowed']) > 0 && !in_array($name, $options['allowed']))
|
||||
// -- пропускаю
|
||||
@ -71,6 +78,32 @@ final class ClassMapper
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверяет, есть ли у свойства класса $class атрибуты GetOnly.
|
||||
*
|
||||
* @param object $class Объект класса.
|
||||
* @param string $propertyName Имя свойства.
|
||||
*
|
||||
* @return bool true если у свойства есть атрибут GetOnly, иначе false.
|
||||
*/
|
||||
private static function HasGetOnlyAttributes (object $class, string $propertyName): bool
|
||||
{
|
||||
// Создаем отражение свойства класса
|
||||
try {
|
||||
$reflectionProperty = new ReflectionProperty(get_class($class), $propertyName);
|
||||
}
|
||||
catch (ReflectionException) {
|
||||
// - возвращаю false, если произошла ошибка создания отражения свойства класса
|
||||
return false;
|
||||
}
|
||||
|
||||
// Получаем список атрибутов у данного свойства
|
||||
$attributes = $reflectionProperty->getAttributes(GetOnly::class);
|
||||
|
||||
// Возвращаем true, если атрибут найден, иначе false
|
||||
return !empty($attributes);
|
||||
}
|
||||
|
||||
/**
|
||||
* Подготавливает значения свойств класса.
|
||||
*
|
||||
@ -211,6 +244,15 @@ final class ClassMapper
|
||||
// -- тип свойства
|
||||
$propertyType = $property->getType();
|
||||
|
||||
// - если значение является типом bool
|
||||
if ($propertyType->getName() === 'bool') {
|
||||
// -- присваиваю дату
|
||||
self::SetParameterToClass($classReflector, $key, $classObj, $value == "1");
|
||||
|
||||
// -- следующий элемент
|
||||
continue;
|
||||
}
|
||||
|
||||
// - если значение является классом
|
||||
if (!$propertyType->isBuiltin() && is_array($value)) {
|
||||
// -- присваиваю объект
|
||||
@ -300,7 +342,7 @@ final class ClassMapper
|
||||
$property->setAccessible(true);
|
||||
|
||||
// Если значение null
|
||||
if ($value == null || $value == "null")
|
||||
if (!is_bool($value) && ($value == null || $value == "null"))
|
||||
// - то присваиваю значение по умолчанию
|
||||
$value = self::GetDefaults($property->getType()->getName());
|
||||
|
||||
|
153
sources/classes/Dictionary.php
Normal file
153
sources/classes/Dictionary.php
Normal file
@ -0,0 +1,153 @@
|
||||
<?php
|
||||
|
||||
namespace goodboyalex\php_components_pack\classes;
|
||||
|
||||
use ArrayAccess;
|
||||
use Countable;
|
||||
use goodboyalex\php_components_pack\interfaces\ISerializable;
|
||||
use goodboyalex\php_components_pack\traits\ArrayBasicTrait;
|
||||
use IteratorAggregate;
|
||||
|
||||
/**
|
||||
* Класс, описывающий словарь типа строка (ключ) -> значение любого типа (значение).
|
||||
*
|
||||
* @author Александр Бабаев
|
||||
* @package php_components_pack
|
||||
* @version 1.0.3
|
||||
* @since 1.0.14
|
||||
*/
|
||||
final class Dictionary implements ArrayAccess, IteratorAggregate, Countable, ISerializable
|
||||
{
|
||||
/**
|
||||
* @var array $Container Контейнер.
|
||||
*/
|
||||
private array $Container = [];
|
||||
|
||||
// Реализация наследуемых интерфейсов и классов
|
||||
use ArrayBasicTrait;
|
||||
|
||||
/**
|
||||
* Добавление элементов в словарь.
|
||||
*
|
||||
* @param array $dictionary Ассоциативный массив вида ключ => значение, который будет добавлен в словарь.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function AddRange (array $dictionary): void
|
||||
{
|
||||
// Для каждого элемента массива
|
||||
foreach ($dictionary as $key => $value)
|
||||
// - добавляем его в словарь.
|
||||
$this->Add($key, $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* Добавление элемента в словарь.
|
||||
*
|
||||
* @param string $key Ключ.
|
||||
* @param mixed $value Хранимое значение.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function Add (string $key, mixed $value): void
|
||||
{
|
||||
$this->Container[$key] = $value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Получение значения по ключу.
|
||||
*
|
||||
* @param string $key Ключ.
|
||||
* @param mixed $default Значение по умолчанию, которое будет возвращено, если элемент с указанным ключом
|
||||
* отсутствует.
|
||||
*
|
||||
* @return mixed Если элемент существует, то возвращается его значение, иначе default.
|
||||
*/
|
||||
public function Get (string $key, mixed $default = null): mixed
|
||||
{
|
||||
return $this->Container[$key] ?? $default;
|
||||
}
|
||||
|
||||
/**
|
||||
* Удаление элемента по ключу.
|
||||
*
|
||||
* @param string $key Ключ.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function Remove (string $key): void
|
||||
{
|
||||
// Если элемент с указанным ключом существует
|
||||
if ($this->Has($key))
|
||||
// - то удаляем его.
|
||||
unset($this->Container[$key]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверка наличия элемента с указанным ключом.
|
||||
*
|
||||
* @param string $key Ключ.
|
||||
*
|
||||
* @return bool Есть ли элемент с указанным ключом.
|
||||
*/
|
||||
public function Has (string $key): bool
|
||||
{
|
||||
return isset($this->Container[$key]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Очистка всех элементов.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function Clear (): void
|
||||
{
|
||||
$this->Container = [];
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function count (): int
|
||||
{
|
||||
return count($this->Container);
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает все ключи словаря.
|
||||
*
|
||||
* @return array Массив всех ключей словаря.
|
||||
*/
|
||||
public function Keys (): array
|
||||
{
|
||||
return array_keys($this->Container);
|
||||
}
|
||||
|
||||
/**
|
||||
* Сортирует внутренние данные по ключам.
|
||||
*
|
||||
* @param bool $descending Сортировать ли данные в обратном порядке?
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function Sort (bool $descending = false): void
|
||||
{
|
||||
// Если задана сортировка по убыванию
|
||||
if ($descending)
|
||||
// - сортируем данные в обратном порядке
|
||||
krsort($this->Container);
|
||||
else
|
||||
// - иначе, стандартная сортировка по ключам в порядке возрастания
|
||||
ksort($this->Container);
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает все элементы словаря в виде массива.
|
||||
*
|
||||
* @return array Массив, содержащий все элементы словаря.
|
||||
*/
|
||||
public function ToArray (): array
|
||||
{
|
||||
return $this->Container;
|
||||
}
|
||||
}
|
351
sources/classes/File.php
Normal file
351
sources/classes/File.php
Normal file
@ -0,0 +1,351 @@
|
||||
<?php
|
||||
|
||||
namespace goodboyalex\php_components_pack\classes;
|
||||
|
||||
use Exception;
|
||||
use RecursiveDirectoryIterator;
|
||||
use RecursiveIteratorIterator;
|
||||
|
||||
/**
|
||||
* Класс, реализующий функционал работы с файлами и выполнение операций над файлами одной командой.
|
||||
*
|
||||
* @author Александр Бабаев
|
||||
* @package php_components_pack
|
||||
* @version 1.0.2
|
||||
* @since 1.0.21
|
||||
*/
|
||||
final class File
|
||||
{
|
||||
/**
|
||||
* @var array Массив сообщений об ошибках при удалении директории.
|
||||
*/
|
||||
public const array REMOVE_DIRECTORY_ERROR_MESSAGES = [
|
||||
'directory_not_exist' => "Директория не существует или нет доступа на запись!",
|
||||
'error_deleting_file_or_link' => 'Ошибка удаления файла или ссылки: %s!',
|
||||
'error_deleting_directory' => 'Ошибка удаления каталога: %s. Код возврата: %d!',
|
||||
'unhandled_error' => 'Ошибка удаления директории %s: %s!'
|
||||
];
|
||||
|
||||
/**
|
||||
* @var array Массив сообщений об ошибках при получении размера файла.
|
||||
*/
|
||||
public const array FILE_SIZE_ERROR_MESSAGES = [
|
||||
'file_not_exist' => 'Файл не существует!',
|
||||
'not_a_file' => 'Указанный путь не является файлом!',
|
||||
'cannot_get_size' => 'Не удалось получить размер файла!'
|
||||
];
|
||||
|
||||
/**
|
||||
* @var array Массив локализации размеров файлов.
|
||||
*/
|
||||
public const array FILE_SIZE_UNITS = ['байт', 'КБ', 'МБ', 'ГБ', 'ТБ'];
|
||||
|
||||
/**
|
||||
* Получает список файлов в директории и поддиректориях, соответствующей шаблону $pattern.
|
||||
*
|
||||
* @param string $dir Родительская директория
|
||||
* @param string $pattern Шаблон имени файла
|
||||
*
|
||||
* @return false|array Список файлов или false в случае ошибки
|
||||
*/
|
||||
public static function FindFiles (string $dir, string $pattern = '*.php'): false|array
|
||||
{
|
||||
// Получаем список файлов и каталогов в текущей директории
|
||||
$files = glob("$dir/$pattern");
|
||||
|
||||
// Если произошла ошибка
|
||||
if ($files === false)
|
||||
// - то возвращаем false
|
||||
return false;
|
||||
|
||||
// Перебираем поддиректории
|
||||
foreach (glob("$dir/*", GLOB_ONLYDIR | GLOB_NOSORT) as $subDir) {
|
||||
// - если ошибка
|
||||
if ($subDir === false)
|
||||
// - то пропускаем
|
||||
continue;
|
||||
|
||||
// - рекурсивный вызов для каждой поддиректории
|
||||
$files = array_merge($files, self::FindFiles($subDir, $pattern));
|
||||
}
|
||||
|
||||
// Возвращаем список файлов
|
||||
return $files;
|
||||
}
|
||||
|
||||
/**
|
||||
* Получает имя файла без пути к нему и расширения.
|
||||
*
|
||||
* @param string $fileName Полное имя файла с путем к нему.
|
||||
*
|
||||
* @return string Имя файла без пути к нему и расширения.
|
||||
*/
|
||||
public static function ExtractFileNameWithoutExtension (string $fileName): string
|
||||
{
|
||||
// Имя файла без пути к нему
|
||||
$fileNameOnly = self::ExtractFileName($fileName);
|
||||
|
||||
// Расширение файла
|
||||
$fileExtension = self::ExtractFileExtension($fileName);
|
||||
|
||||
// Возвращаем имя файла без пути к нему и расширения.
|
||||
return substr($fileNameOnly, 0, -strlen($fileExtension) - 1);
|
||||
}
|
||||
|
||||
/**
|
||||
* Получает имя файла без пути к нему, но с расширением.
|
||||
*
|
||||
* @param string $fileName Полное имя файла с путем к нему.
|
||||
*
|
||||
* @return string Имя файла без пути к нему, но с расширением.
|
||||
*/
|
||||
public static function ExtractFileName (string $fileName): string
|
||||
{
|
||||
return basename($fileName);
|
||||
}
|
||||
|
||||
/**
|
||||
* Получает расширение файла.
|
||||
*
|
||||
* @param string $fileName Имя файла с путем к нему.
|
||||
*
|
||||
* @return string Расширение файла.
|
||||
*/
|
||||
public static function ExtractFileExtension (string $fileName): string
|
||||
{
|
||||
|
||||
return pathinfo($fileName, PATHINFO_EXTENSION);
|
||||
}
|
||||
|
||||
/**
|
||||
* Получает относительный путь к файлу, относительно заданной папки
|
||||
*
|
||||
* @param string $fullPath Полный путь к файлу
|
||||
* @param string $basePath Вырезаемый путь (с начала)
|
||||
*
|
||||
* @return false|string Относительный путь к файлу
|
||||
*/
|
||||
public static function GetRelativePath (string $fullPath, string $basePath): false|string
|
||||
{
|
||||
return stripos($fullPath, $basePath) !== false ? str_replace($basePath, "", $fullPath) : false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Удаляет директорию вместе со всеми файлами и поддиректориями.
|
||||
*
|
||||
* @param string $directory Полный путь к директории.
|
||||
* @param array $errorMessages Сообщения об ошибках удаления (по умолчанию, см.
|
||||
* {@link REMOVE_DIRECTORY_ERROR_MESSAGES}).
|
||||
*
|
||||
* @return ActionState Результат удаления.
|
||||
*/
|
||||
public static function RemoveDir (string $directory,
|
||||
array $errorMessages = self::REMOVE_DIRECTORY_ERROR_MESSAGES): ActionState
|
||||
{
|
||||
// Создаю результат
|
||||
$result = new ActionState(false);
|
||||
|
||||
try {
|
||||
// Проверяем наличие директории и доступ на запись
|
||||
if (!self::DirectoryExists(directory: $directory, checkWriteAccess: true)) {
|
||||
// - если нет, то добавляем ошибку
|
||||
$result->AddError($errorMessages['directory_not_exist']);
|
||||
|
||||
// - и возвращаем результат
|
||||
return $result;
|
||||
}
|
||||
|
||||
// Создаем рекурсивный итерационный объект для перебора всего дерева каталогов
|
||||
$iterator = new RecursiveIteratorIterator(
|
||||
new RecursiveDirectoryIterator($directory),
|
||||
RecursiveIteratorIterator::CHILD_FIRST
|
||||
);
|
||||
|
||||
// Проходим по каждому элементу (каталогам и файлам)
|
||||
foreach ($iterator as $item) {
|
||||
// - получаем путь к файлу
|
||||
$realPath = $item->getRealPath();
|
||||
|
||||
// - если это файл или ссылка
|
||||
if ($item->isFile() || $item->isLink())
|
||||
// -- то удаляем его
|
||||
if (!@unlink($realPath)) {
|
||||
// --- если не удалось удалить, то добавляем ошибку
|
||||
$result->AddError(sprintf($errorMessages['error_deleting_file_or_link'], $realPath));
|
||||
|
||||
// --- и возвращаем результат
|
||||
return $result;
|
||||
}
|
||||
}
|
||||
|
||||
// Определение текущей операционной системы
|
||||
$os = strtolower(PHP_OS_FAMILY);
|
||||
|
||||
// Экранируем аргумент для предотвращения инъекций
|
||||
$escapedDirectory = escapeshellarg($directory);
|
||||
|
||||
// Дальнейшие действия зависят от операционной системы
|
||||
switch ($os) {
|
||||
// - для Windows
|
||||
case 'windows':
|
||||
// -- выполняем команду Windows
|
||||
exec("rd /s /q $escapedDirectory", $output, $returnCode);
|
||||
break;
|
||||
|
||||
// - для Linux/macOS
|
||||
default:
|
||||
// -- выполняем команду Linux/macOS
|
||||
exec("rm -rf $escapedDirectory", $output, $returnCode);
|
||||
break;
|
||||
}
|
||||
|
||||
// Проверяем код возврата
|
||||
if ($returnCode !== 0) {
|
||||
// - если не удалось удалить, то добавляем ошибку
|
||||
$result->AddError(sprintf($errorMessages['error_deleting_directory'], $directory, $returnCode));
|
||||
|
||||
// --- и возвращаем результат
|
||||
return $result;
|
||||
}
|
||||
|
||||
// Если все прошло успешно (а если мы сюда попали, то все должно быть хорошо), то добавляем результат true
|
||||
$result->Value = true;
|
||||
|
||||
// - и возвращаем его
|
||||
return $result;
|
||||
}
|
||||
catch (Exception $exception) {
|
||||
// Если произошла ошибка, то добавляем ошибку
|
||||
$result->AddError(sprintf($errorMessages['unhandled_error'], $directory, $exception->getMessage()));
|
||||
|
||||
// - задаем результат false
|
||||
$result->Value = false;
|
||||
|
||||
// - и возвращаем его
|
||||
return $result;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверяет, существует ли директория.
|
||||
*
|
||||
* @param string $directory Путь к директории.
|
||||
* @param bool $checkReadAccess Проверять ли доступ на чтение директории (по умолчанию true).
|
||||
* @param bool $checkWriteAccess Проверять ли доступ на запись директории (по умолчанию false).
|
||||
*
|
||||
* @return bool Результат проверки.
|
||||
*/
|
||||
public static function DirectoryExists (string $directory, bool $checkReadAccess = true,
|
||||
bool $checkWriteAccess = false): bool
|
||||
{
|
||||
// Очищаем кэш
|
||||
clearstatcache();
|
||||
|
||||
// Проверяем, существует ли директория
|
||||
if (!file_exists($directory))
|
||||
// - если нет, то возвращаем false
|
||||
return false;
|
||||
|
||||
// Проверяем, является ли директория директорией, а не файлом
|
||||
if (!is_dir($directory))
|
||||
// - если нет, то возвращаем false
|
||||
return false;
|
||||
|
||||
// Проверяем, есть ли доступ на чтение директории
|
||||
if ($checkReadAccess && !is_readable($directory))
|
||||
// - если нет, то возвращаем false
|
||||
return false;
|
||||
|
||||
// Проверяем, есть ли доступ на запись директории
|
||||
if ($checkWriteAccess && !is_writable($directory))
|
||||
// - если нет, то возвращаем false
|
||||
return false;
|
||||
|
||||
// Если все проверки пройдены успешно, то возвращаем true
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Получает размер файла в байтах.
|
||||
*
|
||||
* @param string $filename Имя файла.
|
||||
* @param array $errorLocalization Массив сообщений об ошибках при получении размера файла (по умолчанию, см.
|
||||
* {@link FILE_SIZE_ERROR_MESSAGES}).
|
||||
*
|
||||
* @return ActionState Результат с размером файла в байтах.
|
||||
*/
|
||||
public static function FileSize (string $filename,
|
||||
array $errorLocalization = self::FILE_SIZE_ERROR_MESSAGES): ActionState
|
||||
{
|
||||
// Очищаем кэш
|
||||
clearstatcache();
|
||||
|
||||
// Создаём результат
|
||||
$result = new ActionState(-1);
|
||||
|
||||
// Проверяем, существует ли файл
|
||||
if (!file_exists($filename)) {
|
||||
// - если нет, то добавляем ошибку
|
||||
$result->AddError($errorLocalization['file_not_exist']);
|
||||
// - и возвращаем результат
|
||||
return $result;
|
||||
}
|
||||
|
||||
// Проверяем, является ли $filename файлом
|
||||
if (!is_file($filename)) {
|
||||
// - если нет, то добавляем ошибку
|
||||
$result->AddError($errorLocalization['not_a_file']);
|
||||
// - и возвращаем результат
|
||||
return $result;
|
||||
}
|
||||
|
||||
// Получаем размер файла
|
||||
$size = filesize($filename);
|
||||
|
||||
// Проверяем, получилось ли получить размер файла
|
||||
if ($size === false) {
|
||||
// - если нет, то добавляем ошибку
|
||||
$result->AddError($errorLocalization['cannot_get_size']);
|
||||
// - и возвращаем результат
|
||||
return $result;
|
||||
}
|
||||
|
||||
// Устанавливаем значение результата
|
||||
$result->Value = $size;
|
||||
|
||||
// Возвращаем результат
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Преобразует размер файла в байтах в красивое строковое представление.
|
||||
*
|
||||
* @param int $fileSize Размер файла в байтах.
|
||||
* @param array $fileSizeUnits Локализованные единицы измерения размера файла (по умолчанию, см.
|
||||
* {@link FILE_SIZE_UNITS}).
|
||||
* @param string $decimalSeparator Разделитель десятичной части (по умолчанию, запятая).
|
||||
*
|
||||
* @return string Размер файла в красивом строковом представлении. Например, если размер файла составляет 1500
|
||||
* байт, вывод будет «1.46 КБ».
|
||||
*/
|
||||
public static function FileSizeToString (int $fileSize, array $fileSizeUnits = self::FILE_SIZE_UNITS,
|
||||
string $decimalSeparator = ','): string
|
||||
{
|
||||
/**
|
||||
* Вычисление степени для преобразования: берём минимум из 4 и результата округления до ближайшего целого числа
|
||||
* в меньшую сторону логарифма размера файла в байтах по основанию 1024 (это показывает, сколько раз нужно
|
||||
* разделить размер файла на 1024, чтобы получить значение в более крупных единицах измерения). Ограничение в 4
|
||||
* необходимо для того, чтобы соответствовать единице измерения ТБ (терабайт).
|
||||
*/
|
||||
$power = min(4, floor(log($fileSize, 1024)));
|
||||
|
||||
/**
|
||||
* Преобразование размера файла: размер файла делим на 1024 в степени, равной степени $power,
|
||||
* затем округляем полученное до 2 цифр после запятой.
|
||||
*/
|
||||
$size = number_format(round($fileSize / pow(1024, $power), 2), 2, $decimalSeparator);
|
||||
|
||||
// Возвращаем преобразованное значение вместе с единицей измерения
|
||||
return "$size $fileSizeUnits[$power]";
|
||||
}
|
||||
}
|
710
sources/classes/JsonReWriter.md
Normal file
710
sources/classes/JsonReWriter.md
Normal file
@ -0,0 +1,710 @@
|
||||
# Описание класса JsonReWriter
|
||||
|
||||
## Информация о версии
|
||||
|
||||
Версия класса: 1.0
|
||||
|
||||
Впервые введено в пакет с версии: 1.1.0
|
||||
|
||||
Описание класса: Класс для работы с JSON-файлами.
|
||||
|
||||
## Публичные свойства и константы класса
|
||||
|
||||
В классе определены следующие свойства:
|
||||
|
||||
- `string $JsonString` - строка JSON (чтение/запись).
|
||||
|
||||
## Быстрый старт
|
||||
|
||||
### Правила формирования ключей.
|
||||
|
||||
Ключ для чтения/записи данных класса формируется следующим образом: `ключ/подключ/подключ подключа` .
|
||||
|
||||
Например, если дан json-файл:
|
||||
|
||||
{
|
||||
"test": {
|
||||
"subtest": {
|
||||
"AAA": "123",
|
||||
"BBB": 1.23
|
||||
}
|
||||
},
|
||||
"test1": {
|
||||
"test": 123
|
||||
},
|
||||
"test2": {
|
||||
"test": true
|
||||
},
|
||||
"test3": {
|
||||
"test": {
|
||||
"res": "[1,2,3]"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Пусть требуется получить значение `BBB`, тогда ключ должен быть `test/subtest/BBB`.
|
||||
|
||||
### Чтение.
|
||||
|
||||
1. Создайте элемент класса `$json = new JsonReWriter ();`
|
||||
2. Если у вас требуется загрузить json из файла `$fileName`, то воспользуйтесь методом `LoadFromFile`:
|
||||
`$json->LoadFromFile($fileName);`, если же json представлен строкой `$jsonStr`, то загрузите её в свойство
|
||||
`$JsonString`: `$json->JsonString = $jsonStr;`
|
||||
3. Далее можно пользоваться любым методом для чтения `Read*`, в том числе и общим `$json->Read(...)`.
|
||||
|
||||
**Пример:**
|
||||
|
||||
// Имя файла
|
||||
$fileName = __DIR__ . "/test.json";
|
||||
// Создаю класс
|
||||
$json = new JsonReWriter();
|
||||
// Загшружаю данные из файла
|
||||
$json->LoadFromFile($fileName);
|
||||
// Получаю число
|
||||
$float = $json->ReadFloat("test/subtest/BBB", 0.2);
|
||||
|
||||
В итоге в `$float` будет `1.23`.
|
||||
|
||||
### Запись.
|
||||
|
||||
1. Создайте элемент класса `$json = new JsonReWriter ();`
|
||||
2. Далее можно пользоваться любым методом для записи `Write*`, в том числе и общим `$json->Write(...)`.
|
||||
3. Если вам требуется создать json файл с именем `$fileName`, то воспользуйтесь методом `SaveToFile`:
|
||||
`$json->SaveToFile($fileName);`, если же json должен быть представлен строкой `$jsonStr`, то загрузите её из свойства
|
||||
`$JsonString`: `$jsonStr = $json->JsonString;`
|
||||
|
||||
**Пример:**
|
||||
|
||||
// Имя файла
|
||||
$fileName = __DIR__ . "/test.json";
|
||||
// Создаю класс
|
||||
$json = new JsonReWriter();
|
||||
// Загшружаю данные из файла
|
||||
$json->LoadFromFile($fileName);
|
||||
// Получаю число
|
||||
try {
|
||||
$json->Write("test/subtest/BBB", 0.2);
|
||||
}
|
||||
catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
|
||||
В итоге в `test/subtest/BBB` вместо `1.23` будет `0.2`.
|
||||
|
||||
## Коды ошибок JsonErrorCode
|
||||
|
||||
Ниже представлена таблица основных кодов ошибки:
|
||||
|
||||
| Ошибка | Описание | Введено с версии |
|
||||
|:-------------------:|:---------------------------------------------------------------------------:|:----------------:|
|
||||
| Unknown | Неизвестная ошибка | 1.0 |
|
||||
| None | Ошибок нет | 1.0 |
|
||||
| Depth | Достигнута максимальная глубина стека | 1.0 |
|
||||
| StateMismatch | Неверный или некорректный JSON | 1.0 |
|
||||
| CTRLChar | Ошибка управляющего символа, возможно, неверная кодировка | 1.0 |
|
||||
| Syntax | Синтаксическая ошибка | 1.0 |
|
||||
| UTF8 | Некорректные для кодировки UTF-8 символы, возможно, неверная кодировка | 1.0 |
|
||||
| Recursion | Одна или несколько зацикленных ссылок в кодируемом значении | 1.0 |
|
||||
| InfOrNan | Одно или несколько значений NAN или INF в кодируемом значении | 1.0 |
|
||||
| UnsupportedType | Передали значение с неподдерживаемым типом | 1.0 |
|
||||
| InvalidPropertyName | Имя свойства не может быть закодировано | 1.0 |
|
||||
| UTF16 | Некорректный для кодировки UTF-16 символ, возможно, некорректно закодирован | 1.0 |
|
||||
| KeyIsNotArray | Ключ не содержит вложений, хотя от него требуется обратное | 1.0 |
|
||||
| NotISerializable | Класс не реализует интерфейс ISerializable | 1.0 |
|
||||
|
||||
### Методы и функции перечисления JsonErrorCode
|
||||
|
||||
Перечисление содержит **статический метод** `static function FromLastError (): JsonErrorCode`, который получает код
|
||||
ошибки из последней JSON ошибки.
|
||||
|
||||
Например, при успешной загрузке, можем проверить ошибки:
|
||||
|
||||
$errors = JsonErrorCode::FromLastError ();
|
||||
|
||||
После того, как мы выведем `$errors`, мы получим `JsonErrorCode::None`.
|
||||
|
||||
## Исключение JsonException
|
||||
|
||||
Исключение расширяет класс `Exception`, поэтому может выбрасываться через `throw`.
|
||||
|
||||
### Свойства
|
||||
|
||||
Исключение содержит следующие свойства:
|
||||
|
||||
- `?string $JsonString` - строка JSON (или null);
|
||||
- `JsonErrorCode $ErrorCode` - код ошибки JSON;
|
||||
- `?string $ErrorMessage` - сообщение об ошибке JSON (в отличие от функции json_last_error_msg(), данная переменная при
|
||||
отсутствии ошибок выводит null, а не "No error").
|
||||
|
||||
### Методы и функции
|
||||
|
||||
#### Конструктор.
|
||||
|
||||
Конструктор принимает **3 необязательных параметра**:
|
||||
|
||||
* `?string $json` - строка JSON (по умолчанию, `null`);
|
||||
* `JsonErrorCode $errorCode` - код ошибки (по умолчанию, `JsonErrorCode::Unknown`);
|
||||
* `?string $errorMessage` - сообщение об ошибке (по умолчанию, `null`).
|
||||
|
||||
В результате создаётся новое исключение `JsonException`.
|
||||
|
||||
Пример:
|
||||
|
||||
throw new JsonException("{}", JsonErrorCode::Depth, "Пример");
|
||||
|
||||
Создаст исключение `JsonException`.
|
||||
|
||||
## Методы и функции
|
||||
|
||||
### Конструктор и деструктор.
|
||||
|
||||
Конструктор не принимает никаких параметров.
|
||||
|
||||
В результате создаётся новый класс `JsonReWriter`.
|
||||
|
||||
**Пример:**
|
||||
|
||||
// Контсуктор
|
||||
$json = new JsonReWriter ();
|
||||
// Деструктор
|
||||
unset($json);
|
||||
|
||||
Создаст и уничтожит класс `JsonReWriter`.
|
||||
|
||||
### Сохранение и загрузка из файла.
|
||||
|
||||
За сохранение и загрузку отвечают 2 метода: `SaveToFile` и `LoadFromFile`.
|
||||
|
||||
#### Сохранение в файл (метод `SaveToFile`)
|
||||
|
||||
Этот метод сохраняет содержимое JSON в файл. Он содержит **1 обязательный параметр**:
|
||||
|
||||
* `string $fileName` - имя файла на диске.
|
||||
|
||||
Метод возвращает `bool` - сохранены ли данные в файл: `true` - да, `false` - нет.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function SaveToFile (string $fileName): bool
|
||||
|
||||
**Пример:**
|
||||
|
||||
// Имя файла
|
||||
$fileName = __DIR__ . "/test.json";
|
||||
// Создаём класс
|
||||
$json = new JsonReWriter();
|
||||
// Заполним данными
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
$json->Write("test/subtest/BBB", 1.23);
|
||||
$json->Write("test1/test", 123);
|
||||
$json->Write("test2/test", true);
|
||||
$json->WriteArray("test3/test/res", [1, 2, 3]);
|
||||
} catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
// Сохраняем созданный JSON файл
|
||||
$json->SaveToFile($fileName);
|
||||
|
||||
Содержимое файла `test.json` представлено далее:
|
||||
|
||||
{
|
||||
"test": {
|
||||
"subtest": {
|
||||
"AAA": "123",
|
||||
"BBB": 1.23
|
||||
}
|
||||
},
|
||||
"test1": {
|
||||
"test": 123
|
||||
},
|
||||
"test2": {
|
||||
"test": true
|
||||
},
|
||||
"test3": {
|
||||
"test": {
|
||||
"res": "[1,2,3]"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#### Загрузка файла (метод `LoadFromFile`)
|
||||
|
||||
Этот метод загружает содержимое файла в класс. Он содержит **1 обязательный параметр**:
|
||||
|
||||
* `string $fileName` - имя файла на диске.
|
||||
|
||||
Метод возвращает `bool` - загружены ли данные из файла: `true` - да, `false` - нет.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function LoadFromFile (string $fileName): bool
|
||||
|
||||
**Пример:**
|
||||
Пусть дан файл `test.json`, содержимое которого представлено далее:
|
||||
|
||||
{
|
||||
"test": {
|
||||
"subtest": {
|
||||
"AAA": "123",
|
||||
"BBB": 1.23
|
||||
}
|
||||
},
|
||||
"test1": {
|
||||
"test": 123
|
||||
},
|
||||
"test2": {
|
||||
"test": true
|
||||
},
|
||||
"test3": {
|
||||
"test": {
|
||||
"res": "[1,2,3]"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Следующий код загрузит это содержимое в класс:
|
||||
|
||||
// Имя файла
|
||||
$fileName = __DIR__ . "/test.json";
|
||||
// Создаём класс
|
||||
$json = new JsonReWriter();
|
||||
// Загружаю данные
|
||||
$json->LoadFromFile($fileName);
|
||||
|
||||
### Чтение данных
|
||||
|
||||
Для чтения данных используется один общий метод `Read` и 7 его производных метода: `ReadString`, `ReadInt`, `ReadFloat`,
|
||||
`ReadBool`, `ReadArray`, `ReadObject` и `ReadSerializable`.
|
||||
|
||||
#### Метод `Read`
|
||||
|
||||
Это метод, который читает значение ключа JSON. Он имеет **1 обязательный параметр** `string $key` (ключ) и **1
|
||||
необязательный параметр** `mixed $default` (значение по умолчанию, задан по умолчанию в `null`).
|
||||
|
||||
Этот метод возвращает `mixed`: значение ключа JSON или значение по умолчанию.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function Read (string $key, mixed $default = null): mixed
|
||||
|
||||
**Пример,**
|
||||
|
||||
// Создаю класс
|
||||
$json = new JsonReWriter();
|
||||
// Заполняю данными
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
$json->Write("test/subtest/BBB", 1.23);
|
||||
$json->Write("test1/test", 123);
|
||||
$json->Write("test2/test", true);
|
||||
$json->Write("test3/test/res", json_encode([1, 2, 3]));
|
||||
} catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
|
||||
// Получаю значение
|
||||
$float = (float)$json->Read("test/subtest/BBB"));
|
||||
|
||||
В результате, переменная `$float` будет иметь значение `1.23`.
|
||||
|
||||
#### Метод `ReadString`
|
||||
|
||||
Это метод, который читает значение ключа JSON. Он имеет **1 обязательный параметр** `string $key` (ключ) и **1
|
||||
необязательный параметр** `string $default` (значение по умолчанию, задан по умолчанию в `""`).
|
||||
|
||||
Этот метод возвращает `string`: значение ключа JSON или значение по умолчанию.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function ReadString (string $key, string $default = ""): string
|
||||
|
||||
#### Метод `ReadInt`
|
||||
|
||||
Это метод, который читает значение ключа JSON. Он имеет **1 обязательный параметр** `string $key` (ключ) и **1
|
||||
необязательный параметр** `int $default` (значение по умолчанию, задан по умолчанию в `0`).
|
||||
|
||||
Этот метод возвращает `int`: значение ключа JSON или значение по умолчанию.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function ReadInt (string $key, int $default = 0): int
|
||||
|
||||
#### Метод `ReadFloat`
|
||||
|
||||
Это метод, который читает значение ключа JSON. Он имеет **1 обязательный параметр** `string $key` (ключ) и **1
|
||||
необязательный параметр** `float $default` (значение по умолчанию, задан по умолчанию в `0.0`).
|
||||
|
||||
Этот метод возвращает `float`: значение ключа JSON или значение по умолчанию.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function ReadFloat (string $key, float $default = 0.0): float
|
||||
|
||||
#### Метод `ReadBool`
|
||||
|
||||
Это метод, который читает значение ключа JSON. Он имеет **1 обязательный параметр** `string $key` (ключ) и **1
|
||||
необязательный параметр** `bool $default` (значение по умолчанию, задан по умолчанию в `false`).
|
||||
|
||||
Этот метод возвращает `bool`: значение ключа JSON или значение по умолчанию.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function ReadBool (string $key, bool $default = false): bool
|
||||
|
||||
#### Метод `ReadArray`
|
||||
|
||||
Это метод, который читает значение ключа JSON. Он имеет **1 обязательный параметр** `string $key` (ключ) и **1
|
||||
необязательный параметр** `array $default` (значение по умолчанию, задан по умолчанию в `[]`).
|
||||
|
||||
Этот метод возвращает `array`: значение ключа JSON или значение по умолчанию.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function ReadArray (string $key, array $default = []): array
|
||||
|
||||
#### Метод `ReadObject`
|
||||
|
||||
Это метод, который читает значение ключа JSON. Он имеет **2 обязательных параметра**:
|
||||
|
||||
- `string $key` (ключ);
|
||||
- `object $default` (значение по умолчанию).
|
||||
|
||||
Этот метод возвращает `object`: значение ключа JSON или значение по умолчанию.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function ReadObject (string $key, object $default): object
|
||||
|
||||
#### Метод `ReadSerializable`
|
||||
|
||||
Это метод, который читает значение ключа JSON. Он имеет **2 обязательных параметра**:
|
||||
|
||||
- `string $key` (ключ);
|
||||
- `string $serializableClassName` (имя класса, реализующего интерфейс ISerializable, с namespace).
|
||||
|
||||
Этот метод возвращает класс, реализующий интерфейс `ISerializable`.
|
||||
|
||||
**Важно!** Этот метод может выбросить исключение `JsonException`, если класс, заданный в `$serializableClassName` не
|
||||
реализует интерфейс `ISerializable`.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function ReadSerializable (string $key, string $serializableClassName): ISerializable
|
||||
|
||||
**Пример,**
|
||||
|
||||
Пусть для примера, класс `Demo` из namespace `iam\namespace` реализует интерфейс `ISerializable`.
|
||||
|
||||
// Создаю класс
|
||||
$json = new JsonReWriter();
|
||||
// ... Здесь где-то загрузка данных
|
||||
// Получаю класс
|
||||
try {
|
||||
/**
|
||||
* @var Demo $unSerializableClass
|
||||
*/
|
||||
$unSerializableClass = $json->ReadSerializable("test", "iam\\namespace\\Demo");
|
||||
} catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
|
||||
В результате, переменная `$unSerializableClass` будет содержать данные класса `Demo`.
|
||||
|
||||
### Запись данных
|
||||
|
||||
Для чтения данных используется один общий метод `Write` и 3 его производных метода: `WriteArray`, `WriteObject` и
|
||||
`WriteSerializable`.
|
||||
|
||||
**Важно!** Лобой из вышеуказанных методов может выбросить исключение `JsonException`, если ключ не содержит вложений,
|
||||
хотя от него требуется обратное.
|
||||
|
||||
#### Метод `Write`
|
||||
|
||||
Это метод, который записывает значение в ключ JSON. Он имеет **2 обязательных параметра**:
|
||||
|
||||
- `string $key` (ключ);
|
||||
- `mixed $value` (записываемое значение).
|
||||
|
||||
Этот метод ничего не возвращает.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function Write (string $key, mixed $value): void
|
||||
|
||||
**Пример,**
|
||||
|
||||
// Имя файла
|
||||
$fileName = __DIR__ . "/test.json";
|
||||
// Создаём класс
|
||||
$json = new JsonReWriter();
|
||||
// Заполним данными
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
$json->Write("test/subtest/BBB", 1.23);
|
||||
$json->Write("test1/test", 123);
|
||||
$json->Write("test2/test", true);
|
||||
$json->WriteArray("test3/test/res", [1, 2, 3]);
|
||||
} catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
// Сохраняем созданный JSON файл
|
||||
$json->SaveToFile($fileName);
|
||||
|
||||
Содержимое файла `test.json` представлено далее:
|
||||
|
||||
{
|
||||
"test": {
|
||||
"subtest": {
|
||||
"AAA": "123",
|
||||
"BBB": 1.23
|
||||
}
|
||||
},
|
||||
"test1": {
|
||||
"test": 123
|
||||
},
|
||||
"test2": {
|
||||
"test": true
|
||||
},
|
||||
"test3": {
|
||||
"test": {
|
||||
"res": "[1,2,3]"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#### Метод `WriteArray`
|
||||
|
||||
Это метод, который записывает значение в ключ JSON. Он имеет **2 обязательных параметра**:
|
||||
|
||||
- `string $key` (ключ);
|
||||
- `array $array` (записываемое значение).
|
||||
|
||||
Этот метод ничего не возвращает.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function WriteArray (string $key, array $array): void
|
||||
|
||||
#### Метод `WriteObject`
|
||||
|
||||
Это метод, который записывает значение в ключ JSON. Он имеет **2 обязательных параметра**:
|
||||
|
||||
- `string $key` (ключ);
|
||||
- `object $value` (записываемое значение).
|
||||
|
||||
Этот метод ничего не возвращает.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function WriteObject (string $key, object $value): void
|
||||
|
||||
#### Метод `WriteSerializable`
|
||||
|
||||
Это метод, который записывает значение в ключ JSON. Он имеет **2 обязательных параметра**:
|
||||
|
||||
- `string $key` (ключ);
|
||||
- `ISerializable $serializableValue` (записываемое значение).
|
||||
|
||||
Этот метод ничего не возвращает.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function WriteSerializable (string $key, ISerializable $serializableValue): void
|
||||
|
||||
**Пример,**
|
||||
Пусть для примера, класс `Demo` из namespace `iam\namespace` реализует интерфейс `ISerializable`.
|
||||
|
||||
// Имя файла
|
||||
$fileName = __DIR__ . "/test.json";
|
||||
// Создаём класс
|
||||
$json = new JsonReWriter();
|
||||
// Создаём класс Demo
|
||||
$serializableClass = new Demo(...);
|
||||
// Заполним данными
|
||||
try {
|
||||
$json->WriteSerializable("test", $serializableClass);
|
||||
} catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
...
|
||||
|
||||
### Работа с ключами JSON
|
||||
|
||||
Для работы с ключами JSON есть 2 метода: `IsKeyExists` и `GetKeys`.
|
||||
|
||||
#### Метод `IsKeyExists`
|
||||
|
||||
Это метод проверяем наличие ключа в JSON. Он имеет **1 обязательный параметр** - `string $key` (ключ).
|
||||
|
||||
Этот метод возвращает `bool`: `true` если ключ найден и `false` в противном случае.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function IsKeyExists (string $key): bool
|
||||
|
||||
**Пример,**
|
||||
|
||||
// Создаём класс
|
||||
$json = new JsonReWriter();
|
||||
// Заполним данными
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
$json->Write("test/subtest/BBB", 1.23);
|
||||
$json->Write("test1/test", 123);
|
||||
$json->Write("test2/test", true);
|
||||
$json->WriteArray("test3/test/res", [1, 2, 3]);
|
||||
} catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
// Проверяем ключи
|
||||
$check1 = $json->IsKeyExists("test/subtest/AAA");
|
||||
$check2 = $json->IsKeyExists("test/subtest/ССС");
|
||||
|
||||
В результате, `$check1` будет `true`, а `$check2` - `false`.
|
||||
|
||||
#### Метод `GetKeys`
|
||||
|
||||
Это метод получает список ключей. Он имеет **2 необязательных параметра**:
|
||||
|
||||
- `string $parentKey` (ключ родителя (или "" (установлено по умолчанию) для всех);
|
||||
- `bool $includeChildren` (нужно ли включать дочерние ключи (по умолчанию, да)).
|
||||
|
||||
Этот метод возвращает `array`: список ключей.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function GetKeys (string $parentKey = "", bool $includeChildren = true): array
|
||||
|
||||
**Пример,**
|
||||
|
||||
// Создаём класс
|
||||
$json = new JsonReWriter();
|
||||
// Заполним данными
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
$json->Write("test/subtest/BBB", 1.23);
|
||||
$json->Write("test1/test", 123);
|
||||
$json->Write("test2/test", true);
|
||||
$json->WriteArray("test3/test/res", [1, 2, 3]);
|
||||
} catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
// Получаем ключи
|
||||
$keys1 = $json->GetKeys("test");
|
||||
$keys2 = $json->GetKeys("test", false);
|
||||
$keys3 = $json->GetKeys();
|
||||
|
||||
В результате, `$key1` будет следующим массивом:
|
||||
|
||||
[
|
||||
"test/subtest",
|
||||
"test/subtest/AAA",
|
||||
"test/subtest/BBB"
|
||||
]
|
||||
|
||||
`$key2` будет следующим массивом:
|
||||
|
||||
[
|
||||
"subtest"
|
||||
]
|
||||
|
||||
`$key3` будет следующим массивом:
|
||||
|
||||
[
|
||||
"test",
|
||||
"test/subtest",
|
||||
"test/subtest/AAA",
|
||||
"test/subtest/BBB",
|
||||
"test1",
|
||||
"test1/test",
|
||||
"test2",
|
||||
"test2/test",
|
||||
"test3",
|
||||
"test3/test",
|
||||
"test3/test/res"
|
||||
]
|
||||
|
||||
### Удаление ключей JSON
|
||||
|
||||
Для удаления ключей JSON есть 2 метода: `DeleteKey`, который удаляет только определённый ключ и `Clear`, который удаляет
|
||||
**все ключи** из json-файла.
|
||||
|
||||
#### Метод `DeleteKey`
|
||||
|
||||
Это метод удаляет только определённый ключ в JSON. Он имеет **1 обязательный параметр** - `string $key` (ключ).
|
||||
|
||||
Этот метод возвращает `bool` - результат удаления ключа: `true` - удаление прошло успешно, `false` - произошла ошибка
|
||||
при удалении.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function DeleteKey (string $key): bool
|
||||
|
||||
**Пример,**
|
||||
|
||||
// Создаём класс
|
||||
$json = new JsonReWriter();
|
||||
// Заполним данными
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
$json->Write("test/subtest/BBB", 1.23);
|
||||
$json->Write("test1/test", 123);
|
||||
$json->Write("test2/test", true);
|
||||
$json->WriteArray("test3/test/res", [1, 2, 3]);
|
||||
} catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
// Получаемем ключи до удаления
|
||||
$check1 = $json->GetKeys("test/subtest");
|
||||
// Удаляем ключ
|
||||
$this->DeleteKey("test/subtest/BBB");
|
||||
// Получаемем ключи после удаления
|
||||
$check2 = $json->GetKeys("test/subtest");
|
||||
|
||||
В результате, `$check1` будет
|
||||
|
||||
[
|
||||
"test/subtest",
|
||||
"test/subtest/AAA",
|
||||
"test/subtest/BBB"
|
||||
]
|
||||
|
||||
а `$check2`:
|
||||
|
||||
[
|
||||
"test/subtest",
|
||||
"test/subtest/AAA"
|
||||
]
|
||||
|
||||
#### Метод `Clear`
|
||||
|
||||
Это метод удаляет **все ключи** из json-файла. Он не имеет никаких параметров и ничего не возвращает.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function Clear (): void
|
||||
|
||||
**Пример,**
|
||||
|
||||
// Создаём класс
|
||||
$json = new JsonReWriter();
|
||||
// Заполним данными
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
$json->Write("test/subtest/BBB", 1.23);
|
||||
$json->Write("test1/test", 123);
|
||||
$json->Write("test2/test", true);
|
||||
$json->WriteArray("test3/test/res", [1, 2, 3]);
|
||||
} catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
// Очищаем
|
||||
$json->Clear();
|
||||
// Получаем ключи
|
||||
$keys = $json->GetKeys();
|
||||
|
||||
В результате, `$key` будет следующим массивом:
|
||||
|
||||
[
|
||||
]
|
90
sources/classes/JsonReWriter.php
Normal file
90
sources/classes/JsonReWriter.php
Normal file
@ -0,0 +1,90 @@
|
||||
<?php
|
||||
|
||||
namespace goodboyalex\php_components_pack\classes;
|
||||
|
||||
use goodboyalex\php_components_pack\enums\JsonErrorCode;
|
||||
use goodboyalex\php_components_pack\exceptions\JsonException;
|
||||
use goodboyalex\php_components_pack\traits\JsonReWriter\JsonReWriterDeleteTrait;
|
||||
use goodboyalex\php_components_pack\traits\JsonReWriter\JsonReWriterKeyTrait;
|
||||
use goodboyalex\php_components_pack\traits\JsonReWriter\JsonReWriterLoadSaveTrait;
|
||||
use goodboyalex\php_components_pack\traits\JsonReWriter\JsonReWriterReadTrait;
|
||||
use goodboyalex\php_components_pack\traits\JsonReWriter\JsonReWriterWriteTrait;
|
||||
|
||||
/**
|
||||
* Класс для работы с JSON-файлами.
|
||||
*
|
||||
* @author Александр Бабаев
|
||||
* @package php_components_pack
|
||||
* @version 1.0
|
||||
* @since 1.1.0
|
||||
*/
|
||||
final class JsonReWriter
|
||||
{
|
||||
/**
|
||||
* @var string $JsonString Строка JSON.
|
||||
*/
|
||||
public string $JsonString {
|
||||
get {
|
||||
// Проверка на пустоту
|
||||
if (count($this->JsonData) === 0)
|
||||
// - если массив пуст, возвращаем пустой JSON
|
||||
return '{}';
|
||||
|
||||
// Преобразую данные в JSON
|
||||
$json = json_encode($this->JsonData, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE);
|
||||
|
||||
// Проверка на ошибки
|
||||
if (json_last_error() !== JSON_ERROR_NONE)
|
||||
// - если есть ошибки, выбрасываем исключение
|
||||
throw new JsonException(null, JsonErrorCode::FromLastError(), json_last_error_msg());
|
||||
|
||||
// Возвращаем JSON
|
||||
return $json;
|
||||
}
|
||||
set {
|
||||
// Чтение содержимого файла и преобразование JSON в объект
|
||||
$this->JsonData = json_decode($value, true);
|
||||
|
||||
// Проверка на ошибки
|
||||
if ($this->JsonData === null && json_last_error() !== JSON_ERROR_NONE)
|
||||
// - если есть ошибки, выбрасываем исключение
|
||||
throw new JsonException($value, JsonErrorCode::FromLastError(), json_last_error_msg());
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @var array $JsonData Массив данных.
|
||||
*/
|
||||
private array $JsonData;
|
||||
|
||||
/**
|
||||
* Конструктор класса.
|
||||
*/
|
||||
public function __construct ()
|
||||
{
|
||||
$this->JsonData = [];
|
||||
}
|
||||
|
||||
/**
|
||||
* Деструктор класса.
|
||||
*/
|
||||
public function __destruct ()
|
||||
{
|
||||
unset($this->JsonData);
|
||||
}
|
||||
|
||||
// Подключаем методы чтения JSON
|
||||
use JsonReWriterReadTrait;
|
||||
|
||||
// Подключаем методы записи JSON
|
||||
use JsonReWriterWriteTrait;
|
||||
|
||||
// Подключаем методы сохранения и загрузки JSON
|
||||
use JsonReWriterLoadSaveTrait;
|
||||
|
||||
// Подключаем методы работы с ключами
|
||||
use JsonReWriterKeyTrait;
|
||||
|
||||
// Подключаем методы удаления данных из JSON
|
||||
use JsonReWriterDeleteTrait;
|
||||
}
|
@ -5,10 +5,11 @@ namespace goodboyalex\php_components_pack\classes;
|
||||
use ArrayAccess;
|
||||
use Countable;
|
||||
use goodboyalex\php_components_pack\interfaces\ISerializable;
|
||||
use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArrayBasicTrait;
|
||||
use goodboyalex\php_components_pack\traits\ArrayBasicTrait;
|
||||
use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArrayConstantsTrait;
|
||||
use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArrayLINQTrait;
|
||||
use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArraySearchAndSortTrait;
|
||||
use goodboyalex\php_components_pack\traits\ObjectArray\ObjectArraySpecialTrait;
|
||||
use IteratorAggregate;
|
||||
|
||||
/**
|
||||
@ -16,7 +17,7 @@ use IteratorAggregate;
|
||||
*
|
||||
* @author Александр Бабаев
|
||||
* @package php_components_pack
|
||||
* @version 1.0
|
||||
* @version 1.0.5
|
||||
* @since 1.0
|
||||
*/
|
||||
final class ObjectArray implements ArrayAccess, IteratorAggregate, Countable, ISerializable
|
||||
@ -27,7 +28,7 @@ final class ObjectArray implements ArrayAccess, IteratorAggregate, Countable, IS
|
||||
private array $Container;
|
||||
|
||||
// Реализация наследуемых интерфейсов и классов
|
||||
use ObjectArrayBasicTrait;
|
||||
use ArrayBasicTrait;
|
||||
|
||||
// Константы
|
||||
use ObjectArrayConstantsTrait;
|
||||
@ -38,6 +39,9 @@ final class ObjectArray implements ArrayAccess, IteratorAggregate, Countable, IS
|
||||
// LINQ-подобные методы
|
||||
use ObjectArrayLINQTrait;
|
||||
|
||||
// Специальные методы
|
||||
use ObjectArraySpecialTrait;
|
||||
|
||||
/**
|
||||
* Конструктор класса.
|
||||
*
|
||||
@ -47,40 +51,4 @@ final class ObjectArray implements ArrayAccess, IteratorAggregate, Countable, IS
|
||||
{
|
||||
$this->Container = $array;
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает массив объектов, хранящихся в данном классе.
|
||||
*
|
||||
* @return array Массив объектов, хранящихся в данном классе.
|
||||
*/
|
||||
public function ToArray (): array
|
||||
{
|
||||
return $this->Container;
|
||||
}
|
||||
|
||||
/**
|
||||
* Очищает массив объектов, хранящийся в данном классе.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function Clear (): void
|
||||
{
|
||||
// Очищаем массив
|
||||
unset($this->Container);
|
||||
|
||||
// Создаем новый массив
|
||||
$this->Container = [];
|
||||
}
|
||||
|
||||
/**
|
||||
* Объединяет массив объектов, хранящийся в данном классе, с массивом объектов, переданным в качестве параметра.
|
||||
*
|
||||
* @param array $objects Массив объектов, который будет объединен с массивом объектов, хранящимся в данном классе.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function Merge (array $objects): void
|
||||
{
|
||||
$this->Container = array_merge($this->Container, $objects);
|
||||
}
|
||||
}
|
121
sources/classes/Tuple.php
Normal file
121
sources/classes/Tuple.php
Normal file
@ -0,0 +1,121 @@
|
||||
<?php
|
||||
|
||||
namespace goodboyalex\php_components_pack\classes;
|
||||
|
||||
use ArrayAccess;
|
||||
use ArrayIterator;
|
||||
use Countable;
|
||||
use Exception;
|
||||
use goodboyalex\php_components_pack\interfaces\ISerializable;
|
||||
use IteratorAggregate;
|
||||
use Traversable;
|
||||
|
||||
/**
|
||||
* Класс, реализующий функционал кортежей от C#.
|
||||
*
|
||||
* @author Александр Бабаев
|
||||
* @package php_components_pack
|
||||
* @version 1.2
|
||||
* @since 1.0.20
|
||||
*/
|
||||
final class Tuple implements ISerializable, ArrayAccess, IteratorAggregate, Countable
|
||||
{
|
||||
/**
|
||||
* @var array Массив значений кортежа.
|
||||
*/
|
||||
private array $Values;
|
||||
|
||||
/**
|
||||
* Конструктор кортежа.
|
||||
*
|
||||
* @param mixed ...$values Значения кортежа.
|
||||
*/
|
||||
public function __construct (...$values)
|
||||
{
|
||||
$this->Values = $values;
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function Serialize (): string
|
||||
{
|
||||
return serialize($this->Values);
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function UnSerialize (string $serialized): void
|
||||
{
|
||||
$this->Values = unserialize($serialized);
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function offsetExists (mixed $offset): bool
|
||||
{
|
||||
return isset($this->Values[$offset]);
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function offsetGet (mixed $offset): mixed
|
||||
{
|
||||
// Если ключ не является целым числом
|
||||
if (!is_int($offset))
|
||||
// - возвращаем null
|
||||
return null;
|
||||
|
||||
// Возвращаем значение кортежа по индексу
|
||||
return $this->Get($offset);
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает значение кортежа по индексу.
|
||||
*
|
||||
* @param int $index Индекс значения.
|
||||
*
|
||||
* @return mixed Значение кортежа по индексу.
|
||||
*/
|
||||
public function Get (int $index): mixed
|
||||
{
|
||||
return $this->Values[$index] ?? null;
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
* @throws Exception Элементы кортежа не могут быть изменены после создания! / Tuple elements cannot be changed
|
||||
* after creation!
|
||||
*/
|
||||
public function offsetSet (mixed $offset, mixed $value): void
|
||||
{
|
||||
throw new Exception('Элементы кортежа не могут быть изменены после создания! / Tuple elements cannot be changed after creation!');
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function offsetUnset (mixed $offset): void
|
||||
{
|
||||
unset($this->Values[$offset]);
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function getIterator (): Traversable
|
||||
{
|
||||
return new ArrayIterator($this->Values);
|
||||
}
|
||||
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
public function count (): int
|
||||
{
|
||||
return count($this->Values);
|
||||
}
|
||||
}
|
419
sources/classes/VersionInfo.md
Normal file
419
sources/classes/VersionInfo.md
Normal file
@ -0,0 +1,419 @@
|
||||
# Описание класса VersionInfo
|
||||
|
||||
## Информация о версии
|
||||
|
||||
Версия класса: 1.2
|
||||
|
||||
Впервые введено в пакет с версии: 1.0.24
|
||||
Последнее обновление в версии: 1.0.27
|
||||
|
||||
Описание класса: Класс, описывающий информацию о версии.
|
||||
|
||||
## Публичные свойства и константы класса
|
||||
|
||||
В классе определены следующие константы:
|
||||
|
||||
* `array StagesNames` - имена стадий сборки.
|
||||
* `string DefaultTemplate` - шаблон вывода по умолчанию.
|
||||
|
||||
В классе определены следующе свойства:
|
||||
|
||||
* `int $Major` - мажорная версия (**только чтение**).
|
||||
* `int $Minor` - минорная версия (**только чтение**).
|
||||
* `int $Release` - номер релиза (**только чтение**).
|
||||
* `int $Build` - номер сборки (**только чтение**).
|
||||
* `VersionInfoStage $Stage` - стадия сборки (**только чтение**).
|
||||
* `int $StageNumber` - номер стадии сборки (**только чтение**).
|
||||
|
||||
## Методы и функции
|
||||
|
||||
### Конструктор.
|
||||
|
||||
Конструктор принимает **4 обязательных** и **2 дополнительных параметра**:
|
||||
|
||||
* `int $Major` - мажорная версия (**обязательный**);
|
||||
* `int $Minor` - минорная версия (**обязательный**);
|
||||
* `int $Release` - номер релиза (**обязательный**);
|
||||
* `int $Build` - номер сборки (**обязательный**);
|
||||
* `VersionInfoStage` $Stage - стадия сборки (по умолчанию, `VersionInfoStage::Undefined`);
|
||||
* `int $StageNumber` - номер стадии сборки (по умолчанию, `0`).
|
||||
|
||||
В результате создаётся новый класс `VersionInfo`.
|
||||
|
||||
Пример:
|
||||
|
||||
$version = new VersionInfo (1, 0, 0, 0, VersionInfoStage::Beta, 1);
|
||||
|
||||
Создаст класс `VersionInfo` для версии `1.0.0.0 Beta 1`.
|
||||
|
||||
### Преобразование в строку.
|
||||
|
||||
За преобразование в строку отвечает 2 метода: `ToString` и `__toString ()`.
|
||||
|
||||
#### Метод `ToString`
|
||||
|
||||
Этот метод возвращает строковое представление версии. Он содержит **2 необязательных параметра**:
|
||||
|
||||
* `string $template` - шаблон вывода (по умолчанию, `DefaultTemplate`);
|
||||
* `array $stagesNames` - имена стадий сборки (по умолчанию, `StagesNames`).
|
||||
|
||||
Метод возвращает `string` - строковое представление версии.
|
||||
|
||||
В шаблоне должны присутствовать маркеры:
|
||||
|
||||
| Маркер | Описание | Обязательный |
|
||||
|:--------------:|:--------------------|:------------:|
|
||||
| #{Major} | Мажорная версия | ДА |
|
||||
| #{Minor} | Минорная версия | ДА |
|
||||
| #{Release} | Номер релиза | ДА |
|
||||
| #{Build} | Номер сборки | ДА |
|
||||
| #{Stage} | Стадия сборки | НЕТ |
|
||||
| #{StageNumber} | Номер стадии сборки | НЕТ |
|
||||
|
||||
Эти маркеры в шаблоне заменяются на значения соответствующих свойств.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function ToString (string $template, array $stagesNames): string
|
||||
|
||||
Пример,
|
||||
|
||||
// Создаю объект
|
||||
$version = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
|
||||
|
||||
// Задаю шаблон
|
||||
$template = #{Major}.#{Minor}.#{Release} (сборка #{Build});
|
||||
|
||||
// Вывожу
|
||||
echo $version->ToString($template);
|
||||
|
||||
В результате на экране появится:
|
||||
|
||||
1.2.3 (сборка 4)
|
||||
|
||||
#### Метод `__toString`
|
||||
|
||||
Этот метод полностью аналогичен методу `ToString` с той лишь разницей, что в этом методе невозможно задать параметры
|
||||
вывода (такие, как шаблон и имена стадий). Эти параметры берутся по умолчанию.
|
||||
|
||||
Этот метод необходим для вывода корректной информации при попытке привести объект класса `VersionInfo` к типу `string`.
|
||||
|
||||
Метод возвращает `string` - строковое представление версии.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function __toString (): string
|
||||
|
||||
Пример,
|
||||
|
||||
// Создаю объект
|
||||
$version = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
|
||||
|
||||
// Вывожу
|
||||
echo $version;
|
||||
|
||||
В результате на экране появится:
|
||||
|
||||
1.2.3.4 Beta 5
|
||||
|
||||
### Сравнение версий
|
||||
|
||||
Для сравнения версий используется две аналогичные друг другу (но различающиеся по способу вызова) функции: `Compare` и
|
||||
`CompareWith`.
|
||||
|
||||
#### Метод `Compare`
|
||||
|
||||
Это статический метод, который сравнивает две версии, заданные в **2 обязательных параметрах**:
|
||||
|
||||
* `VersionInfo $version1` - версия 1;
|
||||
* `VersionInfo $version2` - версия 2.
|
||||
|
||||
Этот метод возвращает `int`:
|
||||
|
||||
| version1 | version2 | Результат |
|
||||
|:---------:|:---------:|:---------:|
|
||||
| Младше | Старше | -1 |
|
||||
| Совпадает | Совпадает | 0 |
|
||||
| Старше | Младше | 1 |
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public static function Compare (VersionInfo $version1, VersionInfo $version2): int
|
||||
|
||||
Пример,
|
||||
|
||||
// Создаю объекты
|
||||
// - $version11 младше $version12
|
||||
$version11 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
|
||||
$version12 = new VersionInfo (1, 2, 3, 5, VersionInfoStage::Beta, 6);
|
||||
|
||||
// $version21 совпадает с $version22
|
||||
$version21 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
|
||||
$version22 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
|
||||
|
||||
// $version31 старше $version32
|
||||
$version31 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Stable);
|
||||
$version32 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
|
||||
|
||||
// Сравниваю
|
||||
$verCompare1 = VersionInfo::Compare($version11, $version12);
|
||||
$verCompare2 = VersionInfo::Compare($version21, $version22);
|
||||
$verCompare3 = VersionInfo::Compare($version31, $version32);
|
||||
|
||||
// Вывожу
|
||||
echo $verCompare1 . '|' . $verCompare2 . '|' . $verCompare3;
|
||||
|
||||
В результате на экране появится:
|
||||
|
||||
-1|0|1
|
||||
|
||||
#### Метод `CompareWith`
|
||||
|
||||
Этот метод полностью аналогичен методу `Compare`. Он отличается лишь только тем, что **не статичен** и вызывается из
|
||||
ранее созданного экземпляра класса. Он сравнивает текущую версию с переданной. Этот метод имеет только **1 обязательный
|
||||
параметр**: `VersionInfo $version` - переданная версия.
|
||||
|
||||
Этот метод возвращает `int`: `1`, если текущая версия старше переданной, `0`, если совпадает и `-1`, если текущая версия
|
||||
младше переданной.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function CompareWith (VersionInfo $version): int
|
||||
|
||||
Пример,
|
||||
|
||||
// Создаю объекты
|
||||
// - $version11 младше $version12
|
||||
$version11 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
|
||||
$version12 = new VersionInfo (1, 2, 3, 5, VersionInfoStage::Beta, 6);
|
||||
|
||||
// $version21 совпадает с $version22
|
||||
$version21 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
|
||||
$version22 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
|
||||
|
||||
// $version31 старше $version32
|
||||
$version31 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Stable);
|
||||
$version32 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
|
||||
|
||||
// Сравниваю
|
||||
$verCompare1 = $version11->CompareWith($version12);
|
||||
$verCompare2 = $version21->CompareWith($version22);
|
||||
$verCompare3 = $version31->CompareWith($version32);
|
||||
|
||||
// Вывожу
|
||||
echo $verCompare1 . '|' . $verCompare2 . '|' . $verCompare3;
|
||||
|
||||
В результате на экране появится:
|
||||
|
||||
-1|0|1
|
||||
|
||||
#### Метод `CompareWithRange`
|
||||
|
||||
Введено в версии `1.0.27`.
|
||||
|
||||
Это метод, который проверяет, находится ли текущая версия в заданном диапазоне, указанном в **2 необязательных
|
||||
параметрах**:
|
||||
|
||||
* `VersionInfo (или null) $left` - левая граница, по умолчанию, `null`;
|
||||
* `VersionInfo (или null) $right` - правая граница, по умолчанию, `null`.
|
||||
|
||||
В случае, если будет передан `null` вместо левой границы, то метод создаст класс `VersionInfo` с минимально возможной
|
||||
версией `0.0.0.0 PreAlpha 0`, а вместо правой - `VersionInfo` с максимально возможной версией
|
||||
`9223372036854775807.9223372036854775807.9223372036854775807.9223372036854775807 Stable` (здесь `9223372036854775807` -
|
||||
максимальное число INT по умолчанию - у вас может быть другое).
|
||||
|
||||
Границы могут совпадать, тогда поведение будет совпадать с методом `CompareWith` (при условии, что границы включены).
|
||||
Кроме того, работает защита "от дурака" и если границы перепутаны, то метод автоматически поменяет их местами.
|
||||
|
||||
**3-й необязательный параметр** отвечает за параметры сравнения. Это `ObjectArray` из перечисления
|
||||
`VersionCompareRangeOption`, который может содержать следующие настройки:
|
||||
|
||||
| Настройка | Описание | Включена по умолчанию |
|
||||
|:-------------------:|:-------------------------------------:|:---------------------:|
|
||||
| LeftBorderIncluded | Включена ли левая граница в диапазон | ДА |
|
||||
| RightBorderIncluded | Включена ли правая граница в диапазон | ДА |
|
||||
|
||||
Этот метод возвращает `int`:
|
||||
|
||||
| Текущая версия | Результат |
|
||||
|:---------------------------------:|:---------:|
|
||||
| Младше диапазона | -1 |
|
||||
| Внутри диапазона (или на границе) | 0 |
|
||||
| Старше диапазона | 1 |
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function CompareWithRange (?VersionInfo $left = null, ?VersionInfo $right = null, ?ObjectArray $options = null): int
|
||||
|
||||
Пример,
|
||||
|
||||
// Создаю объекты
|
||||
// - 1.2.3.4 Beta 1
|
||||
$versionInfo1 = new VersionInfo(1, 2, 3, 4, VersionInfoStage::Beta, 1);
|
||||
|
||||
// - 1.1.3.4 Alpha 2
|
||||
$versionInfo2 = new VersionInfo(1, 1, 3, 4, VersionInfoStage::Alpha, 2);
|
||||
|
||||
// - 1.1.1.1 Alpha 2
|
||||
$versionInfo3 = new VersionInfo(1, 1, 1, 1, VersionInfoStage::Alpha, 2);
|
||||
|
||||
// - 5.5.5.5 Stable
|
||||
$versionInfo4 = new VersionInfo(5, 5, 5, 5, VersionInfoStage::Stable);
|
||||
|
||||
// Сравниваю
|
||||
echo "Для начала простое сравнение: ";
|
||||
$ver1d1 = $versionInfo1->CompareWithRange($versionInfo3, $versionInfo4);
|
||||
$ver1d2 = $versionInfo2->CompareWithRange($versionInfo1, $versionInfo4);
|
||||
$ver1d2 = $versionInfo4->CompareWithRange($versionInfo2, $versionInfo1);
|
||||
echo "$ver1d1|$ver1d2|$ver1d3 \r\n"
|
||||
|
||||
echo "Немного перепутаем границы =) ";
|
||||
$ver2d1 = $versionInfo4->CompareWithRange($versionInfo1, $versionInfo2);
|
||||
echo "И получим: $ver2d1\r\n";
|
||||
|
||||
echo "А теперь с границами!\r\n";
|
||||
echo "- значение равно левой границе: ";
|
||||
$ver3d1 = $versionInfo2->CompareWithRange($versionInfo2, $versionInfo1);
|
||||
echo " $ver3d1\r\n";
|
||||
echo "- значение равно правой границе: ";
|
||||
$ver3d2 = $versionInfo1->CompareWithRange($versionInfo2, $versionInfo1);
|
||||
echo " $ver3d2\r\n";
|
||||
echo "- а теперь с выключением границ:\r\n";
|
||||
echo "-- для левой: ";
|
||||
$ver3d3 = $versionInfo2->CompareWithRange($versionInfo2, $versionInfo1, $optionNotBorder);
|
||||
echo " $ver3d3\r\n";
|
||||
echo "-- для правой: ";
|
||||
$ver3d4 = $versionInfo1->CompareWithRange($versionInfo2, $versionInfo1, $optionNotBorder);
|
||||
echo " $ver3d4\r\n";
|
||||
echo "А что если границы равны и значение равно?\r\n";
|
||||
echo "- для включённых границ: ";
|
||||
$ver4d1 = $versionInfo1->CompareWithRange($versionInfo1, $versionInfo1);
|
||||
echo " $ver4d1\r\n";
|
||||
echo "- для выключённых границ: ";
|
||||
$ver4d2 = $versionInfo1->CompareWithRange($versionInfo1, $versionInfo1, $optionNotBorder);
|
||||
echo " $ver4d2";
|
||||
|
||||
В результате на экране появится:
|
||||
|
||||
Для начала простое сравнение: 0|-1|1
|
||||
Немного перепутаем границы =) И получим: 1
|
||||
А теперь с границами!
|
||||
- значение равно левой границе: 0
|
||||
- значение равно правой границе: 0
|
||||
- а теперь с выключением границ:
|
||||
-- для левой: -1
|
||||
-- для правой: 1
|
||||
А что если границы равны и значение равно?
|
||||
- для включённых границ: 0
|
||||
- для выключённых границ: -1
|
||||
|
||||
### Парсинг версий
|
||||
|
||||
Для преобразования строки с версией в объект `VersionInfo` используется статичный метод `Parse`.
|
||||
|
||||
Он требует **1 обязательный параметр** и **1 необязательный**:
|
||||
|
||||
* `string $version` - строка с версией (она должна быть в формате
|
||||
`#{Major}.#{Minor}.#{Release}.#{Build} #{Stage} #{StageNumber}`, причём `#{Stage}` и `#{StageNumber}` можно не
|
||||
указывать);
|
||||
* `array $stagesNames` - имена стадий сборки (по умолчанию, `StagesNames`).
|
||||
|
||||
Этот метод возвращает объект {@link VersionInfo} с данными о версии или `new VersionInfo(0, 0, 0, 0)` в случае ошибки.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public static function Parse (string $version, array $stagesNames = self::StagesNames): VersionInfo
|
||||
|
||||
Пример,
|
||||
|
||||
// Создаю текст
|
||||
$verText = '1.2.3.4 Beta 2';
|
||||
|
||||
// Преобразую
|
||||
$version = VersionInfo::Parse($verText);
|
||||
|
||||
// Вывожу
|
||||
echo $version;
|
||||
|
||||
В результате на экране появится:
|
||||
|
||||
1.2.3.4 Beta 2
|
||||
|
||||
### Вспомогательные методы
|
||||
|
||||
#### Метод `IsNotUndefinedOrStable`
|
||||
|
||||
Этот **статический** метод проверяет, является ли версия в неопределённой стадии или уже релизом.
|
||||
|
||||
Он имеет только **1 обязательный параметр**: `VersionInfoStage $versionStage` - стадия сборки.
|
||||
|
||||
Этот метод возвращает `bool`: `true`, если стадия сборки определена и не является релизом и `false` в противном случае.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public static function IsNotUndefinedOrStable (VersionInfoStage $versionStage): bool
|
||||
|
||||
Пример,
|
||||
|
||||
// Создаю объекты
|
||||
$version1 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Undefined, 5);
|
||||
$version2 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Beta, 5);
|
||||
$version3 = new VersionInfo (1, 2, 3, 4, VersionInfoStage::Stable);
|
||||
|
||||
// Сравниваю
|
||||
$res1 = VersionInfo::IsNotUndefinedOrStabl($version1->Stage);
|
||||
$res2 = VersionInfo::IsNotUndefinedOrStabl($version2->Stage);
|
||||
$res3 = VersionInfo::IsNotUndefinedOrStabl($version3->Stage);
|
||||
|
||||
// Вывожу
|
||||
echo $res1 . '|' . $res2 . '|' . $res3;
|
||||
|
||||
В результате на экране появится:
|
||||
|
||||
false|true|false
|
||||
|
||||
#### Метод `MinVersion`
|
||||
|
||||
Введено в версии `1.0.28`.
|
||||
|
||||
Этот **статический** метод **без параметров** возвращает минимальную версию (объект класса `VersionInfo`).
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public static function MinVersion (): VersionInfo
|
||||
|
||||
Пример,
|
||||
|
||||
// Создаю объекты
|
||||
$version = VersionInfo::MinVersion();
|
||||
|
||||
// Вывожу
|
||||
echo $version;
|
||||
|
||||
В результате на экране появится:
|
||||
|
||||
0.0.0.0 PreAlpha 0
|
||||
|
||||
#### Метод `MaxVersion`
|
||||
|
||||
Введено в версии `1.0.28`.
|
||||
|
||||
Этот **статический** метод **без параметров** возвращает максимальную версию (объект класса `VersionInfo`).
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public static function MaxVersion (): VersionInfo
|
||||
|
||||
Пример,
|
||||
|
||||
// Создаю объекты
|
||||
$version = VersionInfo::MaxVersion();
|
||||
|
||||
// В этом примере считается, что константа PHP_INT_MAX равна 9223372036854775807
|
||||
|
||||
// Вывожу
|
||||
echo $version;
|
||||
|
||||
В результате на экране появится:
|
||||
|
||||
9223372036854775807.9223372036854775807.9223372036854775807.9223372036854775807
|
391
sources/classes/VersionInfo.php
Normal file
391
sources/classes/VersionInfo.php
Normal file
@ -0,0 +1,391 @@
|
||||
<?php
|
||||
|
||||
namespace goodboyalex\php_components_pack\classes;
|
||||
|
||||
use goodboyalex\php_components_pack\enums\VersionCompareRangeOption;
|
||||
use goodboyalex\php_components_pack\enums\VersionInfoStage;
|
||||
use goodboyalex\php_components_pack\extensions\StringExtension;
|
||||
|
||||
/**
|
||||
* Класс, описывающий информацию о версии.
|
||||
*
|
||||
* @author Александр Бабаев
|
||||
* @package php_components_pack
|
||||
* @version 1.2
|
||||
* @since 1.0.24
|
||||
*/
|
||||
final class VersionInfo
|
||||
{
|
||||
/**
|
||||
* @var array $StagesNames Имена стадий сборки.
|
||||
*/
|
||||
public const array StagesNames = [
|
||||
VersionInfoStage::PreAlpha->value => 'PreAlpha',
|
||||
VersionInfoStage::Alpha->value => 'Alpha',
|
||||
VersionInfoStage::Beta->value => 'Beta',
|
||||
VersionInfoStage::ReleaseCandidate->value => 'rc',
|
||||
VersionInfoStage::Stable->value => 'Stable'
|
||||
];
|
||||
|
||||
/**
|
||||
* @var string $DefaultTemplate Шаблон вывода по умолчанию.
|
||||
*/
|
||||
public const string DefaultTemplate = '#{Major}.#{Minor}.#{Release}.#{Build} #{Stage} #{StageNumber}';
|
||||
|
||||
/**
|
||||
* @var int $Major Мажорная версия.
|
||||
*/
|
||||
private(set) int $Major = 0;
|
||||
|
||||
/**
|
||||
* @var int $Minor Минорная версия.
|
||||
*/
|
||||
private(set) int $Minor = 0;
|
||||
|
||||
/**
|
||||
* @var int $Release Номер релиза.
|
||||
*/
|
||||
private(set) int $Release = 0;
|
||||
|
||||
/**
|
||||
* @var int $Build Номер сборки.
|
||||
*/
|
||||
private(set) int $Build = 0;
|
||||
|
||||
/**
|
||||
* @var VersionInfoStage $Stage Стадия сборки.
|
||||
*/
|
||||
private(set) VersionInfoStage $Stage = VersionInfoStage::Undefined;
|
||||
|
||||
/**
|
||||
* @var int $StageNumber Номер стадии сборки.
|
||||
*/
|
||||
private(set) int $StageNumber = 0;
|
||||
|
||||
/**
|
||||
* Конструктор.
|
||||
*
|
||||
* @param int $Major Мажорная версия.
|
||||
* @param int $Minor Минорная версия.
|
||||
* @param int $Release Номер релиза.
|
||||
* @param int $Build Номер сборки.
|
||||
* @param VersionInfoStage $Stage Стадия сборки.
|
||||
* @param int $StageNumber Номер стадии сборки.
|
||||
*/
|
||||
public function __construct (int $Major, int $Minor, int $Release, int $Build,
|
||||
VersionInfoStage $Stage = VersionInfoStage::Undefined, int $StageNumber = 0)
|
||||
{
|
||||
$this->Major = $Major;
|
||||
$this->Minor = $Minor;
|
||||
$this->Release = $Release;
|
||||
$this->Build = $Build;
|
||||
$this->Stage = $Stage;
|
||||
$this->StageNumber = $StageNumber;
|
||||
}
|
||||
|
||||
/**
|
||||
* Сравнивает две версии.
|
||||
*
|
||||
* @param VersionInfo $version1 Версия 1.
|
||||
* @param VersionInfo $version2 Версия 2.
|
||||
*
|
||||
* @return int Возвращает 1, если версия 1 больше версии 2, 0, если равны, -1, если версия 1 меньше версии 2.
|
||||
*/
|
||||
public static function Compare (VersionInfo $version1, VersionInfo $version2): int
|
||||
{
|
||||
return $version1->CompareWith($version2);
|
||||
}
|
||||
|
||||
/**
|
||||
* Сравнивает текущую версию с переданной.
|
||||
*
|
||||
* @param VersionInfo $version Переданная версия.
|
||||
*
|
||||
* @return int Возвращает 1, если текущая версия больше переданной, 0, если равны, -1, если текущая версия меньше
|
||||
* переданной.
|
||||
*/
|
||||
public function CompareWith (VersionInfo $version): int
|
||||
{
|
||||
// Задаем шаблон вывода
|
||||
$toStringTemplate = '#{Major}.#{Minor}.#{Release}.#{Build}';
|
||||
|
||||
// Сначала сравним числа (мажорную, минорную версии, номер релиза и сборки):
|
||||
$compareResult = version_compare(
|
||||
$this->ToString($toStringTemplate),
|
||||
$version->ToString($toStringTemplate)
|
||||
);
|
||||
|
||||
// Если численные части совпадают, проверяем стадии сборки
|
||||
if ($compareResult === 0) {
|
||||
// - особый случай: стабильная версия всегда больше любых промежуточных стадий
|
||||
if ($this->Stage === VersionInfoStage::Stable && self::IsNotUndefinedOrStable($version->Stage))
|
||||
// - считаем нашу старшей
|
||||
return 1;
|
||||
|
||||
// - особый случай: если наша версия не stable, а другая stable
|
||||
if ($version->Stage === VersionInfoStage::Stable && self::IsNotUndefinedOrStable($this->Stage))
|
||||
// - считаем нашу младшей
|
||||
return -1;
|
||||
|
||||
// - преобразуем стадии в целые числа для прямого сравнения
|
||||
$currentStageValue = $this->Stage->ToInt();
|
||||
$otherStageValue = $version->Stage->ToInt();
|
||||
|
||||
// - если стадии отличаются
|
||||
if ($currentStageValue !== $otherStageValue)
|
||||
// - сравниваем их
|
||||
return $currentStageValue <=> $otherStageValue;
|
||||
|
||||
// - если стадии одинаковые
|
||||
if (self::IsNotUndefinedOrStable($this->Stage) && self::IsNotUndefinedOrStable($version->Stage)
|
||||
&& $this->StageNumber !== $version->StageNumber)
|
||||
return $this->StageNumber <=> $version->StageNumber;
|
||||
|
||||
// - если все совпадает, то вернём 0
|
||||
return 0;
|
||||
}
|
||||
|
||||
// Возврат результата сравнения
|
||||
return $compareResult;
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает строковое представление версии.
|
||||
*
|
||||
* @param string $template Шаблон вывода. В шаблоне маркеры #{Major}, #{Minor}, #{Release}, #{Build}, #{Stage} и
|
||||
* #{StageNumber} заменяются на значения соответствующих свойств. По умолчанию используется
|
||||
* {@link DefaultTemplate}.
|
||||
* @param array $stagesNames Имена стадий сборки (по умолчанию из константы {@link StagesNames}).
|
||||
*
|
||||
* @return string Строковое представление версии.
|
||||
*/
|
||||
public function ToString (string $template = self::DefaultTemplate, array $stagesNames = self::StagesNames): string
|
||||
{
|
||||
// Получаем строковое представление стадии сборки
|
||||
$stage = match ($this->Stage) {
|
||||
// - для неопределенной стадии сборки и релиза возвращаем пустую строку
|
||||
VersionInfoStage::Undefined, VersionInfoStage::Stable => '',
|
||||
|
||||
// - для остальных стадий сборки возвращаем строковое представление стадии сборки
|
||||
VersionInfoStage::PreAlpha => $stagesNames[VersionInfoStage::PreAlpha->value],
|
||||
VersionInfoStage::Alpha => $stagesNames[VersionInfoStage::Alpha->value],
|
||||
VersionInfoStage::Beta => $stagesNames[VersionInfoStage::Beta->value],
|
||||
VersionInfoStage::ReleaseCandidate => $stagesNames[VersionInfoStage::ReleaseCandidate->value]
|
||||
};
|
||||
|
||||
// Возвращаем строковое представление номера стадии сборки, если конечно стадия определена и она не релиз
|
||||
// и номер сборки должен быть задан (больше 0)
|
||||
$stageNum = self::IsNotUndefinedOrStable($this->Stage) && $this->StageNumber > 0
|
||||
? "$this->StageNumber" : '';
|
||||
|
||||
// Создаём массив для замены
|
||||
$replaceData = [
|
||||
'#{Major}' => "$this->Major",
|
||||
'#{Minor}' => "$this->Minor",
|
||||
'#{Release}' => "$this->Release",
|
||||
'#{Build}' => "$this->Build",
|
||||
'#{Stage}' => $stage,
|
||||
'#{StageNumber}' => $stageNum
|
||||
];
|
||||
|
||||
// Заменяем все в шаблоне
|
||||
$result = StringExtension::ReplaceAll($replaceData, $template);
|
||||
|
||||
// Возвращаем результат, удаляя лишние пробелы в конце
|
||||
return rtrim($result, ' ');
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверяет, является ли версия неопределённой или релизом.
|
||||
*
|
||||
* @param VersionInfoStage $versionStage Стадия сборки.
|
||||
*
|
||||
* @return bool Возвращает true, если стадия сборки определена и не является релизом.
|
||||
*/
|
||||
public static function IsNotUndefinedOrStable (VersionInfoStage $versionStage): bool
|
||||
{
|
||||
return $versionStage !== VersionInfoStage::Undefined && $versionStage !== VersionInfoStage::Stable;
|
||||
}
|
||||
|
||||
/**
|
||||
* Преобразует строку с версией в объект {@link VersionInfo}.
|
||||
*
|
||||
* @param string $version Строка с версией (она должна быть в формате {@link DefaultTemplate}).
|
||||
* @param array $stagesNames Имена стадий сборки (по умолчанию из константы {@link StagesNames}).
|
||||
*
|
||||
* @return VersionInfo Возвращает объект {@link VersionInfo} с данными о версии.
|
||||
*/
|
||||
public static function Parse (string $version, array $stagesNames = self::StagesNames): VersionInfo
|
||||
{
|
||||
// Убираем пробелы в начале и конце строки
|
||||
$version = trim($version);
|
||||
|
||||
// Разбиваем строку на части по пробелам (1 часть - основная - мажор, минор, релиз, сборка,
|
||||
// 2 часть - стадия и 3 - номер стадии)
|
||||
$versionParts = explode(' ', $version);
|
||||
|
||||
// Проверяем, что строка содержит хотя бы 1 часть
|
||||
if (count($versionParts) < 1)
|
||||
// - если нет, то возвращаем пустую версию
|
||||
return new VersionInfo(0, 0, 0, 0);
|
||||
|
||||
// Составим регулярное выражение для парсинга базовой информации о версии
|
||||
$pattern = '/^(\d+)\.(\d+)\.(\d+)\.(\d+)/';
|
||||
|
||||
// Парсим базовую информацию о версии
|
||||
if (!preg_match($pattern, $versionParts[0], $matches))
|
||||
// - если не удалось, то возвращаем пустую версию
|
||||
return new VersionInfo(0, 0, 0, 0);
|
||||
|
||||
// Проверяем, что найдены все 4 части
|
||||
if (!$matches || count($matches) < 5)
|
||||
// - если нет, то возвращаем пустую версию
|
||||
return new VersionInfo(0, 0, 0, 0);
|
||||
|
||||
// Получаем значения
|
||||
[, $major, $minor, $release, $build] = $matches;
|
||||
|
||||
// Парсим обязательные цифры
|
||||
// - мажорная версия
|
||||
$major = intval($major);
|
||||
// - минорная версия
|
||||
$minor = intval($minor);
|
||||
// - номер релиза
|
||||
$release = intval($release);
|
||||
// - номер сборки
|
||||
$build = intval($build);
|
||||
|
||||
// Если частей версии больше 1
|
||||
if (count($versionParts) > 1) {
|
||||
// - получаем массив для перевода строковых имен стадий в числа
|
||||
$stageEnumMap = array_flip($stagesNames);
|
||||
|
||||
// - получаем стадию
|
||||
$stage = VersionInfoStage::FromInt(intval($stageEnumMap[$versionParts[1]] ?? 0));
|
||||
|
||||
// - если стадия определена и не релиз, и кроме того, есть номер стадии
|
||||
if (self::IsNotUndefinedOrStable($stage) && count($versionParts) > 2)
|
||||
// -- получаем номер стадии
|
||||
$stageNumber = intval($versionParts[2]);
|
||||
else
|
||||
// -- иначе, устанавливаем номер стадии 0
|
||||
$stageNumber = 0;
|
||||
}
|
||||
else {
|
||||
// - иначе, устанавливаем стадию неопределённой
|
||||
$stage = VersionInfoStage::Undefined;
|
||||
// - и номер стадии 0
|
||||
$stageNumber = 0;
|
||||
}
|
||||
|
||||
// Создание объекта VersionInfo
|
||||
return new VersionInfo($major, $minor, $release, $build, $stage, $stageNumber);
|
||||
}
|
||||
|
||||
/**
|
||||
* Выводит строковое представление версии (упрощённая версия ToString() с шаблоном по умолчанию, необходимая для
|
||||
* вывода при попытке привести объект к типу string).
|
||||
*
|
||||
* @return string Строковое представление версии.
|
||||
*/
|
||||
public function __toString (): string
|
||||
{
|
||||
// Получаем строковое представление версии и возвращаем его
|
||||
return $this->ToString();
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверяет, находится ли текущая версия в заданном диапазоне.
|
||||
*
|
||||
* @param VersionInfo|null $left Левая граница диапазона или null, если граница не задана (будет использована
|
||||
* минимальная версия).
|
||||
* @param VersionInfo|null $right Правая граница диапазона или null, если граница не задана (будет использована
|
||||
* максимальная версия).
|
||||
* @param ObjectArray|null $options Опции проверки (по умолчанию массив, который разрешает включать границы).
|
||||
*
|
||||
* @return int Возвращает 1, если текущая версия старше интервала, 0, если находится в интервале, -1, если текущая
|
||||
* версия младше интервала.
|
||||
*
|
||||
* @version 1.1
|
||||
* @since 1.0.27
|
||||
*/
|
||||
public function CompareWithRange (?VersionInfo $left = null, ?VersionInfo $right = null,
|
||||
?ObjectArray $options = null): int
|
||||
{
|
||||
// Подготавливаем опции, если они не переданы
|
||||
$options ??= new ObjectArray([
|
||||
VersionCompareRangeOption::LeftBorderIncluded,
|
||||
VersionCompareRangeOption::RightBorderIncluded
|
||||
]);
|
||||
|
||||
// Устанавливаем левую границу
|
||||
$leftBorder = $left ?? self::MinVersion();
|
||||
|
||||
// Устанавливаем правую границу
|
||||
$rightBorder = $right ?? self::MaxVersion();
|
||||
|
||||
// Проверяем, что границы не перепутаны
|
||||
if ($leftBorder->CompareWith($rightBorder) == 0)
|
||||
// - если границы перепутаны, то меняем их местами
|
||||
[$leftBorder, $rightBorder] = [$rightBorder, $leftBorder];
|
||||
|
||||
// Проверяем текущую версию относительно границ
|
||||
$compareLeft = $this->CompareWith($leftBorder);
|
||||
$compareRight = $this->CompareWith($rightBorder);
|
||||
|
||||
// Проверяем, что границы включены
|
||||
// - левая
|
||||
$leftBorderIncluded = $options->IsExist(fn (VersionCompareRangeOption $option)
|
||||
=> $option === VersionCompareRangeOption::LeftBorderIncluded);
|
||||
// - правая
|
||||
$rightBorderIncluded = $options->IsExist(fn (VersionCompareRangeOption $option)
|
||||
=> $option === VersionCompareRangeOption::RightBorderIncluded);
|
||||
|
||||
// Проверяем включение границ
|
||||
$isInInterval =
|
||||
(
|
||||
($compareLeft >= 0 && $leftBorderIncluded)
|
||||
|| ($compareLeft > 0)
|
||||
)
|
||||
&& (
|
||||
($compareRight <= 0 && $rightBorderIncluded)
|
||||
|| ($compareRight < 0)
|
||||
);
|
||||
|
||||
// Итоговая обработка результатов
|
||||
if ($isInInterval)
|
||||
// - версия в пределах диапазона
|
||||
return 0;
|
||||
else // - версия не в пределах диапазона, и если она младше левой границы (или равна ей при не включении границы)
|
||||
if ($compareLeft <= 0)
|
||||
// -- то возвращаем -1
|
||||
return -1;
|
||||
else
|
||||
// -- в противном случае, версия старше правой границы (или равна ей при не включении границы)
|
||||
return 1;
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает минимальную версию.
|
||||
*
|
||||
* @return VersionInfo Минимальная версия.
|
||||
*
|
||||
* @since 1.0.28
|
||||
*/
|
||||
public static function MinVersion (): VersionInfo
|
||||
{
|
||||
return new VersionInfo(0, 0, 0, 0, VersionInfoStage::PreAlpha, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает максимальную версию.
|
||||
*
|
||||
* @return VersionInfo Максимальная версия.
|
||||
*
|
||||
* @since 1.0.28
|
||||
*/
|
||||
public static function MaxVersion (): VersionInfo
|
||||
{
|
||||
return new VersionInfo(PHP_INT_MAX, PHP_INT_MAX, PHP_INT_MAX, PHP_INT_MAX, VersionInfoStage::Stable);
|
||||
}
|
||||
}
|
108
sources/enums/JsonErrorCode.php
Normal file
108
sources/enums/JsonErrorCode.php
Normal file
@ -0,0 +1,108 @@
|
||||
<?php
|
||||
|
||||
namespace goodboyalex\php_components_pack\enums;
|
||||
|
||||
use goodboyalex\php_components_pack\traits\EnumExtensionsTrait;
|
||||
|
||||
/**
|
||||
* Перечисление известных ошибок при работе с JSON файлами.
|
||||
*
|
||||
* @author Александр Бабаев
|
||||
* @package php_components_pack
|
||||
* @version 1.0
|
||||
* @since 1.1.0
|
||||
*/
|
||||
enum JsonErrorCode: int
|
||||
{
|
||||
// Подключаю расширение для Enum
|
||||
use EnumExtensionsTrait;
|
||||
|
||||
/**
|
||||
* Неизвестная ошибка.
|
||||
*/
|
||||
case Unknown = -1;
|
||||
|
||||
/**
|
||||
* Ошибок нет.
|
||||
*/
|
||||
case None = 0;
|
||||
|
||||
/**
|
||||
* Достигнута максимальная глубина стека.
|
||||
*/
|
||||
case Depth = 1;
|
||||
|
||||
/**
|
||||
* Неверный или некорректный JSON.
|
||||
*/
|
||||
case StateMismatch = 2;
|
||||
|
||||
/**
|
||||
* Ошибка управляющего символа, возможно, неверная кодировка.
|
||||
*/
|
||||
case CTRLChar = 3;
|
||||
|
||||
/**
|
||||
* Синтаксическая ошибка.
|
||||
*/
|
||||
case Syntax = 4;
|
||||
|
||||
/**
|
||||
* Некорректные для кодировки UTF-8 символы, возможно, неверная кодировка.
|
||||
*/
|
||||
case UTF8 = 5;
|
||||
|
||||
/**
|
||||
* Одна или несколько зацикленных ссылок в кодируемом значении.
|
||||
*/
|
||||
case Recursion = 6;
|
||||
|
||||
/**
|
||||
* Одно или несколько значений NAN или INF в кодируемом значении.
|
||||
*/
|
||||
case InfOrNan = 7;
|
||||
|
||||
/**
|
||||
* Передали значение с неподдерживаемым типом.
|
||||
*/
|
||||
case UnsupportedType = 8;
|
||||
|
||||
/**
|
||||
* Имя свойства не может быть закодировано.
|
||||
*/
|
||||
case InvalidPropertyName = 9;
|
||||
|
||||
/**
|
||||
* Некорректный для кодировки UTF-16 символ, возможно, некорректно закодирован.
|
||||
*/
|
||||
case UTF16 = 10;
|
||||
|
||||
/**
|
||||
* Ключ не содержит вложений, хотя от него требуется обратное.
|
||||
*/
|
||||
case KeyIsNotArray = 11;
|
||||
|
||||
/**
|
||||
* Класс не реализует интерфейс ISerializable.
|
||||
*/
|
||||
case NotISerializable = 12;
|
||||
|
||||
/**
|
||||
* Получает код ошибки из последней JSON ошибки.
|
||||
*
|
||||
* @return JsonErrorCode Код ошибки.
|
||||
*/
|
||||
public static function FromLastError (): JsonErrorCode
|
||||
{
|
||||
// Получаю код ошибки
|
||||
$error = json_last_error();
|
||||
|
||||
// Проверяю, что код ошибки в диапазоне [0; 10]
|
||||
if ($error < 0 || $error > 10)
|
||||
// - верну неизвестную ошибку, если код не в диапазоне
|
||||
return self::Unknown;
|
||||
|
||||
// Перевожу код в Enum
|
||||
return self::FromInt($error);
|
||||
}
|
||||
}
|
34
sources/enums/VarNotBoolAction.php
Normal file
34
sources/enums/VarNotBoolAction.php
Normal file
@ -0,0 +1,34 @@
|
||||
<?php
|
||||
|
||||
namespace goodboyalex\php_components_pack\enums;
|
||||
|
||||
use goodboyalex\php_components_pack\traits\EnumExtensionsTrait;
|
||||
|
||||
/**
|
||||
* Перечисление типов действий, которые необходимо выполнить, если переменная не является булевым типом.
|
||||
*
|
||||
* @author Александр Бабаев
|
||||
* @package php_components_pack
|
||||
* @version 1.0
|
||||
* @since 1.0.19
|
||||
*/
|
||||
enum VarNotBoolAction: int
|
||||
{
|
||||
// Подключаю расширение для Enum
|
||||
use EnumExtensionsTrait;
|
||||
|
||||
/**
|
||||
* Игнорировать это утверждение.
|
||||
*/
|
||||
case Ignore = 0;
|
||||
|
||||
/**
|
||||
* Считать это утверждение истинным.
|
||||
*/
|
||||
case ConsiderItTrue = 1;
|
||||
|
||||
/**
|
||||
* Считать это утверждение ложным.
|
||||
*/
|
||||
case ConsiderItFalse = 2;
|
||||
}
|
29
sources/enums/VersionCompareRangeOption.php
Normal file
29
sources/enums/VersionCompareRangeOption.php
Normal file
@ -0,0 +1,29 @@
|
||||
<?php
|
||||
|
||||
namespace goodboyalex\php_components_pack\enums;
|
||||
|
||||
use goodboyalex\php_components_pack\traits\EnumExtensionsTrait;
|
||||
|
||||
/**
|
||||
* Перечисление параметров для сравнения версий на промежутке.
|
||||
*
|
||||
* @author Александр Бабаев
|
||||
* @package php_components_pack
|
||||
* @version 1.0
|
||||
* @since 1.0.27
|
||||
*/
|
||||
enum VersionCompareRangeOption: int
|
||||
{
|
||||
// Подключаю расширение для Enum
|
||||
use EnumExtensionsTrait;
|
||||
|
||||
/**
|
||||
* Левая граница включается в диапазон.
|
||||
*/
|
||||
case LeftBorderIncluded = 0;
|
||||
|
||||
/**
|
||||
* Правая граница включается в диапазон.
|
||||
*/
|
||||
case RightBorderIncluded = 1;
|
||||
}
|
49
sources/enums/VersionInfoStage.php
Normal file
49
sources/enums/VersionInfoStage.php
Normal file
@ -0,0 +1,49 @@
|
||||
<?php
|
||||
|
||||
namespace goodboyalex\php_components_pack\enums;
|
||||
|
||||
use goodboyalex\php_components_pack\traits\EnumExtensionsTrait;
|
||||
|
||||
/**
|
||||
* Перечисление стадий в информации о версии.
|
||||
*
|
||||
* @author Александр Бабаев
|
||||
* @package php_components_pack
|
||||
* @version 1.0
|
||||
* @since 1.0.24
|
||||
*/
|
||||
enum VersionInfoStage: int
|
||||
{
|
||||
// Подключаю расширение для Enum
|
||||
use EnumExtensionsTrait;
|
||||
|
||||
/**
|
||||
* Не определена или не задана стадия.
|
||||
*/
|
||||
case Undefined = 0;
|
||||
|
||||
/**
|
||||
* Пре-алфа.
|
||||
*/
|
||||
case PreAlpha = 1;
|
||||
|
||||
/**
|
||||
* Альфа.
|
||||
*/
|
||||
case Alpha = 2;
|
||||
|
||||
/**
|
||||
* Бета.
|
||||
*/
|
||||
case Beta = 3;
|
||||
|
||||
/**
|
||||
* Кандидат в релиз.
|
||||
*/
|
||||
case ReleaseCandidate = 4;
|
||||
|
||||
/**
|
||||
* Релиз.
|
||||
*/
|
||||
case Stable = 5;
|
||||
}
|
67
sources/exceptions/JsonException.php
Normal file
67
sources/exceptions/JsonException.php
Normal file
@ -0,0 +1,67 @@
|
||||
<?php
|
||||
|
||||
namespace goodboyalex\php_components_pack\exceptions;
|
||||
|
||||
use Exception;
|
||||
use goodboyalex\php_components_pack\enums\JsonErrorCode;
|
||||
|
||||
/**
|
||||
* Ошибка работы с JSON.
|
||||
*
|
||||
* @author Александр Бабаев
|
||||
* @package php_components_pack
|
||||
* @version 1.0
|
||||
* @since 1.1.0
|
||||
*/
|
||||
final class JsonException extends Exception
|
||||
{
|
||||
/**
|
||||
* @var string|null $JsonString Строка JSON.
|
||||
*/
|
||||
public ?string $JsonString;
|
||||
|
||||
/**
|
||||
* @var JsonErrorCode $ErrorCode Код ошибки JSON.
|
||||
*/
|
||||
public JsonErrorCode $ErrorCode;
|
||||
|
||||
/**
|
||||
* @link https://www.php.net/manual/ru/function.json-last-error-msg.php
|
||||
* @var string|null $ErrorMessage Сообщение об ошибке JSON.
|
||||
*
|
||||
* Внимание! В отличие от функции json_last_error_msg(), данная переменная при отсутствии ошибок выводит null, а не
|
||||
* "No error".
|
||||
*/
|
||||
public ?string $ErrorMessage;
|
||||
|
||||
/**
|
||||
* Конструктор.
|
||||
*
|
||||
* @param string|null $json Строка JSON.
|
||||
* @param JsonErrorCode $errorCode Код ошибки JSON.
|
||||
* @param string|null $errorMessage Сообщение об ошибке JSON.
|
||||
*/
|
||||
public function __construct (?string $json = null, JsonErrorCode $errorCode = JsonErrorCode::Unknown,
|
||||
?string $errorMessage = null)
|
||||
{
|
||||
// Если код ошибки JSON равен 0
|
||||
if ($errorMessage === "No error")
|
||||
// - то присваиваем ему null для совместимости
|
||||
$errorMessage = null;
|
||||
|
||||
// Сохраняем сообщение об ошибке
|
||||
$this->ErrorMessage = $errorMessage;
|
||||
|
||||
// Если сообщение пусто, то присваиваем ему "" для совместимости
|
||||
$errorMessage = $errorMessage ?? "";
|
||||
|
||||
// Запускаем базовый конструктор
|
||||
parent::__construct($errorMessage);
|
||||
|
||||
// Присваиваем имя файла
|
||||
$this->JsonString = $json;
|
||||
|
||||
// Присваиваем код ошибки
|
||||
$this->ErrorCode = $errorCode;
|
||||
}
|
||||
}
|
@ -2,14 +2,14 @@
|
||||
|
||||
namespace goodboyalex\php_components_pack\extensions;
|
||||
|
||||
use Exception;
|
||||
use goodboyalex\php_components_pack\enums\VarNotBoolAction;
|
||||
|
||||
/**
|
||||
* Расширение типа "правда/ложь".
|
||||
*
|
||||
* @author Александр Бабаев
|
||||
* @package php_components_pack
|
||||
* @version 1.0
|
||||
* @version 1.1
|
||||
* @since 1.0.7
|
||||
*/
|
||||
final class BoolExtensions
|
||||
@ -34,38 +34,55 @@ final class BoolExtensions
|
||||
* <code>true</code>.
|
||||
*
|
||||
* @param array $expressions Переменные формата правда/ложь.
|
||||
* @param VarNotBoolAction $ifNotBool Действие, если какой-то аргумент <code>expressions</code> не является булевым
|
||||
* типом. По умолчанию игнорировать.
|
||||
*
|
||||
* @return bool Есть ли хотя бы одно в значении true.
|
||||
*
|
||||
* @throws Exception Выбрасывается, если хотя бы один аргумент <code>expressions</code> не являются типом
|
||||
* правда/ложь.
|
||||
*/
|
||||
public static function AnyTrue (array $expressions): bool
|
||||
public static function AnyTrue (array $expressions, VarNotBoolAction $ifNotBool = VarNotBoolAction::Ignore): bool
|
||||
{
|
||||
return self::TrueCount($expressions) > 0;
|
||||
return self::TrueCount($expressions, $ifNotBool) > 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Вычисляет количество переменных формата правда/ложь <code>expressions</code> в значении <code>true</code>.
|
||||
*
|
||||
* @param array $expressions Переменные формата правда/ложь.
|
||||
* @param VarNotBoolAction $ifNotBool Действие, если какой-то аргумент <code>expressions</code> не является булевым
|
||||
* типом. По умолчанию игнорировать.
|
||||
*
|
||||
* @return int Количество переменных в значении true.
|
||||
*
|
||||
* @throws Exception Выбрасывается, если хотя бы один аргумент <code>expressions</code> не являются типом
|
||||
* правда/ложь.
|
||||
*/
|
||||
public static function TrueCount (array $expressions): int
|
||||
public static function TrueCount (array $expressions, VarNotBoolAction $ifNotBool = VarNotBoolAction::Ignore): int
|
||||
{
|
||||
// Проверяем все аргументы
|
||||
// Создаем пустой массив для хранения проверяемых аргументов
|
||||
$checkArray = [];
|
||||
|
||||
// Проверяем все входящие аргументы
|
||||
foreach ($expressions as $expression)
|
||||
// - если аргумент не является типом правда/ложь
|
||||
if (!is_bool($expression))
|
||||
// -- то выбрасываем исключение
|
||||
throw new Exception('All arguments must be bool. / Все аргументы должны быть типа «правда/ложь».');
|
||||
// -- то делаем следующее в зависимости от настроек:
|
||||
switch ($ifNotBool) {
|
||||
case VarNotBoolAction::Ignore:
|
||||
// --- игнорируем аргумент
|
||||
break;
|
||||
case VarNotBoolAction::ConsiderItTrue:
|
||||
// --- считаем аргумент как истинное значение
|
||||
$checkArray[] = true;
|
||||
break;
|
||||
case VarNotBoolAction::ConsiderItFalse:
|
||||
// --- считаем аргумент как ложное значение
|
||||
$checkArray[] = false;
|
||||
break;
|
||||
}
|
||||
else
|
||||
// - иначе добавляем аргумент в массив проверяемых аргументов
|
||||
$checkArray[] = $expression;
|
||||
|
||||
// Используем array_filter для фильтрации всех истинных значений
|
||||
$filtered = array_filter($expressions);
|
||||
$filtered = array_filter($checkArray, fn ($value) => $value === true);
|
||||
|
||||
// Возвращаем количество элементов в отфильтрованном массиве
|
||||
return count($filtered);
|
||||
|
@ -207,4 +207,63 @@ final class StringExtension
|
||||
// Возвращаю обрезанный текст
|
||||
return mb_substr($text, 0, $lengthWithoutEndDots) . $endDots;
|
||||
}
|
||||
|
||||
/**
|
||||
* Функция заменяет все вхождения строк поиск на соответствующие строки замены в заданной строке.
|
||||
*
|
||||
* @param array $searchReplace Массив с парами поиска и замены. Например, <code>['-' => '#', '$' => '%']</code>
|
||||
* заменит все дефисы на # и все доллары на %.
|
||||
* @param string $subject Строка, в которой нужно выполнить замену.
|
||||
* @param string $encoding (необязательный) Кодировка (по умолчанию, UTF-8).
|
||||
*
|
||||
* @return string Возвращает новую строку с выполненными заменами.
|
||||
*/
|
||||
public static function ReplaceAll (array $searchReplace, string $subject, string $encoding = 'UTF-8'): string
|
||||
{
|
||||
// Создаю результат
|
||||
$result = $subject;
|
||||
|
||||
// Для каждой пары поиска и замены
|
||||
foreach ($searchReplace as $search => $replace)
|
||||
// - заменяю все вхождения строки поиска на строку замены в заданной строке
|
||||
$result = self::Replace($search, $replace, $result, $encoding);
|
||||
|
||||
// Возвращаю результат
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Функция заменяет все вхождения строки поиска на строку замены в заданной строке (аналог mb_str_replace).
|
||||
*
|
||||
* @param string $search Строка, которую нужно найти и заменить.
|
||||
* @param string $replace Строка, на которую нужно заменить найденную строку.
|
||||
* @param string $subject Строка, в которой нужно выполнить замену.
|
||||
* @param string $encoding (необязательный) Кодировка (по умолчанию, UTF-8).
|
||||
*
|
||||
* @return string Возвращает новую строку с выполненной заменой.
|
||||
*/
|
||||
public static function Replace (string $search, string $replace, string $subject,
|
||||
string $encoding = 'UTF-8'): string
|
||||
{
|
||||
// Если кодировка не UTF-8
|
||||
if ($encoding != 'UTF-8') {
|
||||
// - то перекодируем строку поиска, замены и исходную строку в UTF-8
|
||||
$search = mb_convert_encoding($search, 'UTF-8', $encoding);
|
||||
// - и перекодируем строку замены в UTF-8
|
||||
$replace = mb_convert_encoding($replace, 'UTF-8', $encoding);
|
||||
// - и перекодируем исходную строку в UTF-8
|
||||
$subject = mb_convert_encoding($subject, 'UTF-8', $encoding);
|
||||
}
|
||||
|
||||
// С помощью регулярного выражения заменяем все вхождения строки поиска на строку замены
|
||||
$result = preg_replace('/' . preg_quote($search, '/') . '/u', $replace, $subject);
|
||||
|
||||
// Если кодировка не UTF-8
|
||||
if ($encoding != 'UTF-8')
|
||||
// - то перекодируем результат в исходную кодировку
|
||||
$result = mb_convert_encoding($result, $encoding, 'UTF-8');
|
||||
|
||||
// Возвращаем результат
|
||||
return $result;
|
||||
}
|
||||
}
|
21
sources/interfaces/IDuplicated.php
Normal file
21
sources/interfaces/IDuplicated.php
Normal file
@ -0,0 +1,21 @@
|
||||
<?php
|
||||
|
||||
namespace goodboyalex\php_components_pack\interfaces;
|
||||
|
||||
/**
|
||||
* Интерфейс реализации дублирования классов.
|
||||
*
|
||||
* @author Александр Бабаев
|
||||
* @package freecms
|
||||
* @version 0.1
|
||||
* @since 0.1
|
||||
*/
|
||||
interface IDuplicated
|
||||
{
|
||||
/**
|
||||
* Дублирование класса.
|
||||
*
|
||||
* @return object Класс-дублёр.
|
||||
*/
|
||||
public function Duplicate (): object;
|
||||
}
|
32
sources/interfaces/IStoredAtSQL.php
Normal file
32
sources/interfaces/IStoredAtSQL.php
Normal file
@ -0,0 +1,32 @@
|
||||
<?php
|
||||
|
||||
namespace goodboyalex\php_components_pack\interfaces;
|
||||
|
||||
/**
|
||||
* Интерфейс поддержки моделей и классов, реализующих хранение свойств в SQL базе данных.
|
||||
*
|
||||
* @author Александр Бабаев
|
||||
* @package freecms
|
||||
* @version 0.1
|
||||
* @since 0.1
|
||||
*/
|
||||
interface IStoredAtSQL
|
||||
{
|
||||
/**
|
||||
* Вывод параметров добавления/обновления данных в базу данных.
|
||||
*
|
||||
* @param bool $withId Нужно ли добавлять Id в массив
|
||||
*
|
||||
* @return array Массив параметров
|
||||
*/
|
||||
public function ToSQL (bool $withId = true): array;
|
||||
|
||||
/**
|
||||
* Преобразование данных из базы данных в модель, класс.
|
||||
*
|
||||
* @param array $sqlData Данные из базы данных
|
||||
*
|
||||
* @return self Класс модели с заполненными данными из базы данных
|
||||
*/
|
||||
public function FromSQL (array $sqlData): self;
|
||||
}
|
@ -2,11 +2,8 @@
|
||||
|
||||
namespace goodboyalex\php_components_pack\models;
|
||||
|
||||
use Exception;
|
||||
use goodboyalex\php_components_pack\classes\ClassMapper;
|
||||
use goodboyalex\php_components_pack\enums\MessageType;
|
||||
use goodboyalex\php_components_pack\interfaces\ISerializable;
|
||||
use UnitEnum;
|
||||
|
||||
/**
|
||||
* Класс сообщения состояния.
|
||||
@ -53,18 +50,13 @@ final class ActionStateMessageModel implements ISerializable
|
||||
public function UnSerialize (string $serialized): void
|
||||
{
|
||||
// Десериализую массив
|
||||
$thisNew = unserialize($serialized);
|
||||
$array = json_decode($serialized, true);
|
||||
|
||||
try {
|
||||
// Получаю класс
|
||||
$class = ClassMapper::MapToClassProperty(get_class($this), $thisNew);
|
||||
}
|
||||
catch (Exception) {
|
||||
$class = new ActionStateMessageModel();
|
||||
}
|
||||
|
||||
// Заполняю текущий класс
|
||||
ClassMapper::MapClass($class, $this);
|
||||
// Заполняю поля
|
||||
$this->MessageType =
|
||||
isset($array["MessageType"]) ? MessageType::FromName($array["MessageType"]) : MessageType::Info;
|
||||
$this->IsCritical = isset($array["IsCritical"]) && $array["IsCritical"] == 1;
|
||||
$this->Message = $array["Message"] ?? "";
|
||||
}
|
||||
|
||||
/**
|
||||
@ -75,34 +67,12 @@ final class ActionStateMessageModel implements ISerializable
|
||||
// Создаю массив результата
|
||||
$result = [];
|
||||
|
||||
// Получаю свойства класса
|
||||
$properties = get_object_vars($this);
|
||||
// Заполняю массив
|
||||
$result["MessageType"] = $this->MessageType->GetValue();
|
||||
$result["IsCritical"] = $this->IsCritical ? 1 : 0;
|
||||
$result["Message"] = $this->Message;
|
||||
|
||||
// Для каждого свойства класса
|
||||
foreach ($properties as $key => $value) {
|
||||
|
||||
// - если значение является перечислением
|
||||
if ($value instanceof UnitEnum) {
|
||||
// -- получаю перечисление
|
||||
$result[$key] = $value->name;
|
||||
|
||||
// -- следующий элемент
|
||||
continue;
|
||||
}
|
||||
|
||||
// - если значение является NULL
|
||||
if ($value == null) {
|
||||
// -- присваиваю NULL
|
||||
$result[$key] = "null";
|
||||
// -- следующий элемент
|
||||
continue;
|
||||
}
|
||||
|
||||
// - присваиваю значение
|
||||
$result[$key] = $value;
|
||||
}
|
||||
|
||||
// Сериализую массив и вывожу его
|
||||
return serialize($result);
|
||||
// Сериализую
|
||||
return json_encode($result);
|
||||
}
|
||||
}
|
710
sources/operators/JsonReWriter.md
Normal file
710
sources/operators/JsonReWriter.md
Normal file
@ -0,0 +1,710 @@
|
||||
# Описание класса JsonReWriter
|
||||
|
||||
## Информация о версии
|
||||
|
||||
Версия класса: 1.0
|
||||
|
||||
Впервые введено в пакет с версии: 1.1.0
|
||||
|
||||
Описание класса: Класс для работы с JSON-файлами.
|
||||
|
||||
## Публичные свойства и константы класса
|
||||
|
||||
В классе определены следующие свойства:
|
||||
|
||||
- `string $JsonString` - строка JSON (чтение/запись).
|
||||
|
||||
## Быстрый старт
|
||||
|
||||
### Правила формирования ключей.
|
||||
|
||||
Ключ для чтения/записи данных класса формируется следующим образом: `ключ/подключ/подключ подключа` .
|
||||
|
||||
Например, если дан json-файл:
|
||||
|
||||
{
|
||||
"test": {
|
||||
"subtest": {
|
||||
"AAA": "123",
|
||||
"BBB": 1.23
|
||||
}
|
||||
},
|
||||
"test1": {
|
||||
"test": 123
|
||||
},
|
||||
"test2": {
|
||||
"test": true
|
||||
},
|
||||
"test3": {
|
||||
"test": {
|
||||
"res": "[1,2,3]"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Пусть требуется получить значение `BBB`, тогда ключ должен быть `test/subtest/BBB`.
|
||||
|
||||
### Чтение.
|
||||
|
||||
1. Создайте элемент класса `$json = new JsonReWriter ();`
|
||||
2. Если у вас требуется загрузить json из файла `$fileName`, то воспользуйтесь методом `LoadFromFile`:
|
||||
`$json->LoadFromFile($fileName);`, если же json представлен строкой `$jsonStr`, то загрузите её в свойство
|
||||
`$JsonString`: `$json->JsonString = $jsonStr;`
|
||||
3. Далее можно пользоваться любым методом для чтения `Read*`, в том числе и общим `$json->Read(...)`.
|
||||
|
||||
**Пример:**
|
||||
|
||||
// Имя файла
|
||||
$fileName = __DIR__ . "/test.json";
|
||||
// Создаю класс
|
||||
$json = new JsonReWriter();
|
||||
// Загшружаю данные из файла
|
||||
$json->LoadFromFile($fileName);
|
||||
// Получаю число
|
||||
$float = $json->ReadFloat("test/subtest/BBB", 0.2);
|
||||
|
||||
В итоге в `$float` будет `1.23`.
|
||||
|
||||
### Запись.
|
||||
|
||||
1. Создайте элемент класса `$json = new JsonReWriter ();`
|
||||
2. Далее можно пользоваться любым методом для записи `Write*`, в том числе и общим `$json->Write(...)`.
|
||||
3. Если вам требуется создать json файл с именем `$fileName`, то воспользуйтесь методом `SaveToFile`:
|
||||
`$json->SaveToFile($fileName);`, если же json должен быть представлен строкой `$jsonStr`, то загрузите её из свойства
|
||||
`$JsonString`: `$jsonStr = $json->JsonString;`
|
||||
|
||||
**Пример:**
|
||||
|
||||
// Имя файла
|
||||
$fileName = __DIR__ . "/test.json";
|
||||
// Создаю класс
|
||||
$json = new JsonReWriter();
|
||||
// Загшружаю данные из файла
|
||||
$json->LoadFromFile($fileName);
|
||||
// Получаю число
|
||||
try {
|
||||
$json->Write("test/subtest/BBB", 0.2);
|
||||
}
|
||||
catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
|
||||
В итоге в `test/subtest/BBB` вместо `1.23` будет `0.2`.
|
||||
|
||||
## Коды ошибок JsonErrorCode
|
||||
|
||||
Ниже представлена таблица основных кодов ошибки:
|
||||
|
||||
| Ошибка | Описание | Введено с версии |
|
||||
|:-------------------:|:---------------------------------------------------------------------------:|:----------------:|
|
||||
| Unknown | Неизвестная ошибка | 1.0 |
|
||||
| None | Ошибок нет | 1.0 |
|
||||
| Depth | Достигнута максимальная глубина стека | 1.0 |
|
||||
| StateMismatch | Неверный или некорректный JSON | 1.0 |
|
||||
| CTRLChar | Ошибка управляющего символа, возможно, неверная кодировка | 1.0 |
|
||||
| Syntax | Синтаксическая ошибка | 1.0 |
|
||||
| UTF8 | Некорректные для кодировки UTF-8 символы, возможно, неверная кодировка | 1.0 |
|
||||
| Recursion | Одна или несколько зацикленных ссылок в кодируемом значении | 1.0 |
|
||||
| InfOrNan | Одно или несколько значений NAN или INF в кодируемом значении | 1.0 |
|
||||
| UnsupportedType | Передали значение с неподдерживаемым типом | 1.0 |
|
||||
| InvalidPropertyName | Имя свойства не может быть закодировано | 1.0 |
|
||||
| UTF16 | Некорректный для кодировки UTF-16 символ, возможно, некорректно закодирован | 1.0 |
|
||||
| KeyIsNotArray | Ключ не содержит вложений, хотя от него требуется обратное | 1.0 |
|
||||
| NotISerializable | Класс не реализует интерфейс ISerializable | 1.0 |
|
||||
|
||||
### Методы и функции перечисления JsonErrorCode
|
||||
|
||||
Перечисление содержит **статический метод** `static function FromLastError (): JsonErrorCode`, который получает код
|
||||
ошибки из последней JSON ошибки.
|
||||
|
||||
Например, при успешной загрузке, можем проверить ошибки:
|
||||
|
||||
$errors = JsonErrorCode::FromLastError ();
|
||||
|
||||
После того, как мы выведем `$errors`, мы получим `JsonErrorCode::None`.
|
||||
|
||||
## Исключение JsonException
|
||||
|
||||
Исключение расширяет класс `Exception`, поэтому может выбрасываться через `throw`.
|
||||
|
||||
### Свойства
|
||||
|
||||
Исключение содержит следующие свойства:
|
||||
|
||||
- `?string $JsonString` - строка JSON (или null);
|
||||
- `JsonErrorCode $ErrorCode` - код ошибки JSON;
|
||||
- `?string $ErrorMessage` - сообщение об ошибке JSON (в отличие от функции json_last_error_msg(), данная переменная при
|
||||
отсутствии ошибок выводит null, а не "No error").
|
||||
|
||||
### Методы и функции
|
||||
|
||||
#### Конструктор.
|
||||
|
||||
Конструктор принимает **3 необязательных параметра**:
|
||||
|
||||
* `?string $json` - строка JSON (по умолчанию, `null`);
|
||||
* `JsonErrorCode $errorCode` - код ошибки (по умолчанию, `JsonErrorCode::Unknown`);
|
||||
* `?string $errorMessage` - сообщение об ошибке (по умолчанию, `null`).
|
||||
|
||||
В результате создаётся новое исключение `JsonException`.
|
||||
|
||||
Пример:
|
||||
|
||||
throw new JsonException("{}", JsonErrorCode::Depth, "Пример");
|
||||
|
||||
Создаст исключение `JsonException`.
|
||||
|
||||
## Методы и функции
|
||||
|
||||
### Конструктор и деструктор.
|
||||
|
||||
Конструктор не принимает никаких параметров.
|
||||
|
||||
В результате создаётся новый класс `JsonReWriter`.
|
||||
|
||||
**Пример:**
|
||||
|
||||
// Контсуктор
|
||||
$json = new JsonReWriter ();
|
||||
// Деструктор
|
||||
unset($json);
|
||||
|
||||
Создаст и уничтожит класс `JsonReWriter`.
|
||||
|
||||
### Сохранение и загрузка из файла.
|
||||
|
||||
За сохранение и загрузку отвечают 2 метода: `SaveToFile` и `LoadFromFile`.
|
||||
|
||||
#### Сохранение в файл (метод `SaveToFile`)
|
||||
|
||||
Этот метод сохраняет содержимое JSON в файл. Он содержит **1 обязательный параметр**:
|
||||
|
||||
* `string $fileName` - имя файла на диске.
|
||||
|
||||
Метод возвращает `bool` - сохранены ли данные в файл: `true` - да, `false` - нет.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function SaveToFile (string $fileName): bool
|
||||
|
||||
**Пример:**
|
||||
|
||||
// Имя файла
|
||||
$fileName = __DIR__ . "/test.json";
|
||||
// Создаём класс
|
||||
$json = new JsonReWriter();
|
||||
// Заполним данными
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
$json->Write("test/subtest/BBB", 1.23);
|
||||
$json->Write("test1/test", 123);
|
||||
$json->Write("test2/test", true);
|
||||
$json->WriteArray("test3/test/res", [1, 2, 3]);
|
||||
} catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
// Сохраняем созданный JSON файл
|
||||
$json->SaveToFile($fileName);
|
||||
|
||||
Содержимое файла `test.json` представлено далее:
|
||||
|
||||
{
|
||||
"test": {
|
||||
"subtest": {
|
||||
"AAA": "123",
|
||||
"BBB": 1.23
|
||||
}
|
||||
},
|
||||
"test1": {
|
||||
"test": 123
|
||||
},
|
||||
"test2": {
|
||||
"test": true
|
||||
},
|
||||
"test3": {
|
||||
"test": {
|
||||
"res": "[1,2,3]"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#### Загрузка файла (метод `LoadFromFile`)
|
||||
|
||||
Этот метод загружает содержимое файла в класс. Он содержит **1 обязательный параметр**:
|
||||
|
||||
* `string $fileName` - имя файла на диске.
|
||||
|
||||
Метод возвращает `bool` - загружены ли данные из файла: `true` - да, `false` - нет.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function LoadFromFile (string $fileName): bool
|
||||
|
||||
**Пример:**
|
||||
Пусть дан файл `test.json`, содержимое которого представлено далее:
|
||||
|
||||
{
|
||||
"test": {
|
||||
"subtest": {
|
||||
"AAA": "123",
|
||||
"BBB": 1.23
|
||||
}
|
||||
},
|
||||
"test1": {
|
||||
"test": 123
|
||||
},
|
||||
"test2": {
|
||||
"test": true
|
||||
},
|
||||
"test3": {
|
||||
"test": {
|
||||
"res": "[1,2,3]"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Следующий код загрузит это содержимое в класс:
|
||||
|
||||
// Имя файла
|
||||
$fileName = __DIR__ . "/test.json";
|
||||
// Создаём класс
|
||||
$json = new JsonReWriter();
|
||||
// Загружаю данные
|
||||
$json->LoadFromFile($fileName);
|
||||
|
||||
### Чтение данных
|
||||
|
||||
Для чтения данных используется один общий метод `Read` и 7 его производных метода: `ReadString`, `ReadInt`, `ReadFloat`,
|
||||
`ReadBool`, `ReadArray`, `ReadObject` и `ReadSerializable`.
|
||||
|
||||
#### Метод `Read`
|
||||
|
||||
Это метод, который читает значение ключа JSON. Он имеет **1 обязательный параметр** `string $key` (ключ) и **1
|
||||
необязательный параметр** `mixed $default` (значение по умолчанию, задан по умолчанию в `null`).
|
||||
|
||||
Этот метод возвращает `mixed`: значение ключа JSON или значение по умолчанию.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function Read (string $key, mixed $default = null): mixed
|
||||
|
||||
**Пример,**
|
||||
|
||||
// Создаю класс
|
||||
$json = new JsonReWriter();
|
||||
// Заполняю данными
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
$json->Write("test/subtest/BBB", 1.23);
|
||||
$json->Write("test1/test", 123);
|
||||
$json->Write("test2/test", true);
|
||||
$json->Write("test3/test/res", json_encode([1, 2, 3]));
|
||||
} catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
|
||||
// Получаю значение
|
||||
$float = (float)$json->Read("test/subtest/BBB"));
|
||||
|
||||
В результате, переменная `$float` будет иметь значение `1.23`.
|
||||
|
||||
#### Метод `ReadString`
|
||||
|
||||
Это метод, который читает значение ключа JSON. Он имеет **1 обязательный параметр** `string $key` (ключ) и **1
|
||||
необязательный параметр** `string $default` (значение по умолчанию, задан по умолчанию в `""`).
|
||||
|
||||
Этот метод возвращает `string`: значение ключа JSON или значение по умолчанию.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function ReadString (string $key, string $default = ""): string
|
||||
|
||||
#### Метод `ReadInt`
|
||||
|
||||
Это метод, который читает значение ключа JSON. Он имеет **1 обязательный параметр** `string $key` (ключ) и **1
|
||||
необязательный параметр** `int $default` (значение по умолчанию, задан по умолчанию в `0`).
|
||||
|
||||
Этот метод возвращает `int`: значение ключа JSON или значение по умолчанию.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function ReadInt (string $key, int $default = 0): int
|
||||
|
||||
#### Метод `ReadFloat`
|
||||
|
||||
Это метод, который читает значение ключа JSON. Он имеет **1 обязательный параметр** `string $key` (ключ) и **1
|
||||
необязательный параметр** `float $default` (значение по умолчанию, задан по умолчанию в `0.0`).
|
||||
|
||||
Этот метод возвращает `float`: значение ключа JSON или значение по умолчанию.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function ReadFloat (string $key, float $default = 0.0): float
|
||||
|
||||
#### Метод `ReadBool`
|
||||
|
||||
Это метод, который читает значение ключа JSON. Он имеет **1 обязательный параметр** `string $key` (ключ) и **1
|
||||
необязательный параметр** `bool $default` (значение по умолчанию, задан по умолчанию в `false`).
|
||||
|
||||
Этот метод возвращает `bool`: значение ключа JSON или значение по умолчанию.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function ReadBool (string $key, bool $default = false): bool
|
||||
|
||||
#### Метод `ReadArray`
|
||||
|
||||
Это метод, который читает значение ключа JSON. Он имеет **1 обязательный параметр** `string $key` (ключ) и **1
|
||||
необязательный параметр** `array $default` (значение по умолчанию, задан по умолчанию в `[]`).
|
||||
|
||||
Этот метод возвращает `array`: значение ключа JSON или значение по умолчанию.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function ReadArray (string $key, array $default = []): array
|
||||
|
||||
#### Метод `ReadObject`
|
||||
|
||||
Это метод, который читает значение ключа JSON. Он имеет **2 обязательных параметра**:
|
||||
|
||||
- `string $key` (ключ);
|
||||
- `object $default` (значение по умолчанию).
|
||||
|
||||
Этот метод возвращает `object`: значение ключа JSON или значение по умолчанию.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function ReadObject (string $key, object $default): object
|
||||
|
||||
#### Метод `ReadSerializable`
|
||||
|
||||
Это метод, который читает значение ключа JSON. Он имеет **2 обязательных параметра**:
|
||||
|
||||
- `string $key` (ключ);
|
||||
- `string $serializableClassName` (имя класса, реализующего интерфейс ISerializable, с namespace).
|
||||
|
||||
Этот метод возвращает класс, реализующий интерфейс `ISerializable`.
|
||||
|
||||
**Важно!** Этот метод может выбросить исключение `JsonException`, если класс, заданный в `$serializableClassName` не
|
||||
реализует интерфейс `ISerializable`.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function ReadSerializable (string $key, string $serializableClassName): ISerializable
|
||||
|
||||
**Пример,**
|
||||
|
||||
Пусть для примера, класс `Demo` из namespace `iam\namespace` реализует интерфейс `ISerializable`.
|
||||
|
||||
// Создаю класс
|
||||
$json = new JsonReWriter();
|
||||
// ... Здесь где-то загрузка данных
|
||||
// Получаю класс
|
||||
try {
|
||||
/**
|
||||
* @var Demo $unSerializableClass
|
||||
*/
|
||||
$unSerializableClass = $json->ReadSerializable("test", "iam\\namespace\\Demo");
|
||||
} catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
|
||||
В результате, переменная `$unSerializableClass` будет содержать данные класса `Demo`.
|
||||
|
||||
### Запись данных
|
||||
|
||||
Для чтения данных используется один общий метод `Write` и 3 его производных метода: `WriteArray`, `WriteObject` и
|
||||
`WriteSerializable`.
|
||||
|
||||
**Важно!** Лобой из вышеуказанных методов может выбросить исключение `JsonException`, если ключ не содержит вложений,
|
||||
хотя от него требуется обратное.
|
||||
|
||||
#### Метод `Write`
|
||||
|
||||
Это метод, который записывает значение в ключ JSON. Он имеет **2 обязательных параметра**:
|
||||
|
||||
- `string $key` (ключ);
|
||||
- `mixed $value` (записываемое значение).
|
||||
|
||||
Этот метод ничего не возвращает.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function Write (string $key, mixed $value): void
|
||||
|
||||
**Пример,**
|
||||
|
||||
// Имя файла
|
||||
$fileName = __DIR__ . "/test.json";
|
||||
// Создаём класс
|
||||
$json = new JsonReWriter();
|
||||
// Заполним данными
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
$json->Write("test/subtest/BBB", 1.23);
|
||||
$json->Write("test1/test", 123);
|
||||
$json->Write("test2/test", true);
|
||||
$json->WriteArray("test3/test/res", [1, 2, 3]);
|
||||
} catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
// Сохраняем созданный JSON файл
|
||||
$json->SaveToFile($fileName);
|
||||
|
||||
Содержимое файла `test.json` представлено далее:
|
||||
|
||||
{
|
||||
"test": {
|
||||
"subtest": {
|
||||
"AAA": "123",
|
||||
"BBB": 1.23
|
||||
}
|
||||
},
|
||||
"test1": {
|
||||
"test": 123
|
||||
},
|
||||
"test2": {
|
||||
"test": true
|
||||
},
|
||||
"test3": {
|
||||
"test": {
|
||||
"res": "[1,2,3]"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#### Метод `WriteArray`
|
||||
|
||||
Это метод, который записывает значение в ключ JSON. Он имеет **2 обязательных параметра**:
|
||||
|
||||
- `string $key` (ключ);
|
||||
- `array $array` (записываемое значение).
|
||||
|
||||
Этот метод ничего не возвращает.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function WriteArray (string $key, array $array): void
|
||||
|
||||
#### Метод `WriteObject`
|
||||
|
||||
Это метод, который записывает значение в ключ JSON. Он имеет **2 обязательных параметра**:
|
||||
|
||||
- `string $key` (ключ);
|
||||
- `object $value` (записываемое значение).
|
||||
|
||||
Этот метод ничего не возвращает.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function WriteObject (string $key, object $value): void
|
||||
|
||||
#### Метод `WriteSerializable`
|
||||
|
||||
Это метод, который записывает значение в ключ JSON. Он имеет **2 обязательных параметра**:
|
||||
|
||||
- `string $key` (ключ);
|
||||
- `ISerializable $serializableValue` (записываемое значение).
|
||||
|
||||
Этот метод ничего не возвращает.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function WriteSerializable (string $key, ISerializable $serializableValue): void
|
||||
|
||||
**Пример,**
|
||||
Пусть для примера, класс `Demo` из namespace `iam\namespace` реализует интерфейс `ISerializable`.
|
||||
|
||||
// Имя файла
|
||||
$fileName = __DIR__ . "/test.json";
|
||||
// Создаём класс
|
||||
$json = new JsonReWriter();
|
||||
// Создаём класс Demo
|
||||
$serializableClass = new Demo(...);
|
||||
// Заполним данными
|
||||
try {
|
||||
$json->WriteSerializable("test", $serializableClass);
|
||||
} catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
...
|
||||
|
||||
### Работа с ключами JSON
|
||||
|
||||
Для работы с ключами JSON есть 2 метода: `IsKeyExists` и `GetKeys`.
|
||||
|
||||
#### Метод `IsKeyExists`
|
||||
|
||||
Это метод проверяем наличие ключа в JSON. Он имеет **1 обязательный параметр** - `string $key` (ключ).
|
||||
|
||||
Этот метод возвращает `bool`: `true` если ключ найден и `false` в противном случае.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function IsKeyExists (string $key): bool
|
||||
|
||||
**Пример,**
|
||||
|
||||
// Создаём класс
|
||||
$json = new JsonReWriter();
|
||||
// Заполним данными
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
$json->Write("test/subtest/BBB", 1.23);
|
||||
$json->Write("test1/test", 123);
|
||||
$json->Write("test2/test", true);
|
||||
$json->WriteArray("test3/test/res", [1, 2, 3]);
|
||||
} catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
// Проверяем ключи
|
||||
$check1 = $json->IsKeyExists("test/subtest/AAA");
|
||||
$check2 = $json->IsKeyExists("test/subtest/ССС");
|
||||
|
||||
В результате, `$check1` будет `true`, а `$check2` - `false`.
|
||||
|
||||
#### Метод `GetKeys`
|
||||
|
||||
Это метод получает список ключей. Он имеет **2 необязательных параметра**:
|
||||
|
||||
- `string $parentKey` (ключ родителя (или "" (установлено по умолчанию) для всех);
|
||||
- `bool $includeChildren` (нужно ли включать дочерние ключи (по умолчанию, да)).
|
||||
|
||||
Этот метод возвращает `array`: список ключей.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function GetKeys (string $parentKey = "", bool $includeChildren = true): array
|
||||
|
||||
**Пример,**
|
||||
|
||||
// Создаём класс
|
||||
$json = new JsonReWriter();
|
||||
// Заполним данными
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
$json->Write("test/subtest/BBB", 1.23);
|
||||
$json->Write("test1/test", 123);
|
||||
$json->Write("test2/test", true);
|
||||
$json->WriteArray("test3/test/res", [1, 2, 3]);
|
||||
} catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
// Получаем ключи
|
||||
$keys1 = $json->GetKeys("test");
|
||||
$keys2 = $json->GetKeys("test", false);
|
||||
$keys3 = $json->GetKeys();
|
||||
|
||||
В результате, `$key1` будет следующим массивом:
|
||||
|
||||
[
|
||||
"test/subtest",
|
||||
"test/subtest/AAA",
|
||||
"test/subtest/BBB"
|
||||
]
|
||||
|
||||
`$key2` будет следующим массивом:
|
||||
|
||||
[
|
||||
"subtest"
|
||||
]
|
||||
|
||||
`$key3` будет следующим массивом:
|
||||
|
||||
[
|
||||
"test",
|
||||
"test/subtest",
|
||||
"test/subtest/AAA",
|
||||
"test/subtest/BBB",
|
||||
"test1",
|
||||
"test1/test",
|
||||
"test2",
|
||||
"test2/test",
|
||||
"test3",
|
||||
"test3/test",
|
||||
"test3/test/res"
|
||||
]
|
||||
|
||||
### Удаление ключей JSON
|
||||
|
||||
Для удаления ключей JSON есть 2 метода: `DeleteKey`, который удаляет только определённый ключ и `Clear`, который удаляет
|
||||
**все ключи** из json-файла.
|
||||
|
||||
#### Метод `DeleteKey`
|
||||
|
||||
Это метод удаляет только определённый ключ в JSON. Он имеет **1 обязательный параметр** - `string $key` (ключ).
|
||||
|
||||
Этот метод возвращает `bool` - результат удаления ключа: `true` - удаление прошло успешно, `false` - произошла ошибка
|
||||
при удалении.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function DeleteKey (string $key): bool
|
||||
|
||||
**Пример,**
|
||||
|
||||
// Создаём класс
|
||||
$json = new JsonReWriter();
|
||||
// Заполним данными
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
$json->Write("test/subtest/BBB", 1.23);
|
||||
$json->Write("test1/test", 123);
|
||||
$json->Write("test2/test", true);
|
||||
$json->WriteArray("test3/test/res", [1, 2, 3]);
|
||||
} catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
// Получаемем ключи до удаления
|
||||
$check1 = $json->GetKeys("test/subtest");
|
||||
// Удаляем ключ
|
||||
$this->DeleteKey("test/subtest/BBB");
|
||||
// Получаемем ключи после удаления
|
||||
$check2 = $json->GetKeys("test/subtest");
|
||||
|
||||
В результате, `$check1` будет
|
||||
|
||||
[
|
||||
"test/subtest",
|
||||
"test/subtest/AAA",
|
||||
"test/subtest/BBB"
|
||||
]
|
||||
|
||||
а `$check2`:
|
||||
|
||||
[
|
||||
"test/subtest",
|
||||
"test/subtest/AAA"
|
||||
]
|
||||
|
||||
#### Метод `Clear`
|
||||
|
||||
Это метод удаляет **все ключи** из json-файла. Он не имеет никаких параметров и ничего не возвращает.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function Clear (): void
|
||||
|
||||
**Пример,**
|
||||
|
||||
// Создаём класс
|
||||
$json = new JsonReWriter();
|
||||
// Заполним данными
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
$json->Write("test/subtest/BBB", 1.23);
|
||||
$json->Write("test1/test", 123);
|
||||
$json->Write("test2/test", true);
|
||||
$json->WriteArray("test3/test/res", [1, 2, 3]);
|
||||
} catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
// Очищаем
|
||||
$json->Clear();
|
||||
// Получаем ключи
|
||||
$keys = $json->GetKeys();
|
||||
|
||||
В результате, `$key` будет следующим массивом:
|
||||
|
||||
[
|
||||
]
|
46
sources/operators/Operators.php
Normal file
46
sources/operators/Operators.php
Normal file
@ -0,0 +1,46 @@
|
||||
<?php
|
||||
|
||||
namespace goodboyalex\php_components_pack\operators;
|
||||
|
||||
/**
|
||||
* Полезные операторы.
|
||||
*
|
||||
* @author Александр Бабаев
|
||||
* @package php_components_pack
|
||||
* @version 1.0
|
||||
* @since 1.1.1
|
||||
*/
|
||||
final class Operators
|
||||
{
|
||||
/**
|
||||
* Проверяет, что значение <code>$value</code> равно одному из значений <code>$values</code>.
|
||||
*
|
||||
* @param mixed $value Искомое значение.
|
||||
* @param mixed ...$values Массив значений.
|
||||
*
|
||||
* @return bool Возвращает <code>true</code>, если значение <code>$value</code> равно одному из значений
|
||||
* <code>$values</code>, иначе <code>false</code>.
|
||||
*/
|
||||
public static function Is (mixed $value, mixed ...$values): bool
|
||||
{
|
||||
// Проверяем, что хотя бы одно из значений равно искомому и возвращаем результат
|
||||
return array_any($values, fn ($curValue) => $curValue === $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверяет, сколько раз значение <code>$value</code> встречается в массиве <code>$values</code>.
|
||||
*
|
||||
* @param mixed $value Искомое значение.
|
||||
* @param mixed ...$values Массив значений.
|
||||
*
|
||||
* @return int Возвращает количество значений <code>$values</code>, которые равны <code>$value</code>.
|
||||
*/
|
||||
public static function IsCount (mixed $value, mixed ...$values): int
|
||||
{
|
||||
// Получаем массив значений повторений
|
||||
$result = array_count_values($values);
|
||||
|
||||
// Возвращаем результат
|
||||
return $result[$value] ?? 0;
|
||||
}
|
||||
}
|
114
sources/traits/ActionState/ActionStateAddTrait.php
Normal file
114
sources/traits/ActionState/ActionStateAddTrait.php
Normal file
@ -0,0 +1,114 @@
|
||||
<?php
|
||||
|
||||
namespace goodboyalex\php_components_pack\traits\ActionState;
|
||||
|
||||
use goodboyalex\php_components_pack\classes\ActionState;
|
||||
use goodboyalex\php_components_pack\classes\ObjectArray;
|
||||
use goodboyalex\php_components_pack\enums\MessageType;
|
||||
use goodboyalex\php_components_pack\models\ActionStateMessageModel;
|
||||
|
||||
/**
|
||||
* Часть кода класса ActionState, отвечающая за методы добавления сообщений.
|
||||
*
|
||||
* @author Александр Бабаев
|
||||
* @package php_components_pack
|
||||
* @version 1.0
|
||||
* @since 1.0.13
|
||||
*/
|
||||
trait ActionStateAddTrait
|
||||
{
|
||||
/**
|
||||
* Добавляет данные из другого состояния.
|
||||
*
|
||||
* @param ActionState $state Другое состояние
|
||||
* @param bool $clearAllBefore Очищать сообщения перед добавлением (true) или просто добавить к текущим (false)
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function AddState (ActionState $state, bool $clearAllBefore = false): void
|
||||
{
|
||||
// Если нужно очистить список сообщений
|
||||
if ($clearAllBefore)
|
||||
// - то очищаю список сообщений
|
||||
$this->Clear(fn (ActionStateMessageModel $message) => true);
|
||||
|
||||
// Добавляю сообщения из другого состояния
|
||||
$this->AddRange($state->GetMessages(ActionState::GET_STRING_ALL()));
|
||||
|
||||
// Добавляю значение
|
||||
$this->Value = $state->Value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Добавляет список
|
||||
*
|
||||
* @param ObjectArray|array $messages Список сообщений
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function AddRange (ObjectArray|array $messages): void
|
||||
{
|
||||
// Добавляю сообщения
|
||||
$this->Messages->AddRange($messages);
|
||||
}
|
||||
|
||||
/**
|
||||
* Добавляет сообщение о критической ошибке.
|
||||
*
|
||||
* @param string $message Сообщение
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function AddCritical (string $message): void
|
||||
{
|
||||
$this->Add(new ActionStateMessageModel(MessageType::Error, true, $message));
|
||||
}
|
||||
|
||||
/**
|
||||
* Добавление сообщения.
|
||||
*
|
||||
* @param ActionStateMessageModel $message Сообщение
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function Add (ActionStateMessageModel $message): void
|
||||
{
|
||||
$this->Messages->Add($message);
|
||||
}
|
||||
|
||||
/**
|
||||
* Добавляет сообщение об ошибке.
|
||||
*
|
||||
* @param string $message Сообщение
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function AddError (string $message): void
|
||||
{
|
||||
$this->Add(new ActionStateMessageModel(MessageType::Error, false, $message));
|
||||
}
|
||||
|
||||
/**
|
||||
* Добавляет предупреждение.
|
||||
*
|
||||
* @param string $message Сообщение.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function AddWarning (string $message): void
|
||||
{
|
||||
$this->Add(new ActionStateMessageModel(MessageType::Warning, false, $message));
|
||||
}
|
||||
|
||||
/**
|
||||
* Добавляет информационное сообщение.
|
||||
*
|
||||
* @param string $message Сообщение.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function AddInfo (string $message): void
|
||||
{
|
||||
$this->Add(new ActionStateMessageModel(MessageType::Info, false, $message));
|
||||
}
|
||||
}
|
45
sources/traits/ActionState/ActionStateGetTrait.php
Normal file
45
sources/traits/ActionState/ActionStateGetTrait.php
Normal file
@ -0,0 +1,45 @@
|
||||
<?php
|
||||
|
||||
namespace goodboyalex\php_components_pack\traits\ActionState;
|
||||
|
||||
use goodboyalex\php_components_pack\classes\ObjectArray;
|
||||
|
||||
/**
|
||||
* Часть кода класса ActionState, отвечающая за методы получения сообщений.
|
||||
*
|
||||
* @author Александр Бабаев
|
||||
* @package php_components_pack
|
||||
* @version 1.0
|
||||
* @since 1.0.13
|
||||
*/
|
||||
trait ActionStateGetTrait
|
||||
{
|
||||
/**
|
||||
* Возвращает список сообщений (параметр Message у каждого сообщения).
|
||||
*
|
||||
* @param callable $predicate Условие выборки
|
||||
* @param string $separator Разделитель
|
||||
*
|
||||
* @return string Список сообщений
|
||||
*/
|
||||
public function GetStringMessages (callable $predicate, string $separator = '\n'): string
|
||||
{
|
||||
// Делаю выборку
|
||||
$result = $this->Messages->GetColumn("Message", $predicate);
|
||||
|
||||
// Возвращаю список
|
||||
return implode($separator, $result);
|
||||
}
|
||||
|
||||
/**
|
||||
* Выбирает сообщения по условию predicate.
|
||||
*
|
||||
* @param callable $predicate Условие выборки
|
||||
*
|
||||
* @return ObjectArray Список отобранных сообщений
|
||||
*/
|
||||
public function GetMessages (callable $predicate): ObjectArray
|
||||
{
|
||||
return $this->Messages->GetRows($predicate);
|
||||
}
|
||||
}
|
68
sources/traits/ActionState/ActionStateHasTrait.php
Normal file
68
sources/traits/ActionState/ActionStateHasTrait.php
Normal file
@ -0,0 +1,68 @@
|
||||
<?php
|
||||
|
||||
namespace goodboyalex\php_components_pack\traits\ActionState;
|
||||
|
||||
use goodboyalex\php_components_pack\enums\MessageType;
|
||||
use goodboyalex\php_components_pack\models\ActionStateMessageModel;
|
||||
|
||||
/**
|
||||
* Часть кода класса ActionState, отвечающая за методы проверки на наличие сообщений.
|
||||
*
|
||||
* @author Александр Бабаев
|
||||
* @package php_components_pack
|
||||
* @version 1.0
|
||||
* @since 1.0.13
|
||||
*/
|
||||
trait ActionStateHasTrait
|
||||
{
|
||||
/**
|
||||
* Проверяет, есть ли информационные сообщения.
|
||||
*
|
||||
* @return bool Наличие сообщений
|
||||
*/
|
||||
public function HasInfos (): bool
|
||||
{
|
||||
return $this->Messages->IsExist(fn (ActionStateMessageModel $message)
|
||||
=> $message->MessageType
|
||||
== MessageType::Info);
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверяет, успешно ли завершилась операция.
|
||||
*
|
||||
* @param bool $onlyCritical Игнорировать все некритические ошибки и предупреждения (не рекомендуется!)
|
||||
*
|
||||
* @return bool Успешно ли завершилась операция.
|
||||
*/
|
||||
public function IsSuccess (bool $onlyCritical = false): bool
|
||||
{
|
||||
return ($onlyCritical) ? !$this->HasErrors($onlyCritical) : !$this->HasErrors() && !$this->HasWarnings();
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверяет, есть ли ошибки.
|
||||
*
|
||||
* @param bool $onlyCritical Учитывать только критические ошибки.
|
||||
*
|
||||
* @return bool Наличие ошибок.
|
||||
*/
|
||||
public function HasErrors (bool $onlyCritical = false): bool
|
||||
{
|
||||
return $this->Messages->IsExist(fn (ActionStateMessageModel $message): bool
|
||||
=> $onlyCritical
|
||||
? $message->MessageType == MessageType::Error && $message->IsCritical
|
||||
: $message->MessageType == MessageType::Error);
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверяет, есть ли предупреждения.
|
||||
*
|
||||
* @return bool Наличие предупреждений
|
||||
*/
|
||||
public function HasWarnings (): bool
|
||||
{
|
||||
return $this->Messages->IsExist(fn (ActionStateMessageModel $message)
|
||||
=> $message->MessageType
|
||||
== MessageType::Warning);
|
||||
}
|
||||
}
|
51
sources/traits/ActionState/ActionStateStaticTrait.php
Normal file
51
sources/traits/ActionState/ActionStateStaticTrait.php
Normal file
@ -0,0 +1,51 @@
|
||||
<?php
|
||||
|
||||
namespace goodboyalex\php_components_pack\traits\ActionState;
|
||||
|
||||
use Closure;
|
||||
use goodboyalex\php_components_pack\enums\MessageType;
|
||||
use goodboyalex\php_components_pack\models\ActionStateMessageModel;
|
||||
|
||||
/**
|
||||
* Часть кода класса ActionState, отвечающая за статичные методы и константы.
|
||||
*
|
||||
* @author Александр Бабаев
|
||||
* @package php_components_pack
|
||||
* @version 1.0
|
||||
* @since 1.0.13
|
||||
*/
|
||||
trait ActionStateStaticTrait
|
||||
{
|
||||
/**
|
||||
* При выводе GetStringMessages выводит только ошибки.
|
||||
*
|
||||
* @return Closure Возвращает функцию, проверяющую сообщение на соответствие типу.
|
||||
*/
|
||||
public static function GET_STRING_ERROR_ONLY (): Closure
|
||||
{
|
||||
return fn (ActionStateMessageModel $message)
|
||||
=> $message->MessageType === MessageType::Error;
|
||||
}
|
||||
|
||||
/**
|
||||
* При выводе GetStringMessages выводит ошибки и предупреждения.
|
||||
*
|
||||
* @return Closure Возвращает функцию, проверяющую сообщение на соответствие типу.
|
||||
*/
|
||||
public static function GET_STRING_ERROR_AND_WARNING (): Closure
|
||||
{
|
||||
return fn (ActionStateMessageModel $message)
|
||||
=> $message->MessageType === MessageType::Error
|
||||
|| $message->MessageType === MessageType::Warning;
|
||||
}
|
||||
|
||||
/**
|
||||
* При выводе GetStringMessages выводит все сообщения.
|
||||
*
|
||||
* @return Closure Возвращает функцию, проверяющую сообщение на соответствие типу.
|
||||
*/
|
||||
public static function GET_STRING_ALL (): Closure
|
||||
{
|
||||
return fn (ActionStateMessageModel $message) => true;
|
||||
}
|
||||
}
|
@ -1,18 +1,18 @@
|
||||
<?php
|
||||
|
||||
namespace goodboyalex\php_components_pack\traits\ObjectArray;
|
||||
namespace goodboyalex\php_components_pack\traits;
|
||||
|
||||
use ArrayIterator;
|
||||
|
||||
/**
|
||||
* Часть кода класса ObjectArray, отвечающая за функции из наследуемых интерфейсов и классов.
|
||||
* Часть кода класса ObjectArray и Dictionary, отвечающая за функции из наследуемых интерфейсов и классов.
|
||||
*
|
||||
* @author Александр Бабаев
|
||||
* @package php_components_pack
|
||||
* @version 1.0
|
||||
* @since 1.0
|
||||
*/
|
||||
trait ObjectArrayBasicTrait
|
||||
trait ArrayBasicTrait
|
||||
{
|
||||
/**
|
||||
* @inheritDoc
|
||||
@ -69,7 +69,7 @@ trait ObjectArrayBasicTrait
|
||||
*/
|
||||
public function __isset (mixed $offset): bool
|
||||
{
|
||||
return isset($this->data[$offset]);
|
||||
return isset($this->Container[$offset]);
|
||||
}
|
||||
|
||||
/**
|
||||
@ -77,6 +77,10 @@ trait ObjectArrayBasicTrait
|
||||
*/
|
||||
public function Serialize (): string
|
||||
{
|
||||
/**
|
||||
* ВНИМАНИЕ! Не используйте json_encode для сериализации объектов данного класса, так как он НЕ СОХРАНЯЕТ классы объектов!
|
||||
* Корректное восстановление объектов невозможно (восстанавливает только как ассоциативный массив).
|
||||
*/
|
||||
return serialize($this->Container);
|
||||
}
|
||||
|
||||
@ -85,6 +89,10 @@ trait ObjectArrayBasicTrait
|
||||
*/
|
||||
public function UnSerialize (string $serialized): void
|
||||
{
|
||||
/**
|
||||
* ВНИМАНИЕ! Не используйте json_decode для десериализации объектов данного класса, так как он НЕ ВОССТАНОВЛЯЕТ
|
||||
* классы объектов! Корректное восстановление объектов невозможно (восстанавливается только как ассоциативный массив).
|
||||
*/
|
||||
$this->Container = unserialize($serialized);
|
||||
}
|
||||
}
|
69
sources/traits/JsonReWriter/JsonReWriterDeleteTrait.php
Normal file
69
sources/traits/JsonReWriter/JsonReWriterDeleteTrait.php
Normal file
@ -0,0 +1,69 @@
|
||||
<?php
|
||||
|
||||
namespace goodboyalex\php_components_pack\traits\JsonReWriter;
|
||||
|
||||
/**
|
||||
* Часть кода класса JsonReWriter, отвечающая за методы удаления ключей JSON.
|
||||
*
|
||||
* @author Александр Бабаев
|
||||
* @package php_components_pack
|
||||
* @version 1.0
|
||||
* @since 1.1.0
|
||||
*/
|
||||
trait JsonReWriterDeleteTrait
|
||||
{
|
||||
/**
|
||||
* Очистка данных JSON.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function Clear (): void
|
||||
{
|
||||
// Очистка данных
|
||||
unset($this->JsonData);
|
||||
|
||||
// Создание пустого массива
|
||||
$this->JsonData = [];
|
||||
}
|
||||
|
||||
/**
|
||||
* Удаление ключа JSON.
|
||||
*
|
||||
* @param string $key Требуемый ключ JSON для удаления.
|
||||
*
|
||||
* @return bool Результат удаления ключа: <code>true</code> - удаление прошло успешно, <code>false</code> -
|
||||
* произошла ошибка при удалении.
|
||||
*/
|
||||
public function DeleteKey (string $key): bool
|
||||
{
|
||||
// Очищаем ключ
|
||||
$preparedKey = $this->PrepareKey($key);
|
||||
|
||||
// Проверка ключа
|
||||
if (!$this->IsKeyExists($preparedKey))
|
||||
// - ключ не существует
|
||||
return false;
|
||||
|
||||
// Разбиваем ключ на части
|
||||
$keys = $this->ParseKey($preparedKey);
|
||||
|
||||
// Получаем текущий массив данных
|
||||
$current = &$this->JsonData;
|
||||
|
||||
// Если ключ не является корневым
|
||||
if (count($keys) > 0)
|
||||
// - переходим к вложенному массиву
|
||||
for ($i = 0; $i < count($keys) - 1; $i++)
|
||||
// -- и добавляем массив данных
|
||||
$current = &$current[$keys[$i]];
|
||||
|
||||
// Получаем удаляемый ключ
|
||||
$deleteKey = $keys[count($keys) - 1];
|
||||
|
||||
// Удаляем ключ
|
||||
unset($current[$deleteKey]);
|
||||
|
||||
// Проверяем удаление
|
||||
return $this->IsKeyExists($key);
|
||||
}
|
||||
}
|
129
sources/traits/JsonReWriter/JsonReWriterKeyTrait.php
Normal file
129
sources/traits/JsonReWriter/JsonReWriterKeyTrait.php
Normal file
@ -0,0 +1,129 @@
|
||||
<?php
|
||||
|
||||
namespace goodboyalex\php_components_pack\traits\JsonReWriter;
|
||||
|
||||
use goodboyalex\php_components_pack\extensions\StringExtension;
|
||||
|
||||
/**
|
||||
* Часть кода класса JsonReWriter, отвечающая за методы работы с ключами JSON.
|
||||
*
|
||||
* @author Александр Бабаев
|
||||
* @package php_components_pack
|
||||
* @version 1.0
|
||||
* @since 1.1.0
|
||||
*/
|
||||
trait JsonReWriterKeyTrait
|
||||
{
|
||||
/**
|
||||
* Проверяем наличие ключа в JSON.
|
||||
*
|
||||
* @param string $key Ключ.
|
||||
*
|
||||
* @return bool true если ключ найден, false если нет.
|
||||
*/
|
||||
public function IsKeyExists (string $key): bool
|
||||
{
|
||||
// Получаем массив ключей по вложенности
|
||||
$keys = $this->ParseKey($key);
|
||||
|
||||
// Получаем текущий массив данных
|
||||
$current = $this->JsonData;
|
||||
|
||||
// Для каждого ключа
|
||||
foreach ($keys as $key) {
|
||||
// - проверяем наличие ключа в текущем массиве
|
||||
if (!array_key_exists($key, $current))
|
||||
// - нет? Возвращаем false
|
||||
return false;
|
||||
|
||||
// Переходим ко вложенному массиву
|
||||
$current = $current[$key];
|
||||
}
|
||||
|
||||
// Возвращаем true, если все ключи найдены
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Получение ключей по вложенности. Т.е., ключи вида <code>"key1/key2/key3" => ["key1", "key2", "key3"]</code>.
|
||||
*
|
||||
* @param string $key Ключ.
|
||||
*
|
||||
* @return array Ключи по вложенности.
|
||||
*/
|
||||
private function ParseKey (string $key): array
|
||||
{
|
||||
// Очищаем ключ
|
||||
$key = $this->PrepareKey($key);
|
||||
|
||||
// Разбиваем ключ на части
|
||||
return explode('/', $key);
|
||||
}
|
||||
|
||||
/**
|
||||
* Подготавливает ключ к использованию внутри методов.
|
||||
*
|
||||
* @param string $key Неочищенный ключ.
|
||||
*
|
||||
* @return string Очищенный ключ.
|
||||
*/
|
||||
private function PrepareKey (string $key): string
|
||||
{
|
||||
return trim($key, "/ ");
|
||||
}
|
||||
|
||||
/**
|
||||
* Получение списка ключей.
|
||||
*
|
||||
* @param string $parentKey Ключ родителя (или "" (установлено по умолчанию) для всех).
|
||||
* @param bool $includeChildren Нужно ли включать дочерние ключи (по умолчанию, да).
|
||||
*
|
||||
* @return array Список ключей.
|
||||
*/
|
||||
public function GetKeys (string $parentKey = "", bool $includeChildren = true): array
|
||||
{
|
||||
// Очищаем ключ
|
||||
$parentKey = $this->PrepareKey($parentKey);
|
||||
|
||||
// Разбиваем ключ на части
|
||||
$keys = StringExtension::IsNullOrWhitespace($parentKey) ? [] : $this->ParseKey($parentKey);
|
||||
|
||||
// Получаем текущий массив данных
|
||||
$current = $this->JsonData;
|
||||
|
||||
// Если ключ не является корневым
|
||||
if (count($keys) > 0)
|
||||
// - переходим к вложенному массиву
|
||||
for ($i = 0; $i < count($keys); $i++)
|
||||
// -- и добавляем массив данных
|
||||
$current = $current[$keys[$i]];
|
||||
|
||||
// Получаем список ключей родителя
|
||||
$parentKeysList = array_keys($current);
|
||||
|
||||
// Если не нужно включать дочерние ключи
|
||||
if (!$includeChildren)
|
||||
// - возвращаем список родительских ключей
|
||||
return $parentKeysList;
|
||||
|
||||
// Создаем результирующий массив
|
||||
$result = [];
|
||||
|
||||
// Для каждого ключа
|
||||
foreach ($parentKeysList as $key) {
|
||||
// - очищаем текущий ключ
|
||||
$currentKey = $this->PrepareKey($parentKey . "/" . $key);
|
||||
|
||||
// - добавляем его в результирующий массив
|
||||
$result[] = $currentKey;
|
||||
|
||||
// - если у текущего ключа есть дочерние ключи
|
||||
if (is_array($current[$key]))
|
||||
// -- добавляем их в результирующий массив
|
||||
$result = array_merge($result, $this->GetKeys($currentKey));
|
||||
}
|
||||
|
||||
// Возвращаем результирующий массив
|
||||
return $result;
|
||||
}
|
||||
}
|
56
sources/traits/JsonReWriter/JsonReWriterLoadSaveTrait.php
Normal file
56
sources/traits/JsonReWriter/JsonReWriterLoadSaveTrait.php
Normal file
@ -0,0 +1,56 @@
|
||||
<?php
|
||||
|
||||
namespace goodboyalex\php_components_pack\traits\JsonReWriter;
|
||||
|
||||
/**
|
||||
* Часть кода класса JsonReWriter, отвечающая за методы загрузки и сохранения JSON.
|
||||
*
|
||||
* @author Александр Бабаев
|
||||
* @package php_components_pack
|
||||
* @version 1.0
|
||||
* @since 1.1.0
|
||||
*/
|
||||
trait JsonReWriterLoadSaveTrait
|
||||
{
|
||||
/**
|
||||
* Сохраняем JSON в файл.
|
||||
*
|
||||
* @param string $fileName Имя файла.
|
||||
*
|
||||
* @return bool Сохранены ли данные в файл: <code>true</code> - да, <code>false</code> - нет.
|
||||
*/
|
||||
public function SaveToFile (string $fileName): bool
|
||||
{
|
||||
// Запись данных в файл
|
||||
return file_put_contents($fileName, $this->JsonString) !== false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Загрузка данных из JSON-файла.
|
||||
*
|
||||
* @param string $fileName Имя файла.
|
||||
*
|
||||
* @return bool Загрузились ли данные из файла: <code>true</code> - да, <code>false</code> - нет.
|
||||
*/
|
||||
public function LoadFromFile (string $fileName): bool
|
||||
{
|
||||
// Проверка существования файла
|
||||
if (!is_file($fileName))
|
||||
// - если нет, возвращаем false
|
||||
return false;
|
||||
|
||||
// Чтение содержимого файла
|
||||
$result = file_get_contents($fileName);
|
||||
|
||||
// Проверка на ошибки
|
||||
if ($result === false)
|
||||
// - если есть ошибки, возвращаем false
|
||||
return false;
|
||||
|
||||
// Записываем результат
|
||||
$this->JsonString = $result;
|
||||
|
||||
// Возвращаем true, если все хорошо
|
||||
return true;
|
||||
}
|
||||
}
|
173
sources/traits/JsonReWriter/JsonReWriterReadTrait.php
Normal file
173
sources/traits/JsonReWriter/JsonReWriterReadTrait.php
Normal file
@ -0,0 +1,173 @@
|
||||
<?php
|
||||
|
||||
namespace goodboyalex\php_components_pack\traits\JsonReWriter;
|
||||
|
||||
use goodboyalex\php_components_pack\enums\JsonErrorCode;
|
||||
use goodboyalex\php_components_pack\exceptions\JsonException;
|
||||
use goodboyalex\php_components_pack\interfaces\ISerializable;
|
||||
|
||||
/**
|
||||
* Часть кода класса JsonReWriter, отвечающая за методы чтения ключей и значений JSON.
|
||||
*
|
||||
* @author Александр Бабаев
|
||||
* @package php_components_pack
|
||||
* @version 1.0
|
||||
* @since 1.1.0
|
||||
*/
|
||||
trait JsonReWriterReadTrait
|
||||
{
|
||||
/**
|
||||
* Читает значение ключа JSON как целое число.
|
||||
*
|
||||
* @param string $key Ключ JSON.
|
||||
* @param int $default Значение по умолчанию.
|
||||
*
|
||||
* @return int Значение ключа JSON или значение по умолчанию.
|
||||
*/
|
||||
public function ReadInt (string $key, int $default = 0): int
|
||||
{
|
||||
return (int)$this->Read($key, $default);
|
||||
}
|
||||
|
||||
/**
|
||||
* Читает значение ключа JSON.
|
||||
*
|
||||
* @param string $key Ключ JSON.
|
||||
* @param mixed $default Значение по умолчанию.
|
||||
*
|
||||
* @return mixed Значение ключа JSON или значение по умолчанию.
|
||||
*/
|
||||
public function Read (string $key, mixed $default = null): mixed
|
||||
{
|
||||
// Подготавливаем ключ
|
||||
$key = $this->PrepareKey($key);
|
||||
|
||||
// Проверяем, существует ли ключ
|
||||
if (!$this->IsKeyExists($key))
|
||||
// - если нет, то возвращаем значение по умолчанию
|
||||
return $default;
|
||||
|
||||
// Разбиваем ключ на массив ключей
|
||||
$keys = $this->ParseKey($key);
|
||||
|
||||
// Получаем текущий массив данных
|
||||
$current = $this->JsonData;
|
||||
|
||||
// Для каждого ключа до предпоследнего
|
||||
for ($i = 0; $i < count($keys) - 1; $i++)
|
||||
// - переходим ко вложенному массиву
|
||||
$current = $current[$keys[$i]];
|
||||
|
||||
// Возвращаем значение последнего ключа и если его нет, то возвращаем значение по умолчанию
|
||||
return $current[$keys[count($keys) - 1]] ?? $default;
|
||||
}
|
||||
|
||||
/**
|
||||
* Читает значение ключа JSON как вещественное число.
|
||||
*
|
||||
* @param string $key Ключ JSON.
|
||||
* @param float $default Значение по умолчанию.
|
||||
*
|
||||
* @return float Значение ключа JSON или значение по умолчанию.
|
||||
*/
|
||||
public function ReadFloat (string $key, float $default = 0.0): float
|
||||
{
|
||||
return (float)$this->Read($key, $default);
|
||||
}
|
||||
|
||||
/**
|
||||
* Читает значение ключа JSON как логическое значение.
|
||||
*
|
||||
* @param string $key Ключ JSON.
|
||||
* @param bool $default Значение по умолчанию.
|
||||
*
|
||||
* @return bool Значение ключа JSON или значение по умолчанию.
|
||||
*/
|
||||
public function ReadBool (string $key, bool $default = false): bool
|
||||
{
|
||||
return (bool)$this->Read($key, $default);
|
||||
}
|
||||
|
||||
/**
|
||||
* Читает значение ключа JSON как массив.
|
||||
*
|
||||
* @param string $key Ключ JSON.
|
||||
* @param array $default Значение по умолчанию.
|
||||
*
|
||||
* @return array Значение ключа JSON или значение по умолчанию.
|
||||
*/
|
||||
public function ReadArray (string $key, array $default = []): array
|
||||
{
|
||||
// Получаем значение ключа JSON
|
||||
$serializedDef = json_encode($default);
|
||||
|
||||
// Читаем значение ключа JSON
|
||||
$value = $this->ReadString($key, $serializedDef);
|
||||
|
||||
// Десериализуем значение ключа JSON
|
||||
return json_decode($value, true);
|
||||
}
|
||||
|
||||
/**
|
||||
* Читает значение ключа JSON как строку.
|
||||
*
|
||||
* @param string $key Ключ JSON.
|
||||
* @param string $default Значение по умолчанию.
|
||||
*
|
||||
* @return string Значение ключа JSON или значение по умолчанию.
|
||||
*/
|
||||
public function ReadString (string $key, string $default = ""): string
|
||||
{
|
||||
return (string)$this->Read($key, $default);
|
||||
}
|
||||
|
||||
/**
|
||||
* Читает значение ключа JSON как объект.
|
||||
*
|
||||
* @param string $key Ключ JSON.
|
||||
* @param object $default Значение по умолчанию.
|
||||
*
|
||||
* @return object Значение ключа JSON или значение по умолчанию.
|
||||
*/
|
||||
public function ReadObject (string $key, object $default): object
|
||||
{
|
||||
// Получаем значение ключа JSON
|
||||
$serializedDef = json_encode($default);
|
||||
|
||||
// Читаем значение ключа JSON
|
||||
$value = $this->ReadString($key, $serializedDef);
|
||||
|
||||
// Десериализуем значение ключа JSON
|
||||
return json_decode($value);
|
||||
}
|
||||
|
||||
/**
|
||||
* Читает значение ключа JSON как объект, реализующий интерфейс ISerializable.
|
||||
*
|
||||
* @param string $key Ключ JSON.
|
||||
* @param string $serializableClassName Имя класса, реализующего интерфейс ISerializable, с namespace.
|
||||
*
|
||||
* @return ISerializable Инициализированный объект
|
||||
* @throws JsonException Если класс не реализует интерфейс ISerializable
|
||||
*/
|
||||
public function ReadSerializable (string $key, string $serializableClassName): ISerializable
|
||||
{
|
||||
// Создаем объект
|
||||
$instance = new $serializableClassName();
|
||||
|
||||
// Проверяем, что он реализует интерфейс ISerializable
|
||||
if (!$instance instanceof ISerializable)
|
||||
// - если нет, то выбрасываем исключение
|
||||
throw new JsonException(errorCode: JsonErrorCode::NotISerializable,
|
||||
errorMessage: "Class $serializableClassName is not implements ISerializable interface / Класс $serializableClassName не реализует интерфейс ISerializable");
|
||||
|
||||
// Получаем строку JSON из ключа
|
||||
$json = $this->ReadString($key, $instance->Serialize());
|
||||
|
||||
// Десериализуем строку JSON в объект
|
||||
$instance->UnSerialize($json);
|
||||
|
||||
// Возвращаем объект
|
||||
return $instance;
|
||||
}
|
||||
}
|
109
sources/traits/JsonReWriter/JsonReWriterWriteTrait.php
Normal file
109
sources/traits/JsonReWriter/JsonReWriterWriteTrait.php
Normal file
@ -0,0 +1,109 @@
|
||||
<?php
|
||||
|
||||
namespace goodboyalex\php_components_pack\traits\JsonReWriter;
|
||||
|
||||
use goodboyalex\php_components_pack\enums\JsonErrorCode;
|
||||
use goodboyalex\php_components_pack\exceptions\JsonException;
|
||||
use goodboyalex\php_components_pack\interfaces\ISerializable;
|
||||
|
||||
/**
|
||||
* Часть кода класса JsonReWriter, отвечающая за методы записи ключей и значений JSON.
|
||||
*
|
||||
* @author Александр Бабаев
|
||||
* @package php_components_pack
|
||||
* @version 1.0
|
||||
* @since 1.1.0
|
||||
*/
|
||||
trait JsonReWriterWriteTrait
|
||||
{
|
||||
/**
|
||||
* Записывает объект в ключ JSON.
|
||||
*
|
||||
* @param string $key Ключ JSON.
|
||||
* @param object $value Записываемое значение.
|
||||
*
|
||||
* @return void
|
||||
* @throws JsonException Ключ не содержит вложений, хотя от него требуется обратное.
|
||||
*/
|
||||
public function WriteObject (string $key, object $value): void
|
||||
{
|
||||
$this->Write($key, json_encode($value));
|
||||
}
|
||||
|
||||
/**
|
||||
* Записывает значение в ключ JSON.
|
||||
*
|
||||
* @param string $key Ключ JSON.
|
||||
* @param mixed $value Записываемое значение.
|
||||
*
|
||||
* @return void
|
||||
* @throws JsonException Ключ не содержит вложений, хотя от него требуется обратное.
|
||||
*/
|
||||
public function Write (string $key, mixed $value): void
|
||||
{
|
||||
// Подготавливаем ключ
|
||||
$key = $this->PrepareKey($key);
|
||||
|
||||
// Получаем массив ключей по вложенности
|
||||
$keys = $this->ParseKey($key);
|
||||
|
||||
// Получаем текущий массив данных
|
||||
$current = &$this->JsonData;
|
||||
|
||||
// Для каждого ключа до предпоследнего
|
||||
for ($i = 0; $i < count($keys) - 1; $i++) {
|
||||
// - проверяем наличие ключа в текущем массиве
|
||||
if (!isset($current[$keys[$i]]))
|
||||
// - нет? Создаем ключ (массив)
|
||||
$current[$keys[$i]] = [];
|
||||
|
||||
// - проверяем, что ключ является массивом
|
||||
if (!is_array($current[$keys[$i]]))
|
||||
// - нет? Выбрасываем исключение
|
||||
throw new JsonException(errorCode: JsonErrorCode::KeyIsNotArray,
|
||||
errorMessage: "The key does not contain attachments, although it is required to do the opposite / Ключ не содержит вложений, хотя от него требуется обратное!");
|
||||
|
||||
// - переходим ко вложенному массиву
|
||||
$current = &$current[$keys[$i]];
|
||||
}
|
||||
|
||||
// Создаем ключ (значение)
|
||||
$current[$keys[count($keys) - 1]] = $value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Записывает объект, реализующий интерфейс ISerializable, в ключ JSON.
|
||||
*
|
||||
* @param string $key Ключ JSON.
|
||||
* @param ISerializable $serializableValue Записываемый объект, реализующий интерфейс ISerializable.
|
||||
*
|
||||
* @return void
|
||||
* @throws JsonException Ключ не содержит вложений, хотя от него требуется обратное.
|
||||
*/
|
||||
public function WriteSerializable (string $key, ISerializable $serializableValue): void
|
||||
{
|
||||
// Сериализуем объект
|
||||
$serialized = $serializableValue->Serialize();
|
||||
|
||||
// Записываем в ключ
|
||||
$this->Write($key, $serialized);
|
||||
}
|
||||
|
||||
/**
|
||||
* Записывает массив в ключ JSON.
|
||||
*
|
||||
* @param string $key Ключ JSON.
|
||||
* @param array $array Массив для записи.
|
||||
*
|
||||
* @return void
|
||||
* @throws JsonException Ключ не содержит вложений, хотя от него требуется обратное.
|
||||
*/
|
||||
public function WriteArray (string $key, array $array): void
|
||||
{
|
||||
// Сериализуем массив
|
||||
$serialized = json_encode($array);
|
||||
|
||||
// Записываем в ключ
|
||||
$this->Write($key, $serialized);
|
||||
}
|
||||
}
|
@ -196,8 +196,7 @@ trait ObjectArrayLINQTrait
|
||||
$result = $this->Delete($wherePredicate);
|
||||
|
||||
// Добавляю новые элементы
|
||||
foreach ($setItems as $item)
|
||||
$this->Container[] = $item;
|
||||
$this->AddRange($setItems);
|
||||
|
||||
// Возвращаю результат
|
||||
return $result;
|
||||
|
81
sources/traits/ObjectArray/ObjectArraySpecialTrait.php
Normal file
81
sources/traits/ObjectArray/ObjectArraySpecialTrait.php
Normal file
@ -0,0 +1,81 @@
|
||||
<?php
|
||||
|
||||
namespace goodboyalex\php_components_pack\traits\ObjectArray;
|
||||
|
||||
use goodboyalex\php_components_pack\classes\ObjectArray;
|
||||
|
||||
/**
|
||||
* Часть кода класса ObjectArray, отвечающая за специальные функции.
|
||||
*
|
||||
* @author Александр Бабаев
|
||||
* @package php_components_pack
|
||||
* @version 1.0
|
||||
* @since 1.0
|
||||
*/
|
||||
trait ObjectArraySpecialTrait
|
||||
{
|
||||
/**
|
||||
* Очищает массив объектов, хранящийся в данном классе.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function Clear (): void
|
||||
{
|
||||
// Очищаем массив
|
||||
unset($this->Container);
|
||||
|
||||
// Создаем новый массив
|
||||
$this->Container = [];
|
||||
}
|
||||
|
||||
/**
|
||||
* Добавляет объект в массив объектов, хранящийся в данном классе (аналогично добавлению элемента в массив с
|
||||
* помощью []).
|
||||
*
|
||||
* @param mixed $object Объект, который будет добавлен в массив объектов, хранящийся в данном классе.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function Add (mixed $object): void
|
||||
{
|
||||
$this->Container[] = $object;
|
||||
}
|
||||
|
||||
/**
|
||||
* Добавляет массив объектов (или объекты, заданные с помощью array) в массив объектов, хранящийся в данном классе.
|
||||
*
|
||||
* @param ObjectArray|array $objects Массив объектов, которые будут добавлены в массив объектов.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function AddRange (ObjectArray|array $objects): void
|
||||
{
|
||||
// Если передан массив, то не изменяем его, а если передан объект класса ObjectArray, то конвертируем его в массив объектов
|
||||
$objectsToAdd = is_array($objects) ? $objects : $objects->ToArray();
|
||||
|
||||
// Добавляем массив объектов
|
||||
$this->Merge($objectsToAdd);
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает массив объектов, хранящихся в данном классе.
|
||||
*
|
||||
* @return array Массив объектов, хранящихся в данном классе.
|
||||
*/
|
||||
public function ToArray (): array
|
||||
{
|
||||
return $this->Container;
|
||||
}
|
||||
|
||||
/**
|
||||
* Объединяет массив объектов, хранящийся в данном классе, с массивом объектов, переданным в качестве параметра.
|
||||
*
|
||||
* @param array $objects Массив объектов, который будет объединен с массивом объектов, хранящимся в данном классе.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function Merge (array $objects): void
|
||||
{
|
||||
$this->Container = array_merge($this->Container, $objects);
|
||||
}
|
||||
}
|
119
sources/types/BoolEx.php
Normal file
119
sources/types/BoolEx.php
Normal file
@ -0,0 +1,119 @@
|
||||
<?php
|
||||
|
||||
namespace goodboyalex\php_components_pack\types;
|
||||
|
||||
/**
|
||||
* Тип-расширение для типа bool.
|
||||
*
|
||||
* @author Александр Бабаев
|
||||
* @package php_components_pack
|
||||
* @version 1.0
|
||||
* @since 1.1.1
|
||||
*/
|
||||
final class BoolEx
|
||||
{
|
||||
/**
|
||||
* @var int $False Значение "ложь".
|
||||
*/
|
||||
public const int False = -1;
|
||||
|
||||
/**
|
||||
* @var int $Null Значение не установлено (и не истина, и не ложь).
|
||||
*/
|
||||
public const int Null = 0;
|
||||
|
||||
/**
|
||||
* @var int $True Значение "истина".
|
||||
*/
|
||||
public const int True = 1;
|
||||
|
||||
/**
|
||||
* @var int $Value Хранимое значение.
|
||||
*/
|
||||
private int $Value;
|
||||
|
||||
public function __construct (?bool $value = null)
|
||||
{
|
||||
// Присваиваем значение
|
||||
$this->Value = $value === null ? self::Null : ($value ? self::True : self::False);
|
||||
}
|
||||
|
||||
/**
|
||||
* Преобразует значение в экземпляр типа.
|
||||
*
|
||||
* ВАЖНО: при преобразовании в тип будет использована следующая логика:
|
||||
*
|
||||
* - <code>'true'</code>, <code>'1'</code>, <code>'on'</code>, <code>'yes'</code>, <code>'y'</code>,
|
||||
* <code>'t'</code>, <code>true</code>, <code>1</code>, <code>1.0</code> считаются как истина;
|
||||
* - <code>'false'</code>, <code>'0'</code>, <code>'off'</code>, <code>'no'</code>, <code>'n'</code>,
|
||||
* <code>'f'</code>, <code>false</code>, <code>-1</code>, <code>-1.0</code> считаются как ложь;
|
||||
* - все остальные значения считаются как неустановленною (и не истина, и не ложь).
|
||||
*
|
||||
* @param mixed $value Значение.
|
||||
*
|
||||
* @return BoolEx Возвращает экземпляр типа.
|
||||
*/
|
||||
public static function Parse (mixed $value): BoolEx
|
||||
{
|
||||
// Преобразуем значение в тип
|
||||
$value = match ($value) {
|
||||
'true', '1', 'on', 'yes', 'y', 't', true, 1, 1.0 => self::True,
|
||||
'false', '0', 'off', 'no', 'n', 'f', false, -1, -1.0 => self::False,
|
||||
default => self::Null
|
||||
};
|
||||
|
||||
// Создаем экземпляр типа
|
||||
return new BoolEx($value);
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверяет, является ли значение ложью.
|
||||
*
|
||||
* @return bool Возвращает, является ли значение ложью.
|
||||
*/
|
||||
public function IsFalse (): bool
|
||||
{
|
||||
return $this->Value === self::False;
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверяет, является ли значение истиной.
|
||||
*
|
||||
* @return bool Возвращает, является ли значение истиной.
|
||||
*/
|
||||
public function IsTrue (): bool
|
||||
{
|
||||
return $this->Value === self::True;
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает строковое представление значения.
|
||||
*
|
||||
* @return string Возвращает строковое представление значения.
|
||||
*/
|
||||
public function __toString (): string
|
||||
{
|
||||
// Преобразуем значение в строку
|
||||
return match ($this->Value) {
|
||||
self::True => "true",
|
||||
self::False => "false",
|
||||
self::Null => "null"
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Конвертирует значение в bool.
|
||||
*
|
||||
* @param bool $onNull Значение, возвращаемое при неустановленном значении.
|
||||
*
|
||||
* @return bool Возвращает значение, конвертированное в bool.
|
||||
*/
|
||||
public function AsBool (bool $onNull = false): bool
|
||||
{
|
||||
return match ($this->Value) {
|
||||
self::True => true,
|
||||
self::False => false,
|
||||
default => $onNull
|
||||
};
|
||||
}
|
||||
}
|
710
sources/types/JsonReWriter.md
Normal file
710
sources/types/JsonReWriter.md
Normal file
@ -0,0 +1,710 @@
|
||||
# Описание класса JsonReWriter
|
||||
|
||||
## Информация о версии
|
||||
|
||||
Версия класса: 1.0
|
||||
|
||||
Впервые введено в пакет с версии: 1.1.0
|
||||
|
||||
Описание класса: Класс для работы с JSON-файлами.
|
||||
|
||||
## Публичные свойства и константы класса
|
||||
|
||||
В классе определены следующие свойства:
|
||||
|
||||
- `string $JsonString` - строка JSON (чтение/запись).
|
||||
|
||||
## Быстрый старт
|
||||
|
||||
### Правила формирования ключей.
|
||||
|
||||
Ключ для чтения/записи данных класса формируется следующим образом: `ключ/подключ/подключ подключа` .
|
||||
|
||||
Например, если дан json-файл:
|
||||
|
||||
{
|
||||
"test": {
|
||||
"subtest": {
|
||||
"AAA": "123",
|
||||
"BBB": 1.23
|
||||
}
|
||||
},
|
||||
"test1": {
|
||||
"test": 123
|
||||
},
|
||||
"test2": {
|
||||
"test": true
|
||||
},
|
||||
"test3": {
|
||||
"test": {
|
||||
"res": "[1,2,3]"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Пусть требуется получить значение `BBB`, тогда ключ должен быть `test/subtest/BBB`.
|
||||
|
||||
### Чтение.
|
||||
|
||||
1. Создайте элемент класса `$json = new JsonReWriter ();`
|
||||
2. Если у вас требуется загрузить json из файла `$fileName`, то воспользуйтесь методом `LoadFromFile`:
|
||||
`$json->LoadFromFile($fileName);`, если же json представлен строкой `$jsonStr`, то загрузите её в свойство
|
||||
`$JsonString`: `$json->JsonString = $jsonStr;`
|
||||
3. Далее можно пользоваться любым методом для чтения `Read*`, в том числе и общим `$json->Read(...)`.
|
||||
|
||||
**Пример:**
|
||||
|
||||
// Имя файла
|
||||
$fileName = __DIR__ . "/test.json";
|
||||
// Создаю класс
|
||||
$json = new JsonReWriter();
|
||||
// Загшружаю данные из файла
|
||||
$json->LoadFromFile($fileName);
|
||||
// Получаю число
|
||||
$float = $json->ReadFloat("test/subtest/BBB", 0.2);
|
||||
|
||||
В итоге в `$float` будет `1.23`.
|
||||
|
||||
### Запись.
|
||||
|
||||
1. Создайте элемент класса `$json = new JsonReWriter ();`
|
||||
2. Далее можно пользоваться любым методом для записи `Write*`, в том числе и общим `$json->Write(...)`.
|
||||
3. Если вам требуется создать json файл с именем `$fileName`, то воспользуйтесь методом `SaveToFile`:
|
||||
`$json->SaveToFile($fileName);`, если же json должен быть представлен строкой `$jsonStr`, то загрузите её из свойства
|
||||
`$JsonString`: `$jsonStr = $json->JsonString;`
|
||||
|
||||
**Пример:**
|
||||
|
||||
// Имя файла
|
||||
$fileName = __DIR__ . "/test.json";
|
||||
// Создаю класс
|
||||
$json = new JsonReWriter();
|
||||
// Загшружаю данные из файла
|
||||
$json->LoadFromFile($fileName);
|
||||
// Получаю число
|
||||
try {
|
||||
$json->Write("test/subtest/BBB", 0.2);
|
||||
}
|
||||
catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
|
||||
В итоге в `test/subtest/BBB` вместо `1.23` будет `0.2`.
|
||||
|
||||
## Коды ошибок JsonErrorCode
|
||||
|
||||
Ниже представлена таблица основных кодов ошибки:
|
||||
|
||||
| Ошибка | Описание | Введено с версии |
|
||||
|:-------------------:|:---------------------------------------------------------------------------:|:----------------:|
|
||||
| Unknown | Неизвестная ошибка | 1.0 |
|
||||
| None | Ошибок нет | 1.0 |
|
||||
| Depth | Достигнута максимальная глубина стека | 1.0 |
|
||||
| StateMismatch | Неверный или некорректный JSON | 1.0 |
|
||||
| CTRLChar | Ошибка управляющего символа, возможно, неверная кодировка | 1.0 |
|
||||
| Syntax | Синтаксическая ошибка | 1.0 |
|
||||
| UTF8 | Некорректные для кодировки UTF-8 символы, возможно, неверная кодировка | 1.0 |
|
||||
| Recursion | Одна или несколько зацикленных ссылок в кодируемом значении | 1.0 |
|
||||
| InfOrNan | Одно или несколько значений NAN или INF в кодируемом значении | 1.0 |
|
||||
| UnsupportedType | Передали значение с неподдерживаемым типом | 1.0 |
|
||||
| InvalidPropertyName | Имя свойства не может быть закодировано | 1.0 |
|
||||
| UTF16 | Некорректный для кодировки UTF-16 символ, возможно, некорректно закодирован | 1.0 |
|
||||
| KeyIsNotArray | Ключ не содержит вложений, хотя от него требуется обратное | 1.0 |
|
||||
| NotISerializable | Класс не реализует интерфейс ISerializable | 1.0 |
|
||||
|
||||
### Методы и функции перечисления JsonErrorCode
|
||||
|
||||
Перечисление содержит **статический метод** `static function FromLastError (): JsonErrorCode`, который получает код
|
||||
ошибки из последней JSON ошибки.
|
||||
|
||||
Например, при успешной загрузке, можем проверить ошибки:
|
||||
|
||||
$errors = JsonErrorCode::FromLastError ();
|
||||
|
||||
После того, как мы выведем `$errors`, мы получим `JsonErrorCode::None`.
|
||||
|
||||
## Исключение JsonException
|
||||
|
||||
Исключение расширяет класс `Exception`, поэтому может выбрасываться через `throw`.
|
||||
|
||||
### Свойства
|
||||
|
||||
Исключение содержит следующие свойства:
|
||||
|
||||
- `?string $JsonString` - строка JSON (или null);
|
||||
- `JsonErrorCode $ErrorCode` - код ошибки JSON;
|
||||
- `?string $ErrorMessage` - сообщение об ошибке JSON (в отличие от функции json_last_error_msg(), данная переменная при
|
||||
отсутствии ошибок выводит null, а не "No error").
|
||||
|
||||
### Методы и функции
|
||||
|
||||
#### Конструктор.
|
||||
|
||||
Конструктор принимает **3 необязательных параметра**:
|
||||
|
||||
* `?string $json` - строка JSON (по умолчанию, `null`);
|
||||
* `JsonErrorCode $errorCode` - код ошибки (по умолчанию, `JsonErrorCode::Unknown`);
|
||||
* `?string $errorMessage` - сообщение об ошибке (по умолчанию, `null`).
|
||||
|
||||
В результате создаётся новое исключение `JsonException`.
|
||||
|
||||
Пример:
|
||||
|
||||
throw new JsonException("{}", JsonErrorCode::Depth, "Пример");
|
||||
|
||||
Создаст исключение `JsonException`.
|
||||
|
||||
## Методы и функции
|
||||
|
||||
### Конструктор и деструктор.
|
||||
|
||||
Конструктор не принимает никаких параметров.
|
||||
|
||||
В результате создаётся новый класс `JsonReWriter`.
|
||||
|
||||
**Пример:**
|
||||
|
||||
// Контсуктор
|
||||
$json = new JsonReWriter ();
|
||||
// Деструктор
|
||||
unset($json);
|
||||
|
||||
Создаст и уничтожит класс `JsonReWriter`.
|
||||
|
||||
### Сохранение и загрузка из файла.
|
||||
|
||||
За сохранение и загрузку отвечают 2 метода: `SaveToFile` и `LoadFromFile`.
|
||||
|
||||
#### Сохранение в файл (метод `SaveToFile`)
|
||||
|
||||
Этот метод сохраняет содержимое JSON в файл. Он содержит **1 обязательный параметр**:
|
||||
|
||||
* `string $fileName` - имя файла на диске.
|
||||
|
||||
Метод возвращает `bool` - сохранены ли данные в файл: `true` - да, `false` - нет.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function SaveToFile (string $fileName): bool
|
||||
|
||||
**Пример:**
|
||||
|
||||
// Имя файла
|
||||
$fileName = __DIR__ . "/test.json";
|
||||
// Создаём класс
|
||||
$json = new JsonReWriter();
|
||||
// Заполним данными
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
$json->Write("test/subtest/BBB", 1.23);
|
||||
$json->Write("test1/test", 123);
|
||||
$json->Write("test2/test", true);
|
||||
$json->WriteArray("test3/test/res", [1, 2, 3]);
|
||||
} catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
// Сохраняем созданный JSON файл
|
||||
$json->SaveToFile($fileName);
|
||||
|
||||
Содержимое файла `test.json` представлено далее:
|
||||
|
||||
{
|
||||
"test": {
|
||||
"subtest": {
|
||||
"AAA": "123",
|
||||
"BBB": 1.23
|
||||
}
|
||||
},
|
||||
"test1": {
|
||||
"test": 123
|
||||
},
|
||||
"test2": {
|
||||
"test": true
|
||||
},
|
||||
"test3": {
|
||||
"test": {
|
||||
"res": "[1,2,3]"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#### Загрузка файла (метод `LoadFromFile`)
|
||||
|
||||
Этот метод загружает содержимое файла в класс. Он содержит **1 обязательный параметр**:
|
||||
|
||||
* `string $fileName` - имя файла на диске.
|
||||
|
||||
Метод возвращает `bool` - загружены ли данные из файла: `true` - да, `false` - нет.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function LoadFromFile (string $fileName): bool
|
||||
|
||||
**Пример:**
|
||||
Пусть дан файл `test.json`, содержимое которого представлено далее:
|
||||
|
||||
{
|
||||
"test": {
|
||||
"subtest": {
|
||||
"AAA": "123",
|
||||
"BBB": 1.23
|
||||
}
|
||||
},
|
||||
"test1": {
|
||||
"test": 123
|
||||
},
|
||||
"test2": {
|
||||
"test": true
|
||||
},
|
||||
"test3": {
|
||||
"test": {
|
||||
"res": "[1,2,3]"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Следующий код загрузит это содержимое в класс:
|
||||
|
||||
// Имя файла
|
||||
$fileName = __DIR__ . "/test.json";
|
||||
// Создаём класс
|
||||
$json = new JsonReWriter();
|
||||
// Загружаю данные
|
||||
$json->LoadFromFile($fileName);
|
||||
|
||||
### Чтение данных
|
||||
|
||||
Для чтения данных используется один общий метод `Read` и 7 его производных метода: `ReadString`, `ReadInt`, `ReadFloat`,
|
||||
`ReadBool`, `ReadArray`, `ReadObject` и `ReadSerializable`.
|
||||
|
||||
#### Метод `Read`
|
||||
|
||||
Это метод, который читает значение ключа JSON. Он имеет **1 обязательный параметр** `string $key` (ключ) и **1
|
||||
необязательный параметр** `mixed $default` (значение по умолчанию, задан по умолчанию в `null`).
|
||||
|
||||
Этот метод возвращает `mixed`: значение ключа JSON или значение по умолчанию.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function Read (string $key, mixed $default = null): mixed
|
||||
|
||||
**Пример,**
|
||||
|
||||
// Создаю класс
|
||||
$json = new JsonReWriter();
|
||||
// Заполняю данными
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
$json->Write("test/subtest/BBB", 1.23);
|
||||
$json->Write("test1/test", 123);
|
||||
$json->Write("test2/test", true);
|
||||
$json->Write("test3/test/res", json_encode([1, 2, 3]));
|
||||
} catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
|
||||
// Получаю значение
|
||||
$float = (float)$json->Read("test/subtest/BBB"));
|
||||
|
||||
В результате, переменная `$float` будет иметь значение `1.23`.
|
||||
|
||||
#### Метод `ReadString`
|
||||
|
||||
Это метод, который читает значение ключа JSON. Он имеет **1 обязательный параметр** `string $key` (ключ) и **1
|
||||
необязательный параметр** `string $default` (значение по умолчанию, задан по умолчанию в `""`).
|
||||
|
||||
Этот метод возвращает `string`: значение ключа JSON или значение по умолчанию.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function ReadString (string $key, string $default = ""): string
|
||||
|
||||
#### Метод `ReadInt`
|
||||
|
||||
Это метод, который читает значение ключа JSON. Он имеет **1 обязательный параметр** `string $key` (ключ) и **1
|
||||
необязательный параметр** `int $default` (значение по умолчанию, задан по умолчанию в `0`).
|
||||
|
||||
Этот метод возвращает `int`: значение ключа JSON или значение по умолчанию.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function ReadInt (string $key, int $default = 0): int
|
||||
|
||||
#### Метод `ReadFloat`
|
||||
|
||||
Это метод, который читает значение ключа JSON. Он имеет **1 обязательный параметр** `string $key` (ключ) и **1
|
||||
необязательный параметр** `float $default` (значение по умолчанию, задан по умолчанию в `0.0`).
|
||||
|
||||
Этот метод возвращает `float`: значение ключа JSON или значение по умолчанию.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function ReadFloat (string $key, float $default = 0.0): float
|
||||
|
||||
#### Метод `ReadBool`
|
||||
|
||||
Это метод, который читает значение ключа JSON. Он имеет **1 обязательный параметр** `string $key` (ключ) и **1
|
||||
необязательный параметр** `bool $default` (значение по умолчанию, задан по умолчанию в `false`).
|
||||
|
||||
Этот метод возвращает `bool`: значение ключа JSON или значение по умолчанию.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function ReadBool (string $key, bool $default = false): bool
|
||||
|
||||
#### Метод `ReadArray`
|
||||
|
||||
Это метод, который читает значение ключа JSON. Он имеет **1 обязательный параметр** `string $key` (ключ) и **1
|
||||
необязательный параметр** `array $default` (значение по умолчанию, задан по умолчанию в `[]`).
|
||||
|
||||
Этот метод возвращает `array`: значение ключа JSON или значение по умолчанию.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function ReadArray (string $key, array $default = []): array
|
||||
|
||||
#### Метод `ReadObject`
|
||||
|
||||
Это метод, который читает значение ключа JSON. Он имеет **2 обязательных параметра**:
|
||||
|
||||
- `string $key` (ключ);
|
||||
- `object $default` (значение по умолчанию).
|
||||
|
||||
Этот метод возвращает `object`: значение ключа JSON или значение по умолчанию.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function ReadObject (string $key, object $default): object
|
||||
|
||||
#### Метод `ReadSerializable`
|
||||
|
||||
Это метод, который читает значение ключа JSON. Он имеет **2 обязательных параметра**:
|
||||
|
||||
- `string $key` (ключ);
|
||||
- `string $serializableClassName` (имя класса, реализующего интерфейс ISerializable, с namespace).
|
||||
|
||||
Этот метод возвращает класс, реализующий интерфейс `ISerializable`.
|
||||
|
||||
**Важно!** Этот метод может выбросить исключение `JsonException`, если класс, заданный в `$serializableClassName` не
|
||||
реализует интерфейс `ISerializable`.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function ReadSerializable (string $key, string $serializableClassName): ISerializable
|
||||
|
||||
**Пример,**
|
||||
|
||||
Пусть для примера, класс `Demo` из namespace `iam\namespace` реализует интерфейс `ISerializable`.
|
||||
|
||||
// Создаю класс
|
||||
$json = new JsonReWriter();
|
||||
// ... Здесь где-то загрузка данных
|
||||
// Получаю класс
|
||||
try {
|
||||
/**
|
||||
* @var Demo $unSerializableClass
|
||||
*/
|
||||
$unSerializableClass = $json->ReadSerializable("test", "iam\\namespace\\Demo");
|
||||
} catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
|
||||
В результате, переменная `$unSerializableClass` будет содержать данные класса `Demo`.
|
||||
|
||||
### Запись данных
|
||||
|
||||
Для чтения данных используется один общий метод `Write` и 3 его производных метода: `WriteArray`, `WriteObject` и
|
||||
`WriteSerializable`.
|
||||
|
||||
**Важно!** Лобой из вышеуказанных методов может выбросить исключение `JsonException`, если ключ не содержит вложений,
|
||||
хотя от него требуется обратное.
|
||||
|
||||
#### Метод `Write`
|
||||
|
||||
Это метод, который записывает значение в ключ JSON. Он имеет **2 обязательных параметра**:
|
||||
|
||||
- `string $key` (ключ);
|
||||
- `mixed $value` (записываемое значение).
|
||||
|
||||
Этот метод ничего не возвращает.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function Write (string $key, mixed $value): void
|
||||
|
||||
**Пример,**
|
||||
|
||||
// Имя файла
|
||||
$fileName = __DIR__ . "/test.json";
|
||||
// Создаём класс
|
||||
$json = new JsonReWriter();
|
||||
// Заполним данными
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
$json->Write("test/subtest/BBB", 1.23);
|
||||
$json->Write("test1/test", 123);
|
||||
$json->Write("test2/test", true);
|
||||
$json->WriteArray("test3/test/res", [1, 2, 3]);
|
||||
} catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
// Сохраняем созданный JSON файл
|
||||
$json->SaveToFile($fileName);
|
||||
|
||||
Содержимое файла `test.json` представлено далее:
|
||||
|
||||
{
|
||||
"test": {
|
||||
"subtest": {
|
||||
"AAA": "123",
|
||||
"BBB": 1.23
|
||||
}
|
||||
},
|
||||
"test1": {
|
||||
"test": 123
|
||||
},
|
||||
"test2": {
|
||||
"test": true
|
||||
},
|
||||
"test3": {
|
||||
"test": {
|
||||
"res": "[1,2,3]"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#### Метод `WriteArray`
|
||||
|
||||
Это метод, который записывает значение в ключ JSON. Он имеет **2 обязательных параметра**:
|
||||
|
||||
- `string $key` (ключ);
|
||||
- `array $array` (записываемое значение).
|
||||
|
||||
Этот метод ничего не возвращает.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function WriteArray (string $key, array $array): void
|
||||
|
||||
#### Метод `WriteObject`
|
||||
|
||||
Это метод, который записывает значение в ключ JSON. Он имеет **2 обязательных параметра**:
|
||||
|
||||
- `string $key` (ключ);
|
||||
- `object $value` (записываемое значение).
|
||||
|
||||
Этот метод ничего не возвращает.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function WriteObject (string $key, object $value): void
|
||||
|
||||
#### Метод `WriteSerializable`
|
||||
|
||||
Это метод, который записывает значение в ключ JSON. Он имеет **2 обязательных параметра**:
|
||||
|
||||
- `string $key` (ключ);
|
||||
- `ISerializable $serializableValue` (записываемое значение).
|
||||
|
||||
Этот метод ничего не возвращает.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function WriteSerializable (string $key, ISerializable $serializableValue): void
|
||||
|
||||
**Пример,**
|
||||
Пусть для примера, класс `Demo` из namespace `iam\namespace` реализует интерфейс `ISerializable`.
|
||||
|
||||
// Имя файла
|
||||
$fileName = __DIR__ . "/test.json";
|
||||
// Создаём класс
|
||||
$json = new JsonReWriter();
|
||||
// Создаём класс Demo
|
||||
$serializableClass = new Demo(...);
|
||||
// Заполним данными
|
||||
try {
|
||||
$json->WriteSerializable("test", $serializableClass);
|
||||
} catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
...
|
||||
|
||||
### Работа с ключами JSON
|
||||
|
||||
Для работы с ключами JSON есть 2 метода: `IsKeyExists` и `GetKeys`.
|
||||
|
||||
#### Метод `IsKeyExists`
|
||||
|
||||
Это метод проверяем наличие ключа в JSON. Он имеет **1 обязательный параметр** - `string $key` (ключ).
|
||||
|
||||
Этот метод возвращает `bool`: `true` если ключ найден и `false` в противном случае.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function IsKeyExists (string $key): bool
|
||||
|
||||
**Пример,**
|
||||
|
||||
// Создаём класс
|
||||
$json = new JsonReWriter();
|
||||
// Заполним данными
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
$json->Write("test/subtest/BBB", 1.23);
|
||||
$json->Write("test1/test", 123);
|
||||
$json->Write("test2/test", true);
|
||||
$json->WriteArray("test3/test/res", [1, 2, 3]);
|
||||
} catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
// Проверяем ключи
|
||||
$check1 = $json->IsKeyExists("test/subtest/AAA");
|
||||
$check2 = $json->IsKeyExists("test/subtest/ССС");
|
||||
|
||||
В результате, `$check1` будет `true`, а `$check2` - `false`.
|
||||
|
||||
#### Метод `GetKeys`
|
||||
|
||||
Это метод получает список ключей. Он имеет **2 необязательных параметра**:
|
||||
|
||||
- `string $parentKey` (ключ родителя (или "" (установлено по умолчанию) для всех);
|
||||
- `bool $includeChildren` (нужно ли включать дочерние ключи (по умолчанию, да)).
|
||||
|
||||
Этот метод возвращает `array`: список ключей.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function GetKeys (string $parentKey = "", bool $includeChildren = true): array
|
||||
|
||||
**Пример,**
|
||||
|
||||
// Создаём класс
|
||||
$json = new JsonReWriter();
|
||||
// Заполним данными
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
$json->Write("test/subtest/BBB", 1.23);
|
||||
$json->Write("test1/test", 123);
|
||||
$json->Write("test2/test", true);
|
||||
$json->WriteArray("test3/test/res", [1, 2, 3]);
|
||||
} catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
// Получаем ключи
|
||||
$keys1 = $json->GetKeys("test");
|
||||
$keys2 = $json->GetKeys("test", false);
|
||||
$keys3 = $json->GetKeys();
|
||||
|
||||
В результате, `$key1` будет следующим массивом:
|
||||
|
||||
[
|
||||
"test/subtest",
|
||||
"test/subtest/AAA",
|
||||
"test/subtest/BBB"
|
||||
]
|
||||
|
||||
`$key2` будет следующим массивом:
|
||||
|
||||
[
|
||||
"subtest"
|
||||
]
|
||||
|
||||
`$key3` будет следующим массивом:
|
||||
|
||||
[
|
||||
"test",
|
||||
"test/subtest",
|
||||
"test/subtest/AAA",
|
||||
"test/subtest/BBB",
|
||||
"test1",
|
||||
"test1/test",
|
||||
"test2",
|
||||
"test2/test",
|
||||
"test3",
|
||||
"test3/test",
|
||||
"test3/test/res"
|
||||
]
|
||||
|
||||
### Удаление ключей JSON
|
||||
|
||||
Для удаления ключей JSON есть 2 метода: `DeleteKey`, который удаляет только определённый ключ и `Clear`, который удаляет
|
||||
**все ключи** из json-файла.
|
||||
|
||||
#### Метод `DeleteKey`
|
||||
|
||||
Это метод удаляет только определённый ключ в JSON. Он имеет **1 обязательный параметр** - `string $key` (ключ).
|
||||
|
||||
Этот метод возвращает `bool` - результат удаления ключа: `true` - удаление прошло успешно, `false` - произошла ошибка
|
||||
при удалении.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function DeleteKey (string $key): bool
|
||||
|
||||
**Пример,**
|
||||
|
||||
// Создаём класс
|
||||
$json = new JsonReWriter();
|
||||
// Заполним данными
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
$json->Write("test/subtest/BBB", 1.23);
|
||||
$json->Write("test1/test", 123);
|
||||
$json->Write("test2/test", true);
|
||||
$json->WriteArray("test3/test/res", [1, 2, 3]);
|
||||
} catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
// Получаемем ключи до удаления
|
||||
$check1 = $json->GetKeys("test/subtest");
|
||||
// Удаляем ключ
|
||||
$this->DeleteKey("test/subtest/BBB");
|
||||
// Получаемем ключи после удаления
|
||||
$check2 = $json->GetKeys("test/subtest");
|
||||
|
||||
В результате, `$check1` будет
|
||||
|
||||
[
|
||||
"test/subtest",
|
||||
"test/subtest/AAA",
|
||||
"test/subtest/BBB"
|
||||
]
|
||||
|
||||
а `$check2`:
|
||||
|
||||
[
|
||||
"test/subtest",
|
||||
"test/subtest/AAA"
|
||||
]
|
||||
|
||||
#### Метод `Clear`
|
||||
|
||||
Это метод удаляет **все ключи** из json-файла. Он не имеет никаких параметров и ничего не возвращает.
|
||||
|
||||
Синтаксис:
|
||||
|
||||
public function Clear (): void
|
||||
|
||||
**Пример,**
|
||||
|
||||
// Создаём класс
|
||||
$json = new JsonReWriter();
|
||||
// Заполним данными
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
$json->Write("test/subtest/BBB", 1.23);
|
||||
$json->Write("test1/test", 123);
|
||||
$json->Write("test2/test", true);
|
||||
$json->WriteArray("test3/test/res", [1, 2, 3]);
|
||||
} catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
// Очищаем
|
||||
$json->Clear();
|
||||
// Получаем ключи
|
||||
$keys = $json->GetKeys();
|
||||
|
||||
В результате, `$key` будет следующим массивом:
|
||||
|
||||
[
|
||||
]
|
54
tests/classes/ActionStateTest.php
Normal file
54
tests/classes/ActionStateTest.php
Normal file
@ -0,0 +1,54 @@
|
||||
<?php
|
||||
|
||||
namespace goodboyalex\php_components_pack\tests\classes;
|
||||
|
||||
use goodboyalex\php_components_pack\classes\ActionState;
|
||||
use goodboyalex\php_components_pack\enums\MessageType;
|
||||
use goodboyalex\php_components_pack\models\ActionStateMessageModel;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
|
||||
class ActionStateTest extends TestCase
|
||||
{
|
||||
public function testActionState (): void
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
$actionState = new ActionState('123');
|
||||
|
||||
$this->assertEquals('123', $actionState->Value);
|
||||
|
||||
$actionState->AddError("Non critical error");
|
||||
$actionState->AddCritical("Critical error");
|
||||
$actionState->AddWarning("Its a warning");
|
||||
|
||||
$this->assertTrue($actionState->HasErrors());
|
||||
$this->assertTrue($actionState->HasErrors(true));
|
||||
$this->assertTrue($actionState->HasWarnings());
|
||||
$this->assertFalse($actionState->IsSuccess());
|
||||
|
||||
$messages = $actionState->GetMessages(ActionState::GET_STRING_ERROR_ONLY());
|
||||
$this->assertEquals(2, $messages->Count());
|
||||
|
||||
$this->assertEquals("Non critical error",
|
||||
$actionState->GetStringMessages(fn (ActionStateMessageModel $message)
|
||||
=> $message->MessageType
|
||||
== MessageType::Error
|
||||
&& !$message->IsCritical));
|
||||
|
||||
$actionState2 = new ActionState('321');
|
||||
|
||||
$actionState2->AddState($actionState);
|
||||
|
||||
$this->assertEquals(3, $actionState2->Count(ActionState::GET_STRING_ALL()));
|
||||
$this->assertEquals('123', $actionState2->Value);
|
||||
}
|
||||
|
||||
private function PrepareForTest (): void
|
||||
{
|
||||
require_once __DIR__ . '/../../sources/classes/ActionState.php';
|
||||
require_once __DIR__ . '/../../sources/traits/ActionState/ActionStateAddTrait.php';
|
||||
require_once __DIR__ . '/../../sources/traits/ActionState/ActionStateGetTrait.php';
|
||||
require_once __DIR__ . '/../../sources/traits/ActionState/ActionStateHasTrait.php';
|
||||
require_once __DIR__ . '/../../sources/traits/ActionState/ActionStateStaticTrait.php';
|
||||
require_once __DIR__ . '/../../sources/enums/MessageType.php';
|
||||
}
|
||||
}
|
@ -27,6 +27,7 @@ class ClassMapperTest extends TestCase
|
||||
{
|
||||
require_once __DIR__ . '/../data/A.php';
|
||||
require_once __DIR__ . '/../data/B.php';
|
||||
require_once __DIR__ . '/../../sources/attributes/GetOnly.php';
|
||||
require_once __DIR__ . '/../../sources/classes/classMapper.php';
|
||||
}
|
||||
}
|
154
tests/classes/DictionaryTest.php
Normal file
154
tests/classes/DictionaryTest.php
Normal file
@ -0,0 +1,154 @@
|
||||
<?php
|
||||
|
||||
namespace goodboyalex\php_components_pack\tests\classes;
|
||||
|
||||
use goodboyalex\php_components_pack\classes\Dictionary;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
|
||||
class DictionaryTest extends TestCase
|
||||
{
|
||||
public function testRemove ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$dict = new Dictionary();
|
||||
$dict->Add('1', 1);
|
||||
$dict->Add('2', '2');
|
||||
$dict->Add('3', true);
|
||||
|
||||
$dict->Remove('2');
|
||||
|
||||
$this->assertEquals(1, $dict->Get('1'));
|
||||
$this->assertTrue($dict->Get('3'));
|
||||
$this->assertEquals(2, $dict->count());
|
||||
$this->assertFalse($dict->Has('2'));
|
||||
}
|
||||
|
||||
private function PrepareForTest (): void
|
||||
{
|
||||
require_once __DIR__ . '/../../sources/interfaces/ISerializable.php';
|
||||
require_once __DIR__ . '/../../sources/traits/ArrayBasicTrait.php';
|
||||
require_once __DIR__ . '/../../sources/classes/Dictionary.php';
|
||||
}
|
||||
|
||||
public function testGet ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$dict = new Dictionary();
|
||||
$dict->Add('1', 1);
|
||||
$dict->Add('2', '2');
|
||||
$dict->Add('3', true);
|
||||
|
||||
$this->assertEquals(1, $dict->Get('1'));
|
||||
$this->assertEquals('2', $dict->Get('2'));
|
||||
$this->assertTrue($dict->Get('3'));
|
||||
$this->assertEquals(3, $dict->count());
|
||||
}
|
||||
|
||||
public function testClear ()
|
||||
{
|
||||
|
||||
$this->PrepareForTest();
|
||||
|
||||
$dict = new Dictionary();
|
||||
$dict->Add('1', 1);
|
||||
$dict->Add('2', '2');
|
||||
$dict->Add('3', true);
|
||||
$dict->Clear();
|
||||
|
||||
$this->assertEquals(0, $dict->count());
|
||||
}
|
||||
|
||||
public function testAdd ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$dict = new Dictionary();
|
||||
$dict->Add('1', 1);
|
||||
$dict->Add('2', '2');
|
||||
$dict->Add('3', true);
|
||||
|
||||
$this->assertEquals(1, $dict->Get('1'));
|
||||
$this->assertEquals('2', $dict->Get('2'));
|
||||
$this->assertTrue($dict->Get('3'));
|
||||
$this->assertEquals(3, $dict->count());
|
||||
}
|
||||
|
||||
public function testHas ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$dict = new Dictionary();
|
||||
$dict->Add('1', 1);
|
||||
$dict->Add('2', '2');
|
||||
$dict->Add('3', true);
|
||||
|
||||
$this->assertTrue($dict->Has('3'));
|
||||
$this->assertFalse($dict->Has('4'));
|
||||
}
|
||||
|
||||
public function testKeys ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$dict = new Dictionary();
|
||||
$dict->Add('1', 1);
|
||||
$dict->Add('3', true);
|
||||
$dict->Add('2', '2');
|
||||
|
||||
$array = ['1', '3', '2'];
|
||||
|
||||
$this->assertArrayIsEqualToArrayIgnoringListOfKeys($array, $dict->Keys(), []);
|
||||
}
|
||||
|
||||
public function testSort ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$dict = new Dictionary();
|
||||
$dict->Add('1', 1);
|
||||
$dict->Add('3', true);
|
||||
$dict->Add('2', '2');
|
||||
|
||||
$array = ['1', '2', '3'];
|
||||
|
||||
$dict->Sort();
|
||||
|
||||
$this->assertArrayIsEqualToArrayIgnoringListOfKeys($array, $dict->Keys(), []);
|
||||
}
|
||||
|
||||
public function testAddRange ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$dict = new Dictionary();
|
||||
$dict->Add('1', 1);
|
||||
|
||||
$array = ['2' => '2', '3' => true, '4' => false];
|
||||
|
||||
$dict->AddRange($array);
|
||||
|
||||
$this->assertEquals(1, $dict->Get('1'));
|
||||
$this->assertTrue($dict->Get('3'));
|
||||
$this->assertEquals(4, $dict->count());
|
||||
$this->assertFalse($dict->Get("4"));
|
||||
}
|
||||
|
||||
public function testToArray ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$dict = new Dictionary();
|
||||
$dict->Add('1', 1);
|
||||
$dict->Add('3', true);
|
||||
$dict->Add('2', '2');
|
||||
|
||||
$array = $dict->ToArray();
|
||||
|
||||
$this->assertIsArray($array);
|
||||
$this->assertEquals(1, $array['1']);
|
||||
$this->assertTrue($array['3']);
|
||||
$this->assertCount(3, $array);
|
||||
}
|
||||
}
|
94
tests/classes/FileTest.php
Normal file
94
tests/classes/FileTest.php
Normal file
@ -0,0 +1,94 @@
|
||||
<?php
|
||||
|
||||
namespace goodboyalex\php_components_pack\tests\classes;
|
||||
|
||||
use goodboyalex\php_components_pack\classes\File;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
|
||||
class FileTest extends TestCase
|
||||
{
|
||||
public function testExtractFileName ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$this->assertEquals("test.txt", File::ExtractFileName("c:\\tmp\\test.txt"));
|
||||
$this->assertEquals("test.txt", File::ExtractFileName("c:/tmp/test.txt"));
|
||||
$this->assertEquals("test.txt", File::ExtractFileName("\\tmp\\test.txt"));
|
||||
}
|
||||
|
||||
private function PrepareForTest (): void
|
||||
{
|
||||
require_once __DIR__ . '/../../sources/classes/File.php';
|
||||
}
|
||||
|
||||
public function testFindFiles ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$result = File::FindFiles(__DIR__);
|
||||
|
||||
$this->assertIsArray($result);
|
||||
$this->assertCount(8, $result);
|
||||
}
|
||||
|
||||
public function testGetRelativePath ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$fullPath = "c:\\source\\tmp\\test.txt";
|
||||
|
||||
$basePath = "c:\\source\\";
|
||||
|
||||
$this->assertEquals("tmp\\test.txt", File::GetRelativePath($fullPath, $basePath));
|
||||
}
|
||||
|
||||
public function testExtractFileExtension ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$this->assertEquals("txt", File::ExtractFileExtension("c:\\tmp\\test.txt"));
|
||||
$this->assertEquals("txt", File::ExtractFileExtension("c:/tmp/test.txt"));
|
||||
$this->assertEquals("txt", File::ExtractFileExtension("\\tmp\\test.txt"));
|
||||
}
|
||||
|
||||
public function testExtractFileNameWithoutExtension ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$this->assertEquals("test", File::ExtractFileNameWithoutExtension("c:\\tmp\\test.txt"));
|
||||
$this->assertEquals("test", File::ExtractFileNameWithoutExtension("c:/tmp/test.txt"));
|
||||
$this->assertEquals("test", File::ExtractFileNameWithoutExtension("\\tmp\\test.txt"));
|
||||
}
|
||||
|
||||
public function testRemoveDir ()
|
||||
{
|
||||
/**
|
||||
* ВАЖНО! Перед запуском теста необходимо создать директорию D:\TestDelete и наполнить её ненужными файлами
|
||||
*/
|
||||
|
||||
$this->PrepareForTest();
|
||||
|
||||
$result = File::RemoveDir("D:/TestDelete");
|
||||
|
||||
$this->assertTrue($result->Value);
|
||||
$this->assertFalse(File::DirectoryExists("D:\\TestDelete"));
|
||||
}
|
||||
|
||||
public function testFileSize ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$size = File::FileSize("C:\\Windows/explorer.exe");
|
||||
|
||||
$this->assertEquals(2774080, $size->Value);
|
||||
}
|
||||
|
||||
public function testFileSizeString ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$size = File::FileSizeToString(2774080);
|
||||
|
||||
$this->assertEquals("2,65 МБ", $size);
|
||||
}
|
||||
}
|
319
tests/classes/JsonReWriterTest.php
Normal file
319
tests/classes/JsonReWriterTest.php
Normal file
@ -0,0 +1,319 @@
|
||||
<?php
|
||||
|
||||
namespace goodboyalex\php_components_pack\tests\classes;
|
||||
|
||||
use goodboyalex\php_components_pack\classes\File;
|
||||
use goodboyalex\php_components_pack\classes\BoolEx;
|
||||
use goodboyalex\php_components_pack\exceptions\JsonException;
|
||||
use goodboyalex\php_components_pack\tests\data\A;
|
||||
use goodboyalex\php_components_pack\tests\data\C;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
|
||||
class JsonReWriterTest extends TestCase
|
||||
{
|
||||
public function testIsKeyExists ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$json = new BoolEx();
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
}
|
||||
catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
|
||||
$this->assertTrue($json->IsKeyExists("test/subtest/AAA"));
|
||||
}
|
||||
|
||||
private function PrepareForTest (): void
|
||||
{
|
||||
require_once __DIR__ . '/../../sources/exceptions/JsonException.php';
|
||||
require_once __DIR__ . '/../../sources/traits/JsonReWriter/JsonReWriterDeleteTrait.php';
|
||||
require_once __DIR__ . '/../../sources/traits/JsonReWriter/JsonReWriterKeyTrait.php';
|
||||
require_once __DIR__ . '/../../sources/traits/JsonReWriter/JsonReWriterLoadSaveTrait.php';
|
||||
require_once __DIR__ . '/../../sources/traits/JsonReWriter/JsonReWriterReadTrait.php';
|
||||
require_once __DIR__ . '/../../sources/traits/JsonReWriter/JsonReWriterWriteTrait.php';
|
||||
require_once __DIR__ . '/../../sources/classes/JsonReWriter.php';
|
||||
require_once __DIR__ . '/../data/A.php';
|
||||
require_once __DIR__ . '/../data/C.php';
|
||||
}
|
||||
|
||||
public function testReadWriteInt ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$json = new BoolEx();
|
||||
try {
|
||||
$json->Write("test/test", 123);
|
||||
}
|
||||
catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
|
||||
$this->assertEquals(123, $json->ReadInt("test/test"));
|
||||
}
|
||||
|
||||
public function testReadWriteBool ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$json = new BoolEx();
|
||||
try {
|
||||
$json->Write("test/test1", false);
|
||||
$json->Write("test/test2", true);
|
||||
}
|
||||
catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
|
||||
$this->assertTrue($json->ReadBool("test/test2"));
|
||||
$this->assertFalse($json->ReadBool("test/test1"));
|
||||
}
|
||||
|
||||
public function testReadWriteString ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$json = new BoolEx();
|
||||
try {
|
||||
$json->Write("test/test", "test string");
|
||||
}
|
||||
catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
|
||||
$this->assertEquals("test string", $json->ReadString("test/test", "test this"));
|
||||
}
|
||||
|
||||
public function testSaveToFile ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$fileName = __DIR__ . "/test.json";
|
||||
|
||||
if (file_exists($fileName))
|
||||
unlink($fileName);
|
||||
|
||||
$json = new BoolEx();
|
||||
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
$json->Write("test/subtest/BBB", 1.23);
|
||||
$json->Write("test1/test", 123);
|
||||
$json->Write("test2/test", true);
|
||||
$json->WriteArray("test3/test/res", [1, 2, 3]);
|
||||
}
|
||||
catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
|
||||
$json->SaveToFile($fileName);
|
||||
|
||||
$this->assertFileExists($fileName);
|
||||
|
||||
$size = File::FileSize($fileName)->Value;
|
||||
|
||||
$this->assertEquals(268, $size);
|
||||
|
||||
unlink($fileName);
|
||||
}
|
||||
|
||||
public function testReadWriteArray ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$json = new BoolEx();
|
||||
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
$json->Write("test/subtest/BBB", 1.23);
|
||||
$json->Write("test1/test", 123);
|
||||
$json->Write("test2/test", true);
|
||||
$json->WriteArray("test3/test/res", [1, 2, 3]);
|
||||
}
|
||||
catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
|
||||
$this->assertArrayIsEqualToArrayIgnoringListOfKeys([1, 2, 3], $json->ReadArray("test3/test/res"), []);
|
||||
}
|
||||
|
||||
public function testClear ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$json = new BoolEx();
|
||||
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
$json->Write("test/subtest/BBB", 1.23);
|
||||
$json->Write("test1/test", 123);
|
||||
$json->Write("test2/test", true);
|
||||
$json->WriteArray("test3/test/res", [1, 2, 3]);
|
||||
}
|
||||
catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
|
||||
$json->Clear();
|
||||
|
||||
$this->assertCount(0, $json->GetKeys());
|
||||
}
|
||||
|
||||
public function testReadWriteObject ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$json = new BoolEx();
|
||||
|
||||
$class = new A("test", 123, true);
|
||||
|
||||
try {
|
||||
$json->WriteObject("test", $class);
|
||||
}
|
||||
catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
|
||||
$this->assertEquals("test", $json->ReadObject("test", new A())->a);
|
||||
}
|
||||
|
||||
public function testLoadFromFile ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$fileName = __DIR__ . "/test.json";
|
||||
|
||||
if (file_exists($fileName))
|
||||
unlink($fileName);
|
||||
|
||||
$json = new BoolEx();
|
||||
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
$json->Write("test/subtest/BBB", 1.23);
|
||||
$json->Write("test1/test", 123);
|
||||
$json->Write("test2/test", true);
|
||||
$json->WriteArray("test3/test/res", [1, 2, 3]);
|
||||
}
|
||||
catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
|
||||
$json->SaveToFile($fileName);
|
||||
|
||||
unset($json);
|
||||
|
||||
$json = new BoolEx();
|
||||
|
||||
$json->LoadFromFile($fileName);
|
||||
|
||||
unlink($fileName);
|
||||
|
||||
$this->assertEquals(123, $json->ReadInt("test1/test"));
|
||||
}
|
||||
|
||||
public function testDeleteKey ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$json = new BoolEx();
|
||||
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
$json->Write("test/subtest/BBB", 1.23);
|
||||
$json->Write("test1/test", 123);
|
||||
$json->Write("test2/test", true);
|
||||
$json->WriteArray("test3/test/res", [1, 2, 3]);
|
||||
}
|
||||
catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
|
||||
$json->DeleteKey("test3/test/res");
|
||||
|
||||
$this->assertFalse($json->IsKeyExists("test3/test/res"));
|
||||
}
|
||||
|
||||
public function testReadWrite ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$json = new BoolEx();
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
$json->Write("test/subtest/BBB", 1.23);
|
||||
$json->Write("test1/test", 123);
|
||||
$json->Write("test2/test", true);
|
||||
$json->Write("test3/test/res", json_encode([1, 2, 3]));
|
||||
}
|
||||
catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
|
||||
$this->assertTrue($json->IsKeyExists("test/subtest/AAA"));
|
||||
$this->assertTrue($json->IsKeyExists("test1/test"));
|
||||
$this->assertEquals(1.23, (float)$json->Read("test/subtest/BBB"));
|
||||
}
|
||||
|
||||
public function testGetKeys ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$json = new BoolEx();
|
||||
try {
|
||||
$json->Write("test/subtest/AAA", "123");
|
||||
$json->Write("test/subtest/BBB", 1.23);
|
||||
$json->Write("test1/test", 123);
|
||||
$json->Write("test2/test", true);
|
||||
$json->WriteArray("test3/test/res", [1, 2, 3]);
|
||||
}
|
||||
catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
|
||||
$this->assertCount(11, $json->GetKeys());
|
||||
$this->assertCount(2, $json->GetKeys("test/subtest"));
|
||||
}
|
||||
|
||||
public function testReadWriteSerializable ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$serializableClass = new C("test", 123, true);
|
||||
|
||||
$json = new BoolEx();
|
||||
try {
|
||||
$json->WriteSerializable("test", $serializableClass);
|
||||
|
||||
/**
|
||||
* @var C $unSerializableClass Получаем объект из файла
|
||||
*/
|
||||
$unSerializableClass = $json->ReadSerializable("test", "goodboyalex\\php_components_pack\\tests\\data\\C");
|
||||
}
|
||||
catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
return;
|
||||
}
|
||||
|
||||
$this->assertEquals($serializableClass->stringC, $unSerializableClass->stringC);
|
||||
$this->assertEquals($serializableClass->intC, $unSerializableClass->intC);
|
||||
$this->assertEquals($serializableClass->boolC, $unSerializableClass->boolC);
|
||||
}
|
||||
|
||||
public function testReadWriteFloat ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$json = new BoolEx();
|
||||
try {
|
||||
$json->Write("test", 1.23);
|
||||
}
|
||||
catch (JsonException $e) {
|
||||
echo $e->getMessage();
|
||||
}
|
||||
|
||||
$this->assertEquals(1.23, $json->ReadFloat("test", 0.2));
|
||||
}
|
||||
}
|
@ -39,10 +39,11 @@ class ObjectArrayTest extends TestCase
|
||||
require_once __DIR__ . '/../data/A.php';
|
||||
require_once __DIR__ . '/../data/B.php';
|
||||
require_once __DIR__ . '/../../sources/interfaces/ISerializable.php';
|
||||
require_once __DIR__ . '/../../sources/traits/ObjectArray/ObjectArrayBasicTrait.php';
|
||||
require_once __DIR__ . '/../../sources/traits/ArrayBasicTrait.php';
|
||||
require_once __DIR__ . '/../../sources/traits/ObjectArray/ObjectArrayConstantsTrait.php';
|
||||
require_once __DIR__ . '/../../sources/traits/ObjectArray/ObjectArrayLINQTrait.php';
|
||||
require_once __DIR__ . '/../../sources/traits/ObjectArray/ObjectArraySearchAndSortTrait.php';
|
||||
require_once __DIR__ . '/../../sources/traits/ObjectArray/ObjectArraySpecialTrait.php';
|
||||
require_once __DIR__ . '/../../sources/classes/ObjectArray.php';
|
||||
}
|
||||
|
||||
@ -430,4 +431,53 @@ class ObjectArrayTest extends TestCase
|
||||
$this->assertEquals(3, $b_Array->First()->b);
|
||||
$this->assertEquals(5, $b_Array->Last()->b);
|
||||
}
|
||||
|
||||
public function testAdd ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$obj = new A("a", 3, true);
|
||||
|
||||
$a_Array = new ObjectArray([]);
|
||||
|
||||
$a_Array->Add($obj);
|
||||
|
||||
$b_Array = $a_Array->GetRow(fn (A $a) => $a->a == "a");
|
||||
|
||||
$this->assertEquals(3, $b_Array->b);
|
||||
}
|
||||
|
||||
public function testAddRange ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$array = [
|
||||
new A("a", 3, true),
|
||||
new A("c", 2, false),
|
||||
new A("b", 1, true),
|
||||
new A("d", 5, true),
|
||||
new A("e", 4, true),
|
||||
new A("f", 6, false)
|
||||
];
|
||||
|
||||
$a_Array = new ObjectArray();
|
||||
$a_Array->AddRange($array);
|
||||
|
||||
$this->assertEquals(6, $a_Array->Count());
|
||||
|
||||
$array2 = [
|
||||
new A("g", 3, true),
|
||||
new A("h", 2, false),
|
||||
new A("i", 1, true),
|
||||
new A("k", 5, true),
|
||||
new A("l", 4, true),
|
||||
new A("m", 6, false)
|
||||
];
|
||||
|
||||
$objectArray = new ObjectArray($array2);
|
||||
|
||||
$a_Array->AddRange($objectArray);
|
||||
|
||||
$this->assertEquals(12, $a_Array->Count());
|
||||
}
|
||||
}
|
37
tests/classes/TupleTest.php
Normal file
37
tests/classes/TupleTest.php
Normal file
@ -0,0 +1,37 @@
|
||||
<?php
|
||||
|
||||
namespace goodboyalex\php_components_pack\tests\classes;
|
||||
|
||||
use Exception;
|
||||
use goodboyalex\php_components_pack\classes\Tuple;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
|
||||
class TupleTest extends TestCase
|
||||
{
|
||||
public function testTuple ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$tuple = new Tuple(1, 'string', ['array1', 'array2', 'array3']);
|
||||
|
||||
// Проверка на то, что возвращает значение кортежа при запросе значения по индексу
|
||||
$this->assertEquals(1, $tuple->Get(0));
|
||||
$this->assertEquals('string', $tuple->Get(1));
|
||||
$this->assertEquals(['array1', 'array2', 'array3'], $tuple->Get(2));
|
||||
|
||||
// Проверка на то, что возвращает переменные
|
||||
[$firstElement, $secondElement, $thirdElement] = $tuple;
|
||||
$this->assertEquals(1, $firstElement);
|
||||
$this->assertEquals('string', $secondElement);
|
||||
$this->assertEquals(['array1', 'array2', 'array3'], $thirdElement);
|
||||
|
||||
// Проверка на то, что выбрасывает исключение при попытке задать данные в кортеж после его создания
|
||||
$this->expectException(Exception::class);
|
||||
$tuple[] = 'New data';
|
||||
}
|
||||
|
||||
private function PrepareForTest (): void
|
||||
{
|
||||
require_once __DIR__ . '/../../sources/classes/Tuple.php';
|
||||
}
|
||||
}
|
134
tests/classes/VersionInfoTest.php
Normal file
134
tests/classes/VersionInfoTest.php
Normal file
@ -0,0 +1,134 @@
|
||||
<?php
|
||||
|
||||
namespace goodboyalex\php_components_pack\tests\classes;
|
||||
|
||||
use goodboyalex\php_components_pack\classes\ObjectArray;
|
||||
use goodboyalex\php_components_pack\classes\VersionInfo;
|
||||
use goodboyalex\php_components_pack\enums\VersionInfoStage;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
|
||||
class VersionInfoTest extends TestCase
|
||||
{
|
||||
public function testCompareWith ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$versionInfo1 = new VersionInfo(1, 2, 3, 4, VersionInfoStage::Beta, 1);
|
||||
$versionInfo2 = new VersionInfo(1, 1, 3, 4, VersionInfoStage::Alpha, 2);
|
||||
|
||||
$this->assertEquals(1, $versionInfo1->CompareWith($versionInfo2));
|
||||
|
||||
}
|
||||
|
||||
private function PrepareForTest (): void
|
||||
{
|
||||
require_once __DIR__ . '/../../sources/enums/VersionInfoStage.php';
|
||||
require_once __DIR__ . '/../../sources/classes/VersionInfo.php';
|
||||
}
|
||||
|
||||
public function test__toString ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
$versionInfo = new VersionInfo(1, 2, 3, 4, VersionInfoStage::Beta, 1);
|
||||
$this->assertEquals('1.2.3.4 Beta 1', $versionInfo->__toString());
|
||||
}
|
||||
|
||||
public function testToString ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
$versionInfo = new VersionInfo(1, 2, 3, 4, VersionInfoStage::Beta, 1);
|
||||
|
||||
$template = "Это #{Stage} #{StageNumber} версии #{Major}.#{Minor}.#{Release}.#{Build}";
|
||||
|
||||
$stageNames = [
|
||||
VersionInfoStage::PreAlpha->value => 'рано',
|
||||
VersionInfoStage::Alpha->value => 'начало',
|
||||
VersionInfoStage::Beta->value => 'середнячок',
|
||||
VersionInfoStage::ReleaseCandidate->value => 'почти',
|
||||
VersionInfoStage::Stable->value => 'это релиз, детка!'
|
||||
];
|
||||
|
||||
$this->assertEquals('Это середнячок 1 версии 1.2.3.4', $versionInfo->ToString($template, $stageNames));
|
||||
}
|
||||
|
||||
public function testParse ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$stageNames = [
|
||||
VersionInfoStage::PreAlpha->value => 'pre',
|
||||
VersionInfoStage::Alpha->value => 'alpha',
|
||||
VersionInfoStage::Beta->value => 'beta',
|
||||
VersionInfoStage::ReleaseCandidate->value => 'rc',
|
||||
VersionInfoStage::Stable->value => 'stable'
|
||||
];
|
||||
|
||||
$version = VersionInfo::Parse('1.2.3.4 beta 1', $stageNames);
|
||||
|
||||
$this->assertEquals(1, $version->Major);
|
||||
$this->assertEquals(2, $version->Minor);
|
||||
$this->assertEquals(3, $version->Release);
|
||||
$this->assertEquals(4, $version->Build);
|
||||
$this->assertEquals(VersionInfoStage::Beta, $version->Stage);
|
||||
$this->assertEquals(1, $version->StageNumber);
|
||||
}
|
||||
|
||||
public function test__construct ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$version = new VersionInfo(1, 2, 3, 4, VersionInfoStage::Beta, 1);
|
||||
|
||||
$this->assertEquals(2, $version->Minor);
|
||||
}
|
||||
|
||||
public function testCompare ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$versionInfo1 = new VersionInfo(1, 2, 3, 4, VersionInfoStage::Beta, 1);
|
||||
$versionInfo2 = new VersionInfo(1, 1, 3, 4, VersionInfoStage::Alpha, 2);
|
||||
|
||||
$this->assertEquals(1, VersionInfo::Compare($versionInfo1, $versionInfo2));
|
||||
}
|
||||
|
||||
public function testCompareWithRange ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$versionInfo1 = new VersionInfo(1, 2, 3, 4, VersionInfoStage::Beta, 1);
|
||||
|
||||
$versionInfo2 = new VersionInfo(1, 1, 3, 4, VersionInfoStage::Alpha, 2);
|
||||
|
||||
$versionInfo3 = new VersionInfo(1, 1, 1, 1, VersionInfoStage::Alpha, 2);
|
||||
|
||||
$versionInfo4 = new VersionInfo(5, 5, 5, 5, VersionInfoStage::Stable);
|
||||
|
||||
$optionNotBorder = new ObjectArray();
|
||||
|
||||
// Для начала простое сравнение
|
||||
$this->assertEquals(0, $versionInfo1->CompareWithRange($versionInfo3, $versionInfo4));
|
||||
$this->assertEquals(-1, $versionInfo2->CompareWithRange($versionInfo1, $versionInfo4));
|
||||
$this->assertEquals(1, $versionInfo4->CompareWithRange($versionInfo2, $versionInfo1));
|
||||
|
||||
// Немного перепутаем границы =)
|
||||
$this->assertEquals(1, $versionInfo4->CompareWithRange($versionInfo1, $versionInfo2));
|
||||
|
||||
// А теперь с границами
|
||||
// - значение равно левой границе
|
||||
$this->assertEquals(0, $versionInfo2->CompareWithRange($versionInfo2, $versionInfo1));
|
||||
// - значение равно правой границе
|
||||
$this->assertEquals(0, $versionInfo1->CompareWithRange($versionInfo2, $versionInfo1));
|
||||
// - а теперь с выключением границ
|
||||
// -- для левой
|
||||
$this->assertEquals(-1, $versionInfo2->CompareWithRange($versionInfo2, $versionInfo1, $optionNotBorder));
|
||||
// -- для правой
|
||||
$this->assertEquals(1, $versionInfo1->CompareWithRange($versionInfo2, $versionInfo1, $optionNotBorder));
|
||||
|
||||
// А что если границы равны и значение равно
|
||||
// - для включённых границ
|
||||
$this->assertEquals(0, $versionInfo1->CompareWithRange($versionInfo1, $versionInfo1));
|
||||
// - для выключённых границ
|
||||
$this->assertEquals(-1, $versionInfo1->CompareWithRange($versionInfo1, $versionInfo1, $optionNotBorder));
|
||||
}
|
||||
}
|
36
tests/data/C.php
Normal file
36
tests/data/C.php
Normal file
@ -0,0 +1,36 @@
|
||||
<?php
|
||||
|
||||
namespace goodboyalex\php_components_pack\tests\data;
|
||||
|
||||
use goodboyalex\php_components_pack\interfaces\ISerializable;
|
||||
|
||||
class C implements ISerializable
|
||||
{
|
||||
public string $stringC;
|
||||
public int $intC;
|
||||
public bool $boolC;
|
||||
|
||||
public function __construct (string $string = "", int $int = 0, bool $bool = false)
|
||||
{
|
||||
$this->stringC = $string;
|
||||
$this->intC = $int;
|
||||
$this->boolC = $bool;
|
||||
}
|
||||
|
||||
public function Serialize (): string
|
||||
{
|
||||
$array = [];
|
||||
$array["string"] = $this->stringC;
|
||||
$array["int"] = $this->intC;
|
||||
$array["bool"] = $this->boolC;
|
||||
return json_encode($array);
|
||||
}
|
||||
|
||||
public function UnSerialize (string $serialized): void
|
||||
{
|
||||
$array = json_decode($serialized, true);
|
||||
$this->stringC = $array["string"];
|
||||
$this->intC = $array["int"];
|
||||
$this->boolC = $array["bool"];
|
||||
}
|
||||
}
|
@ -2,7 +2,7 @@
|
||||
|
||||
namespace goodboyalex\php_components_pack\tests\extensions;
|
||||
|
||||
use Exception;
|
||||
use goodboyalex\php_components_pack\enums\VarNotBoolAction;
|
||||
use goodboyalex\php_components_pack\extensions\BoolExtensions;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
|
||||
@ -30,6 +30,7 @@ class BoolExtensionsTest extends TestCase
|
||||
|
||||
private function PrepareForTest (): void
|
||||
{
|
||||
require_once __DIR__ . '/../../sources/enums/VarNotBoolAction.php';
|
||||
require_once __DIR__ . '/../../sources/extensions/BoolExtensions.php';
|
||||
}
|
||||
|
||||
@ -46,23 +47,19 @@ class BoolExtensionsTest extends TestCase
|
||||
$this->assertEquals(14,
|
||||
BoolExtensions::TrueCount($array));
|
||||
|
||||
$this->expectException(Exception::class);
|
||||
|
||||
$array[] = "ПРЕДАТЕЛЬ!";
|
||||
|
||||
BoolExtensions::TrueCount($array);
|
||||
$this->assertEquals(14, BoolExtensions::TrueCount($array));
|
||||
$this->assertEquals(14, BoolExtensions::TrueCount($array, VarNotBoolAction::ConsiderItFalse));
|
||||
$this->assertEquals(15, BoolExtensions::TrueCount($array, VarNotBoolAction::ConsiderItTrue));
|
||||
}
|
||||
|
||||
public function testExportToString ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$b = true;
|
||||
$this->assertEquals('О, да!', BoolExtensions::ExportToString(true, 'О, да!', 'О, нет!'));
|
||||
|
||||
$this->assertEquals('О, да!', BoolExtensions::ExportToString($b, 'О, да!', 'О, нет!'));
|
||||
|
||||
$b = false;
|
||||
|
||||
$this->assertEquals('О, нет!', BoolExtensions::ExportToString($b, 'О, да!', 'О, нет!'));
|
||||
$this->assertEquals('О, нет!', BoolExtensions::ExportToString(false, 'О, да!', 'О, нет!'));
|
||||
}
|
||||
}
|
@ -63,4 +63,20 @@ class StringExtensionTest extends TestCase
|
||||
$this->assertEquals('', StringExtension::GetShortText('test', 0));
|
||||
|
||||
}
|
||||
|
||||
public function testReplace ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$this->assertEquals('Все 2 ночи и 2 дня 2 друга искали тебя!',
|
||||
StringExtension::Replace("4", "2", "Все 4 ночи и 4 дня 2 друга искали тебя!"));
|
||||
}
|
||||
|
||||
public function testReplaceAll ()
|
||||
{
|
||||
$this->PrepareForTest();
|
||||
|
||||
$this->assertEquals('Все 5 ночи и 5 дня 2 друга искали тебя!',
|
||||
StringExtension::ReplaceAll(["4" => "5", "3" => "2"], "Все 4 ночи и 4 дня 3 друга искали тебя!"));
|
||||
}
|
||||
}
|
Loading…
x
Reference in New Issue
Block a user