Browse Source

Initialisation

Mathieu Moulin 1 year ago
commit
ef0c385e61

+ 21 - 0
.gitignore

@@ -0,0 +1,21 @@
+# Generated binaries
+/build/*.zip
+/bin/*.zip
+# Doxygen generated documentation
+/build/doxygen/doxygen_warnings.log
+/doc/code/doxygen
+# Composer managed dependencies
+/vendor
+/dev/bin
+# PHPdocumentor generated files
+/build/phpdoc
+/doc/code/phpdoc
+# Sphinx generated files
+/doc/user/build
+/.settings/
+/.buildpath
+/.project
+# Other
+*.back
+/.editorconfig
+/.gitattributes

+ 9 - 0
.tx/config

@@ -0,0 +1,9 @@
+[main]
+host = https://www.transifex.com
+lang_map = uz: uz_UZ
+
+[mymodule.mymodule]
+file_filter = langs/<lang>/mymodule.lang
+source_file = langs/en_US/mymodule.lang
+source_lang = en_US
+type = MOZILLAPROPERTIES

+ 621 - 0
COPYING

@@ -0,0 +1,621 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 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 General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS

+ 5 - 0
ChangeLog.md

@@ -0,0 +1,5 @@
+# CHANGELOG MMISHIPPING FOR [DOLIBARR ERP CRM](https://www.dolibarr.org)
+
+## 1.0
+
+Initial version

+ 86 - 0
README.md

@@ -0,0 +1,86 @@
+# MMISHIPPING FOR [DOLIBARR ERP CRM](https://www.dolibarr.org)
+
+## Features
+
+Description of the module...
+
+<!--
+![Screenshot mmishipping](img/screenshot_mmishipping.png?raw=true "MMIShipping"){imgmd}
+-->
+
+Other external modules are available on [Dolistore.com](https://www.dolistore.com).
+
+## Translations
+
+Translations can be completed manually by editing files into directories *langs*.
+
+<!--
+This module contains also a sample configuration for Transifex, under the hidden directory [.tx](.tx), so it is possible to manage translation using this service.
+
+For more informations, see the [translator's documentation](https://wiki.dolibarr.org/index.php/Translator_documentation).
+
+There is a [Transifex project](https://transifex.com/projects/p/dolibarr-module-template) for this module.
+-->
+
+<!--
+
+## Installation
+
+### From the ZIP file and GUI interface
+
+If the module is a ready to deploy zip file, so with a name module_xxx-version.zip (like when downloading it from a market place like [Dolistore](https://www.dolistore.com)),
+go into menu ```Home - Setup - Modules - Deploy external module``` and upload the zip file.
+
+Note: If this screen tell you that there is no "custom" directory, check that your setup is correct:
+
+- In your Dolibarr installation directory, edit the ```htdocs/conf/conf.php``` file and check that following lines are not commented:
+
+    ```php
+    //$dolibarr_main_url_root_alt ...
+    //$dolibarr_main_document_root_alt ...
+    ```
+
+- Uncomment them if necessary (delete the leading ```//```) and assign a sensible value according to your Dolibarr installation
+
+    For example :
+
+    - UNIX:
+        ```php
+        $dolibarr_main_url_root_alt = '/custom';
+        $dolibarr_main_document_root_alt = '/var/www/Dolibarr/htdocs/custom';
+        ```
+
+    - Windows:
+        ```php
+        $dolibarr_main_url_root_alt = '/custom';
+        $dolibarr_main_document_root_alt = 'C:/My Web Sites/Dolibarr/htdocs/custom';
+        ```
+
+### From a GIT repository
+
+Clone the repository in ```$dolibarr_main_document_root_alt/mmishipping```
+
+```sh
+cd ....../custom
+git clone git@github.com:gitlogin/mmishipping.git mmishipping
+```
+
+### <a name="final_steps"></a>Final steps
+
+From your browser:
+
+  - Log into Dolibarr as a super-administrator
+  - Go to "Setup" -> "Modules"
+  - You should now be able to find and enable the module
+
+-->
+
+## Licenses
+
+### Main code
+
+GPLv3 or (at your option) any later version. See file COPYING for more information.
+
+### Documentation
+
+All texts and readmes are licensed under GFDL.

+ 29 - 0
admin/about.php

@@ -0,0 +1,29 @@
+<?php
+/* Copyright (C) 2004-2017 Laurent Destailleur  <eldy@users.sourceforge.net>
+ * Copyright (C) 2023 MOULIN Mathieu <webmaster@sfy-gestion.com>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+/**
+ * \file    mmishipping/admin/about.php
+ * \ingroup mmishipping
+ * \brief   About page of module MMIShipping.
+ */
+
+// Load Dolibarr environment
+require_once '../env.inc.php';
+require_once '../main_load.inc.php';
+
+require_once('../../mmicommon/admin/mmiabout_1.inc.php');

+ 35 - 0
admin/setup.php

@@ -0,0 +1,35 @@
+<?php
+/* Copyright (C) 2004-2017 Laurent Destailleur  <eldy@users.sourceforge.net>
+ * Copyright (C) 2023 MOULIN Mathieu <webmaster@sfy-gestion.com>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+/**
+ * \file    mmishipping/admin/setup.php
+ * \ingroup mmishipping
+ * \brief   MMIShipping setup page.
+ */
+
+// Load Dolibarr environment
+require_once '../env.inc.php';
+require_once '../main_load.inc.php';
+
+// Parameters
+$arrayofparameters = array(
+	'MMISHIPPING_DF'=>array('type'=>'yesno', 'enabled'=>1),
+	'MMISHIPPING_DF_ENTREPOT'=>array('type'=>'int', 'enabled'=>1),
+);
+
+require_once('../../mmicommon/admin/mmisetup_1.inc.php');

+ 1327 - 0
backport/v16/core/class/html.formsetup.class.php

@@ -0,0 +1,1327 @@
+<?php
+/* Copyright (C) 2021  John BOTELLA    <john.botella@atm-consulting.fr>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+
+/**
+ * This class help you create setup render
+ */
+class FormSetup
+{
+
+	/**
+	 * @var DoliDB Database handler.
+	 */
+	public $db;
+
+	/** @var FormSetupItem[]  */
+	public $items = array();
+
+	/**
+	 * @var int
+	 */
+	public $setupNotEmpty = 0;
+
+	/** @var Translate */
+	public $langs;
+
+	/** @var Form */
+	public $form;
+
+	/** @var int */
+	protected $maxItemRank;
+
+	/**
+	 * this is an html string display before output form
+	 * @var string
+	 */
+	public $htmlBeforeOutputForm = '';
+
+	/**
+	 * this is an html string display after output form
+	 * @var string
+	 */
+	public $htmlAfterOutputForm = '';
+
+	/**
+	 * this is an html string display on buttons zone
+	 * @var string
+	 */
+	public $htmlOutputMoreButton = '';
+
+
+	/**
+	 *
+	 * @var array
+	 */
+	public $formAttributes = array(
+		'action' => '', // set in __construct
+		'method' => 'POST'
+	);
+
+	/**
+	 * an list of hidden inputs used only in edit mode
+	 * @var array
+	 */
+	public $formHiddenInputs = array();
+
+
+	/**
+	 * Constructor
+	 *
+	 * @param DoliDB $db Database handler
+	 * @param Translate $outputLangs if needed can use another lang
+	 */
+	public function __construct($db, $outputLangs = false)
+	{
+		global $langs;
+		$this->db = $db;
+		$this->form = new Form($this->db);
+		$this->formAttributes['action'] = $_SERVER["PHP_SELF"];
+
+		$this->formHiddenInputs['token'] = newToken();
+		$this->formHiddenInputs['action'] = 'update';
+
+
+		if ($outputLangs) {
+			$this->langs = $outputLangs;
+		} else {
+			$this->langs = $langs;
+		}
+	}
+
+	/**
+	 * Generate an attributes string form an input array
+	 *
+	 * @param 	array 	$attributes 	an array of attributes keys and values,
+	 * @return 	string					attribute string
+	 */
+	static public function generateAttributesStringFromArray($attributes)
+	{
+		$Aattr = array();
+		if (is_array($attributes)) {
+			foreach ($attributes as $attribute => $value) {
+				if (is_array($value) || is_object($value)) {
+					continue;
+				}
+				$Aattr[] = $attribute.'="'.dol_escape_htmltag($value).'"';
+			}
+		}
+
+		return !empty($Aattr)?implode(' ', $Aattr):'';
+	}
+
+
+	/**
+	 * generateOutput
+	 *
+	 * @param 	bool 	$editMode 	true will display output on edit mod
+	 * @return 	string				html output
+	 */
+	public function generateOutput($editMode = false)
+	{
+		global $hookmanager, $action, $langs;
+		require_once DOL_DOCUMENT_ROOT.'/core/class/html.form.class.php';
+
+		$parameters = array(
+			'editMode' => $editMode
+		);
+		$reshook = $hookmanager->executeHooks('formSetupBeforeGenerateOutput', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
+		if ($reshook < 0) {
+			setEventMessages($hookmanager->error, $hookmanager->errors, 'errors');
+		}
+
+		if ($reshook > 0) {
+			return $hookmanager->resPrint;
+		} else {
+			$out = '<!-- Start generateOutput from FormSetup class  -->';
+			$out.= $this->htmlBeforeOutputForm;
+
+			if ($editMode) {
+				$out.= '<form ' . self::generateAttributesStringFromArray($this->formAttributes) . ' >';
+
+				// generate hidden values from $this->formHiddenInputs
+				if (!empty($this->formHiddenInputs) && is_array($this->formHiddenInputs)) {
+					foreach ($this->formHiddenInputs as $hiddenKey => $hiddenValue) {
+						$out.= '<input type="hidden" name="'.dol_escape_htmltag($hiddenKey).'" value="' . dol_escape_htmltag($hiddenValue) . '">';
+					}
+				}
+			}
+
+			// generate output table
+			$out .= $this->generateTableOutput($editMode);
+
+
+			$reshook = $hookmanager->executeHooks('formSetupBeforeGenerateOutputButton', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
+			if ($reshook < 0) {
+				setEventMessages($hookmanager->error, $hookmanager->errors, 'errors');
+			}
+
+			if ($reshook > 0) {
+				return $hookmanager->resPrint;
+			} elseif ($editMode) {
+				$out .= '<br>'; // Todo : remove this <br/> by adding style to form-setup-button-container css class in all themes
+				$out .= '<div class="form-setup-button-container center">'; // Todo : remove .center by adding style to form-setup-button-container css class in all themes
+				$out.= $this->htmlOutputMoreButton;
+				$out .= '<input class="button button-save" type="submit" value="' . $this->langs->trans("Save") . '">'; // Todo fix dolibarr style for <button and use <button instead of input
+				$out .= ' &nbsp;&nbsp; ';
+				$out .= '<a class="button button-cancel" type="submit" href="' . $this->formAttributes['action'] . '">'.$langs->trans('Cancel').'</a>';
+				$out .= '</div>';
+			}
+
+			if ($editMode) {
+				$out .= '</form>';
+			}
+
+			$out.= $this->htmlAfterOutputForm;
+
+			return $out;
+		}
+	}
+
+	/**
+	 * generateTableOutput
+	 *
+	 * @param 	bool 	$editMode 	true will display output on edit mod
+	 * @return 	string				html output
+	 */
+	public function generateTableOutput($editMode = false)
+	{
+		global $hookmanager, $action;
+		require_once DOL_DOCUMENT_ROOT.'/core/class/html.form.class.php';
+
+		$parameters = array(
+			'editMode' => $editMode
+		);
+		$reshook = $hookmanager->executeHooks('formSetupBeforeGenerateTableOutput', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
+		if ($reshook < 0) {
+			setEventMessages($hookmanager->error, $hookmanager->errors, 'errors');
+		}
+
+		if ($reshook > 0) {
+			return $hookmanager->resPrint;
+		} else {
+			$out = '<table class="noborder centpercent">';
+			$out .= '<thead>';
+			$out .= '<tr class="liste_titre">';
+			$out .= '	<td>' . $this->langs->trans("Parameter") . '</td>';
+			$out .= '	<td>' . $this->langs->trans("Value") . '</td>';
+			$out .= '</tr>';
+			$out .= '</thead>';
+
+			// Sort items before render
+			$this->sortingItems();
+
+			$out .= '<tbody>';
+			foreach ($this->items as $item) {
+				$out .= $this->generateLineOutput($item, $editMode);
+			}
+			$out .= '</tbody>';
+
+			$out .= '</table>';
+			return $out;
+		}
+	}
+
+	/**
+	 * saveConfFromPost
+	 *
+	 * @param 	bool 		$noMessageInUpdate display event message on errors and success
+	 * @return	 int        -1 if KO, 1 if OK
+	 */
+	public function saveConfFromPost($noMessageInUpdate = false)
+	{
+		global $hookmanager;
+
+		$parameters = array();
+		$reshook = $hookmanager->executeHooks('formSetupBeforeSaveConfFromPost', $parameters, $this); // Note that $action and $object may have been modified by some hooks
+		if ($reshook < 0) {
+			$this->setErrors($hookmanager->errors);
+			return -1;
+		}
+
+		if ($reshook > 0) {
+			return $reshook;
+		}
+
+
+		if (empty($this->items)) {
+			return null;
+		}
+
+		$this->db->begin();
+		$error = 0;
+		foreach ($this->items as $item) {
+			$res = $item->setValueFromPost();
+			if ($res > 0) {
+				$item->saveConfValue();
+			} elseif ($res < 0) {
+				$error++;
+				break;
+			}
+		}
+
+		if (!$error) {
+			$this->db->commit();
+			if (empty($noMessageInUpdate)) {
+				setEventMessages($this->langs->trans("SetupSaved"), null);
+			}
+			return 1;
+		} else {
+			$this->db->rollback();
+			if (empty($noMessageInUpdate)) {
+				setEventMessages($this->langs->trans("SetupNotSaved"), null, 'errors');
+			}
+			return -1;
+		}
+	}
+
+	/**
+	 * generateLineOutput
+	 *
+	 * @param 	FormSetupItem 	$item 		the setup item
+	 * @param 	bool 			$editMode 	Display as edit mod
+	 * @return 	string 						the html output for an setup item
+	 */
+	public function generateLineOutput($item, $editMode = false)
+	{
+
+		$out = '';
+		if ($item->enabled==1) {
+			$trClass = 'oddeven';
+			if ($item->getType() == 'title') {
+				$trClass = 'liste_titre';
+			}
+
+			$this->setupNotEmpty++;
+			$out.= '<tr class="'.$trClass.'">';
+
+			$out.= '<td class="col-setup-title">';
+			$out.= '<span id="helplink'.$item->confKey.'" class="spanforparamtooltip">';
+			$out.= $this->form->textwithpicto($item->getNameText(), $item->getHelpText(), 1, 'info', '', 0, 3, 'tootips'.$item->confKey);
+			$out.= '</span>';
+			$out.= '</td>';
+
+			$out.= '<td>';
+
+			if ($editMode) {
+				$out.= $item->generateInputField();
+			} else {
+				$out.= $item->generateOutputField();
+			}
+
+			if (!empty($item->errors)) {
+				// TODO : move set event message in a methode to be called by cards not by this class
+				setEventMessages(null, $item->errors, 'errors');
+			}
+
+			$out.= '</td>';
+			$out.= '</tr>';
+		}
+
+		return $out;
+	}
+
+
+	/**
+	 * Method used to test  module builder convertion to this form usage
+	 *
+	 * @param array 	$params 	an array of arrays of params from old modulBuilder params
+	 * @return null
+	 */
+	public function addItemsFromParamsArray($params)
+	{
+		if (!is_array($params) || empty($params)) { return false; }
+		foreach ($params as $confKey => $param) {
+			$this->addItemFromParams($confKey, $param); // todo manage error
+		}
+	}
+
+
+	/**
+	 * From old
+	 * Method was used to test  module builder convertion to this form usage.
+	 *
+	 * @param 	string 	$confKey 	the conf name to store
+	 * @param 	array 	$params 	an array of params from old modulBuilder params
+	 * @return 	bool
+	 */
+	public function addItemFromParams($confKey, $params)
+	{
+		if (empty($confKey) || empty($params['type'])) { return false; }
+
+		/*
+		 * Exemple from old module builder setup page
+		 * 	// 'MMISHIPPING_MYPARAM1'=>array('type'=>'string', 'css'=>'minwidth500' ,'enabled'=>1),
+			// 'MMISHIPPING_MYPARAM2'=>array('type'=>'textarea','enabled'=>1),
+			//'MMISHIPPING_MYPARAM3'=>array('type'=>'category:'.Categorie::TYPE_CUSTOMER, 'enabled'=>1),
+			//'MMISHIPPING_MYPARAM4'=>array('type'=>'emailtemplate:thirdparty', 'enabled'=>1),
+			//'MMISHIPPING_MYPARAM5'=>array('type'=>'yesno', 'enabled'=>1),
+			//'MMISHIPPING_MYPARAM5'=>array('type'=>'thirdparty_type', 'enabled'=>1),
+			//'MMISHIPPING_MYPARAM6'=>array('type'=>'securekey', 'enabled'=>1),
+			//'MMISHIPPING_MYPARAM7'=>array('type'=>'product', 'enabled'=>1),
+		 */
+
+		$item = new FormSetupItem($confKey);
+		// need to be ignored from scrutinizer setTypeFromTypeString was created as deprecated to incite developper to use object oriented usage
+		/** @scrutinizer ignore-deprecated */ $item->setTypeFromTypeString($params['type']);
+
+		if (!empty($params['enabled'])) {
+			$item->enabled = $params['enabled'];
+		}
+
+		if (!empty($params['css'])) {
+			$item->cssClass = $params['css'];
+		}
+
+		$this->items[$item->confKey] = $item;
+
+		return true;
+	}
+
+	/**
+	 * Used to export param array for /core/actions_setmoduleoptions.inc.php template
+	 * Method exists only for manage setup convertion
+	 *
+	 * @return array $arrayofparameters for /core/actions_setmoduleoptions.inc.php
+	 */
+	public function exportItemsAsParamsArray()
+	{
+		$arrayofparameters = array();
+		foreach ($this->items as $item) {
+			$arrayofparameters[$item->confKey] = array(
+				'type' => $item->getType(),
+				'enabled' => $item->enabled
+			);
+		}
+
+		return $arrayofparameters;
+	}
+
+	/**
+	 * Reload for each item default conf
+	 * note: this will override custom configuration
+	 *
+	 * @return bool
+	 */
+	public function reloadConfs()
+	{
+
+		if (!array($this->items)) { return false; }
+		foreach ($this->items as $item) {
+			$item->loadValueFromConf();
+		}
+
+		return true;
+	}
+
+
+	/**
+	 * Create a new item
+	 * the tagret is useful with hooks : that allow externals modules to add setup items on good place
+	 *
+	 * @param string	$confKey 				the conf key used in database
+	 * @param string	$targetItemKey    		target item used to place the new item beside
+	 * @param bool		$insertAfterTarget		insert before or after target item ?
+	 * @return FormSetupItem the new setup item created
+	 */
+	public function newItem($confKey, $targetItemKey = false, $insertAfterTarget = false)
+	{
+		$item = new FormSetupItem($confKey);
+
+		// set item rank if not defined as last item
+		if (empty($item->rank)) {
+			$item->rank = $this->getCurentItemMaxRank() + 1;
+			$this->setItemMaxRank($item->rank); // set new max rank if needed
+		}
+
+		// try to get rank from target column, this will override item->rank
+		if (!empty($targetItemKey)) {
+			if (isset($this->items[$targetItemKey])) {
+				$targetItem = $this->items[$targetItemKey];
+				$item->rank = $targetItem->rank; // $targetItem->rank will be increase after
+				if ($targetItem->rank >= 0 && $insertAfterTarget) {
+					$item->rank++;
+				}
+			}
+
+			// calc new rank for each item to make place for new item
+			foreach ($this->items as $fItem) {
+				if ($item->rank <= $fItem->rank) {
+					$fItem->rank = $fItem->rank + 1;
+					$this->setItemMaxRank($fItem->rank); // set new max rank if needed
+				}
+			}
+		}
+
+		$this->items[$item->confKey] = $item;
+		return $this->items[$item->confKey];
+	}
+
+	/**
+	 * Sort items according to rank
+	 *
+	 * @return bool
+	 */
+	public function sortingItems()
+	{
+		// Sorting
+		return uasort($this->items, array($this, 'itemSort'));
+	}
+
+	/**
+	 * getCurentItemMaxRank
+	 *
+	 * @param bool $cache To use cache or not
+	 * @return int
+	 */
+	public function getCurentItemMaxRank($cache = true)
+	{
+		if (empty($this->items)) {
+			return 0;
+		}
+
+		if ($cache && $this->maxItemRank > 0) {
+			return $this->maxItemRank;
+		}
+
+		$this->maxItemRank = 0;
+		foreach ($this->items as $item) {
+			$this->maxItemRank = max($this->maxItemRank, $item->rank);
+		}
+
+		return $this->maxItemRank;
+	}
+
+
+	/**
+	 * set new max rank if needed
+	 *
+	 * @param 	int 		$rank 	the item rank
+	 * @return 	int|void			new max rank
+	 */
+	public function setItemMaxRank($rank)
+	{
+		$this->maxItemRank = max($this->maxItemRank, $rank);
+	}
+
+
+	/**
+	 * get item position rank from item key
+	 *
+	 * @param	string		$itemKey    	the item key
+	 * @return	int         				rank on success and -1 on error
+	 */
+	public function getLineRank($itemKey)
+	{
+		if (!isset($this->items[$itemKey]->rank)) {
+			return -1;
+		}
+		return  $this->items[$itemKey]->rank;
+	}
+
+
+	/**
+	 *  uasort callback function to Sort params items
+	 *
+	 *  @param	FormSetupItem	$a  formSetup item
+	 *  @param	FormSetupItem	$b  formSetup item
+	 *  @return	int					Return compare result
+	 */
+	public function itemSort(FormSetupItem $a, FormSetupItem $b)
+	{
+		if (empty($a->rank)) {
+			$a->rank = 0;
+		}
+		if (empty($b->rank)) {
+			$b->rank = 0;
+		}
+		if ($a->rank == $b->rank) {
+			return 0;
+		}
+		return ($a->rank < $b->rank) ? -1 : 1;
+	}
+}
+
+/**
+ * This class help to create item for class formSetup
+ */
+class FormSetupItem
+{
+	/**
+	 * @var DoliDB Database handler.
+	 */
+	public $db;
+
+	/** @var Translate */
+	public $langs;
+
+	/** @var int */
+	public $entity;
+
+	/** @var Form */
+	public $form;
+
+	/** @var string $confKey the conf key used in database */
+	public $confKey;
+
+	/** @var string|false $nameText  */
+	public $nameText = false;
+
+	/** @var string $helpText  */
+	public $helpText = '';
+
+	/** @var string $fieldValue  */
+	public $fieldValue;
+
+	/** @var string $defaultFieldValue  */
+	public $defaultFieldValue = null;
+
+	/** @var array $fieldAttr  fields attribute only for compatible fields like input text */
+	public $fieldAttr = array();
+
+	/** @var bool|string set this var to override field output will override $fieldInputOverride and $fieldOutputOverride too */
+	public $fieldOverride = false;
+
+	/** @var bool|string set this var to override field input */
+	public $fieldInputOverride = false;
+
+	/** @var bool|string set this var to override field output */
+	public $fieldOutputOverride = false;
+
+	/** @var int $rank  */
+	public $rank = 0;
+
+	/** @var array set this var for options on select and multiselect items   */
+	public $fieldOptions = array();
+
+	/** @var callable $saveCallBack  */
+	public $saveCallBack;
+
+	/** @var callable $setValueFromPostCallBack  */
+	public $setValueFromPostCallBack;
+
+	/**
+	 * @var string $errors
+	 */
+	public $errors = array();
+
+	/**
+	 * TODO each type must have setAs{type} method to help configuration
+	 *   And set var as protected when its done configuration must be done by method
+	 *   this is important for retrocompatibility of futures versions
+	 * @var string $type  'string', 'textarea', 'category:'.Categorie::TYPE_CUSTOMER', 'emailtemplate', 'thirdparty_type'
+	 */
+	protected $type = 'string';
+
+	public $enabled = 1;
+
+	public $cssClass = '';
+
+	/**
+	 * Constructor
+	 *
+	 * @param string $confKey the conf key used in database
+	 */
+	public function __construct($confKey)
+	{
+		global $langs, $db, $conf, $form;
+		$this->db = $db;
+
+		if (!empty($form) && is_object($form) && get_class($form) == 'Form') { // the form class has a cache inside so I am using it to optimize
+			$this->form = $form;
+		} else {
+			$this->form = new Form($this->db);
+		}
+
+		$this->langs = $langs;
+		$this->entity = $conf->entity;
+
+		$this->confKey = $confKey;
+		$this->loadValueFromConf();
+	}
+
+	/**
+	 * load conf value from databases
+	 * @return bool
+	 */
+	public function loadValueFromConf()
+	{
+		global $conf;
+		if (isset($conf->global->{$this->confKey})) {
+			$this->fieldValue = $conf->global->{$this->confKey};
+			return true;
+		} else {
+			$this->fieldValue = null;
+			return false;
+		}
+	}
+
+	/**
+	 * reload conf value from databases is an aliase of loadValueFromConf
+	 * @deprecated
+	 * @return bool
+	 */
+	public function reloadValueFromConf()
+	{
+		return $this->loadValueFromConf();
+	}
+
+
+	/**
+	 * Save const value based on htdocs/core/actions_setmoduleoptions.inc.php
+	 *	@return     int         			-1 if KO, 1 if OK
+	 */
+	public function saveConfValue()
+	{
+		global $hookmanager;
+
+		$parameters = array();
+		$reshook = $hookmanager->executeHooks('formSetupBeforeSaveConfValue', $parameters, $this); // Note that $action and $object may have been modified by some hooks
+		if ($reshook < 0) {
+			$this->setErrors($hookmanager->errors);
+			return -1;
+		}
+
+		if ($reshook > 0) {
+			return $reshook;
+		}
+
+
+		if (!empty($this->saveCallBack) && is_callable($this->saveCallBack)) {
+			return call_user_func($this->saveCallBack, $this);
+		}
+
+		// Modify constant only if key was posted (avoid resetting key to the null value)
+		if ($this->type != 'title') {
+			$result = dolibarr_set_const($this->db, $this->confKey, $this->fieldValue, 'chaine', 0, '', $this->entity);
+			if ($result < 0) {
+				return -1;
+			} else {
+				return 1;
+			}
+		}
+	}
+
+	/**
+	 * Set an override function for saving data
+	 * @param callable $callBack a callable function
+	 * @return void
+	 */
+	public function setSaveCallBack(callable $callBack)
+	{
+		$this->saveCallBack = $callBack;
+	}
+
+	/**
+	 * Set an override function for get data from post
+	 * @param callable $callBack a callable function
+	 * @return void
+	 */
+	public function setValueFromPostCallBack(callable $callBack)
+	{
+		$this->setValueFromPostCallBack = $callBack;
+	}
+
+	/**
+	 * Save const value based on htdocs/core/actions_setmoduleoptions.inc.php
+	 *	@return     int         			-1 if KO, 0  nothing to do , 1 if OK
+	 */
+	public function setValueFromPost()
+	{
+		if (!empty($this->setValueFromPostCallBack) && is_callable($this->setValueFromPostCallBack)) {
+			return call_user_func($this->setValueFromPostCallBack);
+		}
+
+		// Modify constant only if key was posted (avoid resetting key to the null value)
+		if ($this->type != 'title') {
+			if (preg_match('/category:/', $this->type)) {
+				if (GETPOST($this->confKey, 'int') == '-1') {
+					$val_const = '';
+				} else {
+					$val_const = GETPOST($this->confKey, 'int');
+				}
+			} elseif ($this->type == 'multiselect') {
+				$val = GETPOST($this->confKey, 'array');
+				if ($val && is_array($val)) {
+					$val_const = implode(',', $val);
+				}
+			} elseif ($this->type == 'html') {
+				$val_const = GETPOST($this->confKey, 'restricthtml');
+			} else {
+				$val_const = GETPOST($this->confKey, 'alpha');
+			}
+
+			// TODO add value check with class validate
+			$this->fieldValue = $val_const;
+
+			return 1;
+		}
+
+		return 0;
+	}
+
+	/**
+	 * Get help text or generate it
+	 * @return int|string
+	 */
+	public function getHelpText()
+	{
+		if (!empty($this->helpText)) { return $this->helpText; }
+		return (($this->langs->trans($this->confKey . 'Tooltip') != $this->confKey . 'Tooltip') ? $this->langs->trans($this->confKey . 'Tooltip') : '');
+	}
+
+	/**
+	 * Get field name text or generate it
+	 * @return false|int|string
+	 */
+	public function getNameText()
+	{
+		if (!empty($this->nameText)) { return $this->nameText; }
+		return (($this->langs->trans($this->confKey) != $this->confKey) ? $this->langs->trans($this->confKey) : $this->langs->trans('MissingTranslationForConfKey', $this->confKey));
+	}
+
+	/**
+	 * generate input field
+	 * @return bool|string
+	 */
+	public function generateInputField()
+	{
+		global $conf;
+
+		if (!empty($this->fieldOverride)) {
+			return $this->fieldOverride;
+		}
+
+		if (!empty($this->fieldInputOverride)) {
+			return $this->fieldInputOverride;
+		}
+
+		// Set default value
+		if (is_null($this->fieldValue)) {
+			$this->fieldValue = $this->defaultFieldValue;
+		}
+
+
+		$this->fieldAttr['name'] = $this->confKey;
+		$this->fieldAttr['id'] = 'setup-'.$this->confKey;
+		$this->fieldAttr['value'] = $this->fieldValue;
+
+		$out = '';
+
+		if ($this->type == 'title') {
+			$out.= $this->generateOutputField(); // title have no input
+		} elseif ($this->type == 'multiselect') {
+			$out.= $this->generateInputFieldMultiSelect();
+		} elseif ($this->type == 'select') {
+			$out.= $this->generateInputFieldSelect();
+		} elseif ($this->type == 'textarea') {
+			$out.= $this->generateInputFieldTextarea();
+		} elseif ($this->type== 'html') {
+			$out.= $this->generateInputFieldHtml();
+		} elseif ($this->type== 'color') {
+			$out.=  $this->generateInputFieldColor();
+		} elseif ($this->type == 'yesno') {
+			$out.= $this->form->selectyesno($this->confKey, $this->fieldValue, 1);
+		} elseif (preg_match('/emailtemplate:/', $this->type)) {
+			$out.= $this->generateInputFieldEmailTemplate();
+		} elseif (preg_match('/category:/', $this->type)) {
+			$out.=$this->generateInputFieldCategories();
+		} elseif (preg_match('/thirdparty_type/', $this->type)) {
+			require_once DOL_DOCUMENT_ROOT.'/core/class/html.formcompany.class.php';
+			$formcompany = new FormCompany($this->db);
+			$out.= $formcompany->selectProspectCustomerType($this->fieldValue, $this->confKey);
+		} elseif ($this->type == 'securekey') {
+			$out.= $this->generateInputFieldSecureKey();
+		} elseif ($this->type == 'product') {
+			if (!empty($conf->product->enabled) || !empty($conf->service->enabled)) {
+				$selected = (empty($this->fieldValue) ? '' : $this->fieldValue);
+				$out.= $this->form->select_produits($selected, $this->confKey, '', 0, 0, 1, 2, '', 0, array(), 0, '1', 0, $this->cssClass, 0, '', null, 1);
+			}
+		} else {
+			$out.= $this->generateInputFieldText();
+		}
+
+		return $out;
+	}
+
+	/**
+	 * generatec default input field
+	 * @return string
+	 */
+	public function generateInputFieldText()
+	{
+		if (empty($this->fieldAttr)) { $this->fieldAttr['class'] = 'flat '.(empty($this->cssClass) ? 'minwidth200' : $this->cssClass); }
+		return '<input '.FormSetup::generateAttributesStringFromArray($this->fieldAttr).' />';
+	}
+
+	/**
+	 * generate input field for textarea
+	 * @return string
+	 */
+	public function generateInputFieldTextarea()
+	{
+		$out = '<textarea class="flat" name="'.$this->confKey.'" id="'.$this->confKey.'" cols="50" rows="5" wrap="soft">' . "\n";
+		$out.= dol_htmlentities($this->fieldValue);
+		$out.= "</textarea>\n";
+		return $out;
+	}
+
+	/**
+	 * generate input field for html
+	 * @return string
+	 */
+	public function generateInputFieldHtml()
+	{
+		global $conf;
+		require_once DOL_DOCUMENT_ROOT . '/core/class/doleditor.class.php';
+		$doleditor = new DolEditor($this->confKey, $this->fieldValue, '', 160, 'dolibarr_notes', '', false, false, $conf->fckeditor->enabled, ROWS_5, '90%');
+		return $doleditor->Create(1);
+	}
+
+	/**
+	 * generate input field for categories
+	 * @return string
+	 */
+	public function generateInputFieldCategories()
+	{
+		global $conf;
+		require_once DOL_DOCUMENT_ROOT.'/categories/class/categorie.class.php';
+		require_once DOL_DOCUMENT_ROOT.'/core/class/html.formother.class.php';
+		$formother = new FormOther($this->db);
+
+		$tmp = explode(':', $this->type);
+		$out= img_picto('', 'category', 'class="pictofixedwidth"');
+		$out.= $formother->select_categories($tmp[1],  $this->fieldValue, $this->confKey, 0, $this->langs->trans('CustomersProspectsCategoriesShort'));
+		return $out;
+	}
+
+	/**
+	 * generate input field for email template selector
+	 * @return string
+	 */
+	public function generateInputFieldEmailTemplate()
+	{
+		global $conf, $user;
+		$out = '';
+		if (preg_match('/emailtemplate:/', $this->type)) {
+			include_once DOL_DOCUMENT_ROOT . '/core/class/html.formmail.class.php';
+			$formmail = new FormMail($this->db);
+
+			$tmp = explode(':', $this->type);
+			$nboftemplates = $formmail->fetchAllEMailTemplate($tmp[1], $user, null, 1); // We set lang=null to get in priority record with no lang
+			$arrayOfMessageName = array();
+			if (is_array($formmail->lines_model)) {
+				foreach ($formmail->lines_model as $modelMail) {
+					$moreonlabel = '';
+					if (!empty($arrayOfMessageName[$modelMail->label])) {
+						$moreonlabel = ' <span class="opacitymedium">(' . $this->langs->trans("SeveralLangugeVariatFound") . ')</span>';
+					}
+					// The 'label' is the key that is unique if we exclude the language
+					$arrayOfMessageName[$modelMail->id] = $this->langs->trans(preg_replace('/\(|\)/', '', $modelMail->label)) . $moreonlabel;
+				}
+			}
+			$out .= $this->form->selectarray($this->confKey, $arrayOfMessageName, $this->fieldValue, 'None', 0, 0, '', 0, 0, 0, '', '', 1);
+		}
+
+		return $out;
+	}
+
+
+	/**
+	 * generate input field for secure key
+	 * @return string
+	 */
+	public function generateInputFieldSecureKey()
+	{
+		global $conf;
+		$out = '<input required="required" type="text" class="flat" id="'.$this->confKey.'" name="'.$this->confKey.'" value="'.(GETPOST($this->confKey, 'alpha') ?GETPOST($this->confKey, 'alpha') : $this->fieldValue).'" size="40">';
+		if (!empty($conf->use_javascript_ajax)) {
+			$out.= '&nbsp;'.img_picto($this->langs->trans('Generate'), 'refresh', 'id="generate_token'.$this->confKey.'" class="linkobject"');
+		}
+		if (!empty($conf->use_javascript_ajax)) {
+			$out .= "\n" . '<script type="text/javascript">';
+			$out .= '$(document).ready(function () {
+                        $("#generate_token' . $this->confKey . '").click(function() {
+                	        $.get( "' . DOL_URL_ROOT . '/core/ajax/security.php", {
+                		      action: \'getrandompassword\',
+                		      generic: true
+    				        },
+    				        function(token) {
+    					       $("#' . $this->confKey . '").val(token);
+            				});
+                         });
+                    });';
+			$out .= '</script>';
+		}
+		return $out;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function generateInputFieldMultiSelect()
+	{
+		$TSelected = array();
+		if ($this->fieldValue) {
+			$TSelected = explode(',', $this->fieldValue);
+		}
+
+		return $this->form->multiselectarray($this->confKey, $this->fieldOptions, $TSelected, 0, 0, '', 0, 0, 'style="min-width:100px"');
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function generateInputFieldSelect()
+	{
+		return $this->form->selectarray($this->confKey, $this->fieldOptions, $this->fieldValue);
+	}
+
+	/**
+	 * get the type : used for old module builder setup conf style conversion and tests
+	 * because this two class will quickly evolve it's important to not set or get directly $this->type (will be protected) so this method exist
+	 * to be sure we can manage evolution easily
+	 *
+	 * @return string
+	 */
+	public function getType()
+	{
+		return $this->type;
+	}
+
+	/**
+	 * set the type from string : used for old module builder setup conf style conversion and tests
+	 * because this two class will quickly evolve it's important to not set directly $this->type (will be protected) so this method exist
+	 * to be sure we can manage evolution easily
+	 * @param string $type possible values based on old module builder setup : 'string', 'textarea', 'category:'.Categorie::TYPE_CUSTOMER', 'emailtemplate', 'thirdparty_type'
+	 * @deprecated yes this setTypeFromTypeString came deprecated because it exists only for manage setup convertion
+	 * @return bool
+	 */
+	public function setTypeFromTypeString($type)
+	{
+		$this->type = $type;
+		return true;
+	}
+
+	/**
+	 * Add error
+	 * @param array|string $errors the error text
+	 * @return null
+	 */
+	public function setErrors($errors)
+	{
+		if (is_array($errors)) {
+			if (!empty($errors)) {
+				foreach ($errors as $error) {
+					$this->setErrors($error);
+				}
+			}
+		} elseif (!empty($errors)) {
+			$this->errors[] = $errors;
+		}
+	}
+
+	/**
+	 * @return bool|string Generate the output html for this item
+	 */
+	public function generateOutputField()
+	{
+		global $conf, $user;
+
+		if (!empty($this->fieldOverride)) {
+			return $this->fieldOverride;
+		}
+
+		if (!empty($this->fieldOutputOverride)) {
+			return $this->fieldOutputOverride;
+		}
+
+		$out = '';
+
+		if ($this->type == 'title') {
+			// nothing to do
+		} elseif ($this->type == 'textarea') {
+			$out.= dol_nl2br($this->fieldValue);
+		} elseif ($this->type == 'multiselect') {
+			$out.= $this->generateOutputFieldMultiSelect();
+		} elseif ($this->type == 'select') {
+			$out.= $this->generateOutputFieldSelect();
+		} elseif ($this->type== 'html') {
+			$out.=  $this->fieldValue;
+		} elseif ($this->type== 'color') {
+			$out.=  $this->generateOutputFieldColor();
+		} elseif ($this->type == 'yesno') {
+			$out.= ajax_constantonoff($this->confKey);
+		} elseif (preg_match('/emailtemplate:/', $this->type)) {
+			if ($this->fieldValue > 0) {
+				include_once DOL_DOCUMENT_ROOT . '/core/class/html.formmail.class.php';
+				$formmail = new FormMail($this->db);
+
+				$tmp = explode(':', $this->type);
+
+				$template = $formmail->getEMailTemplate($this->db, $tmp[1], $user, $this->langs, $this->fieldValue);
+				if ($template<0) {
+					$this->setErrors($formmail->errors);
+				}
+				$out.= $this->langs->trans($template->label);
+			}
+		} elseif (preg_match('/category:/', $this->type)) {
+			require_once DOL_DOCUMENT_ROOT.'/categories/class/categorie.class.php';
+			$c = new Categorie($this->db);
+			$result = $c->fetch($this->fieldValue);
+			if ($result < 0) {
+				$this->setErrors($c->errors);
+			}
+			$ways = $c->print_all_ways(' &gt;&gt; ', 'none', 0, 1); // $ways[0] = "ccc2 >> ccc2a >> ccc2a1" with html formated text
+			$toprint = array();
+			foreach ($ways as $way) {
+				$toprint[] = '<li class="select2-search-choice-dolibarr noborderoncategories"' . ($c->color ? ' style="background: #' . $c->color . ';"' : ' style="background: #bbb"') . '>' . $way . '</li>';
+			}
+			$out.='<div class="select2-container-multi-dolibarr" style="width: 90%;"><ul class="select2-choices-dolibarr">' . implode(' ', $toprint) . '</ul></div>';
+		} elseif (preg_match('/thirdparty_type/', $this->type)) {
+			if ($this->fieldValue==2) {
+				$out.= $this->langs->trans("Prospect");
+			} elseif ($this->fieldValue==3) {
+				$out.= $this->langs->trans("ProspectCustomer");
+			} elseif ($this->fieldValue==1) {
+				$out.= $this->langs->trans("Customer");
+			} elseif ($this->fieldValue==0) {
+				$out.= $this->langs->trans("NorProspectNorCustomer");
+			}
+		} elseif ($this->type == 'product') {
+			if (!class_exists("Product")) {
+				require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
+			}
+			$product = new Product($this->db);
+			$resprod = $product->fetch($this->fieldValue);
+			if ($resprod > 0) {
+				$out.= $product->ref;
+			} elseif ($resprod < 0) {
+				$this->setErrors($product->errors);
+			}
+		} else {
+			$out.= $this->fieldValue;
+		}
+
+		return $out;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function generateOutputFieldMultiSelect()
+	{
+		$outPut = '';
+		$TSelected = array();
+		if (!empty($this->fieldValue)) {
+			$TSelected = explode(',', $this->fieldValue);
+		}
+
+		if (!empty($TSelected)) {
+			foreach ($TSelected as $selected) {
+				if (!empty($this->fieldOptions[$selected])) {
+					$outPut.= dolGetBadge('', $this->fieldOptions[$selected], 'info').' ';
+				}
+			}
+		}
+		return $outPut;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function generateOutputFieldColor()
+	{
+		$this->fieldAttr['disabled']=null;
+		return $this->generateInputField();
+	}
+	/**
+	 * @return string
+	 */
+	public function generateInputFieldColor()
+	{
+		$this->fieldAttr['type']= 'color';
+		return $this->generateInputFieldText();
+	}
+
+	/**
+	 * @return string
+	 */
+	public function generateOutputFieldSelect()
+	{
+		$outPut = '';
+		if (!empty($this->fieldOptions[$this->fieldValue])) {
+			$outPut = $this->fieldOptions[$this->fieldValue];
+		}
+
+		return $outPut;
+	}
+
+	/*
+	 * METHODS FOR SETTING DISPLAY TYPE
+	 */
+
+	/**
+	 * Set type of input as string
+	 * @return self
+	 */
+	public function setAsString()
+	{
+		$this->type = 'string';
+		return $this;
+	}
+
+	/**
+	 * Set type of input as color
+	 * @return self
+	 */
+	public function setAsColor()
+	{
+		$this->type = 'color';
+		return $this;
+	}
+
+	/**
+	 * Set type of input as textarea
+	 * @return self
+	 */
+	public function setAsTextarea()
+	{
+		$this->type = 'textarea';
+		return $this;
+	}
+
+	/**
+	 * Set type of input as html editor
+	 * @return self
+	 */
+	public function setAsHtml()
+	{
+		$this->type = 'html';
+		return $this;
+	}
+
+	/**
+	 * Set type of input as emailtemplate selector
+	 * @param string $templateType email template type
+	 * @return self
+	 */
+	public function setAsEmailTemplate($templateType)
+	{
+		$this->type = 'emailtemplate:'.$templateType;
+		return $this;
+	}
+
+	/**
+	 * Set type of input as thirdparty_type selector
+	 * @return self
+	 */
+	public function setAsThirdpartyType()
+	{
+		$this->type = 'thirdparty_type';
+		return $this;
+	}
+
+	/**
+	 * Set type of input as Yes
+	 * @return self
+	 */
+	public function setAsYesNo()
+	{
+		$this->type = 'yesno';
+		return $this;
+	}
+
+	/**
+	 * Set type of input as secure key
+	 * @return self
+	 */
+	public function setAsSecureKey()
+	{
+		$this->type = 'securekey';
+		return $this;
+	}
+
+	/**
+	 * Set type of input as product
+	 * @return self
+	 */
+	public function setAsProduct()
+	{
+		$this->type = 'product';
+		return $this;
+	}
+
+	/**
+	 * Set type of input as a category selector
+	 * TODO add default value
+	 * @param	int		$catType		Type of category ('customer', 'supplier', 'contact', 'product', 'member'). Old mode (0, 1, 2, ...) is deprecated.
+	 * @return self
+	 */
+	public function setAsCategory($catType)
+	{
+		$this->type = 'category:'.$catType;
+		return $this;
+	}
+
+	/**
+	 * Set type of input as a simple title
+	 * no data to store
+	 * @return self
+	 */
+	public function setAsTitle()
+	{
+		$this->type = 'title';
+		return $this;
+	}
+
+
+	/**
+	 * Set type of input as a simple title
+	 * no data to store
+	 * @param array $fieldOptions A table of field options
+	 * @return self
+	 */
+	public function setAsMultiSelect($fieldOptions)
+	{
+		if (is_array($fieldOptions)) {
+			$this->fieldOptions = $fieldOptions;
+		}
+
+		$this->type = 'multiselect';
+		return $this;
+	}
+
+	/**
+	 * Set type of input as a simple title
+	 * no data to store
+	 * @param array $fieldOptions  A table of field options
+	 * @return self
+	 */
+	public function setAsSelect($fieldOptions)
+	{
+		if (is_array($fieldOptions)) {
+			$this->fieldOptions = $fieldOptions;
+		}
+
+		$this->type = 'select';
+		return $this;
+	}
+}

+ 11 - 0
build/makepack-mmishipping.conf

@@ -0,0 +1,11 @@
+# Your module name here
+#
+# Goal:    Goal of module
+# Version: <version>
+# Author:  Copyright <year> - <name of author>
+# License: GPLv3
+# Install: Just unpack content of module package in Dolibarr directory.
+# Setup:   Go on Dolibarr setup - modules to enable module.
+#
+# Files in module
+mymodule/

+ 182 - 0
class/actions_mmishipping.class.php

@@ -0,0 +1,182 @@
+<?php
+/* Copyright (C) 2023 Moulin Mathieu <contact@iprospective.fr>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+dol_include_once('custom/mmicommon/class/mmi_actions.class.php');
+dol_include_once('custom/mmishipping/class/mmishipping.class.php');
+
+require_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
+require_once DOL_DOCUMENT_ROOT.'/product/stock/class/entrepot.class.php';
+require_once DOL_DOCUMENT_ROOT.'/commande/class/commande.class.php';
+require_once DOL_DOCUMENT_ROOT.'/expedition/class/expedition.class.php';
+require_once DOL_DOCUMENT_ROOT.'/fourn/class/fournisseur.commande.class.php';
+require_once DOL_DOCUMENT_ROOT.'/reception/class/reception.class.php';
+
+/**
+ * Class ActionsMMIShipping
+ */
+class ActionsMMIShipping extends MMI_Actions_1_0
+{
+	const MOD_NAME = 'mmishipping';
+
+
+	/**
+	 * Overloading the addMoreMassActions function : replacing the parent's function with the one below
+	 *
+	 * @param   array           $parameters     Hook metadatas (context, etc...)
+	 * @param   CommonObject    $object         The object to process (an invoice if you are in invoice module, a propale in propale's module, etc...)
+	 * @param   string          $action         Current action (if set). Generally create or edit or null
+	 * @param   HookManager     $hookmanager    Hook manager propagated to allow calling another hook
+	 * @return  int                             < 0 on error, 0 on success, 1 to replace standard code
+	 */
+	public function addMoreActionsButtons($parameters, &$object, &$action, $hookmanager)
+	{
+		global $conf, $user, $langs, $db;
+
+		$error = 0; // Error counter
+
+		// Fiche Commande
+		if ($this->in_context($parameters, 'ordersuppliercard')) {
+			// Client réception si commande liée
+			if (!empty($conf->global->MMISHIPPING_DF)) {
+				// Recherche commande liée
+				$sql = "SELECT e.fk_source id
+					FROM ".MAIN_DB_PREFIX."element_element e
+					WHERE e.`targettype` LIKE 'order_supplier' AND e.`fk_target`='".$object->id."' AND e.sourcetype='commande'";
+				//echo '<p>'.$sql.'</p>';
+				$resql = $db->query($sql);
+				if(!empty($resql) && $resql->num_rows>0) {
+					$obj = $db->fetch_object($resql);
+					$fk_commande = $obj->id;
+				}
+				
+				if (!empty($fk_commande)){
+					$link = '?id='.$object->id.'&action=adresse_assign_auto';
+					echo "<a class='butAction' href='".$link."'>".$langs->trans("MMIShippingAssignAddress")."</a>";
+				}
+				if (!empty($fk_commande)){
+					$link = '?id='.$object->id.'&action=receive_and_send';
+					echo "<a class='butAction' href='".$link."'>".$langs->trans("MMIShippingSupplierOrderReceiveAndSend")."</a>";
+				}
+			}
+		}
+
+		if (!$error) {
+			return 0; // or return 1 to replace standard code
+		} else {
+			$this->errors[] = 'Error message';
+			return -1;
+		}
+	}
+
+	function doActions($parameters, &$object, &$action, $hookmanager)
+	{
+		global $conf, $user, $langs, $db;
+
+		$error = 0; // Error counter
+
+		// Associated order
+		if ($this->in_context($parameters, 'ordersuppliercard') && in_array($action, ['adresse_assign_auto', 'receive_and_send']) && !empty($conf->global->MMISHIPPING_DF)) {
+			// Recherche commande liée
+			$sql = "SELECT e.fk_source id
+				FROM ".MAIN_DB_PREFIX."element_element e
+				WHERE e.`targettype` LIKE 'order_supplier' AND e.`fk_target`='".$object->id."' AND e.sourcetype='commande'";
+			//echo '<p>'.$sql.'</p>';
+			$resql = $db->query($sql);
+			//var_dump($resql);
+			if ($obj = $db->fetch_object($resql)) {
+				$commande = new Commande($db);
+				$commande->fetch($obj->id);
+				//var_dump($commande);
+			}
+		}
+
+		// Assign client address
+		if ($this->in_context($parameters, 'ordersuppliercard') && $action=='adresse_assign_auto' && !empty($commande) && !empty($conf->global->MMISHIPPING_DF)) {
+			//var_dump($commande);
+			// Recherche contact livraison commande
+			$contacts = $commande->liste_contact(-1, 'external', 0, 'SHIPPING');
+			if (!empty($contacts)) {
+				$contact = $contacts[0];
+				//var_dump($contact);
+				// Assignation contact livraison commande à la commande fournisseur
+				$object->array_options['options_fk_adresse'] = $contact['id'];
+				//var_dump($object->array_options);
+				//var_dump($object);
+				$object->update($user);
+			}
+		}
+
+		// receive and send
+		if ($this->in_context($parameters, 'ordersuppliercard') && $action=='receive_and_send' && !empty($commande) && !empty($conf->global->MMISHIPPING_DF) && !empty($conf->global->MMISHIPPING_DF_ENTREPOT)) {
+			$entrepot = new Entrepot($db);
+			$entrepot->fetch($conf->global->MMISHIPPING_DF_ENTREPOT);
+			$commande->loadExpeditions();
+			$object->loadReceptions();
+			if ($entrepot->id) {
+				$ok = true;
+				$todo = [];
+				foreach($object->lines as $line) {
+					//var_dump($line);
+					$qty = $line->qty;
+					// déjà reçu
+					if (isset($object->receptions[$line->id]))
+						$qty -= $object->receptions[$line->id];
+					$found = 0;
+					foreach($commande->lines as $cline) {
+						// Qté dans commande
+						if ($cline->fk_product==$line->fk_product)
+							$found += $cline->qty;
+						// Qté déjà expédiée
+						if (isset($commande->expeditions[$cline->id]))
+							$found -= $commande->expeditions[$cline->id];
+					}
+					//var_dump($found, $qty);
+					if ($qty>$found) {
+						$ok = false;
+						$error++;
+						// @todo : mettre le message en traduction
+						$this->errors[] = 'Qty too high for line "'.$line->libelle.'", found '.$found.' but needed to send only '.$qty;
+						break;
+					}
+					else {
+						$todo[$line->id] = $qty;
+					}
+				}
+				// Créer réception & expé
+				if ($ok) {
+					//
+					//var_dump($todo);
+					$reception = mmishipping::commande_fourn_to_reception($user, $object);
+					$shipping = mmishipping::commande_fourn_to_shipping($user, $object);
+				}
+				//var_dump($ok);
+			}
+			else {
+				$error++;
+				// @todo : mettre le message en traduction
+				$this->errors[] = 'Missing entrepot '.$conf->global->MMISHIPPING_DF_ENTREPOT.', bad config MMISHIPPING_DF_ENTREPOT';
+			}
+		}
+
+		if (!$error) {
+			return 0; // or return 1 to replace standard code
+		} else {
+			//$this->errors[] = 'Error message';
+			return -1;
+		}
+	}
+}

+ 259 - 0
class/mmishipping.class.php

@@ -0,0 +1,259 @@
+<?php
+
+require_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
+require_once DOL_DOCUMENT_ROOT.'/product/stock/class/entrepot.class.php';
+require_once DOL_DOCUMENT_ROOT.'/commande/class/commande.class.php';
+require_once DOL_DOCUMENT_ROOT.'/expedition/class/expedition.class.php';
+require_once DOL_DOCUMENT_ROOT.'/fourn/class/fournisseur.commande.class.php';
+require_once DOL_DOCUMENT_ROOT.'/fourn/class/fournisseur.commande.dispatch.class.php';
+require_once DOL_DOCUMENT_ROOT.'/reception/class/reception.class.php';
+
+class mmishipping
+{
+	// expédition auto depuis réception
+	public static function commande_fourn_to_reception(User $user, CommandeFournisseur $commande_fourn, $validate=true)
+	{
+		//var_dump($order); die();
+		//var_dump($user); die();
+		global $conf, $db, $langs;
+
+		if (! $user->rights->reception->creer)
+			return;
+		
+		if (empty($commande_fourn))
+			return;
+		if (!empty($conf->global->MMISHIPPING_DF_ENTREPOT))
+			$warehouse_id = $conf->global->MMISHIPPING_DF_ENTREPOT;
+		
+		// Code récupéré depuis fourn/commande/dispatch.php
+		$error = 0;
+		$notrigger = 0;
+
+		$db->begin();
+
+		$objectsrc = $commande_fourn;
+		$origin = 'supplierorder';
+		$origin_id = $commande_fourn->id;
+		$date_delivery = '';
+
+		$object = new Reception($db);
+
+		$object->origin = $origin;
+		$object->origin_id = $origin_id;
+		$object->fk_project = $commande_fourn->fk_project;
+		$object->weight = NULL;
+		$object->trueHeight = NULL;
+		$object->trueWidth = NULL;
+		$object->trueDepth = NULL;
+		$object->size_units = NULL;
+		$object->weight_units = NULL;
+
+		// On va boucler sur chaque ligne du document d'origine pour completer objet reception
+		// avec info diverses + qte a livrer
+
+		$object->socid = $objectsrc->socid;
+		$object->ref_supplier = 'contremarque';
+		$object->model_pdf = 'rouget';
+		$object->date_delivery = $date_delivery; // Date delivery planed
+		$object->fk_delivery_address = $objectsrc->fk_delivery_address;
+		$object->shipping_method_id = '';
+		$object->tracking_number = '';
+		$object->note_private = '';
+		$object->note_public = '';
+		$object->fk_incoterms = $commande_fourn->fk_incoterms;
+		$object->location_incoterms = $commande_fourn->location_incoterms;
+
+		foreach ($objectsrc->lines as $line) {
+			// Uniquement produit bien spécifié
+			if (empty($line->fk_product))
+				continue;
+			// Uniquement produit "physique" (pas service)
+			if ($line->product_type != 0)
+				continue;
+
+			if (!empty($conf->global->STOCK_CALCULATE_ON_RECEPTION) || !empty($conf->global->STOCK_CALCULATE_ON_RECEPTION_CLOSE)) {
+				$ret = $object->addline($warehouse_id, $line->id, $line->qty, NULL, '', '', '', '', $line->subprice, 'MU');
+			} else {
+				$ret = $object->addline($warehouse_id, $line->id, $line->qty, NULL, '', '', '', '');
+			}
+			if ($ret < 0) {
+				setEventMessages($object->error, $object->errors, 'errors');
+				$error++;
+			}
+		}
+
+		if (!$error) {
+			$ret = $object->create($user); // This create reception (like Odoo picking) and line of receptions. Stock movement will when validating reception.
+
+			if ($ret <= 0) {
+				setEventMessages($object->error, $object->errors, 'errors');
+				$error++;
+			}
+		}
+
+		if (!$error) {
+			$ret = $object->valid($user);
+			$object->setClosed();
+
+			if ($ret <= 0) {
+				setEventMessages($object->error, $object->errors, 'errors');
+				$error++;
+			}
+		}
+
+		if (!$error) {
+			$ret = $commande_fourn->setStatus($user, CommandeFournisseur::STATUS_RECEIVED_COMPLETELY);
+
+			if ($ret <= 0) {
+				setEventMessages($commande_fourn->error, $commande_fourn->errors, 'errors');
+				$error++;
+			}
+		}
+
+		if (!$error) {
+			$db->commit();
+			return $object;
+		} else {
+			$db->rollback();
+		}
+	}
+
+	// Création expédition
+	public static function commande_fourn_to_shipping(User $user, CommandeFournisseur $commande_fourn, $validate=true)
+	{
+		//var_dump($order); die();
+		//var_dump($user); die();
+		global $conf, $db, $langs;
+
+		if (! $user->rights->expedition->creer)
+			return;
+		
+		if (empty($commande_fourn))
+			return;
+		if (!empty($conf->global->MMISHIPPING_DF_ENTREPOT))
+			$warehouse_id = $conf->global->MMISHIPPING_DF_ENTREPOT;
+		
+		// Recherche commande liée
+		$sql = "SELECT e.fk_source id
+			FROM ".MAIN_DB_PREFIX."element_element e
+			WHERE e.`targettype` LIKE 'order_supplier' AND e.`fk_target`='".$commande_fourn->id."' AND e.sourcetype='commande'";
+		//echo '<p>'.$sql.'</p>';
+		$resql = $db->query($sql);
+		//var_dump($resql);
+		if ($obj = $db->fetch_object($resql)) {
+			$order = new Commande($db);
+			$order->fetch($obj->id);
+		}
+		else {
+			return;
+		}
+
+		$error = 0;
+
+		$db->begin();
+
+		$object = new Expedition($db);
+		
+		$origin = 'commande';
+		$origin_id = $order->id;
+		$objectsrc = $order;
+		$date_delivery = date('Y-m-d');
+		$mode_pdf = '';
+
+		$object->origin = $origin;
+		$object->origin_id = $origin_id;
+		$object->fk_project = $objectsrc->fk_project;
+
+		// $object->weight				= 0;
+		// $object->sizeH				= 0;
+		// $object->sizeW				= 0;
+		// $object->sizeS				= 0;
+		// $object->size_units = 0;
+		// $object->weight_units = 0;
+
+		$object->socid = $objectsrc->socid;
+		$object->ref_customer = $objectsrc->ref_client;
+		$object->model_pdf = $mode_pdf;
+		$object->date_delivery = $date_delivery; // Date delivery planed
+		$object->shipping_method_id	= $objectsrc->shipping_method_id;
+		$object->tracking_number = '';
+		$object->note_private = $objectsrc->note_private;
+		$object->note_public = $objectsrc->note_public;
+		$object->fk_incoterms = $objectsrc->fk_incoterms;
+		$object->location_incoterms = $objectsrc->location_incoterms;
+
+		// Parcours produits commande
+		foreach ($commande_fourn->lines as $line) {
+			//var_dump($conf->productbatch->enabled, $line);
+			if (! $line->fk_product)
+				continue;
+
+			$product = new Product($db);
+			$product->fetch($line->fk_product);
+			if (! $product->id)
+				continue;
+			// Kit alimentaire => ne pas expédier ça bug
+			//if (!empty($product->array_options['options_compose']))
+			//	continue;
+
+			// Product shippable (not service, etc.)
+			if ($product->type != 0)
+				continue;
+
+			foreach($order->lines as $cline) {
+				if($cline->fk_product != $line->fk_product)
+					continue;
+				$ret = $object->addline($warehouse_id, $cline->id, $cline->qty);
+				if ($ret < 0) {
+					setEventMessages($object->error, $object->errors, 'errors');
+					$error++;
+				}
+			}
+		}
+
+		if (!$error) {
+			$ret = $object->create($user); // This create shipment (like Odoo picking) and lines of shipments. Stock movement will be done when validating shipment.
+			if ($ret <= 0) {
+				setEventMessages($object->error, $object->errors, 'errors');
+				$error++;
+			}
+		}
+
+		// Validation
+		if (!$error) {
+			if ($validate) {
+				$result = $object->valid($user);
+				if ($result<0) {
+					setEventMessages($object->error, $object->errors, 'errors');
+					dol_syslog(get_class().' ::' .$object->error.implode(',',$object->errors), LOG_ERR);
+					$error++;
+				}
+				$result = $object->setClosed();
+				if ($result<0) {
+					setEventMessages($object->error, $object->errors, 'errors');
+					dol_syslog(get_class().' ::' .$object->error.implode(',',$object->errors), LOG_ERR);
+					$error++;
+				}
+			}
+		}
+
+		// Génération PDF
+		if (!$error) {
+			// Retrieve everything
+			$object->fetch($object->id);
+
+			$docmodel = 'rouget';
+			$object->generateDocument($docmodel, $langs);
+		}
+
+		// OK ou rollback
+		if (!$error) {
+			$db->commit();
+			
+			return $object;
+			//var_dump($expe);
+		} else {
+			$db->rollback();
+		}
+	}
+}

+ 502 - 0
core/modules/modMMIShipping.class.php

@@ -0,0 +1,502 @@
+<?php
+/* Copyright (C) 2004-2018  Laurent Destailleur     <eldy@users.sourceforge.net>
+ * Copyright (C) 2018-2019  Nicolas ZABOURI         <info@inovea-conseil.com>
+ * Copyright (C) 2019-2020  Frédéric France         <frederic.france@netlogic.fr>
+ * Copyright (C) 2023 MOULIN Mathieu <webmaster@sfy-gestion.com>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+/**
+ * 	\defgroup   mmishipping     Module MMIShipping
+ *  \brief      MMIShipping module descriptor.
+ *
+ *  \file       htdocs/mmishipping/core/modules/modMMIShipping.class.php
+ *  \ingroup    mmishipping
+ *  \brief      Description and activation file for module MMIShipping
+ */
+include_once DOL_DOCUMENT_ROOT.'/core/modules/DolibarrModules.class.php';
+
+/**
+ *  Description and activation class for module MMIShipping
+ */
+class modMMIShipping extends DolibarrModules
+{
+	/**
+	 * Constructor. Define names, constants, directories, boxes, permissions
+	 *
+	 * @param DoliDB $db Database handler
+	 */
+	public function __construct($db)
+	{
+		global $langs, $conf;
+		$this->db = $db;
+
+		// Id for module (must be unique).
+		// Use here a free id (See in Home -> System information -> Dolibarr for list of used modules id).
+		$this->numero = 437817; // TODO Go on page https://wiki.dolibarr.org/index.php/List_of_modules_id to reserve an id number for your module
+
+		// Key text used to identify module (for permissions, menus, etc...)
+		$this->rights_class = 'mmishipping';
+
+		// Family can be 'base' (core modules),'crm','financial','hr','projects','products','ecm','technic' (transverse modules),'interface' (link with external tools),'other','...'
+		// It is used to group modules by family in module setup page
+		$this->family = "crm";
+
+		// Module position in the family on 2 digits ('01', '10', '20', ...)
+		$this->module_position = '90';
+
+		// Gives the possibility for the module, to provide his own family info and position of this family (Overwrite $this->family and $this->module_position. Avoid this)
+		//$this->familyinfo = array('myownfamily' => array('position' => '01', 'label' => $langs->trans("MyOwnFamily")));
+		// Module label (no space allowed), used if translation string 'ModuleMMIShippingName' not found (MMIShipping is name of module).
+		$this->name = preg_replace('/^mod/i', '', get_class($this));
+
+		// Module description, used if translation string 'ModuleMMIShippingDesc' not found (MMIShipping is name of module).
+		$this->description = "MMIShippingDescription";
+		// Used only if file README.md and README-LL.md not found.
+		$this->descriptionlong = "MMIShippingDescription";
+
+		// Author
+		$this->editor_name = 'Mathieu Moulin iProspective MMI';
+		$this->editor_url = 'https://iprospective.fr';
+
+		// Possible values for version are: 'development', 'experimental', 'dolibarr', 'dolibarr_deprecated' or a version string like 'x.y.z'
+		$this->version = '1.0';
+		// Url to the file with your last numberversion of this module
+		//$this->url_last_version = 'http://www.example.com/versionmodule.txt';
+
+		// Key used in llx_const table to save module status enabled/disabled (where MMISHIPPING is value of property name of module in uppercase)
+		$this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
+
+		// Name of image file used for this module.
+		// If file is in theme/yourtheme/img directory under name object_pictovalue.png, use this->picto='pictovalue'
+		// If file is in module/img directory under name object_pictovalue.png, use this->picto='pictovalue@module'
+		// To use a supported fa-xxx css style of font awesome, use this->picto='xxx'
+		$this->picto = 'mmilogo@mmishipping';
+
+		// Define some features supported by module (triggers, login, substitutions, menus, css, etc...)
+		$this->module_parts = array(
+			// Set this to 1 if module has its own trigger directory (core/triggers)
+			'triggers' => 0,
+			// Set this to 1 if module has its own login method file (core/login)
+			'login' => 0,
+			// Set this to 1 if module has its own substitution function file (core/substitutions)
+			'substitutions' => 0,
+			// Set this to 1 if module has its own menus handler directory (core/menus)
+			'menus' => 0,
+			// Set this to 1 if module overwrite template dir (core/tpl)
+			'tpl' => 0,
+			// Set this to 1 if module has its own barcode directory (core/modules/barcode)
+			'barcode' => 0,
+			// Set this to 1 if module has its own models directory (core/modules/xxx)
+			'models' => 0,
+			// Set this to 1 if module has its own printing directory (core/modules/printing)
+			'printing' => 0,
+			// Set this to 1 if module has its own theme directory (theme)
+			'theme' => 0,
+			// Set this to relative path of css file if module has its own css file
+			'css' => array(
+				//    '/mmishipping/css/mmishipping.css.php',
+			),
+			// Set this to relative path of js file if module must load a js on all pages
+			'js' => array(
+				//   '/mmishipping/js/mmishipping.js.php',
+			),
+			// Set here all hooks context managed by module. To find available hook context, make a "grep -r '>initHooks(' *" on source code. You can also set hook context to 'all'
+			'hooks' => array(
+				'ordersuppliercard',
+				//   'data' => array(
+				//       'hookcontext1',
+				//       'hookcontext2',
+				//   ),
+				//   'entity' => '0',
+			),
+			// Set this to 1 if features of module are opened to external users
+			'moduleforexternal' => 0,
+		);
+
+		// Data directories to create when module is enabled.
+		// Example: this->dirs = array("/mmishipping/temp","/mmishipping/subdir");
+		$this->dirs = array("/mmishipping/temp");
+
+		// Config pages. Put here list of php page, stored into mmishipping/admin directory, to use to setup module.
+		$this->config_page_url = array("setup.php@mmishipping");
+
+		// Dependencies
+		// A condition to hide module
+		$this->hidden = false;
+		// List of module class names as string that must be enabled if this module is enabled. Example: array('always1'=>'modModuleToEnable1','always2'=>'modModuleToEnable2', 'FR1'=>'modModuleToEnableFR'...)
+		$this->depends = array('modMMICommon');
+		$this->requiredby = array(); // List of module class names as string to disable if this one is disabled. Example: array('modModuleToDisable1', ...)
+		$this->conflictwith = array(); // List of module class names as string this module is in conflict with. Example: array('modModuleToDisable1', ...)
+
+		// The language file dedicated to your module
+		$this->langfiles = array("mmishipping@mmishipping");
+
+		// Prerequisites
+		$this->phpmin = array(7, 4); // Minimum version of PHP required by module
+		$this->need_dolibarr_version = array(11, -3); // Minimum version of Dolibarr required by module
+
+		// Messages at activation
+		$this->warnings_activation = array(); // Warning to show when we activate module. array('always'='text') or array('FR'='textfr','MX'='textmx'...)
+		$this->warnings_activation_ext = array(); // Warning to show when we activate an external module. array('always'='text') or array('FR'='textfr','MX'='textmx'...)
+		//$this->automatic_activation = array('FR'=>'MMIShippingWasAutomaticallyActivatedBecauseOfYourCountryChoice');
+		//$this->always_enabled = true;								// If true, can't be disabled
+
+		// Constants
+		// List of particular constants to add when module is enabled (key, 'chaine', value, desc, visible, 'current' or 'allentities', deleteonunactive)
+		// Example: $this->const=array(1 => array('MMISHIPPING_MYNEWCONST1', 'chaine', 'myvalue', 'This is a constant to add', 1),
+		//                             2 => array('MMISHIPPING_MYNEWCONST2', 'chaine', 'myvalue', 'This is another constant to add', 0, 'current', 1)
+		// );
+		$this->const = array();
+
+		// Some keys to add into the overwriting translation tables
+		/*$this->overwrite_translation = array(
+			'en_US:ParentCompany'=>'Parent company or reseller',
+			'fr_FR:ParentCompany'=>'Maison mère ou revendeur'
+		)*/
+
+		if (!isset($conf->mmishipping) || !isset($conf->mmishipping->enabled)) {
+			$conf->mmishipping = new stdClass();
+			$conf->mmishipping->enabled = 0;
+		}
+
+		// Array to add new pages in new tabs
+		$this->tabs = array();
+		// Example:
+		// $this->tabs[] = array('data'=>'objecttype:+tabname1:Title1:mylangfile@mmishipping:$user->rights->mmishipping->read:/mmishipping/mynewtab1.php?id=__ID__');  					// To add a new tab identified by code tabname1
+		// $this->tabs[] = array('data'=>'objecttype:+tabname2:SUBSTITUTION_Title2:mylangfile@mmishipping:$user->rights->othermodule->read:/mmishipping/mynewtab2.php?id=__ID__',  	// To add another new tab identified by code tabname2. Label will be result of calling all substitution functions on 'Title2' key.
+		// $this->tabs[] = array('data'=>'objecttype:-tabname:NU:conditiontoremove');                                                     										// To remove an existing tab identified by code tabname
+		//
+		// Where objecttype can be
+		// 'categories_x'	  to add a tab in category view (replace 'x' by type of category (0=product, 1=supplier, 2=customer, 3=member)
+		// 'contact'          to add a tab in contact view
+		// 'contract'         to add a tab in contract view
+		// 'group'            to add a tab in group view
+		// 'intervention'     to add a tab in intervention view
+		// 'invoice'          to add a tab in customer invoice view
+		// 'invoice_supplier' to add a tab in supplier invoice view
+		// 'member'           to add a tab in fundation member view
+		// 'opensurveypoll'	  to add a tab in opensurvey poll view
+		// 'order'            to add a tab in customer order view
+		// 'order_supplier'   to add a tab in supplier order view
+		// 'payment'		  to add a tab in payment view
+		// 'payment_supplier' to add a tab in supplier payment view
+		// 'product'          to add a tab in product view
+		// 'propal'           to add a tab in propal view
+		// 'project'          to add a tab in project view
+		// 'stock'            to add a tab in stock view
+		// 'thirdparty'       to add a tab in third party view
+		// 'user'             to add a tab in user view
+
+		// Dictionaries
+		$this->dictionaries = array();
+		/* Example:
+		$this->dictionaries=array(
+			'langs'=>'mmishipping@mmishipping',
+			// List of tables we want to see into dictonnary editor
+			'tabname'=>array("table1", "table2", "table3"),
+			// Label of tables
+			'tablib'=>array("Table1", "Table2", "Table3"),
+			// Request to select fields
+			'tabsql'=>array('SELECT f.rowid as rowid, f.code, f.label, f.active FROM '.MAIN_DB_PREFIX.'table1 as f', 'SELECT f.rowid as rowid, f.code, f.label, f.active FROM '.MAIN_DB_PREFIX.'table2 as f', 'SELECT f.rowid as rowid, f.code, f.label, f.active FROM '.MAIN_DB_PREFIX.'table3 as f'),
+			// Sort order
+			'tabsqlsort'=>array("label ASC", "label ASC", "label ASC"),
+			// List of fields (result of select to show dictionary)
+			'tabfield'=>array("code,label", "code,label", "code,label"),
+			// List of fields (list of fields to edit a record)
+			'tabfieldvalue'=>array("code,label", "code,label", "code,label"),
+			// List of fields (list of fields for insert)
+			'tabfieldinsert'=>array("code,label", "code,label", "code,label"),
+			// Name of columns with primary key (try to always name it 'rowid')
+			'tabrowid'=>array("rowid", "rowid", "rowid"),
+			// Condition to show each dictionary
+			'tabcond'=>array($conf->mmishipping->enabled, $conf->mmishipping->enabled, $conf->mmishipping->enabled),
+			// Tooltip for every fields of dictionaries: DO NOT PUT AN EMPTY ARRAY
+			'tabhelp'=>array(array('code'=>$langs->trans('CodeTooltipHelp'), 'field2' => 'field2tooltip'), array('code'=>$langs->trans('CodeTooltipHelp'), 'field2' => 'field2tooltip'), ...),
+		);
+		*/
+
+		// Boxes/Widgets
+		// Add here list of php file(s) stored in mmishipping/core/boxes that contains a class to show a widget.
+		$this->boxes = array(
+			//  0 => array(
+			//      'file' => 'mmishippingwidget1.php@mmishipping',
+			//      'note' => 'Widget provided by MMIShipping',
+			//      'enabledbydefaulton' => 'Home',
+			//  ),
+			//  ...
+		);
+
+		// Cronjobs (List of cron jobs entries to add when module is enabled)
+		// unit_frequency must be 60 for minute, 3600 for hour, 86400 for day, 604800 for week
+		$this->cronjobs = array(
+			//  0 => array(
+			//      'label' => 'MyJob label',
+			//      'jobtype' => 'method',
+			//      'class' => '/mmishipping/class/myobject.class.php',
+			//      'objectname' => 'MyObject',
+			//      'method' => 'doScheduledJob',
+			//      'parameters' => '',
+			//      'comment' => 'Comment',
+			//      'frequency' => 2,
+			//      'unitfrequency' => 3600,
+			//      'status' => 0,
+			//      'test' => '$conf->mmishipping->enabled',
+			//      'priority' => 50,
+			//  ),
+		);
+		// Example: $this->cronjobs=array(
+		//    0=>array('label'=>'My label', 'jobtype'=>'method', 'class'=>'/dir/class/file.class.php', 'objectname'=>'MyClass', 'method'=>'myMethod', 'parameters'=>'param1, param2', 'comment'=>'Comment', 'frequency'=>2, 'unitfrequency'=>3600, 'status'=>0, 'test'=>'$conf->mmishipping->enabled', 'priority'=>50),
+		//    1=>array('label'=>'My label', 'jobtype'=>'command', 'command'=>'', 'parameters'=>'param1, param2', 'comment'=>'Comment', 'frequency'=>1, 'unitfrequency'=>3600*24, 'status'=>0, 'test'=>'$conf->mmishipping->enabled', 'priority'=>50)
+		// );
+
+		// Permissions provided by this module
+		$this->rights = array();
+		$r = 0;
+		// Add here entries to declare new permissions
+		/* BEGIN MODULEBUILDER PERMISSIONS */
+		$this->rights[$r][0] = $this->numero . sprintf("%02d", $r + 1); // Permission id (must not be already used)
+		$this->rights[$r][1] = 'Read objects of MMIShipping'; // Permission label
+		$this->rights[$r][4] = 'myobject';
+		$this->rights[$r][5] = 'read'; // In php code, permission will be checked by test if ($user->rights->mmishipping->myobject->read)
+		$r++;
+		$this->rights[$r][0] = $this->numero . sprintf("%02d", $r + 1); // Permission id (must not be already used)
+		$this->rights[$r][1] = 'Create/Update objects of MMIShipping'; // Permission label
+		$this->rights[$r][4] = 'myobject';
+		$this->rights[$r][5] = 'write'; // In php code, permission will be checked by test if ($user->rights->mmishipping->myobject->write)
+		$r++;
+		$this->rights[$r][0] = $this->numero . sprintf("%02d", $r + 1); // Permission id (must not be already used)
+		$this->rights[$r][1] = 'Delete objects of MMIShipping'; // Permission label
+		$this->rights[$r][4] = 'myobject';
+		$this->rights[$r][5] = 'delete'; // In php code, permission will be checked by test if ($user->rights->mmishipping->myobject->delete)
+		$r++;
+		/* END MODULEBUILDER PERMISSIONS */
+
+		// Main menu entries to add
+		$this->menu = array();
+		$r = 0;
+		// Add here entries to declare new menus
+		/* BEGIN MODULEBUILDER TOPMENU */
+		$this->menu[$r++] = array(
+			'fk_menu'=>'', // '' if this is a top menu. For left menu, use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
+			'type'=>'top', // This is a Top menu entry
+			'titre'=>'ModuleMMIShippingName',
+			'prefix' => img_picto('', $this->picto, 'class="paddingright pictofixedwidth valignmiddle"'),
+			'mainmenu'=>'mmishipping',
+			'leftmenu'=>'',
+			'url'=>'/mmishipping/mmishippingindex.php',
+			'langs'=>'mmishipping@mmishipping', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
+			'position'=>1000 + $r,
+			'enabled'=>'$conf->mmishipping->enabled', // Define condition to show or hide menu entry. Use '$conf->mmishipping->enabled' if entry must be visible if module is enabled.
+			'perms'=>'1', // Use 'perms'=>'$user->rights->mmishipping->myobject->read' if you want your menu with a permission rules
+			'target'=>'',
+			'user'=>2, // 0=Menu for internal users, 1=external users, 2=both
+		);
+		/* END MODULEBUILDER TOPMENU */
+		/* BEGIN MODULEBUILDER LEFTMENU MYOBJECT
+		$this->menu[$r++]=array(
+			'fk_menu'=>'fk_mainmenu=mmishipping',      // '' if this is a top menu. For left menu, use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
+			'type'=>'left',                          // This is a Left menu entry
+			'titre'=>'MyObject',
+			'prefix' => img_picto('', $this->picto, 'class="paddingright pictofixedwidth valignmiddle"'),
+			'mainmenu'=>'mmishipping',
+			'leftmenu'=>'myobject',
+			'url'=>'/mmishipping/mmishippingindex.php',
+			'langs'=>'mmishipping@mmishipping',	        // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
+			'position'=>1000+$r,
+			'enabled'=>'$conf->mmishipping->enabled',  // Define condition to show or hide menu entry. Use '$conf->mmishipping->enabled' if entry must be visible if module is enabled.
+			'perms'=>'$user->rights->mmishipping->myobject->read',			                // Use 'perms'=>'$user->rights->mmishipping->level1->level2' if you want your menu with a permission rules
+			'target'=>'',
+			'user'=>2,				                // 0=Menu for internal users, 1=external users, 2=both
+		);
+		$this->menu[$r++]=array(
+			'fk_menu'=>'fk_mainmenu=mmishipping,fk_leftmenu=myobject',	    // '' if this is a top menu. For left menu, use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
+			'type'=>'left',			                // This is a Left menu entry
+			'titre'=>'List_MyObject',
+			'mainmenu'=>'mmishipping',
+			'leftmenu'=>'mmishipping_myobject_list',
+			'url'=>'/mmishipping/myobject_list.php',
+			'langs'=>'mmishipping@mmishipping',	        // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
+			'position'=>1000+$r,
+			'enabled'=>'$conf->mmishipping->enabled',  // Define condition to show or hide menu entry. Use '$conf->mmishipping->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
+			'perms'=>'$user->rights->mmishipping->myobject->read',			                // Use 'perms'=>'$user->rights->mmishipping->level1->level2' if you want your menu with a permission rules
+			'target'=>'',
+			'user'=>2,				                // 0=Menu for internal users, 1=external users, 2=both
+		);
+		$this->menu[$r++]=array(
+			'fk_menu'=>'fk_mainmenu=mmishipping,fk_leftmenu=myobject',	    // '' if this is a top menu. For left menu, use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
+			'type'=>'left',			                // This is a Left menu entry
+			'titre'=>'New_MyObject',
+			'mainmenu'=>'mmishipping',
+			'leftmenu'=>'mmishipping_myobject_new',
+			'url'=>'/mmishipping/myobject_card.php?action=create',
+			'langs'=>'mmishipping@mmishipping',	        // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
+			'position'=>1000+$r,
+			'enabled'=>'$conf->mmishipping->enabled',  // Define condition to show or hide menu entry. Use '$conf->mmishipping->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
+			'perms'=>'$user->rights->mmishipping->myobject->write',			                // Use 'perms'=>'$user->rights->mmishipping->level1->level2' if you want your menu with a permission rules
+			'target'=>'',
+			'user'=>2,				                // 0=Menu for internal users, 1=external users, 2=both
+		);
+		END MODULEBUILDER LEFTMENU MYOBJECT */
+		// Exports profiles provided by this module
+		$r = 1;
+		/* BEGIN MODULEBUILDER EXPORT MYOBJECT */
+		/*
+		$langs->load("mmishipping@mmishipping");
+		$this->export_code[$r]=$this->rights_class.'_'.$r;
+		$this->export_label[$r]='MyObjectLines';	// Translation key (used only if key ExportDataset_xxx_z not found)
+		$this->export_icon[$r]='myobject@mmishipping';
+		// Define $this->export_fields_array, $this->export_TypeFields_array and $this->export_entities_array
+		$keyforclass = 'MyObject'; $keyforclassfile='/mmishipping/class/myobject.class.php'; $keyforelement='myobject@mmishipping';
+		include DOL_DOCUMENT_ROOT.'/core/commonfieldsinexport.inc.php';
+		//$this->export_fields_array[$r]['t.fieldtoadd']='FieldToAdd'; $this->export_TypeFields_array[$r]['t.fieldtoadd']='Text';
+		//unset($this->export_fields_array[$r]['t.fieldtoremove']);
+		//$keyforclass = 'MyObjectLine'; $keyforclassfile='/mmishipping/class/myobject.class.php'; $keyforelement='myobjectline@mmishipping'; $keyforalias='tl';
+		//include DOL_DOCUMENT_ROOT.'/core/commonfieldsinexport.inc.php';
+		$keyforselect='myobject'; $keyforaliasextra='extra'; $keyforelement='myobject@mmishipping';
+		include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
+		//$keyforselect='myobjectline'; $keyforaliasextra='extraline'; $keyforelement='myobjectline@mmishipping';
+		//include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
+		//$this->export_dependencies_array[$r] = array('myobjectline'=>array('tl.rowid','tl.ref')); // To force to activate one or several fields if we select some fields that need same (like to select a unique key if we ask a field of a child to avoid the DISTINCT to discard them, or for computed field than need several other fields)
+		//$this->export_special_array[$r] = array('t.field'=>'...');
+		//$this->export_examplevalues_array[$r] = array('t.field'=>'Example');
+		//$this->export_help_array[$r] = array('t.field'=>'FieldDescHelp');
+		$this->export_sql_start[$r]='SELECT DISTINCT ';
+		$this->export_sql_end[$r]  =' FROM '.MAIN_DB_PREFIX.'myobject as t';
+		//$this->export_sql_end[$r]  =' LEFT JOIN '.MAIN_DB_PREFIX.'myobject_line as tl ON tl.fk_myobject = t.rowid';
+		$this->export_sql_end[$r] .=' WHERE 1 = 1';
+		$this->export_sql_end[$r] .=' AND t.entity IN ('.getEntity('myobject').')';
+		$r++; */
+		/* END MODULEBUILDER EXPORT MYOBJECT */
+
+		// Imports profiles provided by this module
+		$r = 1;
+		/* BEGIN MODULEBUILDER IMPORT MYOBJECT */
+		/*
+		$langs->load("mmishipping@mmishipping");
+		$this->import_code[$r]=$this->rights_class.'_'.$r;
+		$this->import_label[$r]='MyObjectLines';	// Translation key (used only if key ExportDataset_xxx_z not found)
+		$this->import_icon[$r]='myobject@mmishipping';
+		$this->import_tables_array[$r] = array('t' => MAIN_DB_PREFIX.'mmishipping_myobject', 'extra' => MAIN_DB_PREFIX.'mmishipping_myobject_extrafields');
+		$this->import_tables_creator_array[$r] = array('t' => 'fk_user_author'); // Fields to store import user id
+		$import_sample = array();
+		$keyforclass = 'MyObject'; $keyforclassfile='/mmishipping/class/myobject.class.php'; $keyforelement='myobject@mmishipping';
+		include DOL_DOCUMENT_ROOT.'/core/commonfieldsinimport.inc.php';
+		$import_extrafield_sample = array();
+		$keyforselect='myobject'; $keyforaliasextra='extra'; $keyforelement='myobject@mmishipping';
+		include DOL_DOCUMENT_ROOT.'/core/extrafieldsinimport.inc.php';
+		$this->import_fieldshidden_array[$r] = array('extra.fk_object' => 'lastrowid-'.MAIN_DB_PREFIX.'mmishipping_myobject');
+		$this->import_regex_array[$r] = array();
+		$this->import_examplevalues_array[$r] = array_merge($import_sample, $import_extrafield_sample);
+		$this->import_updatekeys_array[$r] = array('t.ref' => 'Ref');
+		$this->import_convertvalue_array[$r] = array(
+			't.ref' => array(
+				'rule'=>'getrefifauto',
+				'class'=>(empty($conf->global->MMISHIPPING_MYOBJECT_ADDON) ? 'mod_myobject_standard' : $conf->global->MMISHIPPING_MYOBJECT_ADDON),
+				'path'=>"/core/modules/commande/".(empty($conf->global->MMISHIPPING_MYOBJECT_ADDON) ? 'mod_myobject_standard' : $conf->global->MMISHIPPING_MYOBJECT_ADDON).'.php'
+				'classobject'=>'MyObject',
+				'pathobject'=>'/mmishipping/class/myobject.class.php',
+			),
+			't.fk_soc' => array('rule' => 'fetchidfromref', 'file' => '/societe/class/societe.class.php', 'class' => 'Societe', 'method' => 'fetch', 'element' => 'ThirdParty'),
+			't.fk_user_valid' => array('rule' => 'fetchidfromref', 'file' => '/user/class/user.class.php', 'class' => 'User', 'method' => 'fetch', 'element' => 'user'),
+			't.fk_mode_reglement' => array('rule' => 'fetchidfromcodeorlabel', 'file' => '/compta/paiement/class/cpaiement.class.php', 'class' => 'Cpaiement', 'method' => 'fetch', 'element' => 'cpayment'),
+		);
+		$r++; */
+		/* END MODULEBUILDER IMPORT MYOBJECT */
+	}
+
+	/**
+	 *  Function called when module is enabled.
+	 *  The init function add constants, boxes, permissions and menus (defined in constructor) into Dolibarr database.
+	 *  It also creates data directories
+	 *
+	 *  @param      string  $options    Options when enabling module ('', 'noboxes')
+	 *  @return     int             	1 if OK, 0 if KO
+	 */
+	public function init($options = '')
+	{
+		global $conf, $langs;
+
+		//$result = $this->_load_tables('/install/mysql/', 'mmishipping');
+		$result = $this->_load_tables('/mmishipping/sql/');
+		if ($result < 0) {
+			return -1; // Do not activate module if error 'not allowed' returned when loading module SQL queries (the _load_table run sql with run_sql with the error allowed parameter set to 'default')
+		}
+
+		// Create extrafields during init
+		//include_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
+		//$extrafields = new ExtraFields($this->db);
+		//$result1=$extrafields->addExtraField('mmishipping_myattr1', "New Attr 1 label", 'boolean', 1,  3, 'thirdparty',   0, 0, '', '', 1, '', 0, 0, '', '', 'mmishipping@mmishipping', '$conf->mmishipping->enabled');
+		//$result2=$extrafields->addExtraField('mmishipping_myattr2', "New Attr 2 label", 'varchar', 1, 10, 'project',      0, 0, '', '', 1, '', 0, 0, '', '', 'mmishipping@mmishipping', '$conf->mmishipping->enabled');
+		//$result3=$extrafields->addExtraField('mmishipping_myattr3', "New Attr 3 label", 'varchar', 1, 10, 'bank_account', 0, 0, '', '', 1, '', 0, 0, '', '', 'mmishipping@mmishipping', '$conf->mmishipping->enabled');
+		//$result4=$extrafields->addExtraField('mmishipping_myattr4', "New Attr 4 label", 'select',  1,  3, 'thirdparty',   0, 1, '', array('options'=>array('code1'=>'Val1','code2'=>'Val2','code3'=>'Val3')), 1,'', 0, 0, '', '', 'mmishipping@mmishipping', '$conf->mmishipping->enabled');
+		//$result5=$extrafields->addExtraField('mmishipping_myattr5', "New Attr 5 label", 'text',    1, 10, 'user',         0, 0, '', '', 1, '', 0, 0, '', '', 'mmishipping@mmishipping', '$conf->mmishipping->enabled');
+
+		// Permissions
+		$this->remove($options);
+
+		$sql = array();
+
+		// Document templates
+		$moduledir = dol_sanitizeFileName('mmishipping');
+		$myTmpObjects = array();
+		$myTmpObjects['MyObject'] = array('includerefgeneration'=>0, 'includedocgeneration'=>0);
+
+		foreach ($myTmpObjects as $myTmpObjectKey => $myTmpObjectArray) {
+			if ($myTmpObjectKey == 'MyObject') {
+				continue;
+			}
+			if ($myTmpObjectArray['includerefgeneration']) {
+				$src = DOL_DOCUMENT_ROOT.'/install/doctemplates/'.$moduledir.'/template_myobjects.odt';
+				$dirodt = DOL_DATA_ROOT.'/doctemplates/'.$moduledir;
+				$dest = $dirodt.'/template_myobjects.odt';
+
+				if (file_exists($src) && !file_exists($dest)) {
+					require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
+					dol_mkdir($dirodt);
+					$result = dol_copy($src, $dest, 0, 0);
+					if ($result < 0) {
+						$langs->load("errors");
+						$this->error = $langs->trans('ErrorFailToCopyFile', $src, $dest);
+						return 0;
+					}
+				}
+
+				$sql = array_merge($sql, array(
+					"DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = 'standard_".strtolower($myTmpObjectKey)."' AND type = '".$this->db->escape(strtolower($myTmpObjectKey))."' AND entity = ".((int) $conf->entity),
+					"INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('standard_".strtolower($myTmpObjectKey)."', '".$this->db->escape(strtolower($myTmpObjectKey))."', ".((int) $conf->entity).")",
+					"DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = 'generic_".strtolower($myTmpObjectKey)."_odt' AND type = '".$this->db->escape(strtolower($myTmpObjectKey))."' AND entity = ".((int) $conf->entity),
+					"INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('generic_".strtolower($myTmpObjectKey)."_odt', '".$this->db->escape(strtolower($myTmpObjectKey))."', ".((int) $conf->entity).")"
+				));
+			}
+		}
+
+		return $this->_init($sql, $options);
+	}
+
+	/**
+	 *  Function called when module is disabled.
+	 *  Remove from database constants, boxes and permissions from Dolibarr database.
+	 *  Data directories are not deleted
+	 *
+	 *  @param      string	$options    Options when enabling module ('', 'noboxes')
+	 *  @return     int                 1 if OK, 0 if KO
+	 */
+	public function remove($options = '')
+	{
+		$sql = array();
+		return $this->_remove($sql, $options);
+	}
+}

+ 3 - 0
env.inc.php

@@ -0,0 +1,3 @@
+<?php
+
+$modulename = 'MMIShipping';

BIN
img/object_mmilogo.png


BIN
img/object_mmishipping.png


BIN
img/object_mmishipping_over.png


+ 54 - 0
langs/en_US/mmishipping.lang

@@ -0,0 +1,54 @@
+# Copyright (C) 2023 MOULIN Mathieu <webmaster@sfy-gestion.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+#
+# Generic
+#
+
+# Module label 'ModuleMMIShippingName'
+ModuleMMIShippingName = MMIShipping
+# Module description 'ModuleMMIShippingDesc'
+ModuleMMIShippingDesc = MMIShipping description
+
+#
+# Admin page
+#
+MMIShippingSetup = MMIShipping setup
+Settings = Settings
+MMIShippingSetupPage = MMIShipping setup page
+MMISHIPPING_MYPARAM1 = My param 1
+MMISHIPPING_MYPARAM1Tooltip = My param 1 tooltip
+MMISHIPPING_MYPARAM2=My param 2
+MMISHIPPING_MYPARAM2Tooltip=My param 2 tooltip
+
+
+#
+# About page
+#
+About = About
+MMIShippingAbout = About MMIShipping
+MMIShippingAboutPage = MMIShipping about page
+
+#
+# Sample page
+#
+MMIShippingArea = Home MMIShipping
+MyPageName = My page name
+
+#
+# Sample widget
+#
+MyWidget = My widget
+MyWidgetDescription = My widget description

+ 57 - 0
langs/fr_FR/mmishipping.lang

@@ -0,0 +1,57 @@
+# Copyright (C) 2023 MOULIN Mathieu <webmaster@sfy-gestion.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+#
+# Generic
+#
+
+# Module label 'ModuleMMIShippingName'
+ModuleMMIShippingName = Expéditions avancées
+# Module description 'ModuleMMIShippingDesc'
+ModuleMMIShippingDesc = Réceptions/expédition auto pour contremarques (direct fournisseur)
+
+#
+# Admin page
+#
+MMIShippingSetup = MMIShipping setup
+Settings = Settings
+MMIShippingSetupPage = MMIShipping setup page
+MMISHIPPING_DF = Gestion auto réceptions/expéditions contremarques
+MMISHIPPING_DF_ENTREPOT = Entrepôt "virtuel" pour la livraison directe (réception/expédition)
+
+#
+# About page
+#
+About = About
+MMIShippingAbout = About MMIShipping
+MMIShippingAboutPage = MMIShipping about page
+
+#
+# Sample page
+#
+MMIShippingArea = Home MMIShipping
+MyPageName = My page name
+
+#
+# Sample widget
+#
+MyWidget = My widget
+MyWidgetDescription = My widget description
+
+#
+#
+#
+MMIShippingAssignAddress = Assigner client réception
+MMIShippingSupplierOrderReceiveAndSend = Classer la réception

+ 68 - 0
lib/mmishipping.lib.php

@@ -0,0 +1,68 @@
+<?php
+/* Copyright (C) 2023 MOULIN Mathieu <webmaster@sfy-gestion.com>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+/**
+ * \file    mmishipping/lib/mmishipping.lib.php
+ * \ingroup mmishipping
+ * \brief   Library files with common functions for MMIShipping
+ */
+
+/**
+ * Prepare admin pages header
+ *
+ * @return array
+ */
+function mmishippingAdminPrepareHead()
+{
+	global $langs, $conf;
+
+	$langs->load("mmishipping@mmishipping");
+
+	$h = 0;
+	$head = array();
+
+	$head[$h][0] = dol_buildpath("/mmishipping/admin/setup.php", 1);
+	$head[$h][1] = $langs->trans("Settings");
+	$head[$h][2] = 'settings';
+	$h++;
+
+	/*
+	$head[$h][0] = dol_buildpath("/mmishipping/admin/myobject_extrafields.php", 1);
+	$head[$h][1] = $langs->trans("ExtraFields");
+	$head[$h][2] = 'myobject_extrafields';
+	$h++;
+	*/
+
+	$head[$h][0] = dol_buildpath("/mmishipping/admin/about.php", 1);
+	$head[$h][1] = $langs->trans("About");
+	$head[$h][2] = 'about';
+	$h++;
+
+	// Show more tabs from modules
+	// Entries must be declared in modules descriptor with line
+	//$this->tabs = array(
+	//	'entity:+tabname:Title:@mmishipping:/mmishipping/mypage.php?id=__ID__'
+	//); // to add new tab
+	//$this->tabs = array(
+	//	'entity:-tabname:Title:@mmishipping:/mmishipping/mypage.php?id=__ID__'
+	//); // to remove a tab
+	complete_head_from_modules($conf, $langs, null, $head, $h, 'mmishipping@mmishipping');
+
+	complete_head_from_modules($conf, $langs, null, $head, $h, 'mmishipping@mmishipping', 'remove');
+
+	return $head;
+}

+ 38 - 0
main_load.inc.php

@@ -0,0 +1,38 @@
+<?php
+
+// Load Dolibarr environment
+$res = 0;
+// Try main.inc.php into web root known defined into CONTEXT_DOCUMENT_ROOT (not always defined)
+if (!$res && !empty($_SERVER["CONTEXT_DOCUMENT_ROOT"])) {
+	$res = @include $_SERVER["CONTEXT_DOCUMENT_ROOT"]."/main.inc.php";
+}
+// Try main.inc.php into web root detected using web root calculated from SCRIPT_FILENAME
+$tmp = empty($_SERVER['SCRIPT_FILENAME']) ? '' : $_SERVER['SCRIPT_FILENAME']; $tmp2 = realpath(__FILE__); $i = strlen($tmp) - 1; $j = strlen($tmp2) - 1;
+while ($i > 0 && $j > 0 && isset($tmp[$i]) && isset($tmp2[$j]) && $tmp[$i] == $tmp2[$j]) {
+	$i--; $j--;
+}
+if (!$res && $i > 0 && file_exists(substr($tmp, 0, ($i + 1))."/main.inc.php")) {
+	$res = @include substr($tmp, 0, ($i + 1))."/main.inc.php";
+}
+if (!$res && $i > 0 && file_exists(dirname(substr($tmp, 0, ($i + 1)))."/main.inc.php")) {
+	$res = @include dirname(substr($tmp, 0, ($i + 1)))."/main.inc.php";
+}
+// Try main.inc.php using relative path
+if (!$res && file_exists("../main.inc.php")) {
+	$res = @include "../main.inc.php";
+}
+if (!$res && file_exists("../../main.inc.php")) {
+	$res = @include "../../main.inc.php";
+}
+if (!$res && file_exists("../../../main.inc.php")) {
+	$res = @include "../../../main.inc.php";
+}
+if (!$res) {
+	die("Include of main fails");
+}
+
+// Useful things
+$moduleclassname = 'mod'.$modulename;
+$moduledir = strtolower($modulename);
+$modulecontext = $moduledir."@".$moduledir;
+$moduleprefix = strtoupper($modulename);

+ 241 - 0
mmishippingindex.php

@@ -0,0 +1,241 @@
+<?php
+/* Copyright (C) 2001-2005 Rodolphe Quiedeville <rodolphe@quiedeville.org>
+ * Copyright (C) 2004-2015 Laurent Destailleur  <eldy@users.sourceforge.net>
+ * Copyright (C) 2005-2012 Regis Houssin        <regis.houssin@inodbox.com>
+ * Copyright (C) 2015      Jean-François Ferry	<jfefe@aternatik.fr>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+/**
+ *	\file       mmishipping/mmishippingindex.php
+ *	\ingroup    mmishipping
+ *	\brief      Home page of mmishipping top menu
+ */
+
+// Load Dolibarr environment
+$res = 0;
+// Try main.inc.php into web root known defined into CONTEXT_DOCUMENT_ROOT (not always defined)
+if (!$res && !empty($_SERVER["CONTEXT_DOCUMENT_ROOT"])) {
+	$res = @include $_SERVER["CONTEXT_DOCUMENT_ROOT"]."/main.inc.php";
+}
+// Try main.inc.php into web root detected using web root calculated from SCRIPT_FILENAME
+$tmp = empty($_SERVER['SCRIPT_FILENAME']) ? '' : $_SERVER['SCRIPT_FILENAME']; $tmp2 = realpath(__FILE__); $i = strlen($tmp) - 1; $j = strlen($tmp2) - 1;
+while ($i > 0 && $j > 0 && isset($tmp[$i]) && isset($tmp2[$j]) && $tmp[$i] == $tmp2[$j]) {
+	$i--; $j--;
+}
+if (!$res && $i > 0 && file_exists(substr($tmp, 0, ($i + 1))."/main.inc.php")) {
+	$res = @include substr($tmp, 0, ($i + 1))."/main.inc.php";
+}
+if (!$res && $i > 0 && file_exists(dirname(substr($tmp, 0, ($i + 1)))."/main.inc.php")) {
+	$res = @include dirname(substr($tmp, 0, ($i + 1)))."/main.inc.php";
+}
+// Try main.inc.php using relative path
+if (!$res && file_exists("../main.inc.php")) {
+	$res = @include "../main.inc.php";
+}
+if (!$res && file_exists("../../main.inc.php")) {
+	$res = @include "../../main.inc.php";
+}
+if (!$res && file_exists("../../../main.inc.php")) {
+	$res = @include "../../../main.inc.php";
+}
+if (!$res) {
+	die("Include of main fails");
+}
+
+require_once DOL_DOCUMENT_ROOT.'/core/class/html.formfile.class.php';
+
+// Load translation files required by the page
+$langs->loadLangs(array("mmishipping@mmishipping"));
+
+$action = GETPOST('action', 'aZ09');
+
+
+// Security check
+// if (! $user->rights->mmishipping->myobject->read) {
+// 	accessforbidden();
+// }
+$socid = GETPOST('socid', 'int');
+if (isset($user->socid) && $user->socid > 0) {
+	$action = '';
+	$socid = $user->socid;
+}
+
+$max = 5;
+$now = dol_now();
+
+
+/*
+ * Actions
+ */
+
+// None
+
+
+/*
+ * View
+ */
+
+$form = new Form($db);
+$formfile = new FormFile($db);
+
+llxHeader("", $langs->trans("MMIShippingArea"));
+
+print load_fiche_titre($langs->trans("MMIShippingArea"), '', 'mmishipping.png@mmishipping');
+
+print '<div class="fichecenter"><div class="fichethirdleft">';
+
+
+/* BEGIN MODULEBUILDER DRAFT MYOBJECT
+// Draft MyObject
+if (! empty($conf->mmishipping->enabled) && $user->rights->mmishipping->read)
+{
+	$langs->load("orders");
+
+	$sql = "SELECT c.rowid, c.ref, c.ref_client, c.total_ht, c.tva as total_tva, c.total_ttc, s.rowid as socid, s.nom as name, s.client, s.canvas";
+	$sql.= ", s.code_client";
+	$sql.= " FROM ".MAIN_DB_PREFIX."commande as c";
+	$sql.= ", ".MAIN_DB_PREFIX."societe as s";
+	if (! $user->rights->societe->client->voir && ! $socid) $sql.= ", ".MAIN_DB_PREFIX."societe_commerciaux as sc";
+	$sql.= " WHERE c.fk_soc = s.rowid";
+	$sql.= " AND c.fk_statut = 0";
+	$sql.= " AND c.entity IN (".getEntity('commande').")";
+	if (! $user->rights->societe->client->voir && ! $socid) $sql.= " AND s.rowid = sc.fk_soc AND sc.fk_user = ".((int) $user->id);
+	if ($socid)	$sql.= " AND c.fk_soc = ".((int) $socid);
+
+	$resql = $db->query($sql);
+	if ($resql)
+	{
+		$total = 0;
+		$num = $db->num_rows($resql);
+
+		print '<table class="noborder centpercent">';
+		print '<tr class="liste_titre">';
+		print '<th colspan="3">'.$langs->trans("DraftMyObjects").($num?'<span class="badge marginleftonlyshort">'.$num.'</span>':'').'</th></tr>';
+
+		$var = true;
+		if ($num > 0)
+		{
+			$i = 0;
+			while ($i < $num)
+			{
+
+				$obj = $db->fetch_object($resql);
+				print '<tr class="oddeven"><td class="nowrap">';
+
+				$myobjectstatic->id=$obj->rowid;
+				$myobjectstatic->ref=$obj->ref;
+				$myobjectstatic->ref_client=$obj->ref_client;
+				$myobjectstatic->total_ht = $obj->total_ht;
+				$myobjectstatic->total_tva = $obj->total_tva;
+				$myobjectstatic->total_ttc = $obj->total_ttc;
+
+				print $myobjectstatic->getNomUrl(1);
+				print '</td>';
+				print '<td class="nowrap">';
+				print '</td>';
+				print '<td class="right" class="nowrap">'.price($obj->total_ttc).'</td></tr>';
+				$i++;
+				$total += $obj->total_ttc;
+			}
+			if ($total>0)
+			{
+
+				print '<tr class="liste_total"><td>'.$langs->trans("Total").'</td><td colspan="2" class="right">'.price($total)."</td></tr>";
+			}
+		}
+		else
+		{
+
+			print '<tr class="oddeven"><td colspan="3" class="opacitymedium">'.$langs->trans("NoOrder").'</td></tr>';
+		}
+		print "</table><br>";
+
+		$db->free($resql);
+	}
+	else
+	{
+		dol_print_error($db);
+	}
+}
+END MODULEBUILDER DRAFT MYOBJECT */
+
+
+print '</div><div class="fichetwothirdright">';
+
+
+$NBMAX = $conf->global->MAIN_SIZE_SHORTLIST_LIMIT;
+$max = $conf->global->MAIN_SIZE_SHORTLIST_LIMIT;
+
+/* BEGIN MODULEBUILDER LASTMODIFIED MYOBJECT
+// Last modified myobject
+if (! empty($conf->mmishipping->enabled) && $user->rights->mmishipping->read)
+{
+	$sql = "SELECT s.rowid, s.ref, s.label, s.date_creation, s.tms";
+	$sql.= " FROM ".MAIN_DB_PREFIX."mmishipping_myobject as s";
+	//if (! $user->rights->societe->client->voir && ! $socid) $sql.= ", ".MAIN_DB_PREFIX."societe_commerciaux as sc";
+	$sql.= " WHERE s.entity IN (".getEntity($myobjectstatic->element).")";
+	//if (! $user->rights->societe->client->voir && ! $socid) $sql.= " AND s.rowid = sc.fk_soc AND sc.fk_user = ".((int) $user->id);
+	//if ($socid)	$sql.= " AND s.rowid = $socid";
+	$sql .= " ORDER BY s.tms DESC";
+	$sql .= $db->plimit($max, 0);
+
+	$resql = $db->query($sql);
+	if ($resql)
+	{
+		$num = $db->num_rows($resql);
+		$i = 0;
+
+		print '<table class="noborder centpercent">';
+		print '<tr class="liste_titre">';
+		print '<th colspan="2">';
+		print $langs->trans("BoxTitleLatestModifiedMyObjects", $max);
+		print '</th>';
+		print '<th class="right">'.$langs->trans("DateModificationShort").'</th>';
+		print '</tr>';
+		if ($num)
+		{
+			while ($i < $num)
+			{
+				$objp = $db->fetch_object($resql);
+
+				$myobjectstatic->id=$objp->rowid;
+				$myobjectstatic->ref=$objp->ref;
+				$myobjectstatic->label=$objp->label;
+				$myobjectstatic->status = $objp->status;
+
+				print '<tr class="oddeven">';
+				print '<td class="nowrap">'.$myobjectstatic->getNomUrl(1).'</td>';
+				print '<td class="right nowrap">';
+				print "</td>";
+				print '<td class="right nowrap">'.dol_print_date($db->jdate($objp->tms), 'day')."</td>";
+				print '</tr>';
+				$i++;
+			}
+
+			$db->free($resql);
+		} else {
+			print '<tr class="oddeven"><td colspan="3" class="opacitymedium">'.$langs->trans("None").'</td></tr>';
+		}
+		print "</table><br>";
+	}
+}
+*/
+
+print '</div></div>';
+
+// End of page
+llxFooter();
+$db->close();

+ 3 - 0
modulebuilder.txt

@@ -0,0 +1,3 @@
+# DO NOT DELETE THIS FILE MANUALLY
+# File to flag module built using official module template.
+# When this file is present into a module directory, you can edit it with the module builder tool. 

+ 3 - 0
sql/dolibarr_allversions.sql

@@ -0,0 +1,3 @@
+--
+-- Script run when an upgrade of Dolibarr is done. Whatever is the Dolibarr version.
+--

+ 304 - 0
test/phpunit/MMIShippingFunctionalTest.php

@@ -0,0 +1,304 @@
+<?php
+/* Copyright (C) 2007-2017 Laurent Destailleur  <eldy@users.sourceforge.net>
+ * Copyright (C) 2023 MOULIN Mathieu <webmaster@sfy-gestion.com>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+/**
+ * \file    test/phpunit/MMIShippingFunctionalTest.php
+ * \ingroup mmishipping
+ * \brief   Example Selenium test.
+ *
+ * Put detailed description here.
+ */
+
+namespace test\functional;
+
+use PHPUnit_Extensions_Selenium2TestCase_WebDriverException;
+
+/**
+ * Class MMIShippingFunctionalTest
+ *
+ * Requires chromedriver for Google Chrome
+ * Requires geckodriver for Mozilla Firefox
+ *
+ * @fixme Firefox (Geckodriver/Marionette) support
+ * @todo Opera linux support
+ * @todo Windows support (IE, Google Chrome, Mozilla Firefox, Safari)
+ * @todo OSX support (Safari, Google Chrome, Mozilla Firefox)
+ *
+ * @package Testmmishipping
+ */
+class MMIShippingFunctionalTest extends \PHPUnit_Extensions_Selenium2TestCase
+{
+	// TODO: move to a global configuration file?
+	/** @var string Base URL of the webserver under test */
+	protected static $base_url = 'http://dev.zenfusion.fr';
+	/**
+	 * @var string Dolibarr admin username
+	 * @see authenticate
+	 */
+	protected static $dol_admin_user = 'admin';
+	/**
+	 * @var string Dolibarr admin password
+	 * @see authenticate
+	 */
+	protected static $dol_admin_pass = 'admin';
+	/** @var int Dolibarr module ID */
+	private static $module_id = 500000; // TODO: autodetect?
+
+	/** @var array Browsers to test with */
+	public static $browsers = array(
+		array(
+			'browser' => 'Google Chrome on Linux',
+			'browserName' => 'chrome',
+			'sessionStrategy' => 'shared',
+			'desiredCapabilities' => array()
+		),
+		// Geckodriver does not keep the session at the moment?!
+		// XPath selectors also don't seem to work
+		//array(
+		//    'browser' => 'Mozilla Firefox on Linux',
+		//    'browserName' => 'firefox',
+		//    'sessionStrategy' => 'shared',
+		//    'desiredCapabilities' => array(
+		//        'marionette' => true,
+		//    ),
+		//)
+	);
+
+	/**
+	 * Helper function to select links by href
+	 *
+	 * @param  string  $value      Href
+	 * @return mixed               Helper string
+	 */
+	protected function byHref($value)
+	{
+		$anchor = null;
+		$anchors = $this->elements($this->using('tag name')->value('a'));
+		foreach ($anchors as $anchor) {
+			if (strstr($anchor->attribute('href'), $value)) {
+				break;
+			}
+		}
+		return $anchor;
+	}
+
+	/**
+	 * Global test setup
+	 * @return void
+	 */
+	public static function setUpBeforeClass()
+	{
+	}
+
+	/**
+	 * Unit test setup
+	 * @return void
+	 */
+	public function setUp()
+	{
+		$this->setSeleniumServerRequestsTimeout(3600);
+		$this->setBrowserUrl(self::$base_url);
+	}
+
+	/**
+	 * Verify pre conditions
+	 * @return void
+	 */
+	protected function assertPreConditions()
+	{
+	}
+
+	/**
+	 * Handle Dolibarr authentication
+	 * @return void
+	 */
+	private function authenticate()
+	{
+		try {
+			if ($this->byId('login')) {
+				$login = $this->byId('username');
+				$login->clear();
+				$login->value('admin');
+				$password = $this->byId('password');
+				$password->clear();
+				$password->value('admin');
+				$this->byId('login')->submit();
+			}
+		} catch (PHPUnit_Extensions_Selenium2TestCase_WebDriverException $e) {
+			// Login does not exist. Assume we are already authenticated
+		}
+	}
+
+	/**
+	 * Test enabling developer mode
+	 * @return bool
+	 */
+	public function testEnableDeveloperMode()
+	{
+		$this->url('/admin/const.php');
+		$this->authenticate();
+		$main_features_level_path = '//input[@value="MAIN_FEATURES_LEVEL"]/following::input[@type="text"]';
+		$main_features_level = $this->byXPath($main_features_level_path);
+		$main_features_level->clear();
+		$main_features_level->value('2');
+		$this->byName('update')->click();
+		// Page reloaded, we need a new XPath
+		$main_features_level = $this->byXPath($main_features_level_path);
+		return $this->assertEquals('2', $main_features_level->value(), "MAIN_FEATURES_LEVEL value is 2");
+	}
+
+	/**
+	 * Test enabling the module
+	 *
+	 * @depends testEnableDeveloperMode
+	 * @return bool
+	 */
+	public function testModuleEnabled()
+	{
+		$this->url('/admin/modules.php');
+		$this->authenticate();
+		$module_status_image_path = '//a[contains(@href, "'.self::$module_id.'")]/img';
+		$module_status_image = $this->byXPath($module_status_image_path);
+		if (strstr($module_status_image->attribute('src'), 'switch_off.png')) {
+			// Enable the module
+			$this->byHref('modMMIShipping')->click();
+		} else {
+			// Disable the module
+			$this->byHref('modMMIShipping')->click();
+			// Reenable the module
+			$this->byHref('modMMIShipping')->click();
+		}
+		// Page reloaded, we need a new Xpath
+		$module_status_image = $this->byXPath($module_status_image_path);
+		return $this->assertContains('switch_on.png', $module_status_image->attribute('src'), "Module enabled");
+	}
+
+	/**
+	 * Test access to the configuration page
+	 *
+	 * @depends testModuleEnabled
+	 * @return bool
+	 */
+	public function testConfigurationPage()
+	{
+		$this->url('/custom/mmishipping/admin/setup.php');
+		$this->authenticate();
+		return $this->assertContains('mmishipping/admin/setup.php', $this->url(), 'Configuration page');
+	}
+
+	/**
+	 * Test access to the about page
+	 *
+	 * @depends testConfigurationPage
+	 * @return bool
+	 */
+	public function testAboutPage()
+	{
+		$this->url('/custom/mmishipping/admin/about.php');
+		$this->authenticate();
+		return $this->assertContains('mmishipping/admin/about.php', $this->url(), 'About page');
+	}
+
+	/**
+	 * Test about page is rendering Markdown
+	 *
+	 * @depends testAboutPage
+	 * @return bool
+	 */
+	public function testAboutPageRendersMarkdownReadme()
+	{
+		$this->url('/custom/mmishipping/admin/about.php');
+		$this->authenticate();
+		return $this->assertEquals(
+			'Dolibarr Module Template (aka My Module)',
+			$this->byTag('h1')->text(),
+			"Readme title"
+		);
+	}
+
+	/**
+	 * Test box is properly declared
+	 *
+	 * @depends testModuleEnabled
+	 * @return bool
+	 */
+	public function testBoxDeclared()
+	{
+		$this->url('/admin/boxes.php');
+		$this->authenticate();
+		return $this->assertContains('mmishippingwidget1', $this->source(), "Box enabled");
+	}
+
+	/**
+	 * Test trigger is properly enabled
+	 *
+	 * @depends testModuleEnabled
+	 * @return bool
+	 */
+	public function testTriggerDeclared()
+	{
+		$this->url('/admin/triggers.php');
+		$this->authenticate();
+		return $this->assertContains(
+			'interface_99_modMMIShipping_MMIShippingTriggers.class.php',
+			$this->byTag('body')->text(),
+			"Trigger declared"
+		);
+	}
+
+	/**
+	 * Test trigger is properly declared
+	 *
+	 * @depends testTriggerDeclared
+	 * @return bool
+	 */
+	public function testTriggerEnabled()
+	{
+		$this->url('/admin/triggers.php');
+		$this->authenticate();
+		return $this->assertContains(
+			'tick.png',
+			$this->byXPath('//td[text()="interface_99_modMMIShipping_MyTrigger.class.php"]/following::img')->attribute('src'),
+			"Trigger enabled"
+		);
+	}
+
+	/**
+	 * Verify post conditions
+	 * @return void
+	 */
+	protected function assertPostConditions()
+	{
+	}
+
+	/**
+	 * Unit test teardown
+	 * @return void
+	 */
+	public function tearDown()
+	{
+	}
+
+	/**
+	 * Global test teardown
+	 * @return void
+	 */
+	public static function tearDownAfterClass()
+	{
+	}
+}