Model Integration

<?php

namespace App\Models;

use ArtisanPackUI\Seo\Traits\HasSeo;
use Illuminate\Database\Eloquent\Model;

class Post extends Model
{
    use HasSeo;
}

// Access the SEO meta record directly
$seoMeta = $post->seoMeta;

// The relationship is defined as:
public function seoMeta(): MorphOne
{
    return $this->morphOne(SeoMeta::class, 'seoable');
}

$meta = $post->getOrCreateSeoMeta();

// Returns SeoMeta model instance
// Creates one if it doesn't exist

$post->updateSeoMeta([
    'meta_title' => 'Custom Title',
    'meta_description' => 'Custom description.',
    'og_title' => 'Social Title',
    'noindex' => false,
]);

// Only updates provided fields
// Returns the updated SeoMeta model

$data = $post->getSeoData();

// Returns array with all SEO fields:
// [
//     'title' => 'Effective Title',
//     'description' => 'Effective Description',
//     'image' => 'https://...',
//     'og_title' => '...',
//     'og_description' => '...',
//     'twitter_card' => '...',
//     'schema_type' => '...',
//     'noindex' => false,
//     'nofollow' => false,
//     ...
// ]

$title = $post->getSeoTitle();

// Fallback order:
// 1. meta_title from SEO meta
// 2. Model's 'title' attribute
// 3. Model's 'name' attribute
// 4. Model class name

protected function getSeoTitleAttribute(): ?string
{
    return $this->headline ?? $this->title;
}

$fullTitle = $post->getSeoTitleWithSuffix();
// Result: "Post Title | My Site"

// Custom suffix
$fullTitle = $post->getSeoTitleWithSuffix(' - Custom Site');
// Result: "Post Title - Custom Site"

$description = $post->getSeoDescription();

// Fallback order:
// 1. meta_description from SEO meta
// 2. Model's 'description' attribute
// 3. Model's 'excerpt' attribute
// 4. Truncated 'content' attribute
// 5. Site default from config

protected function getSeoDescriptionAttribute(): ?string
{
    return $this->summary ?? $this->excerpt ?? $this->description;
}

$image = $post->getSeoImage();

// Fallback order:
// 1. og_image from SEO meta
// 2. Image from og_image_id (Media Library)
// 3. Model's 'image' attribute
// 4. Model's 'featured_image' attribute
// 5. Default image from config

protected function getSeoImageAttribute(): ?string
{
    return $this->cover_image ?? $this->thumbnail;
}

$url = $post->getSeoUrl();

// Default implementation:
// Returns the model's 'url' attribute
// Or generates from route if RouteModelBinding is used

protected function getSeoUrlAttribute(): ?string
{
    return route('posts.show', $this);
}

if ($post->shouldBeIndexed()) {
    // robots: index
}

// Returns true unless noindex is explicitly set

if ($post->shouldBeFollowed()) {
    // robots: follow
}

// Returns true unless nofollow is explicitly set

$robots = $post->getRobotsDirective();
// Result: "index, follow" or "noindex, nofollow" etc.

if ($post->shouldBeInSitemap()) {
    // Include in sitemap
}

// Returns false if:
// - noindex is true
// - exclude_from_sitemap is true

$priority = $post->getSitemapPriority();
// Returns: 0.0 to 1.0

$changefreq = $post->getSitemapChangefreq();
// Returns: always, hourly, daily, weekly, monthly, yearly, never

$lastmod = $post->getSitemapLastmod();
// Returns: Carbon instance or null

$type = $post->getSchemaType();
// Returns: Article, BlogPosting, Product, etc.

$schemaData = $post->getSchemaData();
// Returns: array of schema properties

$schema = $post->buildSchema();
// Returns: Complete JSON-LD ready array

$og = $post->getOpenGraphData();
// Returns array:
// [
//     'title' => '...',
//     'description' => '...',
//     'image' => '...',
//     'type' => '...',
//     'url' => '...',
//     'site_name' => '...',
//     'locale' => '...',
// ]

$twitter = $post->getTwitterCardData();
// Returns array:
// [
//     'card' => 'summary_large_image',
//     'title' => '...',
//     'description' => '...',
//     'image' => '...',
//     'site' => '@...',
//     'creator' => '@...',
// ]

$hreflang = $post->getHreflang();
// Returns array:
// [
//     'en' => 'https://...',
//     'fr' => 'https://...',
//     'x-default' => 'https://...',
// ]

$post->setHreflang([
    'en' => 'https://example.com/post',
    'fr' => 'https://example.fr/article',
]);

$analysis = $post->getSeoAnalysis();
// Returns array of analyzer results:
// [
//     'score' => 75,
//     'readability' => ['status' => 'pass', 'message' => '...'],
//     'keyword_density' => ['status' => 'warning', 'message' => '...'],
//     ...
// ]

$analysis = $post->refreshSeoAnalysis();
// Clears cache and re-runs all analyzers

// On model created
// - Creates default SEO meta record (if auto_create enabled)

// On model updated
// - Clears SEO cache
// - Updates sitemap entry

// On model deleted
// - Deletes associated SEO meta
// - Removes from sitemap

<?php

namespace App\Models;

use ArtisanPackUI\Seo\Traits\HasSeo;
use Illuminate\Database\Eloquent\Model;

class Product extends Model
{
    use HasSeo;

    // Custom title resolution
    protected function getSeoTitleAttribute(): ?string
    {
        return $this->product_name . ' - ' . $this->brand->name;
    }

    // Custom description
    protected function getSeoDescriptionAttribute(): ?string
    {
        return $this->short_description ?? substr($this->description, 0, 160);
    }

    // Custom image
    protected function getSeoImageAttribute(): ?string
    {
        return $this->images->first()?->url ?? $this->category->default_image;
    }

    // Custom URL
    protected function getSeoUrlAttribute(): ?string
    {
        return route('products.show', [
            'category' => $this->category->slug,
            'product' => $this->slug,
        ]);
    }

    // Custom schema type
    public function getSchemaType(): string
    {
        return 'Product';
    }

    // Custom schema data
    public function getSchemaData(): array
    {
        return [
            'name' => $this->product_name,
            'description' => $this->description,
            'sku' => $this->sku,
            'brand' => ['@type' => 'Brand', 'name' => $this->brand->name],
            'offers' => [
                '@type' => 'Offer',
                'price' => $this->price,
                'priceCurrency' => 'USD',
                'availability' => $this->in_stock
                    ? 'https://schema.org/InStock'
                    : 'https://schema.org/OutOfStock',
            ],
        ];
    }
}