applied common formatting

This commit is contained in:
Steffen Schröder
2014-05-02 17:50:30 +02:00
parent ba720f46bf
commit a0f5421bea
48 changed files with 3539 additions and 3595 deletions

View File

@ -12,9 +12,9 @@ use ManiaControl\Players\PlayerManager;
/**
* Class managing the Custom UI Settings
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
* @author ManiaControl Team <mail@maniacontrol.com>
* @copyright 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class CustomUIManager implements CallbackListener, TimerListener {
/*
@ -51,19 +51,6 @@ class CustomUIManager implements CallbackListener, TimerListener {
$this->customUI = new CustomUI();
}
/**
* Update the CustomUI Manialink
*
* @param Player $player
*/
private function updateManialink(Player $player = null) {
if ($player) {
$this->maniaControl->manialinkManager->sendManialink($this->customUI, $player->login);
return;
}
$this->maniaControl->manialinkManager->sendManialink($this->customUI);
}
/**
* Handle 1Second
*
@ -77,6 +64,19 @@ class CustomUIManager implements CallbackListener, TimerListener {
$this->updateManialink();
}
/**
* Update the CustomUI Manialink
*
* @param Player $player
*/
private function updateManialink(Player $player = null) {
if ($player) {
$this->maniaControl->manialinkManager->sendManialink($this->customUI, $player->login);
return;
}
$this->maniaControl->manialinkManager->sendManialink($this->customUI);
}
/**
* Handle PlayerJoined Callback
*
@ -87,9 +87,9 @@ class CustomUIManager implements CallbackListener, TimerListener {
//send it again after 500ms
$self = $this;
$this->maniaControl->timerManager->registerOneTimeListening($this, function($time) use (&$self, &$player){
$this->maniaControl->timerManager->registerOneTimeListening($this, function ($time) use (&$self, &$player) {
$self->updateManialink($player);
},500);
}, 500);
}
/**

View File

@ -8,15 +8,15 @@ use FML\ManiaLink;
use ManiaControl\Callbacks\CallbackListener;
use ManiaControl\Callbacks\CallbackManager;
use ManiaControl\ManiaControl;
use ManiaControl\Players\PlayerManager;
use ManiaControl\Players\Player;
use ManiaControl\Players\PlayerManager;
/**
* Class managing Icons
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
* @author ManiaControl Team <mail@maniacontrol.com>
* @copyright 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class IconManager implements CallbackListener {
/*
@ -95,15 +95,6 @@ class IconManager implements CallbackListener {
$this->preloadIcons();
}
/**
* Handle PlayerConnect Callback
*
* @param Player $player
*/
public function handlePlayerConnect(Player $player) {
$this->preloadIcons($player);
}
/**
* Preload Icons
*
@ -115,7 +106,7 @@ class IconManager implements CallbackListener {
$maniaLink->add($frame);
$frame->setPosition(500, 500);
foreach($this->icons as $iconUrl) {
foreach ($this->icons as $iconUrl) {
$iconQuad = new Quad();
$iconQuad->setImage($iconUrl);
$iconQuad->setSize(1, 1);
@ -125,4 +116,13 @@ class IconManager implements CallbackListener {
// Send manialink
$this->maniaControl->manialinkManager->sendManialink($maniaLink, $player);
}
/**
* Handle PlayerConnect Callback
*
* @param Player $player
*/
public function handlePlayerConnect(Player $player) {
$this->preloadIcons($player);
}
}

View File

@ -15,27 +15,27 @@ use Maniaplanet\DedicatedServer\Xmlrpc\NotInScriptModeException;
/**
* Manialink Manager Class
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*
* @author ManiaControl Team <mail@maniacontrol.com>
* @copyright 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class ManialinkManager implements ManialinkPageAnswerListener, CallbackListener {
/*
* Constants
*/
const MAIN_MLID = 'Main.ManiaLinkId';
const ACTION_CLOSEWIDGET = 'ManiaLinkManager.CloseWidget';
const MAIN_MLID = 'Main.ManiaLinkId';
const ACTION_CLOSEWIDGET = 'ManiaLinkManager.CloseWidget';
const CB_MAIN_WINDOW_CLOSED = 'ManialinkManagerCallback.MainWindowClosed';
const CB_MAIN_WINDOW_OPENED = 'ManialinkManagerCallback.MainWindowOpened';
/*
* Public Properties
*/
public $styleManager = null;
public $customUIManager = null;
public $iconManager = null;
/*
* Private Properties
*/
@ -45,15 +45,15 @@ class ManialinkManager implements ManialinkPageAnswerListener, CallbackListener
/**
* Create a new manialink manager
*
*
* @param ManiaControl $maniaControl
*/
public function __construct(ManiaControl $maniaControl) {
$this->maniaControl = $maniaControl;
$this->styleManager = new StyleManager($maniaControl);
$this->maniaControl = $maniaControl;
$this->styleManager = new StyleManager($maniaControl);
$this->customUIManager = new CustomUIManager($maniaControl);
$this->iconManager = new IconManager($maniaControl);
$this->iconManager = new IconManager($maniaControl);
// Register for callbacks
$this->registerManialinkPageAnswerListener(self::ACTION_CLOSEWIDGET, $this, 'closeWidgetCallback');
$this->maniaControl->callbackManager->registerCallbackListener(CallbackManager::CB_MP_PLAYERMANIALINKPAGEANSWER, $this, 'handleManialinkPageAnswer');
@ -61,10 +61,10 @@ class ManialinkManager implements ManialinkPageAnswerListener, CallbackListener
/**
* Register a new manialink page answer listener
*
* @param string $actionId
*
* @param string $actionId
* @param ManialinkPageAnswerListener $listener
* @param string $method
* @param string $method
* @return bool
*/
public function registerManialinkPageAnswerListener($actionId, ManialinkPageAnswerListener $listener, $method) {
@ -72,24 +72,24 @@ class ManialinkManager implements ManialinkPageAnswerListener, CallbackListener
trigger_error("Given listener for actionId '{$actionId}' doesn't have callback method '{$method}'!");
return false;
}
if (!array_key_exists($actionId, $this->pageAnswerListeners) || !is_array($this->pageAnswerListeners[$actionId])) {
// Init listeners array
$this->pageAnswerListeners[$actionId] = array();
}
// Register page answer listener
array_push($this->pageAnswerListeners[$actionId], array($listener, $method));
return true;
}
/**
* Register a new manialink page answer reg ex listener
*
* @param string $actionIdRegex
*
* @param string $actionIdRegex
* @param ManialinkPageAnswerListener $listener
* @param string $method
* @param string $method
* @return bool
*/
public function registerManialinkPageAnswerRegexListener($actionIdRegex, ManialinkPageAnswerListener $listener, $method) {
@ -97,26 +97,26 @@ class ManialinkManager implements ManialinkPageAnswerListener, CallbackListener
trigger_error("Given listener for actionIdRegex '{$actionIdRegex}' doesn't have callback method '{$method}'!");
return false;
}
if (!array_key_exists($actionIdRegex, $this->pageAnswerRegexListener) || !is_array($this->pageAnswerRegexListener[$actionIdRegex])) {
// Init regex listeners array
$this->pageAnswerRegexListener[$actionIdRegex] = array();
}
// Register page answer reg exlistener
array_push($this->pageAnswerRegexListener[$actionIdRegex], array($listener, $method));
return true;
}
/**
* Remove a Manialink Page Answer Listener
*
*
* @param ManialinkPageAnswerListener $listener
* @return bool
*/
public function unregisterManialinkPageAnswerListener(ManialinkPageAnswerListener $listener) {
$removed = false;
$removed = false;
$allListeners = array_merge($this->pageAnswerListeners, $this->pageAnswerRegexListener);
foreach ($allListeners as &$listeners) {
foreach ($listeners as $key => &$listenerCallback) {
@ -132,21 +132,21 @@ class ManialinkManager implements ManialinkPageAnswerListener, CallbackListener
/**
* Handle ManialinkPageAnswer callback
*
*
* @param array $callback
*/
public function handleManialinkPageAnswer(array $callback) {
$actionId = $callback[1][2];
$login = $callback[1][1];
$player = $this->maniaControl->playerManager->getPlayer($login);
$login = $callback[1][1];
$player = $this->maniaControl->playerManager->getPlayer($login);
if (array_key_exists($actionId, $this->pageAnswerListeners) && is_array($this->pageAnswerListeners[$actionId])) {
// Inform page answer listeners
foreach ($this->pageAnswerListeners[$actionId] as $listener) {
call_user_func($listener, $callback, $player);
}
}
// Check regex listeners
foreach ($this->pageAnswerRegexListener as $actionIdRegex => $pageAnswerRegexListeners) {
if (preg_match($actionIdRegex, $actionId)) {
@ -160,7 +160,7 @@ class ManialinkManager implements ManialinkPageAnswerListener, CallbackListener
/**
* Hide the Manialink with the given Id
*
*
* @param mixed $manialinkId
* @param mixed $logins
*/
@ -174,23 +174,23 @@ class ManialinkManager implements ManialinkPageAnswerListener, CallbackListener
$this->sendManialink($emptyManialink, $logins);
}
}
/**
* Send the given manialink to players
*
*
* @param string $manialinkText
* @param mixed $logins
* @param int $timeout
* @param bool $hideOnClick
* @param mixed $logins
* @param int $timeout
* @param bool $hideOnClick
* @return bool
*/
public function sendManialink($manialinkText, $logins = null, $timeout = 0, $hideOnClick = false) {
$manialinkText = (string) $manialinkText;
$manialinkText = (string)$manialinkText;
if (!$manialinkText) {
return true;
}
try {
if (!$logins) {
return $this->maniaControl->client->sendDisplayManialinkPage(null, $manialinkText, $timeout, $hideOnClick);
@ -211,60 +211,27 @@ class ManialinkManager implements ManialinkPageAnswerListener, CallbackListener
$success = false;
}
}
return $success;
}
}
catch (LoginUnknownException $e) {
} catch (LoginUnknownException $e) {
return false;
}
return true;
}
/**
* Enable the alt menu for the player
*
* @param Player $player
* @return bool
*/
public function enableAltMenu(Player $player) {
try {
$success = $this->maniaControl->client->triggerModeScriptEvent('LibXmlRpc_EnableAltMenu', $player->login);
}
catch (NotInScriptModeException $e) {
return false;
}
return $success;
}
/**
* Disable the alt menu for the player
*
* @param Player $player
* @return bool
*/
public function disableAltMenu(Player $player) {
try {
$success = $this->maniaControl->client->triggerModeScriptEvent('LibXmlRpc_DisableAltMenu', $player->login);
}
catch (NotInScriptModeException $e) {
return false;
}
return $success;
}
/**
* Displays a ManiaLink Widget to a certain Player (Should only be used on Main Widgets)
*
* @param mixed $maniaLink
*
* @param mixed $maniaLink
* @param Player $player
* @param string $widgetName
*/
public function displayWidget($maniaLink, Player $player, $widgetName = '') {
// render and display xml
$this->sendManialink($maniaLink, $player->login);
if ($widgetName != '') {
// TODO make check by manialinkId, getter is needed to avoid uses on non main widgets
$this->disableAltMenu($player);
@ -273,10 +240,25 @@ class ManialinkManager implements ManialinkPageAnswerListener, CallbackListener
}
}
/**
* Disable the alt menu for the player
*
* @param Player $player
* @return bool
*/
public function disableAltMenu(Player $player) {
try {
$success = $this->maniaControl->client->triggerModeScriptEvent('LibXmlRpc_DisableAltMenu', $player->login);
} catch (NotInScriptModeException $e) {
return false;
}
return $success;
}
/**
* Closes a widget via the callback
*
* @param array $callback
*
* @param array $callback
* @param Player $player
*/
public function closeWidgetCallback(array $callback, Player $player) {
@ -285,28 +267,42 @@ class ManialinkManager implements ManialinkPageAnswerListener, CallbackListener
/**
* Closes a Manialink Widget
*
*
* @param Player $player
* @param bool $widgetId
* @param bool $widgetId
*/
public function closeWidget(Player $player, $widgetId = false) {
if (!$widgetId) {
$emptyManialink = new ManiaLink(self::MAIN_MLID);
$this->sendManialink($emptyManialink, $player->login);
$this->enableAltMenu($player);
// Trigger callback
$this->maniaControl->callbackManager->triggerCallback(self::CB_MAIN_WINDOW_CLOSED, $player);
}
else {
} else {
$emptyManialink = new ManiaLink($widgetId);
$this->sendManialink($emptyManialink, $player->login);
}
}
/**
* Enable the alt menu for the player
*
* @param Player $player
* @return bool
*/
public function enableAltMenu(Player $player) {
try {
$success = $this->maniaControl->client->triggerModeScriptEvent('LibXmlRpc_EnableAltMenu', $player->login);
} catch (NotInScriptModeException $e) {
return false;
}
return $success;
}
/**
* Adds a line of labels
*
*
* @param Frame $frame
* @param array $labelStrings
* @param array $properties
@ -314,12 +310,12 @@ class ManialinkManager implements ManialinkPageAnswerListener, CallbackListener
*/
public function labelLine(Frame $frame, array $labelStrings, array $properties = array()) {
// define standard properties
$hAlign = (isset($properties['hAlign']) ? $properties['hAlign'] : Control::LEFT);
$style = (isset($properties['style']) ? $properties['style'] : Label_Text::STYLE_TextCardSmall);
$textSize = (isset($properties['textSize']) ? $properties['textSize'] : 1.5);
$hAlign = (isset($properties['hAlign']) ? $properties['hAlign'] : Control::LEFT);
$style = (isset($properties['style']) ? $properties['style'] : Label_Text::STYLE_TextCardSmall);
$textSize = (isset($properties['textSize']) ? $properties['textSize'] : 1.5);
$textColor = (isset($properties['textColor']) ? $properties['textColor'] : 'FFF');
$profile = (isset($properties['profile']) ? $properties['profile'] : false);
$profile = (isset($properties['profile']) ? $properties['profile'] : false);
$labels = array();
foreach ($labelStrings as $text => $x) {
$label = new Label_Text();
@ -330,14 +326,14 @@ class ManialinkManager implements ManialinkPageAnswerListener, CallbackListener
$label->setTextSize($textSize);
$label->setText($text);
$label->setTextColor($textColor);
if ($profile) {
$label->addPlayerProfileFeature($profile);
}
$labels[] = $label; // add Label to the labels array
}
return $labels;
}
}

View File

@ -5,9 +5,9 @@ namespace ManiaControl\Manialinks;
/**
* Interface for Manialink Page Answer Listeners
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
* @author ManiaControl Team <mail@maniacontrol.com>
* @copyright 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
interface ManialinkPageAnswerListener {
}

View File

@ -16,9 +16,9 @@ use ManiaControl\ManiaControl;
/**
* Class managing default Control Styles
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
* @author ManiaControl Team <mail@maniacontrol.com>
* @copyright 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class StyleManager {
/*
@ -97,43 +97,6 @@ class StyleManager {
return $this->maniaControl->settingManager->getSetting($this, self::SETTING_QUAD_DEFAULT_SUBSTYLE);
}
/**
* Get the default main window style
*
* @return string
*/
public function getDefaultMainWindowStyle() {
return $this->maniaControl->settingManager->getSetting($this, self::SETTING_MAIN_WIDGET_DEFAULT_STYLE);
}
/**
* Get the default main window substyle
*
* @return string
*/
public function getDefaultMainWindowSubStyle() {
return $this->maniaControl->settingManager->getSetting($this, self::SETTING_MAIN_WIDGET_DEFAULT_SUBSTYLE);
}
/**
* Get the default list widget width
*
* @return string
*/
public function getListWidgetsWidth() {
return $this->maniaControl->settingManager->getSetting($this, self::SETTING_LIST_WIDGETS_WIDTH);
}
/**
* Get the default list widget height
*
* @return string
*/
public function getListWidgetsHeight() {
return $this->maniaControl->settingManager->getSetting($this, self::SETTING_LIST_WIDGETS_HEIGHT);
}
/**
* Gets the Default Description Label
*
@ -154,13 +117,31 @@ class StyleManager {
return $descriptionLabel;
}
/**
* Get the default list widget width
*
* @return string
*/
public function getListWidgetsWidth() {
return $this->maniaControl->settingManager->getSetting($this, self::SETTING_LIST_WIDGETS_WIDTH);
}
/**
* Get the default list widget height
*
* @return string
*/
public function getListWidgetsHeight() {
return $this->maniaControl->settingManager->getSetting($this, self::SETTING_LIST_WIDGETS_HEIGHT);
}
/**
* Builds the Default List Frame
*
* @return Frame $frame
*/
public function getDefaultListFrame() {
$args = func_get_args();
$args = func_get_args();
$script = null;
$paging = null;
foreach ($args as $arg) {
@ -171,7 +152,7 @@ class StyleManager {
$paging = $arg;
}
}
$width = $this->getListWidgetsWidth();
$height = $this->getListWidgetsHeight();
$quadStyle = $this->getDefaultMainWindowStyle();
@ -210,10 +191,10 @@ class StyleManager {
$pagerNext->setSize($pagerSize, $pagerSize);
$pagerNext->setSubStyle(Quad_Icons64x64_1::SUBSTYLE_ArrowNext);
if ($paging) {
$paging->addButton($pagerNext);
$paging->addButton($pagerPrev);
}
if ($paging) {
$paging->addButton($pagerNext);
$paging->addButton($pagerPrev);
}
$pageCountLabel = new Label_Text();
$frame->add($pageCountLabel);
@ -221,11 +202,29 @@ class StyleManager {
$pageCountLabel->setPosition($width * 0.40, $height * -0.44, 1);
$pageCountLabel->setStyle($pageCountLabel::STYLE_TextTitle1);
$pageCountLabel->setTextSize(1.3);
if ($paging) {
$paging->setLabel($pageCountLabel);
}
if ($paging) {
$paging->setLabel($pageCountLabel);
}
}
return $frame;
}
/**
* Get the default main window style
*
* @return string
*/
public function getDefaultMainWindowStyle() {
return $this->maniaControl->settingManager->getSetting($this, self::SETTING_MAIN_WIDGET_DEFAULT_STYLE);
}
/**
* Get the default main window substyle
*
* @return string
*/
public function getDefaultMainWindowSubStyle() {
return $this->maniaControl->settingManager->getSetting($this, self::SETTING_MAIN_WIDGET_DEFAULT_SUBSTYLE);
}
}