summaryrefslogtreecommitdiffstats
path: root/vendor/ipl/html/src/FormElement/SubmitButtonElement.php
blob: b880bb54c22aedfdd11d705e98ceda0cf0f27c3c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
<?php

namespace ipl\Html\FormElement;

use ipl\Html\Attributes;
use ipl\Html\Contract\FormSubmitElement;

class SubmitButtonElement extends ButtonElement implements FormSubmitElement
{
    protected $defaultAttributes = ['type' => 'submit'];

    /** @var string The value that's transmitted once the button is pressed */
    protected $submitValue = 'y';

    /**
     * Get the value to transmit once the button is pressed
     *
     * @return string
     */
    public function getSubmitValue(): string
    {
        return $this->submitValue;
    }

    /**
     * Set the value to transmit once the button is pressed
     *
     * @param string $value
     *
     * @return $this
     */
    public function setSubmitValue(string $value): self
    {
        $this->submitValue = $value;

        return $this;
    }

    public function setLabel($label)
    {
        return $this->setContent($label);
    }

    public function hasBeenPressed()
    {
        return $this->getValue() === $this->getSubmitValue();
    }

    public function isIgnored()
    {
        return true;
    }

    protected function registerAttributeCallbacks(Attributes $attributes)
    {
        parent::registerAttributeCallbacks($attributes);

        $attributes->registerAttributeCallback('value', null, [$this, 'setSubmitValue']);
    }

    public function getValueAttribute()
    {
        return $this->submitValue;
    }
}