Add Support to ULID column type

config/media-library.php

@@ -14,6 +14,11 @@
  */
  'max_file_size' => 1024 * 1024 * 10, // 10MB
 
+ /*
+ * Determiner if the media table should use ULID instead of UUID.
+ */
+ 'use_ulid_column' => env('MEDIA_USE_ULID_COLUMN', false),
+
  /*
  * This queue connection will be used to generate derived and responsive images.
  * Leave empty to use the default queue connection.

database/migrations/create_media_table.php.stub

@@ -12,7 +12,13 @@ return new class extends Migration
  $table->id();
 
  $table->morphs('model');
- $table->uuid()->nullable()->unique();
+
+ if (config('media-library.use_ulid_column') === true) {
+ $table->ulid()->nullable()->unique();
+ } else {
+ $table->uuid()->nullable()->unique();
+ }
+
  $table->string('collection_name');
  $table->string('name');
  $table->string('file_name');

docs/installation-setup.md

@@ -51,6 +51,11 @@ return [
  * Adding a larger file will result in an exception.
  */
  'max_file_size' => 1024 * 1024 * 10,
+
+ /*
+ * Determiner if the media table should use ULID instead of UUID.
+ */
+ 'use_ulid_column' => env('MEDIA_USE_ULID_COLUMN', false),
 
  /*
  * This queue connection will be used to generate derived and responsive images.

src/MediaCollections/Models/Concerns/DetermineUniqueIdentifierColumn.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Spatie\MediaLibrary\MediaCollections\Models\Concerns;
+
+trait DetermineUniqueIdentifierColumn
+{
+ public static function determineUniqueIdentifierColumn(): string
+ {
+ return config('media-library.use_ulid_column') === true ? 'ulid' : 'uuid';
+ }
+}

src/MediaCollections/Models/Concerns/HasUuid.php

@@ -10,9 +10,11 @@ trait HasUuid
  public static function bootHasUuid(): void
  {
  static::creating(function (Model $model) {
+ $column = self::determineUniqueIdentifierColumn();
+
  /** @var \Spatie\MediaLibrary\MediaCollections\Models\Media $model */
- if (empty($model->uuid)) {
- $model->uuid = (string) Str::uuid();
+ if (empty($model->{$column})) {
+ $model->{$column} = $column === 'ulid' ? (string) Str::ulid() : (string) Str::uuid();
  }
  });
  }
@@ -21,4 +23,14 @@ public static function findByUuid(string $uuid): ?Model
  {
  return static::where('uuid', $uuid)->first();
  }
+
+ public static function findByUlid(string $ulid): ?Model
+ {
+ return static::where('ulid', $ulid)->first();
+ }
+
+ public static function findBy(string $unique): ?Model
+ {
+ return static::where(self::determineUniqueIdentifierColumn(), $unique)->first();
+ }
 }

src/MediaCollections/Models/Media.php

@@ -26,6 +26,7 @@
 use Spatie\MediaLibrary\MediaCollections\HtmlableMedia;
 use Spatie\MediaLibrary\MediaCollections\Models\Collections\MediaCollection;
 use Spatie\MediaLibrary\MediaCollections\Models\Concerns\CustomMediaProperties;
+use Spatie\MediaLibrary\MediaCollections\Models\Concerns\DetermineUniqueIdentifierColumn;
 use Spatie\MediaLibrary\MediaCollections\Models\Concerns\HasUuid;
 use Spatie\MediaLibrary\MediaCollections\Models\Concerns\IsSorted;
 use Spatie\MediaLibrary\ResponsiveImages\RegisteredResponsiveImages;
@@ -39,6 +40,7 @@
 
 /**
  * @property string $uuid
+ * @property string $ulid
  * @property string $model_type
  * @property string|int $model_id
  * @property string $collection_name
@@ -64,6 +66,7 @@
 class Media extends Model implements Attachable, Htmlable, Responsable
 {
  use CustomMediaProperties;
+ use DetermineUniqueIdentifierColumn;
  use HasUuid;
  use IsSorted;