Compare commits
41 Commits
3e1609862e
...
master
Author | SHA1 | Date | |
---|---|---|---|
615f2a0c50 | |||
9ce2cf2e12 | |||
1c40875639 | |||
d4aba69375 | |||
28a927f6bd | |||
3d58f71135 | |||
f9125ca8cf | |||
5dcffefefd | |||
197af28a18 | |||
53571362b7 | |||
d21eb055d3 | |||
cd884c7f76 | |||
0aa835114d | |||
97c06c18a4 | |||
947a78b03a | |||
7370a1e7e2 | |||
89af62623d | |||
6f8e86c319 | |||
c27902fda1 | |||
a591406a7f | |||
f9cfc1f16a | |||
d1f38cbff3 | |||
5d3b0f9448 | |||
972ece51f9 | |||
4aede2ad1b | |||
7d76195d8c | |||
b6e49b77c8 | |||
bcb3b06bc3 | |||
85f7d28a0f | |||
1d695ea372 | |||
fa1807f5fc | |||
af75b9544a | |||
43cc60f860 | |||
b0d647e091 | |||
66687bf8b1 | |||
bd6e3f2d60 | |||
753aafe24d | |||
6913a0ca8f | |||
dfbad4b488 | |||
3e03887bda | |||
023c0f53e6 |
19
.gitignore
vendored
19
.gitignore
vendored
@ -1,27 +1,32 @@
|
|||||||
### Project Specific
|
### Project Specific
|
||||||
# Files
|
# Files
|
||||||
|
env.php
|
||||||
phpcs.xml
|
phpcs.xml
|
||||||
phpunit.xml
|
phpunit.xml
|
||||||
.phpunit.result.cache
|
.phpunit.result.cache
|
||||||
|
|
||||||
# Directories
|
# Directories
|
||||||
/vendor/
|
/vendor
|
||||||
node_modules/
|
/node_modules
|
||||||
cache/
|
cache/
|
||||||
|
|
||||||
### Editor Specific
|
### Editor Specific
|
||||||
# Files
|
# Files
|
||||||
nmsp-plugin-name.sublime-project
|
/*.sublime-project
|
||||||
nmsp-plugin-name.sublime-workspace
|
/*.sublime-workspace
|
||||||
|
|
||||||
# Directories
|
# Directories
|
||||||
.idea
|
/.fleet
|
||||||
.vscode
|
/.idea
|
||||||
|
/.vscode
|
||||||
|
|
||||||
### System Specific
|
### System Specific
|
||||||
# Files
|
# Files
|
||||||
|
.*.sw?
|
||||||
|
._*
|
||||||
.DS_Store
|
.DS_Store
|
||||||
|
.DS_Store?
|
||||||
Thumbs.db
|
Thumbs.db
|
||||||
|
|
||||||
# Directories
|
# Directories
|
||||||
__MACOSX
|
__MACOSX/
|
||||||
|
26
CHANGELOG.md
26
CHANGELOG.md
@ -0,0 +1,26 @@
|
|||||||
|
# Changelog
|
||||||
|
All notable changes to this project will be documented in this file.
|
||||||
|
|
||||||
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||||
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||||
|
|
||||||
|
## [Unreleased]
|
||||||
|
### Added
|
||||||
|
-
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
-
|
||||||
|
|
||||||
|
### Removed
|
||||||
|
-
|
||||||
|
|
||||||
|
|
||||||
|
## [1.0.0] - 20XX-01-01
|
||||||
|
### Added
|
||||||
|
-
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
-
|
||||||
|
|
||||||
|
### Removed
|
||||||
|
-
|
675
LICENSE.md
675
LICENSE.md
@ -0,0 +1,675 @@
|
|||||||
|
### GNU GENERAL PUBLIC LICENSE
|
||||||
|
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc.
|
||||||
|
<https://fsf.org/>
|
||||||
|
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies of this
|
||||||
|
license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
### Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom
|
||||||
|
to share and change all versions of a program--to make sure it remains
|
||||||
|
free software for all its users. We, the Free Software Foundation, use
|
||||||
|
the GNU General Public License for most of our software; it applies
|
||||||
|
also to any other work released this way by its authors. You can apply
|
||||||
|
it to your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you
|
||||||
|
have certain responsibilities if you distribute copies of the
|
||||||
|
software, or if you modify it: responsibilities to respect the freedom
|
||||||
|
of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the
|
||||||
|
manufacturer can do so. This is fundamentally incompatible with the
|
||||||
|
aim of protecting users' freedom to change the software. The
|
||||||
|
systematic pattern of such abuse occurs in the area of products for
|
||||||
|
individuals to use, which is precisely where it is most unacceptable.
|
||||||
|
Therefore, we have designed this version of the GPL to prohibit the
|
||||||
|
practice for those products. If such problems arise substantially in
|
||||||
|
other domains, we stand ready to extend this provision to those
|
||||||
|
domains in future versions of the GPL, as needed to protect the
|
||||||
|
freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish
|
||||||
|
to avoid the special danger that patents applied to a free program
|
||||||
|
could make it effectively proprietary. To prevent this, the GPL
|
||||||
|
assures that patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
### TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
#### 0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds
|
||||||
|
of works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of
|
||||||
|
an exact copy. The resulting work is called a "modified version" of
|
||||||
|
the earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user
|
||||||
|
through a computer network, with no transfer of a copy, is not
|
||||||
|
conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices" to
|
||||||
|
the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
#### 1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work for
|
||||||
|
making modifications to it. "Object code" means any non-source form of
|
||||||
|
a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users can
|
||||||
|
regenerate automatically from other parts of the Corresponding Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that same
|
||||||
|
work.
|
||||||
|
|
||||||
|
#### 2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not convey,
|
||||||
|
without conditions so long as your license otherwise remains in force.
|
||||||
|
You may convey covered works to others for the sole purpose of having
|
||||||
|
them make modifications exclusively for you, or provide you with
|
||||||
|
facilities for running those works, provided that you comply with the
|
||||||
|
terms of this License in conveying all material for which you do not
|
||||||
|
control copyright. Those thus making or running the covered works for
|
||||||
|
you must do so exclusively on your behalf, under your direction and
|
||||||
|
control, on terms that prohibit them from making any copies of your
|
||||||
|
copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under the
|
||||||
|
conditions stated below. Sublicensing is not allowed; section 10 makes
|
||||||
|
it unnecessary.
|
||||||
|
|
||||||
|
#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such
|
||||||
|
circumvention is effected by exercising rights under this License with
|
||||||
|
respect to the covered work, and you disclaim any intention to limit
|
||||||
|
operation or modification of the work as a means of enforcing, against
|
||||||
|
the work's users, your or third parties' legal rights to forbid
|
||||||
|
circumvention of technological measures.
|
||||||
|
|
||||||
|
#### 4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
#### 5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these
|
||||||
|
conditions:
|
||||||
|
|
||||||
|
- a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
- b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under
|
||||||
|
section 7. This requirement modifies the requirement in section 4
|
||||||
|
to "keep intact all notices".
|
||||||
|
- c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
- d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
#### 6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms of
|
||||||
|
sections 4 and 5, provided that you also convey the machine-readable
|
||||||
|
Corresponding Source under the terms of this License, in one of these
|
||||||
|
ways:
|
||||||
|
|
||||||
|
- a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
- b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the Corresponding
|
||||||
|
Source from a network server at no charge.
|
||||||
|
- c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
- d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
- e) Convey the object code using peer-to-peer transmission,
|
||||||
|
provided you inform other peers where the object code and
|
||||||
|
Corresponding Source of the work are being offered to the general
|
||||||
|
public at no charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal,
|
||||||
|
family, or household purposes, or (2) anything designed or sold for
|
||||||
|
incorporation into a dwelling. In determining whether a product is a
|
||||||
|
consumer product, doubtful cases shall be resolved in favor of
|
||||||
|
coverage. For a particular product received by a particular user,
|
||||||
|
"normally used" refers to a typical or common use of that class of
|
||||||
|
product, regardless of the status of the particular user or of the way
|
||||||
|
in which the particular user actually uses, or expects or is expected
|
||||||
|
to use, the product. A product is a consumer product regardless of
|
||||||
|
whether the product has substantial commercial, industrial or
|
||||||
|
non-consumer uses, unless such uses represent the only significant
|
||||||
|
mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to
|
||||||
|
install and execute modified versions of a covered work in that User
|
||||||
|
Product from a modified version of its Corresponding Source. The
|
||||||
|
information must suffice to ensure that the continued functioning of
|
||||||
|
the modified object code is in no case prevented or interfered with
|
||||||
|
solely because modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or
|
||||||
|
updates for a work that has been modified or installed by the
|
||||||
|
recipient, or for the User Product in which it has been modified or
|
||||||
|
installed. Access to a network may be denied when the modification
|
||||||
|
itself materially and adversely affects the operation of the network
|
||||||
|
or violates the rules and protocols for communication across the
|
||||||
|
network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
#### 7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders
|
||||||
|
of that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
- a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
- b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
- c) Prohibiting misrepresentation of the origin of that material,
|
||||||
|
or requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
- d) Limiting the use for publicity purposes of names of licensors
|
||||||
|
or authors of the material; or
|
||||||
|
- e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
- f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions
|
||||||
|
of it) with contractual assumptions of liability to the recipient,
|
||||||
|
for any liability that these contractual assumptions directly
|
||||||
|
impose on those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions; the
|
||||||
|
above requirements apply either way.
|
||||||
|
|
||||||
|
#### 8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your license
|
||||||
|
from a particular copyright holder is reinstated (a) provisionally,
|
||||||
|
unless and until the copyright holder explicitly and finally
|
||||||
|
terminates your license, and (b) permanently, if the copyright holder
|
||||||
|
fails to notify you of the violation by some reasonable means prior to
|
||||||
|
60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
#### 9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or run
|
||||||
|
a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
#### 10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
#### 11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims owned
|
||||||
|
or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within the
|
||||||
|
scope of its coverage, prohibits the exercise of, or is conditioned on
|
||||||
|
the non-exercise of one or more of the rights that are specifically
|
||||||
|
granted under this License. You may not convey a covered work if you
|
||||||
|
are a party to an arrangement with a third party that is in the
|
||||||
|
business of distributing software, under which you make payment to the
|
||||||
|
third party based on the extent of your activity of conveying the
|
||||||
|
work, and under which the third party grants, to any of the parties
|
||||||
|
who would receive the covered work from you, a discriminatory patent
|
||||||
|
license (a) in connection with copies of the covered work conveyed by
|
||||||
|
you (or copies made from those copies), or (b) primarily for and in
|
||||||
|
connection with specific products or compilations that contain the
|
||||||
|
covered work, unless you entered into that arrangement, or that patent
|
||||||
|
license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
#### 12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under
|
||||||
|
this License and any other pertinent obligations, then as a
|
||||||
|
consequence you may not convey it at all. For example, if you agree to
|
||||||
|
terms that obligate you to collect a royalty for further conveying
|
||||||
|
from those to whom you convey the Program, the only way you could
|
||||||
|
satisfy both those terms and this License would be to refrain entirely
|
||||||
|
from conveying the Program.
|
||||||
|
|
||||||
|
#### 13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
#### 14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions
|
||||||
|
of the GNU General Public License from time to time. Such new versions
|
||||||
|
will be similar in spirit to the present version, but may differ in
|
||||||
|
detail to address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the Program
|
||||||
|
specifies that a certain numbered version of the GNU General Public
|
||||||
|
License "or any later version" applies to it, you have the option of
|
||||||
|
following the terms and conditions either of that numbered version or
|
||||||
|
of any later version published by the Free Software Foundation. If the
|
||||||
|
Program does not specify a version number of the GNU General Public
|
||||||
|
License, you may choose any version ever published by the Free
|
||||||
|
Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future versions
|
||||||
|
of the GNU General Public License can be used, that proxy's public
|
||||||
|
statement of acceptance of a version permanently authorizes you to
|
||||||
|
choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
#### 15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
|
||||||
|
WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
|
||||||
|
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
|
||||||
|
PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
|
||||||
|
DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
|
||||||
|
CORRECTION.
|
||||||
|
|
||||||
|
#### 16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
|
||||||
|
CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
||||||
|
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
|
||||||
|
ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
|
||||||
|
NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
|
||||||
|
LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
|
||||||
|
TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
|
||||||
|
PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
|
||||||
|
|
||||||
|
#### 17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
### How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these
|
||||||
|
terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest to
|
||||||
|
attach them to the start of each source file to most effectively state
|
||||||
|
the exclusion of warranty; and each file should have at least the
|
||||||
|
"copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper
|
||||||
|
mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands \`show w' and \`show c' should show the
|
||||||
|
appropriate parts of the General Public License. Of course, your
|
||||||
|
program's commands might be different; for a GUI interface, you would
|
||||||
|
use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or
|
||||||
|
school, if any, to sign a "copyright disclaimer" for the program, if
|
||||||
|
necessary. For more information on this, and how to apply and follow
|
||||||
|
the GNU GPL, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your
|
||||||
|
program into proprietary programs. If your program is a subroutine
|
||||||
|
library, you may consider it more useful to permit linking proprietary
|
||||||
|
applications with the library. If this is what you want to do, use the
|
||||||
|
GNU Lesser General Public License instead of this License. But first,
|
||||||
|
please read <https://www.gnu.org/licenses/why-not-lgpl.html>.
|
@ -67,7 +67,7 @@ You'll need to run a few commands to set up the plugin for further development.
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
composer install
|
composer install
|
||||||
npm install && npm run development
|
npm install && npm run compile
|
||||||
```
|
```
|
||||||
|
|
||||||
### Available CLI commands
|
### Available CLI commands
|
||||||
|
140
admin/class-adminsettings.php
Normal file
140
admin/class-adminsettings.php
Normal file
@ -0,0 +1,140 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace PluginNamespace\Admin;
|
||||||
|
|
||||||
|
if ( ! defined( 'ABSPATH' ) ) {
|
||||||
|
exit;
|
||||||
|
}
|
||||||
|
|
||||||
|
class AdminSettings {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Class constructor.
|
||||||
|
*
|
||||||
|
* @since 1.0.0
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function __construct() {
|
||||||
|
add_action( 'admin_menu', array( $this, 'add_admin_menu' ), 11 );
|
||||||
|
add_action( 'admin_menu', array( $this, 'add_submenu_items' ), 12 );
|
||||||
|
|
||||||
|
add_action( 'admin_enqueue_scripts', array( $this, 'register_scripts' ) );
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Setting up the WordPress admin menu for this plugin. Also setting up
|
||||||
|
* a submenu item that will take the place of the main settings page.
|
||||||
|
*
|
||||||
|
* @since 1.0.0
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function add_admin_menu(): void {
|
||||||
|
$page_title = __( 'Plugin Name', 'nmsp_plugin_name_settings_title' );
|
||||||
|
$menu_title = __( 'Plugin Name', 'nmsp_plugin_name_settings_title' );
|
||||||
|
$capability = 'manage_options';
|
||||||
|
$menu_slug = 'nmsp-plugin-name-menu-slug';
|
||||||
|
$callback = '';
|
||||||
|
$icon = 'data:image/svg+xml;base64,' . base64_encode( file_get_contents( NMSP_PLUGIN_BASE_DIR . '/assets/images/menu-icon.svg' ) );
|
||||||
|
$position = 100; // after the separator below "Settings"
|
||||||
|
|
||||||
|
$subpage_title = __( 'Namespace Plugin Name - Settings', 'nmsp_plugin_name_settings_title' );
|
||||||
|
$submenu_title = __( 'Settings', 'nmsp_plugin_name_settings_title' );
|
||||||
|
$subcallback = array( $this, 'show_main_settings_page' );
|
||||||
|
|
||||||
|
add_menu_page( $page_title, $menu_title, $capability, $menu_slug, '', $icon, $position );
|
||||||
|
add_submenu_page( $menu_slug, $subpage_title, $submenu_title, $capability, $menu_slug, $subcallback );
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Append to the admin menu entry for this plugin.
|
||||||
|
*
|
||||||
|
* @since 1.0.0
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function add_submenu_items(): void {
|
||||||
|
$parent_menu_slug = 'nmsp-plugin-name-menu-slug';
|
||||||
|
$page_title = __( 'Namespace Plugin Name - Other', 'nmsp_plugin_name_settings_title' );
|
||||||
|
$menu_title = __( 'Other', 'nmsp_plugin_name_settings_title' );
|
||||||
|
$menu_slug = 'nmsp-plugin-name-menu-other-slug';
|
||||||
|
$capability = 'manage_options';
|
||||||
|
$callback = array( $this, 'show_other_page' );
|
||||||
|
|
||||||
|
add_submenu_page( $parent_menu_slug, $page_title, $menu_title, $capability, $menu_slug, $callback );
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Show the settings page.
|
||||||
|
*
|
||||||
|
* @since 1.0.0
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function show_main_settings_page(): void {
|
||||||
|
$data = array();
|
||||||
|
$this->localize_script();
|
||||||
|
|
||||||
|
ob_start();
|
||||||
|
echo nmsp_plugin_app()->blade->run( 'admin.settings', $data );
|
||||||
|
$output = ob_get_clean();
|
||||||
|
echo wp_kses_post( $output );
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Show the "other" page.
|
||||||
|
*
|
||||||
|
* @since 1.0.0
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function show_other_page(): void {
|
||||||
|
$data = array();
|
||||||
|
$this->localize_script();
|
||||||
|
|
||||||
|
ob_start();
|
||||||
|
echo nmsp_plugin_app()->blade->run( 'admin.other', $data );
|
||||||
|
$output = ob_get_clean();
|
||||||
|
echo wp_kses_post( $output );
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Register and enqueue stylesheets and javascript files.
|
||||||
|
*
|
||||||
|
* @since 1.0.0
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function register_scripts(): void {
|
||||||
|
wp_enqueue_style( 'nmsp-plugin-name-admin-css', plugins_url( '../assets/css/nmsp-plugin-name-admin.css', __FILE__ ), array(), '1.0.0', 'screen' );
|
||||||
|
|
||||||
|
wp_register_script( 'nmsp-plugin-name-admin-js', plugins_url( '../assets/js/nmsp-plugin-name-admin.js', __FILE__ ), array( 'jquery' ), '1.0.0', false );
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Description
|
||||||
|
*
|
||||||
|
* @since 1.0.0
|
||||||
|
*
|
||||||
|
* @param array $additional_data (optional) Additional key-value paired data to pass to JavaScript.
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
private function localize_script( array $additional_data = array() ): void {
|
||||||
|
wp_enqueue_script( 'nmsp-plugin-name-admin-js' );
|
||||||
|
|
||||||
|
$payload = array_merge(
|
||||||
|
$additional_data,
|
||||||
|
array(
|
||||||
|
'wp_ajax_url' => admin_url( 'admin-ajax.php' ),
|
||||||
|
'_nonce' => wp_create_nonce( NMSP_PLUGIN_NONCE ),
|
||||||
|
)
|
||||||
|
);
|
||||||
|
wp_localize_script( 'nmsp-plugin-name-admin-js', 'nmspPluginAdminApi', $payload );
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
new AdminSettings();
|
17
admin/class-install.php
Normal file
17
admin/class-install.php
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace PluginNamespace;
|
||||||
|
|
||||||
|
if ( ! defined( 'ABSPATH' ) ) {
|
||||||
|
exit;
|
||||||
|
}
|
||||||
|
|
||||||
|
class Install {
|
||||||
|
|
||||||
|
private static $db_updates = array(
|
||||||
|
'1.1.0' => array(
|
||||||
|
'dh_update_110_options',
|
||||||
|
),
|
||||||
|
);
|
||||||
|
|
||||||
|
}
|
@ -1,90 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
namespace PluginNamespace\Admin;
|
|
||||||
|
|
||||||
class Settings {
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Class constructor.
|
|
||||||
*
|
|
||||||
* @since 1.0.0
|
|
||||||
*
|
|
||||||
* @return void
|
|
||||||
*/
|
|
||||||
public function __construct() {
|
|
||||||
add_action( 'admin_menu', array( $this, 'append_to_admin_menu' ), 12 );
|
|
||||||
|
|
||||||
add_action( 'admin_enqueue_scripts', array( $this, 'register_scripts' ) );
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Append to the admin menu (prevents doubling).
|
|
||||||
*
|
|
||||||
* @since 1.0.0
|
|
||||||
*
|
|
||||||
* @return void
|
|
||||||
*/
|
|
||||||
public function append_to_admin_menu(): void {
|
|
||||||
$parent_slug = 'nmsp-plugin-name-menu-slug';
|
|
||||||
$page_title = __( 'Namespace Plugin Name - Settings', 'nmsp_plugin_name_settings_title' );
|
|
||||||
$menu_title = __( 'Settings', 'nmsp_plugin_name_settings_title' );
|
|
||||||
$capability = 'manage_options';
|
|
||||||
$menu_slug = $parent_slug;
|
|
||||||
$callback = array( $this, 'show_main_settings_page' );
|
|
||||||
|
|
||||||
add_submenu_page( $parent_slug, $page_title, $menu_title, $capability, $menu_slug, $callback );
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Show the settings page.
|
|
||||||
*
|
|
||||||
* @since 1.0.0
|
|
||||||
*
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
public function show_main_settings_page(): string {
|
|
||||||
$data = array();
|
|
||||||
|
|
||||||
$this->localize_script();
|
|
||||||
|
|
||||||
ob_start();
|
|
||||||
echo nmsp_plugin_app()->blade->run( 'admin.settings', $data );
|
|
||||||
$output = ob_get_clean();
|
|
||||||
return wp_kses_post( $output );
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Register and enqueue stylesheets and javascript files.
|
|
||||||
*
|
|
||||||
* @since 1.0.0
|
|
||||||
*
|
|
||||||
* @return void
|
|
||||||
*/
|
|
||||||
public function register_scripts(): void {
|
|
||||||
wp_enqueue_style( 'nmsp-plugin-name-admin-css', plugins_url( '../assets/css/nmsp-plugin-name-admin.css', __FILE__ ), array(), '1.0.0', 'screen' );
|
|
||||||
|
|
||||||
wp_register_script( 'nmsp-plugin-name-admin-js', plugins_url( '../assets/js/nmsp-plugin-name-admin.js', __FILE__ ), array( 'jquery' ), '1.0.0', false );
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Description
|
|
||||||
*
|
|
||||||
* @since 1.0.0
|
|
||||||
*
|
|
||||||
* @param array $additional_data (optional) Additional key-value paired data to pass to JavaScript.
|
|
||||||
*
|
|
||||||
* @return void
|
|
||||||
*/
|
|
||||||
private function localize_script( array $additional_data = array() ): void {
|
|
||||||
wp_enqueue_script( 'nmsp-plugin-name-admin-js' );
|
|
||||||
|
|
||||||
$payload = array(
|
|
||||||
'wp_ajax_url' => admin_url( 'admin-ajax.php' ),
|
|
||||||
'_nonce' => wp_create_nonce( NMSP_PLUGIN_NONCE ),
|
|
||||||
);
|
|
||||||
wp_localize_script( 'nmsp-plugin-name-admin-js', 'nmspPluginAdminApi', $payload );
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
new Settings();
|
|
48
admin/nmsp-admin-functions.php
Normal file
48
admin/nmsp-admin-functions.php
Normal file
@ -0,0 +1,48 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
if ( ! defined( 'ABSPATH' ) ) {
|
||||||
|
exit;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Show a notice on the admin panel.
|
||||||
|
*
|
||||||
|
* @since 1.0.0
|
||||||
|
*
|
||||||
|
* @param string $message The message to show in the notice
|
||||||
|
* @param string $type The 'type' of notice, e.g. info (default), success, warning, or error
|
||||||
|
* @param bool $dismissible Whether the notice should be dismissible
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
function nmsp_admin_notice( string $message, string $type = 'info', bool $dismissible = true ) {
|
||||||
|
$classes = 'notice';
|
||||||
|
switch ($type) {
|
||||||
|
case 'success':
|
||||||
|
$classes .= ' notice-success';
|
||||||
|
break;
|
||||||
|
case 'warning':
|
||||||
|
$classes .= ' notice-warning';
|
||||||
|
break;
|
||||||
|
case 'error':
|
||||||
|
$classes .= ' notice-error';
|
||||||
|
break;
|
||||||
|
case 'info':
|
||||||
|
default:
|
||||||
|
$classes .= ' notice-info';
|
||||||
|
}
|
||||||
|
|
||||||
|
if ( $dismissible ) {
|
||||||
|
$classes .= ' is-dismissible';
|
||||||
|
}
|
||||||
|
|
||||||
|
add_action( 'admin_notices', function () use ( $classes, $message ) {
|
||||||
|
ob_start();
|
||||||
|
?>
|
||||||
|
<div class="<?php echo $classes; ?>">
|
||||||
|
<p><?php _e( $message, 'nmsp-plugin-name-text-domain' ); ?></p>
|
||||||
|
</div>
|
||||||
|
<?php
|
||||||
|
echo ob_get_clean();
|
||||||
|
});
|
||||||
|
}
|
18
admin/nmsp-update-functions.php
Normal file
18
admin/nmsp-update-functions.php
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
if ( ! defined( 'ABSPATH' ) ) {
|
||||||
|
exit;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Update something in the database
|
||||||
|
*
|
||||||
|
* @since 1.1.0
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
function dh_update_110_options() {
|
||||||
|
global $wpdb;
|
||||||
|
|
||||||
|
// do the thing here to update the database
|
||||||
|
}
|
@ -0,0 +1,12 @@
|
|||||||
|
<svg version="1.0" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" preserveAspectRatio="xMidYMid meet">
|
||||||
|
<rect x="4" y="4" width="16" height="16" rx="2" ry="2"></rect>
|
||||||
|
<rect x="9" y="9" width="6" height="6"></rect>
|
||||||
|
<line x1="9" y1="1" x2="9" y2="4"></line>
|
||||||
|
<line x1="15" y1="1" x2="15" y2="4"></line>
|
||||||
|
<line x1="9" y1="20" x2="9" y2="23"></line>
|
||||||
|
<line x1="15" y1="20" x2="15" y2="23"></line>
|
||||||
|
<line x1="20" y1="9" x2="23" y2="9"></line>
|
||||||
|
<line x1="20" y1="14" x2="23" y2="14"></line>
|
||||||
|
<line x1="1" y1="9" x2="4" y2="9"></line>
|
||||||
|
<line x1="1" y1="14" x2="4" y2="14"></line>
|
||||||
|
</svg>
|
Before Width: | Height: | Size: 0 B After Width: | Height: | Size: 717 B |
8
assets/js/nmsp-plugin-name-admin.js
Normal file
8
assets/js/nmsp-plugin-name-admin.js
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
(() => {
|
||||||
|
// resources/admin/js/nmsp-plugin-name-admin.js
|
||||||
|
(function($) {
|
||||||
|
console.log("Your plugin just got loaded on the admin page!");
|
||||||
|
console.log("This is what you get as jQuery:", $);
|
||||||
|
console.log("Here is what you set for nmspPluginAdminApi:", window.nmspPluginAdminApi);
|
||||||
|
})(window.jQuery);
|
||||||
|
})();
|
@ -0,0 +1,8 @@
|
|||||||
|
(() => {
|
||||||
|
// resources/front/js/nmsp-plugin-name.js
|
||||||
|
(function($) {
|
||||||
|
console.log("Your plugin just got loaded!");
|
||||||
|
console.log("This is what you get as jQuery:", $);
|
||||||
|
console.log("Here is what you set for nmspPluginApi:", window.nmspPluginApi);
|
||||||
|
})(window.jQuery);
|
||||||
|
})();
|
@ -1,5 +1,9 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
|
if ( ! defined( 'ABSPATH' ) ) {
|
||||||
|
exit;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
| ----------------------------------------------------------------
|
| ----------------------------------------------------------------
|
||||||
| Bootstrap
|
| Bootstrap
|
||||||
|
@ -11,24 +11,31 @@
|
|||||||
}
|
}
|
||||||
],
|
],
|
||||||
"require": {
|
"require": {
|
||||||
"php": ">=7.3.0",
|
"php": "~8.1",
|
||||||
"eftec/bladeone": "^3.52"
|
"eftec/bladeone": "^4.9"
|
||||||
},
|
},
|
||||||
"require-dev": {
|
"require-dev": {
|
||||||
"php-parallel-lint/php-parallel-lint": "^1.3.0",
|
"php-parallel-lint/php-parallel-lint": "^1.3.2",
|
||||||
"wp-cli/i18n-command": "^2.2.8",
|
"phpstan/extension-installer": "^1.3.1",
|
||||||
|
"phpstan/phpstan": "^1.10.26",
|
||||||
|
"szepeviktor/phpstan-wordpress": "^1.3.0",
|
||||||
"wp-coding-standards/wpcs": "^2.3.0"
|
"wp-coding-standards/wpcs": "^2.3.0"
|
||||||
},
|
},
|
||||||
"config": {
|
"config": {
|
||||||
"optimize-autoloader": true,
|
"optimize-autoloader": true,
|
||||||
"preferred-install": "dist",
|
"preferred-install": "dist",
|
||||||
"sort-packages": true
|
"sort-packages": true,
|
||||||
|
"allow-plugins": {
|
||||||
|
"phpstan/extension-installer": true
|
||||||
|
}
|
||||||
},
|
},
|
||||||
"autoload": {
|
"autoload": {
|
||||||
"psr-4": {
|
"psr-4": {
|
||||||
|
"PluginNamespace\\Admin\\": "admin/",
|
||||||
"PluginNamespace\\": "includes/"
|
"PluginNamespace\\": "includes/"
|
||||||
},
|
},
|
||||||
"classmap": [
|
"classmap": [
|
||||||
|
"admin/",
|
||||||
"includes/"
|
"includes/"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
816
composer.lock
generated
816
composer.lock
generated
File diff suppressed because it is too large
Load Diff
@ -1,5 +1,9 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
|
if ( ! defined( 'ABSPATH' ) ) {
|
||||||
|
exit;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
| ----------------------------------------------------------------
|
| ----------------------------------------------------------------
|
||||||
| Base Definitions
|
| Base Definitions
|
||||||
|
@ -1,5 +1,9 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
|
if ( ! defined( 'ABSPATH' ) ) {
|
||||||
|
exit;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
| ----------------------------------------------------------------
|
| ----------------------------------------------------------------
|
||||||
| HTTP Status Code Definitions
|
| HTTP Status Code Definitions
|
||||||
|
@ -1,5 +1,9 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
|
if ( ! defined( 'ABSPATH' ) ) {
|
||||||
|
exit;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
| ----------------------------------------------------------------
|
| ----------------------------------------------------------------
|
||||||
| URL Rewrite Definitions
|
| URL Rewrite Definitions
|
||||||
|
5
env.php.example
Normal file
5
env.php.example
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
return [
|
||||||
|
'envrionment' => 'development',
|
||||||
|
];
|
@ -5,6 +5,10 @@ namespace PluginNamespace;
|
|||||||
use eftec\bladeone\BladeOne;
|
use eftec\bladeone\BladeOne;
|
||||||
use Exception;
|
use Exception;
|
||||||
|
|
||||||
|
if ( ! defined( 'ABSPATH' ) ) {
|
||||||
|
exit;
|
||||||
|
}
|
||||||
|
|
||||||
class App {
|
class App {
|
||||||
|
|
||||||
/** @var \PluginNamespace\App */
|
/** @var \PluginNamespace\App */
|
||||||
@ -16,29 +20,39 @@ class App {
|
|||||||
/**
|
/**
|
||||||
* Any logic that needs executed when the plugin is activated.
|
* Any logic that needs executed when the plugin is activated.
|
||||||
*
|
*
|
||||||
|
* @package PluginNamespace\App
|
||||||
* @since 1.0.0
|
* @since 1.0.0
|
||||||
*
|
*
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public static function plugin_activation(): void {
|
public static function plugin_activation(): void {
|
||||||
self::ensure_template_cache_dir_exists();
|
self::ensure_template_cache_dir_exists();
|
||||||
|
|
||||||
|
$plugin_metadata = array(
|
||||||
|
'plugin_version' => PLUGIN_NAME_VERSION,
|
||||||
|
'db_version' => PLUGIN_NAME_DB_VERSION,
|
||||||
|
);
|
||||||
|
add_option( 'nmsp_plugin_metadata', $plugin_metadata );
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Any logic that needs executed when the plugin is deactivated.
|
* Any logic that needs executed when the plugin is deactivated.
|
||||||
*
|
*
|
||||||
|
* @package PluginNamespace\App
|
||||||
* @since 1.0.0
|
* @since 1.0.0
|
||||||
*
|
*
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public static function plugin_deactivation(): void {
|
public static function plugin_deactivation(): void {
|
||||||
//
|
// phpcs:disable
|
||||||
|
// phpcs:enable
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Check that the cache directory for Blade exists and
|
* Check that the cache directory for Blade exists and
|
||||||
* if not then attempt to create it.
|
* if not then attempt to create it.
|
||||||
*
|
*
|
||||||
|
* @package PluginNamespace\App
|
||||||
* @since 1.0.0
|
* @since 1.0.0
|
||||||
*
|
*
|
||||||
* @throws \Exception
|
* @throws \Exception
|
||||||
@ -49,13 +63,13 @@ class App {
|
|||||||
if ( ! file_exists( NMSP_PLUGIN_BASE_DIR . '/cache/blade/.gitignore' ) ) {
|
if ( ! file_exists( NMSP_PLUGIN_BASE_DIR . '/cache/blade/.gitignore' ) ) {
|
||||||
try {
|
try {
|
||||||
mkdir( NMSP_PLUGIN_BASE_DIR . '/cache/blade', 0755, true );
|
mkdir( NMSP_PLUGIN_BASE_DIR . '/cache/blade', 0755, true );
|
||||||
} catch ( Exception $e ) {
|
} catch ( Exception $exp ) {
|
||||||
$error_payload = array(
|
$error_payload = array(
|
||||||
'level' => 'critical',
|
'level' => 'critical',
|
||||||
'message' => $e->getMessage(),
|
'message' => $exp->getMessage(),
|
||||||
'context' => array(
|
'context' => array(
|
||||||
'file' => $e->getFile(),
|
'file' => $exp->getFile(),
|
||||||
'line' => $e->getLine(),
|
'line' => $exp->getLine(),
|
||||||
),
|
),
|
||||||
);
|
);
|
||||||
error_log( json_encode( $error_payload, JSON_PRETTY_PRINT ) );
|
error_log( json_encode( $error_payload, JSON_PRETTY_PRINT ) );
|
||||||
@ -67,12 +81,13 @@ class App {
|
|||||||
* Return an instance of this plugin class. If it has
|
* Return an instance of this plugin class. If it has
|
||||||
* not been initialized, do so then return it.
|
* not been initialized, do so then return it.
|
||||||
*
|
*
|
||||||
|
* @package PluginNamespace\App
|
||||||
* @since 1.0.0
|
* @since 1.0.0
|
||||||
*
|
*
|
||||||
* @return \PluginNamespace\App
|
* @return \PluginNamespace\App
|
||||||
*/
|
*/
|
||||||
public static function get_instance(): App {
|
public static function get_instance(): App {
|
||||||
if ( ! isset( self::$instance ) && ! ( self::$instance instanceof App ) ) {
|
if ( ! ( self::$instance instanceof App ) ) {
|
||||||
self::$instance = new App();
|
self::$instance = new App();
|
||||||
|
|
||||||
self::$instance->load_plugin_textdomain();
|
self::$instance->load_plugin_textdomain();
|
||||||
@ -86,6 +101,7 @@ class App {
|
|||||||
/**
|
/**
|
||||||
* Load your translation files for this plugin.
|
* Load your translation files for this plugin.
|
||||||
*
|
*
|
||||||
|
* @package PluginNamespace\App
|
||||||
* @since 1.0.0
|
* @since 1.0.0
|
||||||
*
|
*
|
||||||
* @return void
|
* @return void
|
||||||
@ -97,32 +113,21 @@ class App {
|
|||||||
/**
|
/**
|
||||||
* Steps to take when initializing this plugin??
|
* Steps to take when initializing this plugin??
|
||||||
*
|
*
|
||||||
|
* @package PluginNamespace\App
|
||||||
* @since 1.0.0
|
* @since 1.0.0
|
||||||
*
|
*
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function scaffold_plugin(): void {
|
public function scaffold_plugin(): void {
|
||||||
add_action( 'admin_menu', array( $this, 'add_admin_menu' ) );
|
// phpcs:disable
|
||||||
|
if ( is_admin() ) {
|
||||||
|
// admin only logic here, remove phpcs calls around this
|
||||||
}
|
}
|
||||||
|
// phpcs:enable
|
||||||
|
|
||||||
/**
|
// other logic here
|
||||||
* Setting up the WordPress dashboard menu for this plugin.
|
add_filter( 'network_admin_plugin_action_links_nmsp-plugin-name/nmsp-plugin-name.php', array( $this, 'filter_plugin_action_links' ) );
|
||||||
* Setting this here to be overriden later so that a base is always available.
|
add_filter( 'plugin_action_links_nmsp-plugin-name/nmsp-plugin-name.php', array( $this, 'filter_plugin_action_links' ) );
|
||||||
*
|
|
||||||
* @since 1.0.0
|
|
||||||
*
|
|
||||||
* @return void
|
|
||||||
*/
|
|
||||||
public function add_admin_menu(): void {
|
|
||||||
$page_title = __( 'Namespace Plugin Name', 'nmsp_plugin_name_menu' );
|
|
||||||
$menu_title = __( 'Namespace Plugin Name', 'nmsp_plugin_name_menu' );
|
|
||||||
$capability = 'manage_options';
|
|
||||||
$menu_slug = 'nmsp-plugin-name-menu-slug';
|
|
||||||
$callback = '';
|
|
||||||
$icon = plugins_url( '../assets/images/menu-icon.svg', __FILE__ );
|
|
||||||
$position = 100;
|
|
||||||
|
|
||||||
add_menu_page( $page_title, $menu_title, $capability, $menu_slug, $callback, $icon, $position );
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -132,6 +137,7 @@ class App {
|
|||||||
*
|
*
|
||||||
* @codeCoverageIgnore
|
* @codeCoverageIgnore
|
||||||
*
|
*
|
||||||
|
* @package PluginNamespace\App
|
||||||
* @since 1.0.0
|
* @since 1.0.0
|
||||||
*
|
*
|
||||||
* @return void
|
* @return void
|
||||||
@ -139,9 +145,10 @@ class App {
|
|||||||
public function includes(): void {
|
public function includes(): void {
|
||||||
// Files to include on the admin.
|
// Files to include on the admin.
|
||||||
if ( is_admin() ) {
|
if ( is_admin() ) {
|
||||||
require_once NMSP_PLUGIN_BASE_DIR . '/admin/class-settings.php';
|
require_once NMSP_PLUGIN_BASE_DIR . '/admin/nmsp-admin-functions.php';
|
||||||
|
require_once NMSP_PLUGIN_BASE_DIR . '/admin/nmsp-update-functions.php';
|
||||||
|
require_once NMSP_PLUGIN_BASE_DIR . '/admin/class-adminsettings.php';
|
||||||
}
|
}
|
||||||
//
|
|
||||||
|
|
||||||
// Files to include on every request.
|
// Files to include on every request.
|
||||||
//
|
//
|
||||||
@ -151,8 +158,29 @@ class App {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Load Blade as the templating engine for the plugin.
|
* Description.
|
||||||
*
|
*
|
||||||
|
* @package PluginNamespace\App
|
||||||
|
* @since 1.0.0
|
||||||
|
*
|
||||||
|
* @param array<string, string> $actions
|
||||||
|
*
|
||||||
|
* @return array<string, string>
|
||||||
|
*/
|
||||||
|
public function filter_plugin_action_links( array $actions = array() ): array {
|
||||||
|
$plugin_settings_url = admin_url( 'admin.php?page=nmsp-plugin-name-menu-slug' );
|
||||||
|
return array_merge(
|
||||||
|
array(
|
||||||
|
'settings' => '<a href="' . $plugin_settings_url . '">' . esc_html__( 'Settings', 'nmsp-plugin-name-text-domain' ) . '</a>',
|
||||||
|
),
|
||||||
|
$actions
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Load BladeOne as the templating engine for the plugin.
|
||||||
|
*
|
||||||
|
* @package PluginNamespace\App
|
||||||
* @since 1.0.0
|
* @since 1.0.0
|
||||||
*
|
*
|
||||||
* @param \eftec\bladeone\BladeOne $blade
|
* @param \eftec\bladeone\BladeOne $blade
|
||||||
|
@ -5,7 +5,7 @@ namespace PluginNamespace;
|
|||||||
use WP_CLI;
|
use WP_CLI;
|
||||||
|
|
||||||
if ( ! defined( 'ABSPATH' ) ) {
|
if ( ! defined( 'ABSPATH' ) ) {
|
||||||
exit; // Exit if accessed directly
|
exit;
|
||||||
}
|
}
|
||||||
|
|
||||||
class NmspCli {
|
class NmspCli {
|
||||||
@ -13,6 +13,7 @@ class NmspCli {
|
|||||||
/**
|
/**
|
||||||
* Class constructor. Can add commands here.
|
* Class constructor. Can add commands here.
|
||||||
*
|
*
|
||||||
|
* @package PluginNamespace\NmspCli
|
||||||
* @since 1.0.0
|
* @since 1.0.0
|
||||||
*
|
*
|
||||||
* @return void
|
* @return void
|
||||||
@ -31,6 +32,7 @@ class NmspCli {
|
|||||||
/**
|
/**
|
||||||
* A sample method where something is done by being invoked from WP CLI.
|
* A sample method where something is done by being invoked from WP CLI.
|
||||||
*
|
*
|
||||||
|
* @package PluginNamespace\NmspCli
|
||||||
* @since 1.0.0
|
* @since 1.0.0
|
||||||
*
|
*
|
||||||
* @return void
|
* @return void
|
||||||
|
@ -2,11 +2,16 @@
|
|||||||
|
|
||||||
namespace PluginNamespace\Front;
|
namespace PluginNamespace\Front;
|
||||||
|
|
||||||
|
if ( ! defined( 'ABSPATH' ) ) {
|
||||||
|
exit;
|
||||||
|
}
|
||||||
|
|
||||||
class CustomPage {
|
class CustomPage {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class constructor.
|
* Class constructor.
|
||||||
*
|
*
|
||||||
|
* @package PluginNamespace\Front\CustomPage
|
||||||
* @since 1.0.0
|
* @since 1.0.0
|
||||||
*
|
*
|
||||||
* @return void
|
* @return void
|
||||||
@ -18,6 +23,7 @@ class CustomPage {
|
|||||||
/**
|
/**
|
||||||
* Register and enqueue stylesheets and javascript files.
|
* Register and enqueue stylesheets and javascript files.
|
||||||
*
|
*
|
||||||
|
* @package PluginNamespace\Front\CustomPage
|
||||||
* @since 1.0.0
|
* @since 1.0.0
|
||||||
*
|
*
|
||||||
* @return void
|
* @return void
|
||||||
@ -38,14 +44,15 @@ class CustomPage {
|
|||||||
/**
|
/**
|
||||||
* Display a page in place of a shortcode.
|
* Display a page in place of a shortcode.
|
||||||
*
|
*
|
||||||
|
* @package PluginNamespace\Front\CustomPage
|
||||||
* @since 1.0.0
|
* @since 1.0.0
|
||||||
*
|
*
|
||||||
* @param array $attributes Array of attributes on the shortcode string in the post body.
|
* @param array<string, string> $attributes Array of attributes on the shortcode string in the post body.
|
||||||
* @param string $content (optional) Text content that is between opening and closing shortcodes.
|
* @param string|null $content (optional) Text content that is between opening and closing shortcodes.
|
||||||
*
|
*
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
public function display_custom_page( array $attributes = array(), $content = null ) {
|
public function display_custom_page( array $attributes = array(), ?string $content = null ): string {
|
||||||
$data = array(
|
$data = array(
|
||||||
'shortcode' => array(
|
'shortcode' => array(
|
||||||
'attributes' => $attributes,
|
'attributes' => $attributes,
|
||||||
@ -54,7 +61,9 @@ class CustomPage {
|
|||||||
);
|
);
|
||||||
|
|
||||||
ob_start();
|
ob_start();
|
||||||
|
// phpcs:disable
|
||||||
echo nmsp_plugin_app()->blade->run( 'front.custom-page', $data );
|
echo nmsp_plugin_app()->blade->run( 'front.custom-page', $data );
|
||||||
|
// phpcs:enable
|
||||||
$output = ob_get_clean();
|
$output = ob_get_clean();
|
||||||
return wp_kses_post( $output );
|
return wp_kses_post( $output );
|
||||||
}
|
}
|
||||||
|
@ -2,11 +2,16 @@
|
|||||||
|
|
||||||
namespace PluginNamespace\Front;
|
namespace PluginNamespace\Front;
|
||||||
|
|
||||||
|
if ( ! defined( 'ABSPATH' ) ) {
|
||||||
|
exit;
|
||||||
|
}
|
||||||
|
|
||||||
class Rewrites {
|
class Rewrites {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class constructor.
|
* Class constructor.
|
||||||
*
|
*
|
||||||
|
* @package PluginNamespace\Front\Rewrites
|
||||||
* @since 1.0.0
|
* @since 1.0.0
|
||||||
*
|
*
|
||||||
* @return void
|
* @return void
|
||||||
@ -21,6 +26,7 @@ class Rewrites {
|
|||||||
/**
|
/**
|
||||||
* Generate new rewrite rules and flush the cached values.
|
* Generate new rewrite rules and flush the cached values.
|
||||||
*
|
*
|
||||||
|
* @package PluginNamespace\Front\Rewrites
|
||||||
* @since 1.0.0
|
* @since 1.0.0
|
||||||
*
|
*
|
||||||
* @return void
|
* @return void
|
||||||
@ -46,9 +52,10 @@ class Rewrites {
|
|||||||
* Build the array of post IDs that have a slug for the URL
|
* Build the array of post IDs that have a slug for the URL
|
||||||
* along with what custom query variable to use.
|
* along with what custom query variable to use.
|
||||||
*
|
*
|
||||||
|
* @package PluginNamespace\Front\Rewrites
|
||||||
* @since 1.0.0
|
* @since 1.0.0
|
||||||
*
|
*
|
||||||
* @return array
|
* @return array<int, array<string, string>>
|
||||||
*/
|
*/
|
||||||
public function build_rewrite_urls(): array {
|
public function build_rewrite_urls(): array {
|
||||||
$pages = array();
|
$pages = array();
|
||||||
@ -78,11 +85,12 @@ class Rewrites {
|
|||||||
* Append custom query variables to the list WordPress maintinas
|
* Append custom query variables to the list WordPress maintinas
|
||||||
* with each request.
|
* with each request.
|
||||||
*
|
*
|
||||||
|
* @package PluginNamespace\Front\Rewrites
|
||||||
* @since 1.0.0
|
* @since 1.0.0
|
||||||
*
|
*
|
||||||
* @param array $variable
|
* @param array<int, string> $vars
|
||||||
*
|
*
|
||||||
* @return array
|
* @return array<int, string>
|
||||||
*/
|
*/
|
||||||
public function custom_query_vars( array $vars ): array {
|
public function custom_query_vars( array $vars ): array {
|
||||||
$vars[] = 'foo';
|
$vars[] = 'foo';
|
||||||
|
@ -1,33 +1,56 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
|
use PluginNamespace\App;
|
||||||
|
use eftec\bladeone\BladeOne;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Boilerplate Plugin
|
* Boilerplate Plugin v2
|
||||||
*
|
*
|
||||||
* @package BoilerplatePlugin
|
* @package BoilerplatePlugin
|
||||||
* @author
|
* @author Plugin Author
|
||||||
* @copyright
|
* @copyright GPLv3
|
||||||
* @license
|
* @license https://www.gnu.org/licenses/gpl-3.0.en.html
|
||||||
*
|
*
|
||||||
* @wordpress-plugin
|
* @wordpress-plugin
|
||||||
* Plugin Name: Boilerplate Plugin
|
* Plugin Name: Boilerplate Plugin
|
||||||
* Description: Your plugin description.
|
* Description: Your plugin description.
|
||||||
* License: GPL v2
|
* License: GPLv3
|
||||||
* License URI: http://www.gnu.org/licenses/gpl-2.0.txt
|
* License URI: https://www.gnu.org/licenses/gpl-3.0.en.html
|
||||||
* Plugin URI: https://domain.com
|
* Plugin URI: https://domain.com
|
||||||
* Update URI: https://example.com/my-plugin/
|
* Update URI: https://example.com/my-plugin/
|
||||||
* Version: 1.0.0
|
* Version: 1.0.0
|
||||||
* Requires at least: 5.2
|
* Requires at least: 5.2
|
||||||
* Requires PHP: 7.2
|
* Requires PHP: 8.1
|
||||||
* Author: Plugin Author
|
* Author: Plugin Author
|
||||||
* Author URI: https://plugin-author.com
|
* Author URI: https://plugin-author.com
|
||||||
* Text Domain: nmsp-plugin-name-text-domain
|
* Text Domain: nmsp-plugin-name-text-domain
|
||||||
|
* Domain Path: /languages
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
// If this file is called directly, abort.
|
||||||
if ( ! defined( 'ABSPATH' ) ) {
|
if ( ! defined( 'ABSPATH' ) ) {
|
||||||
exit; // Exit if accessed directly
|
exit;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Currently plugin version.
|
||||||
|
* Start at version 1.0.0 and use SemVer - https://semver.org
|
||||||
|
* Rename this for your plugin and update it as you release new versions.
|
||||||
|
*/
|
||||||
|
if ( ! defined( 'PLUGIN_NAME_VERSION' ) ) {
|
||||||
|
define( 'PLUGIN_NAME_VERSION', '1.0.0' );
|
||||||
|
}
|
||||||
|
if ( ! defined( 'PLUGIN_NAME_DB_VERSION' ) ) {
|
||||||
|
define( 'PLUGIN_NAME_DB_VERSION', '1.0.0' );
|
||||||
|
}
|
||||||
|
|
||||||
|
if ( ! defined( 'NMSP_PLUGIN_BASE_DIR' ) ) {
|
||||||
define( 'NMSP_PLUGIN_BASE_DIR', __DIR__ );
|
define( 'NMSP_PLUGIN_BASE_DIR', __DIR__ );
|
||||||
|
}
|
||||||
|
|
||||||
|
if ( ! defined( 'NMSP_PLUGIN_BASE_FILE' ) ) {
|
||||||
|
define( 'NMSP_PLUGIN_BASE_FILE', __FILE__ );
|
||||||
|
}
|
||||||
|
|
||||||
require_once __DIR__ . '/vendor/autoload.php';
|
require_once __DIR__ . '/vendor/autoload.php';
|
||||||
require_once __DIR__ . '/bootstrap.php';
|
require_once __DIR__ . '/bootstrap.php';
|
||||||
@ -37,10 +60,9 @@ if ( defined( 'WP_CLI' ) && WP_CLI ) {
|
|||||||
require_once __DIR__ . '/includes/class-nmspcli.php';
|
require_once __DIR__ . '/includes/class-nmspcli.php';
|
||||||
}
|
}
|
||||||
|
|
||||||
$mode = \eftec\bladeone\BladeOne::MODE_AUTO; // Can also be MODE_DEBUG
|
$blade = new BladeOne( __DIR__ . '/templates', __DIR__ . '/cache/blade' );
|
||||||
$blade = new \eftec\bladeone\BladeOne( __DIR__ . '/templates', __DIR__ . '/cache/blade', $mode );
|
|
||||||
|
|
||||||
register_activation_hook( __FILE__, array( \PluginNamespace\App::class, 'plugin_activation' ) );
|
register_activation_hook( __FILE__, array( App::class, 'plugin_activation' ) );
|
||||||
register_deactivation_hook( __FILE__, array( \PluginNamespace\App::class, 'plugin_deactivation' ) );
|
register_deactivation_hook( __FILE__, array( App::class, 'plugin_deactivation' ) );
|
||||||
|
|
||||||
nmsp_plugin_app()->load_blade( $blade );
|
nmsp_plugin_app()->load_blade( $blade );
|
||||||
|
30816
package-lock.json
generated
30816
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
44
package.json
44
package.json
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "Namespace-PluginName",
|
"name": "Namespace-PluginName",
|
||||||
"version": "1.0.0",
|
"version": "1.1.0",
|
||||||
"description": "",
|
"description": "",
|
||||||
"author": "",
|
"author": "",
|
||||||
"license": "GPL-2.0",
|
"license": "GPL-2.0",
|
||||||
@ -12,13 +12,32 @@
|
|||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://github.com/namespace/plugin-name/issues"
|
"url": "https://github.com/namespace/plugin-name/issues"
|
||||||
},
|
},
|
||||||
"dependencies": {},
|
"scripts": {
|
||||||
|
"watch:css": "node-sass resources/front/sass/nmsp-plugin-name.scss -o ./assets/css/ --source-map true --output-style expanded --indent-type tab --indent-width 1 -w",
|
||||||
|
"watch:css-admin": "node-sass resources/admin/sass/nmsp-plugin-name-admin.scss -o ./assets/css/ --source-map true --output-style expanded --indent-type tab --indent-width 1 -w",
|
||||||
|
"watch:js": "esbuild --format=iife resources/front/js/nmsp-plugin-name.js --outfile=assets/js/nmsp-plugin-name.js --bundle --watch",
|
||||||
|
"watch:js-admin": "esbuild --format=iife resources/admin/js/nmsp-plugin-name-admin.js --outfile=assets/js/nmsp-plugin-name-admin.js --bundle --watch",
|
||||||
|
"watch-admin": "node-sass resources/admin/sass/nmsp-plugin-name-admin.scss -o ./assets/css/ --source-map true --output-style expanded --indent-type tab --indent-width 1 -w",
|
||||||
|
"watch": "concurrently --kill-others \"npm run watch:css\" \"npm run watch:css-admin\" \"npm run watch:js\" \"npm run watch:js-admin\"",
|
||||||
|
"compile:css": "node-sass resources/front/sass/nmsp-plugin-name.scss -o ./assets/css/ && stylelint 'assets/css/nmsp-plugin-name.css' --fix || true && stylelint 'assets/css/nmsp-plugin-name.css' --fix",
|
||||||
|
"compile:css-admin": "node-sass resources/admin/sass/nmsp-plugin-name-admin.scss -o ./assets/css/ && stylelint 'assets/css/nmsp-plugin-name-admin.css' --fix || true && stylelint 'assets/css/nmsp-plugin-name-admin.css' --fix",
|
||||||
|
"compile:rtl": "rtlcss assets/css/nmsp-plugin-name.css assets/css/nmsp-plugin-name-rtl.css && rtlcss assets/css/nmsp-plugin-name.css assets/css/nmsp-plugin-name-rtl.css",
|
||||||
|
"compile:rtl-admin": "rtlcss assets/css/nmsp-plugin-name-admin.css assets/css/nmsp-plugin-name-admin-rtl.css && rtlcss assets/css/nmsp-plugin-name-admin-admin.css assets/css/nmsp-plugin-name-admin-rtl.css",
|
||||||
|
"compile:js": "cp resources/front/js/nmsp-plugin-name.js assets/js/nmsp-plugin-name.js",
|
||||||
|
"compile:js-admin": "cp resources/admin/js/nmsp-plugin-name-admin.js assets/js/nmsp-plugin-name-admin.js",
|
||||||
|
"compile": "concurrently --kill-others \"npm run compile:css\" \"npm run compile:css-admin\" \"npm run compile:rtl\" \"npm run compile:rtl-admin\" \"npm run compile:js\" \"npm run compile:js-admin\"",
|
||||||
|
"lint:js": "wp-scripts lint-js 'resources/**/js/*.js'",
|
||||||
|
"lint:scss": "wp-scripts lint-style 'resources/**/sass/**/*.scss'",
|
||||||
|
"bundle": "dir-archiver --src . --dest ../nmsp-plugin-name.zip --exclude .DS_Store .stylelintrc.json .eslintrc .git .gitattributes .github .gitignore README.md CHANGELOG.md composer.lock node_modules vendor package-lock.json package.json .travis.yml phpcs.xml.dist resources assets/css/nmsp-plugin-name.css.map assets/css/nmsp-plugin-name-admin.css.map"
|
||||||
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@wordpress/scripts": "^16.1.1",
|
"@wordpress/scripts": "^26.9.0",
|
||||||
"@wordpress/stylelint-config": "19.0.5",
|
"@wordpress/stylelint-config": "21.21.0",
|
||||||
"dir-archiver": "^1.2.0",
|
"concurrently": "^8.2.0",
|
||||||
"node-sass": "^6.0.0",
|
"dir-archiver": "^2.1.0",
|
||||||
"rtlcss": "^3.2.0"
|
"esbuild": "^0.18.17",
|
||||||
|
"node-sass": "^9.0.0",
|
||||||
|
"rtlcss": "^4.1.0"
|
||||||
},
|
},
|
||||||
"rtlcssConfig": {
|
"rtlcssConfig": {
|
||||||
"options": {
|
"options": {
|
||||||
@ -32,16 +51,5 @@
|
|||||||
},
|
},
|
||||||
"plugins": [],
|
"plugins": [],
|
||||||
"map": false
|
"map": false
|
||||||
},
|
|
||||||
"scripts": {
|
|
||||||
"watch": "node-sass resources/front/sass/nmsp-plugin-name.scss -o ./assets/css/ --source-map true --output-style expanded --indent-type tab --indent-width 1 -w",
|
|
||||||
"watch-admin": "node-sass resources/admin/sass/nmsp-plugin-name-admin.scss -o ./assets/css/ --source-map true --output-style expanded --indent-type tab --indent-width 1 -w",
|
|
||||||
"compile:css": "node-sass resources/front/sass/nmsp-plugin-name.scss -o ./assets/css/ && stylelint 'assets/css/nmsp-plugin-name.css' --fix || true && stylelint 'assets/css/nmsp-plugin-name.css' --fix",
|
|
||||||
"compile:css-admin": "node-sass resources/admin/sass/nmsp-plugin-name-admin.scss -o ./assets/css/ && stylelint 'assets/css/nmsp-plugin-name-admin.css' --fix || true && stylelint 'assets/css/nmsp-plugin-name-admin.css' --fix",
|
|
||||||
"compile:rtl": "rtlcss assets/css/nmsp-plugin-name.css assets/css/nmsp-plugin-name-rtl.css && rtlcss assets/css/nmsp-plugin-name.css assets/css/nmsp-plugin-name-rtl.css",
|
|
||||||
"compile:rtl-admin": "rtlcss assets/css/nmsp-plugin-name-admin.css assets/css/nmsp-plugin-name-admin-rtl.css && rtlcss assets/css/nmsp-plugin-name-admin-admin.css assets/css/nmsp-plugin-name-admin-rtl.css",
|
|
||||||
"lint:scss": "wp-scripts lint-style 'resources/**/sass/**/*.scss'",
|
|
||||||
"lint:js": "wp-scripts lint-js 'resources/**/js/*.js'",
|
|
||||||
"bundle": "dir-archiver --src . --dest ../nmsp-plugin-name.zip --exclude .DS_Store .stylelintrc.json .eslintrc .git .gitattributes .github .gitignore README.md CHANGELOG.md composer.lock node_modules vendor package-lock.json package.json .travis.yml phpcs.xml.dist resources assets/css/nmsp-plugin-name.css.map assets/css/nmsp-plugin-name-admin.css.map"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
9
phpstan.neon
Normal file
9
phpstan.neon
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
parameters:
|
||||||
|
level: 6
|
||||||
|
bootstrapFiles:
|
||||||
|
- bootstrap.php
|
||||||
|
- nmsp-plugin-name.php
|
||||||
|
paths:
|
||||||
|
- admin
|
||||||
|
- constants
|
||||||
|
- includes
|
5
templates/admin/other.blade.php
Normal file
5
templates/admin/other.blade.php
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
@extends('layouts.admin')
|
||||||
|
|
||||||
|
@section('content')
|
||||||
|
<p>PluginNamespace Plugin {{ __( 'Admin Other Page', 'nmsp-plugin-name-text-domain' ) }}</p>
|
||||||
|
@endsection
|
3
templates/admin/partials/notice.blade.php
Normal file
3
templates/admin/partials/notice.blade.php
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
<div class="notice {{ $classes }}">
|
||||||
|
<p>{{ $message }}</p>
|
||||||
|
</div>
|
@ -1,12 +1,11 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
if ( ! defined( 'ABSPATH' ) ) {
|
if ( ! defined( 'ABSPATH' ) ) {
|
||||||
// Exit if accessed directly
|
|
||||||
exit;
|
exit;
|
||||||
}
|
}
|
||||||
|
|
||||||
if ( ! defined( 'WP_UNINSTALL_PLUGIN' ) ) {
|
|
||||||
// This constant gets set when WordPress' uninstall.php file is invoked.
|
// This constant gets set when WordPress' uninstall.php file is invoked.
|
||||||
|
if ( ! defined( 'WP_UNINSTALL_PLUGIN' ) ) {
|
||||||
exit;
|
exit;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user