Current File : //home/forge/api-takeaseat.eco-n-tech.co.uk/vendor/laravel/nova/src/Actions/Action.php
<?php
namespace Laravel\Nova\Actions;
use Closure;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Validator;
use Illuminate\Support\Str;
use JsonSerializable;
use Laravel\Nova\AuthorizedToSee;
use Laravel\Nova\Exceptions\MissingActionHandlerException;
use Laravel\Nova\Fields\ActionFields;
use Laravel\Nova\Http\Requests\ActionRequest;
use Laravel\Nova\Http\Requests\NovaRequest;
use Laravel\Nova\Makeable;
use Laravel\Nova\Metable;
use Laravel\Nova\Nova;
use Laravel\Nova\ProxiesCanSeeToGate;
use ReflectionClass;
class Action implements JsonSerializable
{
use Metable, AuthorizedToSee, ProxiesCanSeeToGate, Makeable;
/**
* The displayable name of the action.
*
* @var string
*/
public $name;
/**
* The action's component.
*
* @var string
*/
public $component = 'confirm-action-modal';
/**
* Indicates if need to skip log action events for models.
*
* @var bool
*/
public $withoutActionEvents = false;
/**
* Indicates if this action is available to run against the entire resource.
*
* @var bool
*/
public $availableForEntireResource = false;
/**
* Determine where the action redirection should be without confirmation.
*
* @var bool
*/
public $withoutConfirmation = false;
/**
* Indicates if this action is only available on the resource index view.
*
* @var bool
*/
public $onlyOnIndex = false;
/**
* Indicates if this action is only available on the resource detail view.
*
* @var bool
*/
public $onlyOnDetail = false;
/**
* Indicates if this action is available on the resource index view.
*
* @var bool
*/
public $showOnIndex = true;
/**
* Indicates if this action is available on the resource detail view.
*
* @var bool
*/
public $showOnDetail = true;
/**
* Indicates if this action is available on the resource's table row.
*
* @var bool
*/
public $showOnTableRow = false;
/**
* The current batch ID being handled by the action.
*
* @var string|null
*/
public $batchId;
/**
* The callback used to authorize running the action.
*
* @var \Closure|null
*/
public $runCallback;
/**
* The number of models that should be included in each chunk.
*
* @var int
*/
public static $chunkCount = 200;
/**
* The text to be used for the action's confirm button.
*
* @var string
*/
public $confirmButtonText = 'Run Action';
/**
* The text to be used for the action's cancel button.
*
* @var string
*/
public $cancelButtonText = 'Cancel';
/**
* The text to be used for the action's confirmation text.
*
* @var string
*/
public $confirmText = 'Are you sure you want to run this action?';
/**
* Indicates if the action can be run without any models.
*
* @var bool
*/
public $standalone = false;
/**
* Determine if the action is executable for the given request.
*
* @param \Illuminate\Http\Request $request
* @param \Illuminate\Database\Eloquent\Model $model
* @return bool
*/
public function authorizedToRun(Request $request, $model)
{
return $this->runCallback ? call_user_func($this->runCallback, $request, $model) : true;
}
/**
* Return a message response from the action.
*
* @param string $message
* @return array
*/
public static function message($message)
{
return ['message' => $message];
}
/**
* Return a dangerous message response from the action.
*
* @param string $message
* @return array
*/
public static function danger($message)
{
return ['danger' => $message];
}
/**
* Return a delete response from the action.
*
* @return array
*/
public static function deleted()
{
return ['deleted' => true];
}
/**
* Return a redirect response from the action.
*
* @param string $url
* @return array
*/
public static function redirect($url)
{
return ['redirect' => $url];
}
/**
* Return a Vue router response from the action.
*
* @param string $path
* @param array $query
* @return array
*/
public static function push($path, $query = [])
{
return [
'push' => [
'path' => $path,
'query' => $query,
],
];
}
/**
* Return an open new tab response from the action.
*
* @param string $url
* @return array
*/
public static function openInNewTab($url)
{
return ['openInNewTab' => $url];
}
/**
* Return a download response from the action.
*
* @param string $url
* @param string $name
* @return array
*/
public static function download($url, $name)
{
return ['download' => $url, 'name' => $name];
}
/**
* Return an action modal response from the action.
*
* @param string $modal
* @param array $data
* @return array
*/
public static function modal($modal, $data)
{
return array_merge(['modal' => $modal], $data);
}
/**
* Execute the action for the given request.
*
* @param \Laravel\Nova\Http\Requests\ActionRequest $request
* @return mixed
* @throws MissingActionHandlerException
*/
public function handleRequest(ActionRequest $request)
{
$method = ActionMethod::determine($this, $request->targetModel());
if (! method_exists($this, $method)) {
throw MissingActionHandlerException::make($this, $method);
}
$wasExecuted = false;
$fields = $request->resolveFields();
if ($this->standalone) {
$wasExecuted = true;
$results = [
DispatchAction::forModels(
$request, $this, $method, $results = collect([]), $fields
),
];
} else {
$results = $request->chunks(
static::$chunkCount, function ($models) use ($fields, $request, $method, &$wasExecuted) {
$models = $models->filterForExecution($request);
if (count($models) > 0) {
$wasExecuted = true;
}
return DispatchAction::forModels(
$request, $this, $method, $models, $fields
);
}
);
}
if (! $wasExecuted) {
return static::danger(__('Sorry! You are not authorized to perform this action.'));
}
return $this->handleResult($fields, $results);
}
/**
* Handle chunk results.
*
* @param \Laravel\Nova\Fields\ActionFields $fields
* @param array $results
*
* @return mixed
*/
public function handleResult(ActionFields $fields, $results)
{
return count($results) ? end($results) : null;
}
/**
* Handle any post-validation processing.
*
* @param \Laravel\Nova\Http\Requests\NovaRequest $request
* @param \Illuminate\Contracts\Validation\Validator $validator
* @return void
*/
protected function afterValidation(NovaRequest $request, $validator)
{
//
}
/**
* Mark the action event record for the model as finished.
*
* @param \Illuminate\Database\Eloquent\Model $model
* @return int
*/
protected function markAsFinished($model)
{
return $this->batchId ? Nova::actionEvent()->markAsFinished($this->batchId, $model) : 0;
}
/**
* Mark the action event record for the model as failed.
*
* @param \Illuminate\Database\Eloquent\Model $model
* @param \Throwable|string $e
* @return int
*/
protected function markAsFailed($model, $e = null)
{
return $this->batchId ? Nova::actionEvent()->markAsFailed($this->batchId, $model, $e) : 0;
}
/**
* Get the fields available on the action.
*
* @return array
*/
public function fields()
{
return [];
}
/**
* Validate the given request.
*
* @param \Laravel\Nova\Http\Requests\ActionRequest $request
* @return array
*
* @throws \Illuminate\Validation\ValidationException
*/
public function validateFields(ActionRequest $request)
{
$fields = collect($this->fields());
return Validator::make(
$request->all(),
$fields->mapWithKeys(function ($field) use ($request) {
return $field->getCreationRules($request);
})->all(),
[],
$fields->reject(function ($field) {
return empty($field->name);
})->mapWithKeys(function ($field) {
return [$field->attribute => $field->name];
})->all()
)->after(function ($validator) use ($request) {
$this->afterValidation($request, $validator);
})->validate();
}
/**
* Indicate that this action can be run for the entire resource at once.
*
* @param bool $value
* @return $this
*
* @deprecated
*/
public function availableForEntireResource($value = true)
{
$this->availableForEntireResource = $value;
return $this;
}
/**
* Indicate that this action is only available on the resource index view.
*
* @param bool $value
* @return $this
*/
public function onlyOnIndex($value = true)
{
$this->onlyOnIndex = $value;
$this->showOnIndex = $value;
$this->showOnDetail = ! $value;
$this->showOnTableRow = ! $value;
return $this;
}
/**
* Indicate that this action is available except on the resource index view.
*
* @return $this
*/
public function exceptOnIndex()
{
$this->showOnDetail = true;
$this->showOnTableRow = true;
$this->showOnIndex = false;
return $this;
}
/**
* Indicate that this action is only available on the resource detail view.
*
* @param bool $value
* @return $this
*/
public function onlyOnDetail($value = true)
{
$this->onlyOnDetail = $value;
$this->showOnDetail = $value;
$this->showOnIndex = ! $value;
$this->showOnTableRow = ! $value;
return $this;
}
/**
* Indicate that this action is available except on the resource detail view.
*
* @return $this
*/
public function exceptOnDetail()
{
$this->showOnIndex = true;
$this->showOnDetail = false;
$this->showOnTableRow = true;
return $this;
}
/**
* Indicate that this action is only available on the resource's table row.
*
* @param bool $value
* @return $this
*/
public function onlyOnTableRow($value = true)
{
$this->showOnTableRow = $value;
$this->showOnIndex = ! $value;
$this->showOnDetail = ! $value;
return $this;
}
/**
* Indicate that this action is available except on the resource's table row.
*
* @return $this
*/
public function exceptOnTableRow()
{
$this->showOnTableRow = false;
$this->showOnIndex = true;
$this->showOnDetail = true;
return $this;
}
/**
* Show the action on the index view.
*
* @return $this
*/
public function showOnIndex()
{
$this->showOnIndex = true;
return $this;
}
/**
* Show the action on the detail view.
*
* @return $this
*/
public function showOnDetail()
{
$this->showOnDetail = true;
return $this;
}
/**
* Show the action on the table row.
*
* @return $this
*/
public function showOnTableRow()
{
$this->showOnTableRow = true;
return $this;
}
/**
* Set the current batch ID being handled by the action.
*
* @param string $batchId
* @return $this
*/
public function withBatchId($batchId)
{
$this->batchId = $batchId;
return $this;
}
/**
* Set the callback to be run to authorize running the action.
*
* @param \Closure $callback
* @return $this
*/
public function canRun(Closure $callback)
{
$this->runCallback = $callback;
return $this;
}
/**
* Get the component name for the action.
*
* @return string
*/
public function component()
{
return $this->component;
}
/**
* Get the displayable name of the action.
*
* @return string
*/
public function name()
{
return $this->name ?: Nova::humanize($this);
}
/**
* Get the URI key for the action.
*
* @return string
*/
public function uriKey()
{
return Str::slug($this->name(), '-', null);
}
/**
* Set the action to execute instantly.
*
* @return $this
*/
public function withoutConfirmation()
{
$this->withoutConfirmation = true;
return $this;
}
/**
* Set the action to skip action events for models.
*
* @return $this
*/
public function withoutActionEvents()
{
$this->withoutActionEvents = true;
return $this;
}
/**
* Determine if the action is to be shown on the index view.
*
* @return bool
*/
public function shownOnIndex()
{
if ($this->onlyOnIndex == true) {
return true;
}
if ($this->onlyOnDetail) {
return false;
}
return $this->showOnIndex;
}
/**
* Determine if the action is to be shown on the detail view.
*
* @return bool
*/
public function shownOnDetail()
{
if ($this->onlyOnDetail) {
return true;
}
if ($this->onlyOnIndex) {
return false;
}
return $this->showOnDetail;
}
/**
* Determine if the action is to be sown on the table row.
*
* @return bool
*/
public function shownOnTableRow()
{
return $this->showOnTableRow;
}
/**
* Set the text for the action's confirmation button.
*
* @param string $text
* @return $this
*/
public function confirmButtonText($text)
{
$this->confirmButtonText = $text;
return $this;
}
/**
* Set the text for the action's cancel button.
*
* @param string $text
* @return $this
*/
public function cancelButtonText($text)
{
$this->cancelButtonText = $text;
return $this;
}
/**
* Set the text for the action's confirmation message.
*
* @param string $text
* @return $this
*/
public function confirmText($text)
{
$this->confirmText = $text;
return $this;
}
/**
* Return the CSS classes for the Action.
*
* @return string
*/
public function actionClass()
{
return $this instanceof DestructiveAction
? 'btn-danger'
: 'btn-primary';
}
/**
* Mark the action as a standalone action.
*
* @return $this
*/
public function standalone()
{
$this->standalone = true;
return $this;
}
/**
* Determine if the action is a standalone action.
*
* @return bool
*/
public function isStandalone()
{
return $this->standalone;
}
/**
* Prepare the action for JSON serialization.
*
* @return array
*/
public function jsonSerialize()
{
$request = app(NovaRequest::class);
return array_merge([
'cancelButtonText' => __($this->cancelButtonText),
'component' => $this->component(),
'confirmButtonText' => __($this->confirmButtonText),
'class' => $this->actionClass(),
'confirmText' => __($this->confirmText),
'destructive' => $this instanceof DestructiveAction,
'name' => $this->name(),
'uriKey' => $this->uriKey(),
'fields' => collect($this->fields())->each->resolveForAction($request)->all(),
'availableForEntireResource' => $this->availableForEntireResource,
'showOnDetail' => $this->shownOnDetail(),
'showOnIndex' => $this->shownOnIndex(),
'showOnTableRow' => $this->shownOnTableRow(),
'standalone' => $this->isStandalone(),
'withoutConfirmation' => $this->withoutConfirmation,
], $this->meta());
}
/**
* Prepare the instance for serialization.
*
* @return array
*/
public function __sleep()
{
$properties = (new ReflectionClass($this))->getProperties();
return array_values(array_filter(array_map(function ($p) {
return ($p->isStatic() || in_array($name = $p->getName(), ['runCallback', 'seeCallback'])) ? null : $name;
}, $properties)));
}
}
Mini Shell