flipbox\craft\integration\fields\actions\AbstractIntegrationAction

Complexity

Total Complexity

8

Size/Duplication

Total Lines	79
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

0%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	isDestructive()	0	4	1
A	getTriggerLabel()	0	4	1
A	getTriggerHtml()	0	4	1
A	getConfirmationMessage()	0	3	1
A	performAction()	0	4	1
A	getMessage()	0	4	1
A	setMessage()	0	4	1
A	attributes()	0	9	1

<?php

/**
 * @copyright  Copyright (c) Flipbox Digital Limited
 * @license    https://github.com/flipboxfactory/craft-integration/blob/master/LICENSE
 * @link       https://github.com/flipboxfactory/craft-integration/
 */

namespace flipbox\craft\integration\fields\actions;

use craft\base\ElementInterface;
use craft\base\SavableComponent;
use flipbox\craft\integration\fields\Integrations;

abstract class AbstractIntegrationAction extends SavableComponent implements IntegrationActionInterface
{
    /**
     * The message that should be displayed to the user after the action is performed.
     *
     * @var string
     */
    private $message;

    /**
     * @inheritdoc
     */
    public static function isDestructive(): bool
    {
        return false;
    }

    /**
     * @inheritdoc
     */
    public function getTriggerLabel(): string
    {
        return static::displayName();
    }

    /**
     * @inheritdoc
     */
    public function getTriggerHtml()
    {
        return null;
    }

    /**
     * @inheritdoc
     */
    public function getConfirmationMessage()
    {
    }

    /**
     * @inheritdoc
     */
    public function performAction(Integrations $field, ElementInterface $element): bool
    {
        return true;
    }

    /**
     * @inheritdoc
     */
    public function getMessage()
    {
        return $this->message;
    }

    /**
     * Sets the message that should be displayed to the user after the action is performed.
     *
     * @param string $message The message that should be displayed to the user after the action is performed.
     */
    protected function setMessage(string $message)
    {
        $this->message = $message;
    }

    /**
     * @inheritdoc
     */
    public function attributes()
    {
        return array_merge(
            parent::attributes(),
            [
                'message'
            ]
        );
    }
}