Cập nhật gói thư viện DEVirion #1

Commando/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER 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.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser 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
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

Commando/README.md

@@ -0,0 +1,104 @@
+<h1>Commando<img src="https://raw.githubusercontent.com/CortexPE/Commando/master/commando.png" height="64" width="64" align="left"></img>&nbsp;<img src="https://poggit.pmmp.io/ci.shield/CortexPE/Commando/~"></img></h1>
+<br />
+
+A PocketMine-MP Virion for easier implementation of dynamic commands, including support for Minecraft: Bedrock Edition argument listing aimed for both the end users and the plugin developers.
+
+# Usage:
+Installation is easy, you may get a compiled phar [here](https://poggit.pmmp.io/ci/CortexPE/Commando/~), integrate the virion itself into your plugin or you could also use it as a composer library by running the command below:
+
+`composer require cortexpe/commando`
+
+This virion is purely object oriented. So, to use it you'll have to extend the `BaseCommand` object, import the `PacketHooker` object and the optional objects for subcommands and arguments (whenever necessary).
+
+# Why is this necessary?
+The virion provides an easy way to verify user input, convert user input, and for making sure that our arguments are the type that we expect it to.
+
+On the plus side, it also provides the argument list for the client to recognize making it easy to use the command without remembering the order of arguments.
+
+Because not only MC: Bedrock can use the commands, I've also implemented command usage pre-generation for ease of use with the console as well.
+
+This also provides an easy to use API for lessening boilerplate code while adding more functionality and verbosity (error codes, and error lists, and sending usage messages).
+
+It is structured in a similar way to the legacy PocketMine commands for ease of migration from an older codebase.
+
+**Upon the time of writing this readme file, This virion will be used on [Hierarchy](https://github.com/CortexPE/Hierarchy) for the command implementation clean-up**
+
+## Basic Usage:
+
+***NOTE: Other miscellaneous functions can be indexed within your IDEs or by reading the source code. This is only the basic usage of the virion, it does not show every aspect of it as that'd be too long to document.***
+
+### Create your command class
+In our command class, we need to extend `BaseCommand` and implement its required methods to use all of Commando's features.
+```php
+<?php
+
+use CortexPE\Commando\BaseCommand;
+use pocketmine\command\CommandSender;
+
+class MyCommand extends BaseCommand {
+	protected function prepare(): void {
+		// This is where we'll register our arguments and subcommands
+	}
+
+	public function onRun(CommandSender $sender, string $aliasUsed, array $args): void {
+		// This is where the processing will occur if it's NOT handled by other subcommands
+	}
+}
+```
+
+### Register the arguments
+If we register arguments, we need to import and use / extend (if needed) the provided argument objects.
+```php
+use CortexPE\Commando\args\RawStringArgument;
+
+	protected function prepare(): void {
+		// $this->registerArgument(position, argument object (name, isOptional));
+		$this->registerArgument(0, new RawStringArgument("name", true));
+	}
+```
+
+### Handling our arguments
+The arguments passed on our `onRun` method will be mapped by `name => value` this makes it easy to understand which argument is which, instead of using numeric indices. It is also guaranteed that the arguments passed will be the declared type that we've set.
+```php
+	public function onRun(CommandSender $sender, string $aliasUsed, array $args): void {
+		if(isset($args["name"])){
+			$sender->sendMessage("Hello, " . $args["name"] . "!");
+		} else {
+			$this->sendUsage();
+		}
+	}
+```
+
+### Registering the `PacketHooker` for vanilla command arguments
+The `PacketHooker` listener is required for us to be able to inject data to the `AvailableCommandsPacket` the server sends.
+```php
+use CortexPE\Commando\PacketHooker;
+
+// onEnable:
+	if(!PacketHooker::isRegistered()) {
+		PacketHooker::register($this);
+	}
+```
+
+### Registering the command from a plugin
+Once we've constructed our command with our arguments and subcommands, we can now register our command to PocketMine's command map, to be available to our users.
+```php
+// onEnable:
+$this->getServer()->getCommandMap()->register("myplugin", new MyCommand($this, "greet", "Make the server greet you!"));
+```
+The only difference with using this framework is that you don't need to set the usage message, as they are pre-generated after all the arguments have been registered.
+
+### SubCommands
+Subcommands work the same way as regular commands, the only difference is that they're registered on the parent command with `BaseCommand->registerSubCommand()` having their own set of arguments and own usage message.
+
+### Error messages
+The virion provides default error messages for user input errors regarding the arguments given. It also provides a way to register your own error message formats for the sake of customizability.
+```php
+$cmdCtx->setErrorFormat($errorCode, $format);
+// Arrays can be passed on `BaseCommand->setErrorFormats()` to bulk-set other error messages
+```
+The error messages are sent in bulk to the users to let them know what parts are wrong with their input, not having to do trial-and-error.
+*A current limitation is that, you cannot register your own error messages with other error codes.*
+
+-----
+**This framework was made with :heart: by CortexPE, Enjoy!~ :3**

Commando/composer.json

@@ -0,0 +1,9 @@
+{
+    "name": "cortexpe/commando",
+    "description": "A Command Framework virion for PocketMine-MP ",
+    "type": "library",
+    "license": "LGPL-3.0-only",
+    "autoload": {
+        "psr-4": {"CortexPE\\Commando\\": ["src\\CortexPE\\Commando\\"]}
+    }
+}

Commando/docs/MIGRATION.md

@@ -0,0 +1,31 @@
+### Migration for versions 1.x.x -> 2.x.x
+
+As the implementation of the `PluginIdentifiableCommand` is now being enforced by Poggit-CI, we needed to comply and include it with the virion itself (being a base framework, to reduce boilerplate code)
+
+To migrate your plugins, if you have overridden the constructor (`__construct()`) of any class that's extending `BaseCommand`, you will need to update the function's signature as it now includes the `Plugin` context before anything else.
+
+```php
+public function __construct(
+	Plugin $plugin,
+	string $name,
+	string $description = "",
+	array $aliases = []
+)
+```
+
+You will need to change the parent call (`parent::__construct($name, $description, $aliases)`) to include the plugin instance:
+```php
+parent::__construct($plugin, $name, $description, null, $aliases);
+```
+
+Along with these changes, you will need to include the `Plugin` context with your class' constructor.
+
+Because of those signature differences, you will need to update the part where your plugin registers a command that uses Commando. As an example:
+```php
+// Example code from 1.x.x README.md
+$this->getServer()->getCommandMap()->register("myplugin", new MyCommand("greet", "Make the server greet you!"));
+// Will have to be migrated to:
+$this->getServer()->getCommandMap()->register("myplugin", new MyCommand($this, "greet", "Make the server greet you!"));
+```
+
+Assuming you're calling `CommandMap->register()` directly from the plugin itself.