Multisite

When applying multisite to a model, only records belonging to the active site are available to manage. The active site is attached to the site_id column set on the record. To enable multi-site for a model, apply the October\Rain\Database\Traits\Multisite trait and define the attributes to propagate across all records using the $propagatable property:

class User extends Model
{
    use \October\Rain\Database\Traits\Multisite;

    protected $propagatable = ['api_code'];
}

To add a site_id column to your table, you may use the integer method from a migration. A site_root_id may also be used to link records together using a root record.

Schema::table('posts', function ($table) {
    $table->integer('site_id')->nullable()->index();
    $table->integer('site_root_id')->nullable()->index();
});

Now, when a record is created it will be assigned to the active site and switching to a different site will propagate a new record automatically. When updating a record, propagated fields are copied to every record belonging to the root record.

# Enforcing Synchronization

In some cases, all records must exist for every site, such as categories and tags. You may force every record to exist across all sites by setting the $propagatableSync property to true, which is false by default. Once enabled, after a model is saved, it will create the same model for other sites if they do not already exist.

protected $propagatableSync = true;

When using Site Groups, the records will be propagated to all sites within that group. This can be controlled by setting the $propagatableSync property to an array containing configuration options.

• sync - logic to sync specific sites, available options: all, group, locale. Default: group
• delete - delete all linked records when any record is deleted, default: true
• except - provides attribute names that should not be replicated for newly synced records

protected $propagatableSync = [
    'sync' => 'all',
    'delete' => false,
    'except' => [
        'description'
    ]
];

# Saving Models

Models saved with the multisite trait do not propagate by default. Use the savePropagate method to ensure the propagation rules take effect.

$model->savePropagate();

# See Also