Primary Key = filename

[trovster]

I am migrating my content from custom repository pattern to Orbit and when I created the model I inserted the filename of the markdown file, as to generate a unique key. This also acted at the route key.

Would it make sense to insert the filename as part of inserting data? This could be treated at the primary key by default. This could be changed by supplying a key (pk) in the frontmatter for Markdown files.

If not, would I be able to do this by extending/overwriting? Would this have to be a custom driver?

[trovster]

(I have upgraded to v2) which the upgrade.md file states;

• The parse() method will receive a file path and should return an array of attributes for the given file.

But I've noticed the parse() method for drivers are being passed a string… this puts a spanner in the works for the above, as the driver not longer receives the filename.

public function refresh(Orbit&Model $model, Driver $driver): void
{
    $directory = config('orbit.paths.content') . DIRECTORY_SEPARATOR . $model->getOrbitSource();
    $iterator = new FilesystemIterator($directory, FilesystemIterator::SKIP_DOTS);
    $records = [];

    foreach ($iterator as $file) {
        $contents = file_get_contents($file->getRealPath());
        $records[] = $driver->parse($contents);
    }

[trovster]

I have managed to do what I needed using v1. By default the key is populated by the file name. This allows me to set the getKeyName() and routing works correctly based on the filename. I am also able to manually set a key in the frontmatter which overrides this default.

I added my custom Markdown driver to the app provider.

Orbit::extend('md', static fn (): Markdown => new Markdown());

And my driver looks like this;

<?php

namespace App\Orbit\Drivers;

use App\Support\Str;
use Illuminate\Database\Schema\Blueprint;
use Orbit\Drivers\Markdown as Driver;
use Spatie\YamlFrontMatter\YamlFrontMatter;
use SplFileInfo;

class Markdown extends Driver
{
    public function schema(Blueprint $table): void
    {
        if (! $table->hasColumn('key')) {
            $table->string('key');
        }

        parent::schema($table);
    }

    protected function parseContent(SplFileInfo $file): array
    {
        $document = YamlFrontMatter::parseFile($file->getPathname());
        $fileName = Str::of($file->getPathname())->afterLast('/')->beforeLast('.')->value();

        return [
            'key' => $fileName,
            ...$document->matter(),
            'content' => trim($document->body()),
        ];
    }
}