Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
108 lines (91 sloc) 2.17 KB
<?php
/**
* @link https://craftcms.com/
* @copyright Copyright (c) Pixel & Tonic, Inc.
* @license https://craftcms.github.io/license/
*/
namespace craft\base;
use craft\elements\db\ElementQueryInterface;
/**
* ElementAction is the base class for classes representing element actions in terms of objects.
*
* @author Pixel & Tonic, Inc. <support@pixelandtonic.com>
* @since 3.0
*/
abstract class ElementAction extends SavableComponent implements ElementActionInterface
{
// Static
// =========================================================================
/**
* @inheritdoc
*/
public static function isDestructive(): bool
{
return false;
}
// Properties
// =========================================================================
/**
* @var string|ElementInterface
*/
protected $elementType;
/**
* @var
*/
private $_message;
// Public Methods
// =========================================================================
/**
* @inheritdoc
*/
public function setElementType(string $elementType)
{
$this->elementType = $elementType;
}
/**
* @inheritdoc
*/
public function getTriggerLabel(): string
{
return static::displayName();
}
/**
* @inheritdoc
*/
public function getTriggerHtml()
{
return null;
}
/**
* @inheritdoc
*/
public function getConfirmationMessage()
{
return null;
}
/**
* @inheritdoc
*/
public function performAction(ElementQueryInterface $query): bool
{
return true;
}
/**
* @inheritdoc
*/
public function getMessage()
{
return $this->_message;
}
// Protected Methods
// =========================================================================
/**
* 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;
}
}
You can’t perform that action at this time.