class.ilButton.php

Go to the documentation of this file.

<?php

class ilButton extends ilButtonBase
{
    public const BUTTON_TYPE_BUTTON = 'button';

    public const BUTTON_TYPE_SUBMIT = 'submit';

    public const BUTTON_TYPE_RESET = 'reset';

    public const FORM_ENC_TYPE_APPLICATION = 'application/x-www-form-urlencoded';

    public const FORM_ENC_TYPE_MULTI_PART = 'multipart/form-data';

    public const FORM_ENC_TYPE_PLAIN = 'text/plain';
    public const FORM_METHOD_POST = 'POST';
    public const FORM_METHOD_GET = 'GET';

    public const FORM_TARGET_SELF = '_self';

    public const FORM_TARGET_BLANK = '_blank';

    public const FORM_TARGET_PARENT = '_parent';

    public const FORM_TARGET_TOP = '_top';

    protected string $button_type = self::BUTTON_TYPE_SUBMIT;
    protected ?string $name = null;
    protected ?string $value = null;
    protected ?string $form = null;
    protected ?string $form_action = null;
    protected ?string $form_enc_type = null;
    protected ?string $form_method = null;
    protected ?string $form_target = null;
    protected bool $form_novalidate = false;

    public static function getInstance(): self
    {
        return new self(self::TYPE_BUTTON);
    }

    public static function getValidFormTargets(): array
    {
        return array(
            self::FORM_TARGET_BLANK,
            self::FORM_TARGET_PARENT,
            self::FORM_TARGET_SELF,
            self::FORM_TARGET_TOP
        );
    }

    public static function getValidFormMethods(): array
    {
        return array(
            self::FORM_METHOD_POST,
            self::FORM_METHOD_GET
        );
    }

    public static function getValidFormEncTypes(): array
    {
        return array(
            self::FORM_ENC_TYPE_APPLICATION,
            self::FORM_ENC_TYPE_MULTI_PART,
            self::FORM_ENC_TYPE_PLAIN
        );
    }

    public static function getValidButtonTypes(): array
    {
        return array(
            self::BUTTON_TYPE_SUBMIT,
            self::BUTTON_TYPE_BUTTON,
            self::BUTTON_TYPE_RESET
        );
    }

    public function isFormNovalidate(): ?bool
    {
        return $this->form_novalidate;
    }

    public function setFormNovalidate(bool $form_novalidate): self
    {
        if (!is_bool($form_novalidate)) {
            throw new InvalidArgumentException(
                "Please pass a value of type 'boolean' to specify whether the form is not to be validated when it is submitted"
            );
        }

        $this->form_novalidate = $form_novalidate;
        return $this;
    }

    public function getFormTarget(): ?string
    {
        return $this->form_target;
    }

    public function setFormTarget(string $form_target): self
    {
        if (!in_array($form_target, self::getValidFormTargets())) {
            throw new InvalidArgumentException(
                sprintf(
                    "Invalid form target passed, must be one of these: %s",
                    implode(', ', self::getValidFormTargets())
                )
            );
        }

        $this->form_target = $form_target;
        return $this;
    }

    public function getFormMethod(): ?string
    {
        return $this->form_method;
    }

    public function setFormMethod(string $form_method): self
    {
        if (!in_array($form_method, self::getValidFormMethods())) {
            throw new InvalidArgumentException(
                sprintf(
                    "Invalid form method passed, must be one of these: %s",
                    implode(', ', self::getValidFormMethods())
                )
            );
        }

        $this->form_method = $form_method;
        return $this;
    }

    public function getFormEncType(): ?string
    {
        return $this->form_enc_type;
    }

    public function setFormEncType(string $form_enc_type): self
    {
        if (!in_array($form_enc_type, self::getValidFormEncTypes())) {
            throw new InvalidArgumentException(
                sprintf(
                    "Invalid form enc type passed, must be one of these: %s",
                    implode(', ', self::getValidFormEncTypes())
                )
            );
        }

        $this->form_enc_type = $form_enc_type;
        return $this;
    }

    public function getFormAction(): ?string
    {
        return $this->form_action;
    }

    public function setFormAction(string $form_action): self
    {
        if (!is_string($form_action)) {
            throw new InvalidArgumentException(
                "The form action must be of type 'string'"
            );
        }

        $this->form_action = $form_action;
        return $this;
    }

    public function getForm(): string
    {
        return $this->form;
    }

    public function setForm(string $form): self
    {
        if (!is_string($form)) {
            throw new InvalidArgumentException(
                "The form id must be of type 'string'"
            );
        }

        $this->form = $form;
        return $this;
    }

    public function getValue(): ?string
    {
        return $this->value;
    }

    public function setValue(string $value): self
    {
        if (!is_string($value)) {
            throw new InvalidArgumentException(
                "The initial value of the button must be of type 'string'"
            );
        }

        $this->value = $value;
        return $this;
    }

    public function getName(): ?string
    {
        return $this->name;
    }

    public function setName(string $name, bool $is_command = true): self
    {
        if (!is_string($name)) {
            throw new InvalidArgumentException(
                "The name of the button must be of type 'string'"
            );
        }

        $this->name = $is_command ? 'cmd[' . $name . ']' : $name;
        return $this;
    }

    public function getButtonType(): string
    {
        return $this->button_type;
    }

    public function setButtonType(string $button_type): self
    {
        if (!in_array($button_type, self::getValidButtonTypes())) {
            throw new InvalidArgumentException(
                sprintf(
                    "Invalid button type passed, must be one of these: %s",
                    implode(', ', self::getValidButtonTypes())
                )
            );
        }

        $this->button_type = $button_type;
        return $this;
    }

    public function render(): string
    {
        $this->prepareRender();

        $attr = [];
        $attr['type'] = $this->getButtonType() ?? '';
        $attr['name'] = $this->getName() ?? '';
        $attr['value'] = $this->getValue() ?? '';
        $attr['form'] = $this->getForm() ?? '';
        $attr['formaction'] = $this->getFormAction() ?? '';
        $attr['formmethod'] = $this->getFormMethod() ?? '';
        $attr['formenctype'] = $this->getFormEncType() ?? '';
        $attr['formtarget'] = $this->getFormTarget() ?? '';
        $attr['formnovalidate'] = $this->isFormNovalidate() ? var_export($this->isFormNovalidate(), 1) : null;

        if (self::FORM_TARGET_BLANK === $this->getFormTarget()) {
            $attr['rel'] = 'noopener';
        }

        return '<button' . $this->renderAttributes(array_filter($attr)) . '>' . $this->getCaption() . '</button>';
    }
}