add nova

nova/src/Fields/FieldCollection.php

@@ -0,0 +1,344 @@
+<?php
+
+namespace Laravel\Nova\Fields;
+
+use Illuminate\Database\Eloquent\Relations\Pivot;
+use Illuminate\Http\Request;
+use Illuminate\Http\Resources\MissingValue;
+use Illuminate\Support\Collection;
+use Illuminate\Support\LazyCollection;
+use Laravel\Nova\Contracts\FilterableField;
+use Laravel\Nova\Contracts\ListableField;
+use Laravel\Nova\Contracts\RelatableField;
+use Laravel\Nova\Contracts\Resolvable;
+use Laravel\Nova\Http\Requests\NovaRequest;
+use Laravel\Nova\Panel;
+use Laravel\Nova\ResourceTool;
+use Laravel\Nova\ResourceToolElement;
+use Laravel\Nova\Util;
+
+/**
+ * @template TKey of int
+ * @template TValue of \Laravel\Nova\Panel|\Laravel\Nova\ResourceToolElement|\Laravel\Nova\Fields\Field|\Illuminate\Http\Resources\MissingValue
+ *
+ * @extends \Illuminate\Support\Collection<TKey, TValue>
+ */
+class FieldCollection extends Collection
+{
+    /**
+     * Assign the fields with the given panels to their parent panel.
+     *
+     * @param  string  $label
+     * @return static<TKey, TValue>
+     */
+    public function assignDefaultPanel($label)
+    {
+        new Panel($label, $this->reject(function ($field) {
+            return isset($field->panel);
+        }));
+
+        return $this;
+    }
+
+    /**
+     * Flatten stacked fields.
+     *
+     * @return static<int, TValue>
+     */
+    public function flattenStackedFields()
+    {
+        return $this->map(function ($field) {
+            if ($field instanceof Stack) {
+                return $field->fields()->all();
+            }
+
+            return $field;
+        })->flatten();
+    }
+
+    /**
+     * Find a given field by its attribute.
+     *
+     * @template TGetDefault
+     *
+     * @param  string  $attribute
+     * @param  TGetDefault|\Closure():TGetDefault  $default
+     * @return TValue|TGetDefault
+     */
+    public function findFieldByAttribute($attribute, $default = null)
+    {
+        return $this->first(function ($field) use ($attribute) {
+            return isset($field->attribute) &&
+                $field->attribute == $attribute;
+        }, $default);
+    }
+
+    /**
+     * Filter elements should be displayed for the given request.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return static<int, TValue>
+     */
+    public function authorized(Request $request)
+    {
+        return $this->filter(function ($field) use ($request) {
+            return $field->authorize($request);
+        })->values();
+    }
+
+    /**
+     * Filter elements should be displayed for the given request.
+     *
+     * @param  mixed  $resource
+     * @return static<int, TValue>
+     */
+    public function resolve($resource)
+    {
+        return $this->each(function ($field) use ($resource) {
+            if ($field instanceof Resolvable) {
+                $field->resolve($resource);
+            }
+        });
+    }
+
+    /**
+     * Resolve value of fields for display.
+     *
+     * @param  mixed  $resource
+     * @return static<int, TValue>
+     */
+    public function resolveForDisplay($resource)
+    {
+        return $this->each(function ($field) use ($resource) {
+            if ($field instanceof ListableField || ! $field instanceof Resolvable) {
+                return;
+            }
+
+            if ($field->pivot) {
+                $field->resolveForDisplay($resource->{$field->pivotAccessor} ?? new Pivot);
+            } else {
+                $field->resolveForDisplay($resource);
+            }
+        });
+    }
+
+    /**
+     * Remove non-creation fields from the collection.
+     *
+     * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
+     * @param  mixed  $resource
+     * @return static<int, \Laravel\Nova\Fields\Field>
+     */
+    public function onlyCreateFields(NovaRequest $request, $resource)
+    {
+        return $this->reject(function ($field) use ($resource, $request) {
+            return $field instanceof ListableField ||
+                ($field instanceof ResourceTool || $field instanceof ResourceToolElement) ||
+                $field->attribute === 'ComputedField' ||
+                ($field instanceof ID && $field->attribute === $resource->getKeyName()) ||
+                ! $field->isShownOnCreation($request);
+        });
+    }
+
+    /**
+     * Remove non-update fields from the collection.
+     *
+     * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
+     * @param  mixed  $resource
+     * @return static<int, \Laravel\Nova\Fields\Field>
+     */
+    public function onlyUpdateFields(NovaRequest $request, $resource)
+    {
+        return $this->reject(function ($field) use ($resource, $request) {
+            return $field instanceof ListableField ||
+                ($field instanceof ResourceTool || $field instanceof ResourceToolElement) ||
+                $field->attribute === 'ComputedField' ||
+                ($field instanceof ID && $field->attribute === $resource->getKeyName()) ||
+                ! $field->isShownOnUpdate($request, $resource);
+        });
+    }
+
+    /**
+     * Filter fields for showing on detail.
+     *
+     * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
+     * @param  mixed  $resource
+     * @return static<int, \Laravel\Nova\Fields\Field>
+     */
+    public function filterForDetail(NovaRequest $request, $resource)
+    {
+        return $this->filter(function ($field) use ($resource, $request) {
+            return $field->isShownOnDetail($request, $resource);
+        })->values();
+    }
+
+    /**
+     * Filter fields for showing on preview.
+     *
+     * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
+     * @param  mixed  $resource
+     * @return static<int, \Laravel\Nova\Fields\Field>
+     */
+    public function filterForPreview(NovaRequest $request, $resource)
+    {
+        return $this->filter(function (Field $field) use ($resource, $request) {
+            return $field->isShownOnPreview($request, $resource);
+        })->values();
+    }
+
+    /**
+     * Filter fields for showing when peeking.
+     *
+     * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
+     * @return static<int, \Laravel\Nova\Fields\Field>
+     */
+    public function filterForPeeking(NovaRequest $request)
+    {
+        return $this
+            ->filter(function (Field $field) use ($request) {
+                return $field->isShownWhenPeeking($request);
+            })->values();
+    }
+
+    /**
+     * Filter fields for showing on index.
+     *
+     * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
+     * @param  mixed  $resource
+     * @return static<int, \Laravel\Nova\Fields\Field>
+     */
+    public function filterForIndex(NovaRequest $request, $resource)
+    {
+        return $this->filter(function ($field) use ($resource, $request) {
+            return $field->isShownOnIndex($request, $resource);
+        })->values();
+    }
+
+    /**
+     * Reject if the field is readonly.
+     *
+     * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
+     * @return static<int, TValue>
+     */
+    public function withoutReadonly(NovaRequest $request)
+    {
+        return $this->reject(function ($field) use ($request) {
+            return $field->isReadonly($request);
+        });
+    }
+
+    /**
+     * Reject if the field is a missing value.
+     *
+     * @return static<int, \Laravel\Nova\Panel|\Laravel\Nova\ResourceToolElement|\Laravel\Nova\Fields\Field>
+     */
+    public function withoutMissingValues()
+    {
+        return $this->reject(function ($field) {
+            return $field instanceof MissingValue;
+        });
+    }
+
+    /**
+     * Reject fields which use their own index listings.
+     *
+     * @return static<int, TValue>
+     */
+    public function withoutListableFields()
+    {
+        return $this->reject(function ($field) {
+            return $field instanceof ListableField;
+        });
+    }
+
+    /**
+     * Reject if the field is unfillable.
+     *
+     * @return static<int, TValue>
+     */
+    public function withoutUnfillable()
+    {
+        return $this->reject(function ($field) {
+            return $field instanceof Unfillable;
+        });
+    }
+
+    /**
+     * Reject fields which are actually ResourceTools.
+     *
+     * @return static<int, TValue>
+     */
+    public function withoutResourceTools()
+    {
+        return $this->reject(function ($field) {
+            return $field instanceof ResourceToolElement;
+        });
+    }
+
+    /**
+     * Filter the fields to only many-to-many relationships.
+     *
+     * @return static<TKey, \Laravel\Nova\Fields\MorphToMany|\Laravel\Nova\Fields\BelongsToMany>
+     */
+    public function filterForManyToManyRelations()
+    {
+        return $this->filter(function ($field) {
+            return $field instanceof BelongsToMany || $field instanceof MorphToMany;
+        });
+    }
+
+    /**
+     * Reject if the field supports Filterable Field.
+     *
+     * @return static<TKey, \Laravel\Nova\Fields\Field&\Laravel\Nova\Contracts\FilterableField>
+     */
+    public function withOnlyFilterableFields()
+    {
+        return $this->whereInstanceOf(Field::class)
+            ->whereInstanceOf(FilterableField::class)
+            ->filter(function ($field) {
+                /** @var \Laravel\Nova\Fields\Field&\Laravel\Nova\Contracts\FilterableField $field */
+                return $field->attribute !== 'ComputedField' && ! is_null($field->filterableCallback);
+            });
+    }
+
+    /**
+     * Apply depends on for the request.
+     *
+     * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
+     * @return $this
+     */
+    public function applyDependsOn(NovaRequest $request)
+    {
+        $this->each->applyDependsOn($request);
+
+        return $this;
+    }
+
+    /**
+     * Apply depends on for the request with default values.
+     *
+     * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
+     * @return $this
+     */
+    public function applyDependsOnWithDefaultValues(NovaRequest $request)
+    {
+        $payloads = new LazyCollection(function () use ($request) {
+            foreach ($this->items as $field) {
+                $key = $field instanceof RelatableField ? $field->relationshipName() : $field->attribute;
+
+                if ($field instanceof MorphTo) {
+                    yield "{$key}_type" => $field->morphToType;
+                }
+
+                yield $key => Util::hydrate($field->resolveDependentValue($request));
+            }
+        });
+
+        $this->each->applyDependsOn(
+            NovaRequest::createFrom($request)->mergeIfMissing($payloads->all())
+        );
+
+        return $this;
+    }
+}