Action.php

<?php

namespace Statamic\Actions;

use Illuminate\Contracts\Support\Arrayable;
use Statamic\Extend\HasFields;
use Statamic\Extend\HasHandle;
use Statamic\Extend\HasTitle;
use Statamic\Extend\RegistersItself;

abstract class Action implements Arrayable
{
    use HasFields, HasHandle, HasTitle, RegistersItself;

    protected static $binding = 'actions';

    protected $items;
    protected $confirm = true;
    protected $dangerous = false;
    protected $fields = [];
    protected $context = [];

    public function __construct()
    {
        $this->items = collect();
    }

    public function items($items)
    {
        $this->items = collect($items);

        return $this;
    }

    public function visibleTo($item)
    {
        return true;
    }

    public function visibleToBulk($items)
    {
        $allowedOnItems = $items->filter(function ($item) {
            return $this->visibleTo($item);
        });

        return $items->count() === $allowedOnItems->count();
    }

    public function authorize($user, $item)
    {
        return true;
    }

    public function authorizeBulk($user, $items)
    {
        $authorizedOnItems = $items->filter(function ($item) use ($user) {
            return $this->authorize($user, $item);
        });

        return $items->count() === $authorizedOnItems->count();
    }

    public function context($context)
    {
        if (! isset($context['view'])) {
            $context['view'] = 'list';
        }

        $this->context = $context;

        return $this;
    }

    protected function fieldItems()
    {
        return $this->fields;
    }

    public function run($items, $values)
    {
        //
    }

    public function redirect($items, $values)
    {
        return false;
    }

    public function download($items, $values)
    {
        return false;
    }

    public function buttonText()
    {
        /** @translation */
        return 'Run action|Run action on :count items';
    }

    public function confirmationText()
    {
        /** @translation */
        return 'Are you sure you want to run this action?|Are you sure you want to run this action on :count items?';
    }

    public function warningText()
    {
        return null;
    }

    public function dirtyWarningText()
    {
        /** @translation */
        return "Any unsaved changes will not be reflected in this action's behavior.";
    }

    public function bypassesDirtyWarning(): bool
    {
        return false;
    }

    public function requiresElevatedSession(): bool
    {
        return false;
    }

    public function toArray()
    {
        return [
            'handle' => $this->handle(),
            'title' => $this->title(),
            'confirm' => $this->confirm,
            'buttonText' => $this->buttonText(),
            'confirmationText' => $this->confirmationText(),
            'warningText' => $this->warningText(),
            'dirtyWarningText' => $this->dirtyWarningText(),
            'bypassesDirtyWarning' => $this->bypassesDirtyWarning(),
            'requiresElevatedSession' => $this->requiresElevatedSession(),
            'dangerous' => $this->dangerous,
            'fields' => $this->fields()->toPublishArray(),
            'values' => $this->fields()->preProcess()->values(),
            'meta' => $this->fields()->meta(),
            'context' => $this->context,
        ];
    }
}