BanListCommand Class Reference

Public Member Functions
	__construct ($name)
	execute (CommandSender $sender, $currentAlias, array $args)
Public Member Functions inherited from VanillaCommand
	__construct ($name, $description="", $usageMessage=null, array $aliases=[])
Public Member Functions inherited from Command
	__construct ($name, $description="", $usageMessage=null, array $aliases=[])
	getDefaultCommandData ()
	generateCustomCommandData (Player $player)
	getOverloads ()
	execute (CommandSender $sender, $commandLabel, array $args)
	getName ()
	getPermission ()
	setPermission ($permission)
	testPermission (CommandSender $target)
	testPermissionSilent (CommandSender $target)
	getLabel ()
	setLabel ($name)
	register (CommandMap $commandMap)
	unregister (CommandMap $commandMap)
	isRegistered ()
	getAliases ()
	getPermissionMessage ()
	getDescription ()
	getUsage ()
	setAliases (array $aliases)
	setDescription ($description)
	setPermissionMessage ($permissionMessage)
	setUsage ($usage)
	__toString ()

Additional Inherited Members
Static Public Member Functions inherited from Command
static	generateDefaultData ()
static	broadcastCommandMessage (CommandSender $source, $message, $sendToSource=true)
Data Fields inherited from VanillaCommand
const	MAX_COORD = 30000000
const	MIN_COORD = -30000000
Data Fields inherited from Command
	$timings
Protected Member Functions inherited from VanillaCommand
	getInteger (CommandSender $sender, $value, $min=self::MIN_COORD, $max=self::MAX_COORD)
	getRelativeDouble ($original, CommandSender $sender, $input, $min=self::MIN_COORD, $max=self::MAX_COORD)
	getDouble (CommandSender $sender, $value, $min=self::MIN_COORD, $max=self::MAX_COORD)
Protected Attributes inherited from Command
	$commandData = null
	$description = ""
	$usageMessage

Constructor & Destructor Documentation

__construct()

__construct

(

$name

)

BanListCommand constructor.

Parameters

string

$name

                                      {
        parent::__construct(
            $name,
            "%pocketmine.command.banlist.description",
            "%pocketmine.command.banlist.usage"
        );
        $this->setPermission("pocketmine.command.ban.list");
    }

Member Function Documentation

execute()

execute	(	CommandSender	$sender,
			$currentAlias,
		array	$args
	)

Parameters

CommandSender	$sender
string	$currentAlias
array	$args

Returns

bool

                                                                              {
        if(!$this->testPermission($sender)){
            return true;
        }

        $args[0] = (isset($args[0]) ? strtolower($args[0]) : "");

        switch($args[0]){
            case "ips":
                $list = $sender->getServer()->getIPBans();
                $title = "commands.banlist.ips";
                break;
            case "cids":
                $list = $list = $sender->getServer()->getCIDBans();
                $title = "commands.banlist.cids";
                break;
            case "players":
                $list = $sender->getServer()->getNameBans();
                $title = "commands.banlist.players";
                break;
            default:
                $sender->sendMessage(new TranslationContainer("commands.generic.usage", [$this->usageMessage]));
                return false;
        }

        $message = "";
        $list = $list->getEntries();
        foreach($list as $entry){
            $message .= $entry->getName() . ", ";
        }

        $sender->sendMessage(Server::getInstance()->getLanguage()->translateString($title, [count($list)]));
        $sender->sendMessage(\substr($message, 0, -2));

        return true;
    }

---

The documentation for this class was generated from the following file:

• src/pocketmine/command/defaults/BanListCommand.php