Updated to ManiaLink v3

This commit is contained in:
Jocy Wolff
2017-03-25 18:40:15 +01:00
parent 1010c1db6b
commit 120a0e2169
133 changed files with 16194 additions and 8949 deletions

View File

@ -9,104 +9,159 @@ use FML\Script\ScriptLabel;
use FML\Types\Scriptable;
/**
* Script Feature for triggering a manialink page action
* Script Feature for triggering a ManiaLink page action
*
* @author steeffeen
* @copyright FancyManiaLinks Copyright © 2014 Steffen Schröder
* @copyright FancyManiaLinks Copyright © 2017 Steffen Schröder
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class ActionTrigger extends ScriptFeature {
/*
* Protected properties
*/
protected $actionName = null;
/** @var Control $control */
protected $control = null;
protected $labelName = null;
class ActionTrigger extends ScriptFeature
{
/**
* Construct a new Action Trigger Feature
*
* @param string $actionName (optional) Triggered action
* @param Control $control (optional) Action Control
* @param string $labelName (optional) Script Label name
*/
public function __construct($actionName = null, Control $control = null, $labelName = ScriptLabel::MOUSECLICK) {
if ($actionName !== null) {
$this->setActionName($actionName);
}
if ($control !== null) {
$this->setControl($control);
}
if ($labelName !== null) {
$this->setLabelName($labelName);
}
}
/**
* @var string $actionName Triggered action
*/
protected $actionName = null;
/**
* Set the action to trigger
*
* @param string $actionName
* @return static
*/
public function setActionName($actionName) {
$this->actionName = (string)$actionName;
return $this;
}
/**
* @var Control $control Action Control
*/
protected $control = null;
/**
* Set the Control
*
* @param Control $control Action Control
* @return static
*/
public function setControl(Control $control) {
$control->checkId();
if ($control instanceof Scriptable) {
$control->setScriptEvents(true);
}
$this->control = $control;
return $this;
}
/**
* @var string $labelName Script label name
*/
protected $labelName = null;
/**
* Set the label name
*
* @param string $labelName Script Label name
* @return static
*/
public function setLabelName($labelName) {
$this->labelName = (string)$labelName;
return $this;
}
/**
* Construct a new Action Trigger
*
* @api
* @param string $actionName (optional) Triggered action
* @param Control $control (optional) Action Control
* @param string $labelName (optional) Script label name
*/
public function __construct($actionName = null, Control $control = null, $labelName = ScriptLabel::MOUSECLICK)
{
if ($actionName) {
$this->setActionName($actionName);
}
if ($control) {
$this->setControl($control);
}
if ($labelName) {
$this->setLabelName($labelName);
}
}
/**
* @see \FML\Script\Features\ScriptFeature::prepare()
*/
public function prepare(Script $script) {
$script->appendGenericScriptLabel($this->labelName, $this->getScriptText());
return $this;
}
/**
* Get the action to trigger
*
* @api
* @return string
*/
public function getActionName()
{
return $this->actionName;
}
/**
* Get the script text
*
* @return string
*/
protected function getScriptText() {
$actionName = Builder::escapeText($this->actionName, true);
if ($this->control) {
// Control event
$controlId = Builder::escapeText($this->control->getId(), true);
$scriptText = "
/**
* Set the action to trigger
*
* @api
* @param string $actionName Action name
* @return static
*/
public function setActionName($actionName)
{
$this->actionName = (string)$actionName;
return $this;
}
/**
* Get the Control that should trigger the action
*
* @api
* @return Control
*/
public function getControl()
{
return $this->control;
}
/**
* Set the Control that should trigger the action
*
* @api
* @param Control $control Action Control
* @return static
*/
public function setControl(Control $control = null)
{
if ($control) {
$control->checkId();
if ($control instanceof Scriptable) {
$control->setScriptEvents(true);
}
}
$this->control = $control;
return $this;
}
/**
* Get the script label name
*
* @api
* @return string
*/
public function getLabelName()
{
return $this->labelName;
}
/**
* Set the script label name
*
* @api
* @param string $labelName Script Label name
* @return static
*/
public function setLabelName($labelName)
{
$this->labelName = (string)$labelName;
return $this;
}
/**
* @see ScriptFeature::prepare()
*/
public function prepare(Script $script)
{
$script->appendGenericScriptLabel($this->labelName, $this->getScriptText());
return $this;
}
/**
* Get the script text
*
* @return string
*/
protected function getScriptText()
{
$actionName = Builder::escapeText($this->actionName);
if ($this->control) {
// Control event
$controlId = Builder::escapeText($this->control->getId());
$scriptText = "
if (Event.Control.ControlId == {$controlId}) {
TriggerPageAction({$actionName});
}";
} else {
// Other
$scriptText = "
} else {
// Other
$scriptText = "
TriggerPageAction({$actionName});";
}
return $scriptText;
}
}
return $scriptText;
}
}