website·Indexed 32 days ago
https://runway.duncanmcclean.com/A tool to manage Eloquent models within Statamic. It provides integration for the Statamic Control Panel, front-end routing, and support for GraphQL and REST APIs. Key features include Blueprints for content modeling, Eloquent relationship management, revisions, and Antlers templating tags. Requires Statamic 5, Laravel 10+, and PHP 8.2+.
Site::selected()->handle() method.// app/Models/Post.php
use Illuminate
Database
Eloquent
Attributes
Scope;
use Illuminate
Database
Eloquent
Builder;
#[Scope]
protected function runwayListing(Builder $query): void
{
// Replace 'site' with the actual handle of your site column
$query->where('site', Site::selected()->handle());
}composer.json, run the composer update command, and clear the application caches. It is strongly recommended to upgrade one major version at a time (e.g., do not skip from v3 directly to v5) and test the installation locally before deploying to production."doublethreedigital/runway": "^5.0"composer update doublethreedigital/runway --with-dependencies
php artisan route:clear
php artisan view:clearSTATAMIC_REVISIONS_ENABLED=true// config/runway.php
'resources' => [
\App\Models\Order::class => [
'name' => 'Orders',
'published' => true, // Assumes the model has a `published` boolean column, or specify the column name
'revisions' => true,
],
],To avoid creating a database migration for every new field, you can store fields within JSON columns. This requires three steps:
config/runway.php under the nested_field_prefixes key for the specific model.array, json, or AsArrayObject::class).address_street_name to store street_name inside the address column).// 1. config/runway.php
'resources' => [
Order::class => [
'nested_field_prefixes' => [
'address',
],
],
],
// 2. Eloquent Model
protected function casts(): array
{
return [
'address' => 'array',
];
}// 3. Blueprint
-
handle: address_street_name
field:
type: text
display: 'Street Name'use Illuminate\Database\Eloquent\Casts\Attribute;
public function fullName(): Attribute
{
return Attribute::make(
get: function () {
return "{$this->first_name} {$this->last_name}";
}
);
}belongs_to fieldtype to manage Eloquent belongsTo relationships. To implement this, define the relationship in your Laravel model and add the corresponding field to your Statamic blueprint. The field handle must match the database column name.// Model definition
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
class Post extends Model
{
public function author(): BelongsTo
{
return $this->belongsTo(Author::class);
}
}# Blueprint configuration
- handle: author_id
field:
type: belongs_to
display: Author
resource: authorstorage/statamic/revisions directory. To store them in the database instead, install the official Eloquent Driver and select the 'Revisions' repository.php please install:eloquent-driverMinimum PHP: 8.2
Minimum Laravel: 11
Recommended PHP: 8.4
Recommended Laravel: 12To upgrade from Runway v5.x to v6.0, follow these steps in order. Do not skip versions (e.g., do not upgrade directly from v4 to v6). Test all changes locally before deploying to production.
HasRunwayResource and RunwayRoutes in your Eloquent models.# 1. Re-install
composer remove doublethreedigital/runway
composer require statamic-rad-pack/runway:^6.0
# 3. Migrate blueprints
php please runway:migrate-blueprints
# 4. Clear caches
php artisan route:clear
php artisan view:clearStatamicRadPack\Runway\Policies\ResourcePolicy class and rebind it in your AppServiceProvider.// app/Policies/ResourcePolicy.php
namespace App\Policies;
use StatamicRadPack\Runway\Policies\ResourcePolicy as RunwayResourcePolicy;
use Illuminate\Auth\Access\HandlesAuthorization;
class ResourcePolicy extends RunwayResourcePolicy
{
use HandlesAuthorization;
public function edit($user, $resource)
{
// Custom checks here
return parent::edit($user, $resource);
}
}
// app/Providers/AppServiceProvider.php
public function boot()
{
$this->app->bind(\StatamicRadPack\Runway\Policies\ResourcePolicy::class, \App\Policies\ResourcePolicy::class);
}{{ runway:resource_name }} Antlers tag (or <s:runway:resource_name> Blade component) to fetch model data for specific resources. This allows you to loop through records and display their fields in your templates.{{ runway:post }}
<h2>{{ title }}</h2>
<p>{{ intro_text }}</p>
{{ /runway:post }}<s:runway:post>
<h2>{{ $title }}</h2>
<p>{{ $intro_text }}</p>
</s:runway:post>