Button::getTranslate() - Code Metrics - eXpansionPluginPack/eXpansion2 - Measure and Improve Code Quality continuously with Scrutinizer

Button::getTranslate() A
last analyzed 2020-03-13 11:49 UTC

↳ Parent: Button

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	5
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

namespace eXpansion\Framework\Gui\Components;

use FML\Controls\Frame;
use FML\Controls\Quad;
use FML\Elements\Format;
use FML\Script\Features\ScriptFeature;
use FML\Script\Script;
use FML\Script\ScriptLabel;
use FML\Types\Container;
use FML\Types\Renderable;
use FML\Types\ScriptFeatureable;

class Button extends AbstractUiElement implements ScriptFeatureable, Container
{
    const TYPE_DECORATED = "decorated";
    const TYPE_DEFAULT = "default";
    const COLOR_DEFAULT = "777";
    const COLOR_SUCCESS = "0d0";
    const COLOR_WARNING = "d00";
    const COLOR_PRIMARY = "3af";
    const COLOR_SECONDARY = "000";

    /** @var  Label */
    protected $buttonLabel;
    protected $type;
    protected $textColor = "fff";
    protected $backColor = self::COLOR_DEFAULT;
    protected $focusColor = "aaa";
    protected $borderColor = "fff";
    protected $translate = true;

    protected $action = null;
    protected $text = "button";
    protected $scale = 1.;

    public function __construct($text = "button", $type = self::TYPE_DEFAULT)
    {
        $this->setHorizontalAlign("left");
        $this->setVerticalAlign("center");

        $this->text = $text;
        $this->type = $type;
        $this->setSize(18, 5);
        $this->buttonLabel = new Label("", Label::TYPE_TITLE);
        $this->buttonLabel->addClass('uiButtonElement');
        $this->buttonLabel->setTranslate($this->translate);

        $this->setHorizontalAlign("center");
        $this->setVerticalAlign("center");
        $this->setText($text);
    }


    /**
     * Render the XML element
     *
     * @param \DOMDocument $domDocument DOMDocument for which the XML element should be rendered
     * @return \DOMElement
     *
     * <frame pos="64 -35" class="uiContainer UiButton">
     * <label size="26 9" data-color="fff" text="Cancel" class="button noAnim"  textprefix=" " opacity="1" halign="center" valign="center" focusareacolor1="0000" focusareacolor2="d00" scriptevents="1" translate="0" textsize="2"/>
     * <quad size="26 9" style="Bgs1" colorize="d00" substyle="BgColorContour" class="button" halign="center" valign="center" pos="0 0"/>
     * </frame>
     */
    public function render(\DOMDocument $domDocument)
    {
        $buttonFrame = new Frame();
        $buttonFrame->setAlign("center", "center")
            ->setPosition($this->posX + ($this->width / 2), $this->posY - ($this->height / 2), $this->posZ)
            ->addClasses(['uiContainer', 'uiButton']+$this->_classes)
            ->addDataAttribute("action", $this->action)
            ->setScale($this->scale);

        foreach ($this->_dataAttributes as $name => $value) {
            $buttonFrame->addDataAttribute($name, $value);
        }

        if ($this->type == self::TYPE_DECORATED) {
            $quad = new Quad();
            $this->backColor = 0000;
            $quad->setStyles("Bgs1", "BgColorContour")
                ->setColorize($this->borderColor)
                ->setSize($this->width, $this->height)
                //->setPosition(-$this->width / 2, $this->height / 2)
                ->setAlign("center", "center2");
            $buttonFrame->addChild($quad);
        }

        $this->buttonLabel->setSize($this->width, $this->height)
            ->setTextSize(1)
            ->setScriptEvents(true)
            ->setAreaColor($this->backColor)
            ->setAreaFocusColor($this->focusColor)
            ->setTextColor($this->textColor)
            ->setAlign("center", "center2");

        if ($this->type != self::TYPE_DECORATED) {
            $this->buttonLabel->setAreaFocusColor($this->focusColor);
        }

        $this->buttonLabel->setDataAttributes($this->_dataAttributes);
        $this->buttonLabel->addClasses($this->_classes);

        $buttonFrame->addChild($this->buttonLabel);


        return $buttonFrame->render($domDocument);

    }

    /**
     * @return string
     */
    public function getText()
    {
        return $this->text;
    }

    /**
     * @param string $text
     * @return Button
     */
    public function setText($text)
    {
        $this->text = $text;
        if ($this->translate) {
            $this->buttonLabel->setTextId($this->getText());
        } else {
            $this->buttonLabel->setText($this->getText());
        }

        return $this;
    }

    /**
     * Get the Script Features
     *
     * @return ScriptFeature[]
     */
    public function getScriptFeatures()
    {
        return ScriptFeature::collect($this);
    }

    /**
     * Prepare the given Script for rendering by adding the needed Labels, etc.
     *
     * @param Script $script Script to prepar
     * @return void
     */
    public function prepare(Script $script)
    {
        $script->addScriptFunction("buttonscript", $this->getScriptFunction());
        $script->addCustomScriptLabel(ScriptLabel::MouseClick, $this->getScriptMouseClick());
        $script->addCustomScriptLabel(ScriptLabel::MouseOver, <<<EOL
               if (Event.Control.Parent.HasClass("uiButton")) {                 
                  (Event.Control.Parent as CMlFrame).RelativeScale=1.1;
               }
EOL
        );

        $script->addCustomScriptLabel(ScriptLabel::MouseOut, <<<EOL
               if (Event.Control.Parent.HasClass("uiButton")) {                  
                  (Event.Control.Parent as CMlFrame).RelativeScale= 1.; 
               }
EOL
        );
    }

    protected function getScriptMouseClick()
    {
        return /** @lang textmate */
            <<<EOD
            if (Event.Control.HasClass("uiButtonElement") ) {            
                TriggerButtonClick(Event.Control);                             
            }
EOD;
    }

    protected function getScriptFunction()
    {
        return
            /** @lang textmate */
            <<<EOD
       
            Void TriggerButtonClick(CMlControl Control) {                
                 if (Control.Parent.HasClass("uiButton")) {
                    Control.Parent.RelativeScale = 0.75;
                    AnimMgr.Add(Control.Parent, "<elem scale=\"1.\" />", 200, CAnimManager::EAnimManagerEasing::QuadIn); 
                    TriggerPageAction(Control.Parent.DataAttributeGet("action"));
                 }                                
            }
            
            Void TriggerButtonClick(Text ControlId) {
                declare Control <=> Page.GetFirstChild(ControlId);
                TriggerButtonClick(Control);
            }


EOD;
    }


    /**
     * @return string
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * @param string $type
     * @return Button
     */
    public function setType($type)
    {
        $this->type = $type;

        return $this;
    }

    /**
     * @return string
     */
    public function getTextColor()
    {
        return $this->textColor;
    }

    /**
     * @param string $textColor
     * @return Button
     */
    public function setTextColor($textColor)
    {
        $this->textColor = $textColor;

        return $this;
    }

    /**
     * @return string
     */
    public function getBackgroundColor()
    {
        return $this->backColor;
    }

    /**
     * @param string $backColor
     * @return Button
     */
    public function setBackgroundColor($backColor)
    {
        $this->backColor = $backColor;

        return $this;
    }

    /**
     * @return string
     */
    public function getBorderColor()
    {
        return $this->borderColor;
    }

    /**
     * @param string $borderColor
     * @return Button
     */
    public function setBorderColor($borderColor)
    {
        $this->borderColor = $borderColor;

        return $this;
    }

    /**
     * @return null
     */
    public function getAction()
    {
        return $this->action;
    }

    /**
     * @param null $action
     * @return Button
     */
    public function setAction($action)
    {
        $this->action = $action;

        return $this;
    }

    /**
     * @return string
     */
    public function getFocusColor()
    {
        return $this->focusColor;
    }

    /**
     * @param string $focusColor
     * @return Button
     */
    public function setFocusColor($focusColor)
    {
        $this->focusColor = $focusColor;

        return $this;
    }

    /**
     * @return float
     */
    public function getScale()
    {
        return $this->scale;
    }

    /**
     * @param float $scale
     * @return Button
     */
    public function setScale($scale)
    {
        $this->scale = $scale;

        return $this;
    }

    /**
     * @return bool
     */
    public function getTranslate()
    {
        return $this->translate;

    }

    /**
     * @param bool $translate
     * @return Button
     */
    public function setTranslate($translate = true)
    {
        $this->buttonLabel->setTranslate($translate);
        $this->setText($this->getText());

        return $this;
    }

    /**
     * Get the children
     *
     * @api
     * @return Renderable[]
     */
    public function getChildren()
    {
        return [$this->buttonLabel];
    }

    /**
     * Add a new child
     *
     * @api
     * @param Renderable $child Child Control to add
     * @deprecated
     * @return void
     */
    public function addChild(Renderable $child)
    {

    }

    /**
     * Add a new child
     *
     * @api
     * @param Renderable $child Child Control to add
     * @return void
     * @deprecated Use addChild()
     * @see        Container::addChild()
     */
    public function add(Renderable $child)
    {

    }

    /**
     * Add new children
     *
     * @api
     * @param Renderable[] $children Child Controls to add
     * @return void
     */
    public function addChildren(array $children)
    {

    }

    /**
     * Remove all children
     *
     * @api
     * @return void
     */
    public function removeAllChildren()
    {

    }

    /**
     * Remove all children
     *
     * @api
     * @return void
     * @deprecated Use removeAllChildren()
     * @see        Container::removeAllChildren()
     */
    public function removeChildren()
    {

    }

    /**
     * Get the Format
     *
     * @api
     * @param bool $createIfEmpty If the format should be created if it doesn't exist yet
     * @return void
     * @deprecated Use Style
     * @see        Style
     */
    public function getFormat($createIfEmpty = true)
    {

    }

    /**
     * Set the Format
     *
     * @api
     * @param Format $format New Format
     * @return void
     * @deprecated Use Style
     * @see        Style
     */
    public function setFormat(Format $format = null)
    {

    }

    /**
     * @return string|null
     */
    public function getId()
    {
        return $this->buttonLabel->getId();
    }

    /**
     * @param null $id
     * @return Button
     */
    public function setId($id)
    {
        $this->buttonLabel->setId($id);

        return $this;
    }
}


1			<?php
2
3			namespace eXpansion\Framework\Gui\Components;
4
5			use FML\Controls\Frame;
6			use FML\Controls\Quad;
7			use FML\Elements\Format;
8			use FML\Script\Features\ScriptFeature;
9			use FML\Script\Script;
10			use FML\Script\ScriptLabel;
11			use FML\Types\Container;
12			use FML\Types\Renderable;
13			use FML\Types\ScriptFeatureable;
14
15			class Button extends AbstractUiElement implements ScriptFeatureable, Container
16			{
17			const TYPE_DECORATED = "decorated";
18			const TYPE_DEFAULT = "default";
19			const COLOR_DEFAULT = "777";
20			const COLOR_SUCCESS = "0d0";
21			const COLOR_WARNING = "d00";
22			const COLOR_PRIMARY = "3af";
23			const COLOR_SECONDARY = "000";
24
25			/** @var Label */
26			protected $buttonLabel;
27			protected $type;
28			protected $textColor = "fff";
29			protected $backColor = self::COLOR_DEFAULT;
30			protected $focusColor = "aaa";
31			protected $borderColor = "fff";
32			protected $translate = true;
33
34			protected $action = null;
35			protected $text = "button";
36			protected $scale = 1.;
37
38			public function __construct($text = "button", $type = self::TYPE_DEFAULT)
39			{
40			$this->setHorizontalAlign("left");
41			$this->setVerticalAlign("center");
42
43			$this->text = $text;
44			$this->type = $type;
45			$this->setSize(18, 5);
46			$this->buttonLabel = new Label("", Label::TYPE_TITLE);
47			$this->buttonLabel->addClass('uiButtonElement');
48			$this->buttonLabel->setTranslate($this->translate);
49
50			$this->setHorizontalAlign("center");
51			$this->setVerticalAlign("center");
52			$this->setText($text);
53			}
54
55
56			/**
57			* Render the XML element
58			*
59			* @param \DOMDocument $domDocument DOMDocument for which the XML element should be rendered
60			* @return \DOMElement
61			*
62			* <frame pos="64 -35" class="uiContainer UiButton">
63			* <label size="26 9" data-color="fff" text="Cancel" class="button noAnim" textprefix=" " opacity="1" halign="center" valign="center" focusareacolor1="0000" focusareacolor2="d00" scriptevents="1" translate="0" textsize="2"/>
64			* <quad size="26 9" style="Bgs1" colorize="d00" substyle="BgColorContour" class="button" halign="center" valign="center" pos="0 0"/>
65			* </frame>
66			*/
67			public function render(\DOMDocument $domDocument)
68			{
69			$buttonFrame = new Frame();
70			$buttonFrame->setAlign("center", "center")
71			->setPosition($this->posX + ($this->width / 2), $this->posY - ($this->height / 2), $this->posZ)
72			->addClasses(['uiContainer', 'uiButton']+$this->_classes)
73			->addDataAttribute("action", $this->action)
74			->setScale($this->scale);
75
76			foreach ($this->_dataAttributes as $name => $value) {
77			$buttonFrame->addDataAttribute($name, $value);
78			}
79
80			if ($this->type == self::TYPE_DECORATED) {
81			$quad = new Quad();
82			$this->backColor = 0000;
83			$quad->setStyles("Bgs1", "BgColorContour")
84			->setColorize($this->borderColor)
85			->setSize($this->width, $this->height)
86			//->setPosition(-$this->width / 2, $this->height / 2)
87			->setAlign("center", "center2");
88			$buttonFrame->addChild($quad);
89			}
90
91			$this->buttonLabel->setSize($this->width, $this->height)
92			->setTextSize(1)
93			->setScriptEvents(true)
94			->setAreaColor($this->backColor)
95			->setAreaFocusColor($this->focusColor)
96			->setTextColor($this->textColor)
97			->setAlign("center", "center2");
98
99			if ($this->type != self::TYPE_DECORATED) {
100			$this->buttonLabel->setAreaFocusColor($this->focusColor);
101			}
102
103			$this->buttonLabel->setDataAttributes($this->_dataAttributes);
104			$this->buttonLabel->addClasses($this->_classes);
105
106			$buttonFrame->addChild($this->buttonLabel);
107
108
109			return $buttonFrame->render($domDocument);
110
111			}
112
113			/**
114			* @return string
115			*/
116			public function getText()
117			{
118			return $this->text;
119			}
120
121			/**
122			* @param string $text
123			* @return Button
124			*/
125			public function setText($text)
126			{
127			$this->text = $text;
128			if ($this->translate) {
129			$this->buttonLabel->setTextId($this->getText());
130			} else {
131			$this->buttonLabel->setText($this->getText());
132			}
133
134			return $this;
135			}
136
137			/**
138			* Get the Script Features
139			*
140			* @return ScriptFeature[]
141			*/
142			public function getScriptFeatures()
143			{
144			return ScriptFeature::collect($this);
145			}
146
147			/**
148			* Prepare the given Script for rendering by adding the needed Labels, etc.
149			*
150			* @param Script $script Script to prepar
151			* @return void
152			*/
153			public function prepare(Script $script)
154			{
155			$script->addScriptFunction("buttonscript", $this->getScriptFunction());
156			$script->addCustomScriptLabel(ScriptLabel::MouseClick, $this->getScriptMouseClick());
157			$script->addCustomScriptLabel(ScriptLabel::MouseOver, <<<EOL
158			if (Event.Control.Parent.HasClass("uiButton")) {
159			(Event.Control.Parent as CMlFrame).RelativeScale=1.1;
160			}
161			EOL
162			);
163
164			$script->addCustomScriptLabel(ScriptLabel::MouseOut, <<<EOL
165			if (Event.Control.Parent.HasClass("uiButton")) {
166			(Event.Control.Parent as CMlFrame).RelativeScale= 1.;
167			}
168			EOL
169			);
170			}
171
172			protected function getScriptMouseClick()
173			{
174			return /** @lang textmate */
175			<<<EOD
176			if (Event.Control.HasClass("uiButtonElement") ) {
177			TriggerButtonClick(Event.Control);
178			}
179			EOD;
180			}
181
182			protected function getScriptFunction()
183			{
184			return
185			/** @lang textmate */
186			<<<EOD
187
188			Void TriggerButtonClick(CMlControl Control) {
189			if (Control.Parent.HasClass("uiButton")) {
190			Control.Parent.RelativeScale = 0.75;
191			AnimMgr.Add(Control.Parent, "<elem scale=\"1.\" />", 200, CAnimManager::EAnimManagerEasing::QuadIn);
192			TriggerPageAction(Control.Parent.DataAttributeGet("action"));
193			}
194			}
195
196			Void TriggerButtonClick(Text ControlId) {
197			declare Control <=> Page.GetFirstChild(ControlId);
198			TriggerButtonClick(Control);
199			}
200
201
202			EOD;
203			}
204
205
206			/**
207			* @return string
208			*/
209			public function getType()
210			{
211			return $this->type;
212			}
213
214			/**
215			* @param string $type
216			* @return Button
217			*/
218			public function setType($type)
219			{
220			$this->type = $type;
221
222			return $this;
223			}
224
225			/**
226			* @return string
227			*/
228			public function getTextColor()
229			{
230			return $this->textColor;
231			}
232
233			/**
234			* @param string $textColor
235			* @return Button
236			*/
237			public function setTextColor($textColor)
238			{
239			$this->textColor = $textColor;
240
241			return $this;
242			}
243
244			/**
245			* @return string
246			*/
247			public function getBackgroundColor()
248			{
249			return $this->backColor;
250			}
251
252			/**
253			* @param string $backColor
254			* @return Button
255			*/
256			public function setBackgroundColor($backColor)
257			{
258			$this->backColor = $backColor;
259
260			return $this;
261			}
262
263			/**
264			* @return string
265			*/
266			public function getBorderColor()
267			{
268			return $this->borderColor;
269			}
270
271			/**
272			* @param string $borderColor
273			* @return Button
274			*/
275			public function setBorderColor($borderColor)
276			{
277			$this->borderColor = $borderColor;
278
279			return $this;
280			}
281
282			/**
283			* @return null
284			*/
285			public function getAction()
286			{
287			return $this->action;
288			}
289
290			/**
291			* @param null $action
292			* @return Button
293			*/
294			public function setAction($action)
295			{
296			$this->action = $action;
297
298			return $this;
299			}
300
301			/**
302			* @return string
303			*/
304			public function getFocusColor()
305			{
306			return $this->focusColor;
307			}
308
309			/**
310			* @param string $focusColor
311			* @return Button
312			*/
313			public function setFocusColor($focusColor)
314			{
315			$this->focusColor = $focusColor;
316
317			return $this;
318			}
319
320			/**
321			* @return float
322			*/
323			public function getScale()
324			{
325			return $this->scale;
326			}
327
328			/**
329			* @param float $scale
330			* @return Button
331			*/
332			public function setScale($scale)
333			{
334			$this->scale = $scale;
335
336			return $this;
337			}
338
339			/**
340			* @return bool
341			*/
342			public function getTranslate()
343			{
344			return $this->translate;
345
346			}
347
348			/**
349			* @param bool $translate
350			* @return Button
351			*/
352			public function setTranslate($translate = true)
353			{
354			$this->buttonLabel->setTranslate($translate);
355			$this->setText($this->getText());
356
357			return $this;
358			}
359
360			/**
361			* Get the children
362			*
363			* @api
364			* @return Renderable[]
365			*/
366			public function getChildren()
367			{
368			return [$this->buttonLabel];
369			}
370
371			/**
372			* Add a new child
373			*
374			* @api
375			* @param Renderable $child Child Control to add
376			* @deprecated
377			* @return void
378			*/
379			public function addChild(Renderable $child)
380			{
381
382			}
383
384			/**
385			* Add a new child
386			*
387			* @api
388			* @param Renderable $child Child Control to add
389			* @return void
390			* @deprecated Use addChild()
391			* @see Container::addChild()
392			*/
393			public function add(Renderable $child)
394			{
395
396			}
397
398			/**
399			* Add new children
400			*
401			* @api
402			* @param Renderable[] $children Child Controls to add
403			* @return void
404			*/
405			public function addChildren(array $children)
406			{
407
408			}
409
410			/**
411			* Remove all children
412			*
413			* @api
414			* @return void
415			*/
416			public function removeAllChildren()
417			{
418
419			}
420
421			/**
422			* Remove all children
423			*
424			* @api
425			* @return void
426			* @deprecated Use removeAllChildren()
427			* @see Container::removeAllChildren()
428			*/
429			public function removeChildren()
430			{
431
432			}
433
434			/**
435			* Get the Format
436			*
437			* @api
438			* @param bool $createIfEmpty If the format should be created if it doesn't exist yet
439			* @return void
440			* @deprecated Use Style
441			* @see Style
442			*/
443			public function getFormat($createIfEmpty = true)
444			{
445
446			}
447
448			/**
449			* Set the Format
450			*
451			* @api
452			* @param Format $format New Format
453			* @return void
454			* @deprecated Use Style
455			* @see Style
456			*/
457			public function setFormat(Format $format = null)
458			{
459
460			}
461
462			/**
463			* @return string\|null
464			*/
465			public function getId()
466			{
467			return $this->buttonLabel->getId();
468			}
469
470			/**
471			* @param null $id
472			* @return Button
473			*/
474			public function setId($id)
475			{
476			$this->buttonLabel->setId($id);
477
478			return $this;
479			}
480			}
481

eXpansionPluginPack / eXpansion2

Button::getTranslate() A last analyzed 2020-03-13 11:49 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Button::getTranslate() A
last analyzed 2020-03-13 11:49 UTC