add nova

nova/src/Panel.php

@@ -0,0 +1,311 @@
+<?php
+
+namespace Laravel\Nova;
+
+use Illuminate\Http\Resources\ConditionallyLoadsAttributes;
+use Illuminate\Http\Resources\MergeValue;
+use Illuminate\Http\Resources\MissingValue;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Str;
+use Illuminate\Support\Traits\Macroable;
+use JsonSerializable;
+use Laravel\Nova\Contracts\RelatableField;
+use Laravel\Nova\Fields\Collapsable;
+use Laravel\Nova\Http\Requests\NovaRequest;
+use Laravel\Nova\Metrics\HasHelpText;
+
+/**
+ * @phpstan-type TFields \Laravel\Nova\Fields\Field|\Laravel\Nova\ResourceToolElement|\Illuminate\Http\Resources\MergeValue|\Illuminate\Http\Resources\MissingValue
+ * @phpstan-type TPanelFields array<int, TFields>|iterable<int, TFields>
+ *
+ * @method static static make(string $name, \Closure|array|iterable $fields = [])
+ */
+#[\AllowDynamicProperties]
+class Panel extends MergeValue implements JsonSerializable
+{
+    use Collapsable;
+    use ConditionallyLoadsAttributes;
+    use HasHelpText;
+    use Macroable;
+    use Makeable;
+    use Metable;
+
+    /**
+     * The name of the panel.
+     *
+     * @var string
+     */
+    public $name;
+
+    /**
+     * The unique identifier of the panel.
+     *
+     * @var string
+     */
+    public $attribute;
+
+    /**
+     * The panel fields.
+     *
+     * @var array<int, \Laravel\Nova\Fields\Field>
+     */
+    public $data;
+
+    /**
+     * The panel's component.
+     *
+     * @var string
+     */
+    public $component = 'panel';
+
+    /**
+     * Indicates whether the detail toolbar should be visible on this panel.
+     *
+     * @var bool
+     */
+    public $showToolbar = false;
+
+    /**
+     * The initial field display limit.
+     *
+     * @var int|null
+     */
+    public $limit = null;
+
+    /**
+     * The help text for the element.
+     *
+     * @var string
+     */
+    public $helpText;
+
+    /**
+     * Create a new panel instance.
+     *
+     * @param  string  $name
+     * @param  (\Closure():(object))|object  $fields
+     * @param  string  $attribute
+     * @return void
+     *
+     * @phpstan-param (\Closure():(TPanelFields))|TPanelFields $fields
+     */
+    public function __construct($name, $fields = [], $attribute = null)
+    {
+        $this->name = $name;
+        $this->attribute = $attribute ?? Str::slug($name);
+
+        parent::__construct($this->prepareFields($fields));
+    }
+
+    /**
+     * Mutate new panel from list of fields.
+     *
+     * @param  string  $name
+     * @param  \Laravel\Nova\Fields\FieldCollection<int, \Laravel\Nova\Fields\Field>  $fields
+     * @return static
+     */
+    public static function mutate($name, $fields)
+    {
+        $first = $fields->first();
+
+        if ($first instanceof ResourceToolElement) {
+            return static::make($name)
+                ->withComponent($first->component)
+                ->withMeta(['fields' => $fields, 'prefixComponent' => false]);
+        }
+
+        return tap($first->assignedPanel, function ($panel) use ($name, $fields) {
+            $panel->name = $name;
+            $panel->withMeta(['fields' => $fields]);
+        });
+    }
+
+    /**
+     * Prepare the given fields.
+     *
+     * @param  (\Closure():(object))|object  $fields
+     * @return array<int, \Laravel\Nova\Fields\Field>
+     *
+     * @phpstan-param (\Closure():(TPanelFields))|TPanelFields $fields
+     */
+    protected function prepareFields($fields)
+    {
+        $fields = is_callable($fields) ? $fields() : $fields;
+
+        return collect($this->filter($fields instanceof Collection ? $fields->all() : $fields))
+            ->reject(function ($field) {
+                return $field instanceof MissingValue;
+            })
+            ->values()
+            ->each(function ($field) {
+                $field->assignedPanel = $this;
+                $field->panel = $this->name;
+            })->all();
+    }
+
+    /**
+     * Get the default panel name for the given resource.
+     *
+     * @param  \Laravel\Nova\Resource  $resource
+     * @return string
+     */
+    public static function defaultNameForDetail(Resource $resource)
+    {
+        return Nova::__(':resource Details: :title', [
+            'resource' => $resource->singularLabel(),
+            'title' => (string) $resource->title(),
+        ]);
+    }
+
+    /**
+     * Get the default panel name for a create panel.
+     *
+     * @param  \Laravel\Nova\Resource  $resource
+     * @return string
+     */
+    public static function defaultNameForCreate(Resource $resource)
+    {
+        return Nova::__('Create :resource', [
+            'resource' => (string) $resource->singularLabel(),
+        ]);
+    }
+
+    /**
+     * Get the default panel name for the update panel.
+     *
+     * @param  \Laravel\Nova\Resource  $resource
+     * @return string
+     */
+    public static function defaultNameForUpdate(Resource $resource)
+    {
+        return Nova::__('Update :resource: :title', [
+            'resource' => $resource->singularLabel(),
+            'title' => $resource->title(),
+        ]);
+    }
+
+    /**
+     * Get the default panel name for the given resource.
+     *
+     * @param  \Laravel\Nova\Resource  $resource
+     * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
+     * @return string
+     */
+    public static function defaultNameForViaRelationship(Resource $resource, NovaRequest $request)
+    {
+        $field = $request->newViaResource()
+            ->availableFields($request)
+            ->filter(function ($field) use ($request) {
+                return $field instanceof RelatableField
+                    && $field->resourceName === $request->resource
+                    && $field->relationshipName() === $request->viaRelationship;
+            })->first();
+
+        return $field->name;
+    }
+
+    /**
+     * Display the toolbar when showing this panel.
+     *
+     * @return $this
+     */
+    public function withToolbar()
+    {
+        $this->showToolbar = true;
+
+        return $this;
+    }
+
+    /**
+     * Set the number of initially visible fields.
+     *
+     * @param  int  $limit
+     * @return $this
+     */
+    public function limit($limit)
+    {
+        $this->limit = $limit;
+
+        return $this;
+    }
+
+    /**
+     * Set the Vue component key for the panel.
+     *
+     * @param  string  $component
+     * @return $this
+     */
+    public function withComponent($component)
+    {
+        $this->component = $component;
+
+        return $this;
+    }
+
+    /**
+     * Get the Vue component key for the panel.
+     *
+     * @return string
+     */
+    public function component()
+    {
+        return $this->component;
+    }
+
+    /**
+     * Set the width for the help text tooltip.
+     *
+     * @param  string  $helpWidth
+     * @return $this
+     *
+     * @throws \Exception
+     */
+    public function helpWidth($helpWidth)
+    {
+        throw new \Exception('Help width is not supported on panels.');
+    }
+
+    /**
+     * Return the width of the help text tooltip.
+     *
+     * @return string
+     *
+     * @throws \Exception
+     */
+    public function getHelpWidth()
+    {
+        throw new \Exception('Help width is not supported on panels.');
+    }
+
+    /**
+     * Set the unique identifier for the panel.
+     *
+     * @param  string  $attribute
+     * @return $this
+     */
+    public function withAttribute($attribute)
+    {
+        $this->attribute = $attribute;
+
+        return $this;
+    }
+
+    /**
+     * Prepare the panel for JSON serialization.
+     *
+     * @return array<string, mixed>
+     */
+    public function jsonSerialize(): array
+    {
+        return array_merge([
+            'collapsable' => $this->collapsable,
+            'collapsedByDefault' => $this->collapsedByDefault,
+            'component' => $this->component(),
+            'name' => $this->name,
+            'attribute' => $this->attribute,
+            'showToolbar' => $this->showToolbar,
+            'limit' => $this->limit,
+            'helpText' => $this->getHelpText(),
+        ], $this->meta());
+    }
+}